Onchain.Aave.V4.Types.SpokeUserPosition (onchain_aave v0.4.0)

Copy Markdown View Source

Typed Aave V4 ISpoke.UserPosition data for one user and reserve.

API Functions

FunctionArityDescriptionParam Kinds
from_raw1Convert a decoded ISpoke.UserPosition tuple into a typed struct.raw: exchange_data

Summary

Functions

Convert a decoded ISpoke.UserPosition tuple into a typed struct.

Types

t()

@type t() :: %Onchain.Aave.V4.Types.SpokeUserPosition{
  drawn_shares: non_neg_integer(),
  dynamic_config_key: non_neg_integer(),
  premium_offset_ray: integer(),
  premium_shares: non_neg_integer(),
  supplied_shares: non_neg_integer()
}

Functions

from_raw(arg)

@spec from_raw(tuple()) :: t()

Convert a decoded ISpoke.UserPosition tuple into a typed struct.

Parameters

  • raw - 5-element tuple returned by getUserPosition (exchange_data)

Returns

%SpokeUserPosition{} (struct)

# descripex:contract
%{
  params: %{
    raw: %{
      description: "5-element tuple returned by getUserPosition",
      kind: :exchange_data
    }
  },
  returns: %{type: :struct, description: "%SpokeUserPosition{}"}
}