Class: Privy::Models::EthereumEarnVaultDetailsResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Privy::Models::EthereumEarnVaultDetailsResponse

Defined in:

lib/privy/models/ethereum_earn_vault_details_response.rb

Instance Attribute Summary

• #app_apy ⇒ Float^?

  Annual percentage yield earned by the app from fee wrapper fees, in basis points.

• #asset ⇒ Privy::Models::EarnAsset

  Asset metadata for an earn vault position.

• #available_liquidity_usd ⇒ Float^?

  Available liquidity in USD.

• #caip2 ⇒ String

  CAIP-2 chain identifier (e.g. “eip155:8453”).

• #id ⇒ String

  Vault identifier.

• #name ⇒ String

  Human-readable vault name from the yield provider.

• #provider ⇒ Symbol, Privy::Models::EthereumEarnProvider

  Supported earn provider protocols.

• #tvl_usd ⇒ Float^?

  Total value locked in USD.

• #user_apy ⇒ Float^?

  Current annual percentage yield in basis points (e.g. 500 for 5%).

• #vault_address ⇒ String

  Onchain vault contract address.

Instance Method Summary

• #initialize(id:, app_apy:, asset:, available_liquidity_usd:, caip2:, name:, provider:, tvl_usd:, user_apy:, vault_address:) ⇒ Object constructor

  Some parameter documentations has been truncated, see EthereumEarnVaultDetailsResponse for more details.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, app_apy:, asset:, available_liquidity_usd:, caip2:, name:, provider:, tvl_usd:, user_apy:, vault_address:) ⇒ Object

Some parameter documentations has been truncated, see Privy::Models::EthereumEarnVaultDetailsResponse for more details.

Detailed vault information including current APY, liquidity, and asset metadata.

Parameters:

• id (String) —

  Vault identifier.

• app_apy (Float, nil) —

  Annual percentage yield earned by the app from fee wrapper fees, in basis points

• asset (Privy::Models::EarnAsset) —

  Asset metadata for an earn vault position.

• available_liquidity_usd (Float, nil) —

  Available liquidity in USD.

• caip2 (String) —

  CAIP-2 chain identifier (e.g. “eip155:8453”).

• name (String) —

  Human-readable vault name from the yield provider.

• provider (Symbol, Privy::Models::EthereumEarnProvider) —

  Supported earn provider protocols.

• tvl_usd (Float, nil) —

  Total value locked in USD.

• user_apy (Float, nil) —

  Current annual percentage yield in basis points (e.g. 500 for 5%). 1 basis point

• vault_address (String) —

  Onchain vault contract address.

# File 'lib/privy/models/ethereum_earn_vault_details_response.rb', line 68

Instance Attribute Details

#app_apy ⇒ Float^?

Annual percentage yield earned by the app from fee wrapper fees, in basis points.

Returns:

• (Float, nil)

# File 'lib/privy/models/ethereum_earn_vault_details_response.rb', line 17

required :app_apy, Float, nil?: true

#asset ⇒ Privy::Models::EarnAsset

Asset metadata for an earn vault position.

Returns:

• (Privy::Models::EarnAsset)

# File 'lib/privy/models/ethereum_earn_vault_details_response.rb', line 23

required :asset, -> { Privy::EarnAsset }

#available_liquidity_usd ⇒ Float^?

Available liquidity in USD.

Returns:

• (Float, nil)

# File 'lib/privy/models/ethereum_earn_vault_details_response.rb', line 29

required :available_liquidity_usd, Float, nil?: true

#caip2 ⇒ String

CAIP-2 chain identifier (e.g. “eip155:8453”).

Returns:

• (String)

# File 'lib/privy/models/ethereum_earn_vault_details_response.rb', line 35

required :caip2, String

#id ⇒ String

Vault identifier.

Returns:

• (String)

# File 'lib/privy/models/ethereum_earn_vault_details_response.rb', line 10

required :id, String

#name ⇒ String

Human-readable vault name from the yield provider.

Returns:

• (String)

# File 'lib/privy/models/ethereum_earn_vault_details_response.rb', line 41

required :name, String

#provider ⇒ Symbol, Privy::Models::EthereumEarnProvider

Supported earn provider protocols.

Returns:

• (Symbol, Privy::Models::EthereumEarnProvider)

# File 'lib/privy/models/ethereum_earn_vault_details_response.rb', line 47

required :provider, enum: -> { Privy::EthereumEarnProvider }

#tvl_usd ⇒ Float^?

Total value locked in USD.

Returns:

• (Float, nil)

# File 'lib/privy/models/ethereum_earn_vault_details_response.rb', line 53

required :tvl_usd, Float, nil?: true

#user_apy ⇒ Float^?

Current annual percentage yield in basis points (e.g. 500 for 5%). 1 basis point

0.01%.

Returns:

• (Float, nil)

# File 'lib/privy/models/ethereum_earn_vault_details_response.rb', line 60

required :user_apy, Float, nil?: true

#vault_address ⇒ String

Onchain vault contract address.

Returns:

• (String)

# File 'lib/privy/models/ethereum_earn_vault_details_response.rb', line 66

required :vault_address, String