privy_ruby 0.2.0 → 0.3.0

data/lib/privy/models/wallets/earn_incentive_claim_action_response.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      class EarnIncentiveClaimActionResponse < Privy::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the wallet action.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute chain
+        #   EVM chain name (e.g. "base", "ethereum").
+        #
+        #   @return [String]
+        required :chain, String
+
+        # @!attribute created_at
+        #   ISO 8601 timestamp of when the wallet action was created.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute rewards
+        #   Claimed reward tokens. Populated after the preparation step fetches from Merkl.
+        #
+        #   @return [Array<Privy::Models::Wallets::EarnIncetiveClaimRewardEntry>, nil]
+        required :rewards,
+                 -> { Privy::Internal::Type::ArrayOf[Privy::Wallets::EarnIncetiveClaimRewardEntry] },
+                 nil?: true
+
+        # @!attribute status
+        #   Status of a wallet action.
+        #
+        #   @return [Symbol, Privy::Models::Wallets::WalletActionStatus]
+        required :status, enum: -> { Privy::Wallets::WalletActionStatus }
+
+        # @!attribute type
+        #
+        #   @return [Symbol, Privy::Models::Wallets::EarnIncentiveClaimActionResponse::Type]
+        required :type, enum: -> { Privy::Wallets::EarnIncentiveClaimActionResponse::Type }
+
+        # @!attribute wallet_id
+        #   The ID of the wallet involved in the action.
+        #
+        #   @return [String]
+        required :wallet_id, String
+
+        # @!attribute failure_reason
+        #   A description of why a wallet action (or a step within a wallet action) failed.
+        #
+        #   @return [Privy::Models::Wallets::FailureReason, nil]
+        optional :failure_reason, -> { Privy::Wallets::FailureReason }
+
+        # @!attribute steps
+        #   The steps of the wallet action. Only returned if `?include=steps` is provided.
+        #
+        #   @return [Array<Privy::Models::Wallets::EvmTransactionWalletActionStep, Privy::Models::Wallets::EvmUserOperationWalletActionStep, Privy::Models::Wallets::SvmTransactionWalletActionStep, Privy::Models::Wallets::TvmTransactionWalletActionStep, Privy::Models::Wallets::ExternalTransactionWalletActionStep, Privy::Models::Wallets::CustodianTransactionWalletActionStep>, nil]
+        optional :steps, -> { Privy::Internal::Type::ArrayOf[union: Privy::Wallets::WalletActionStep] }
+
+        # @!method initialize(id:, chain:, created_at:, rewards:, status:, type:, wallet_id:, failure_reason: nil, steps: nil)
+        #   Response for an earn incentive claim action.
+        #
+        #   @param id [String] The ID of the wallet action.
+        #
+        #   @param chain [String] EVM chain name (e.g. "base", "ethereum").
+        #
+        #   @param created_at [Time] ISO 8601 timestamp of when the wallet action was created.
+        #
+        #   @param rewards [Array<Privy::Models::Wallets::EarnIncetiveClaimRewardEntry>, nil] Claimed reward tokens. Populated after the preparation step fetches from Merkl.
+        #
+        #   @param status [Symbol, Privy::Models::Wallets::WalletActionStatus] Status of a wallet action.
+        #
+        #   @param type [Symbol, Privy::Models::Wallets::EarnIncentiveClaimActionResponse::Type]
+        #
+        #   @param wallet_id [String] The ID of the wallet involved in the action.
+        #
+        #   @param failure_reason [Privy::Models::Wallets::FailureReason] A description of why a wallet action (or a step within a wallet action) failed.
+        #
+        #   @param steps [Array<Privy::Models::Wallets::EvmTransactionWalletActionStep, Privy::Models::Wallets::EvmUserOperationWalletActionStep, Privy::Models::Wallets::SvmTransactionWalletActionStep, Privy::Models::Wallets::TvmTransactionWalletActionStep, Privy::Models::Wallets::ExternalTransactionWalletActionStep, Privy::Models::Wallets::CustodianTransactionWalletActionStep>] The steps of the wallet action. Only returned if `?include=steps` is provided.
+
+        # @see Privy::Models::Wallets::EarnIncentiveClaimActionResponse#type
+        module Type
+          extend Privy::Internal::Type::Enum
+
+          EARN_INCENTIVE_CLAIM = :earn_incentive_claim
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/privy/models/wallets/earn_incentive_claim_request_body.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      class EarnIncentiveClaimRequestBody < Privy::Internal::Type::BaseModel
+        # @!attribute chain
+        #   The blockchain network on which to perform the incentive claim. Supported chains
+        #   include: 'ethereum', 'base', 'arbitrum', 'polygon', 'solana', and more, along
+        #   with their respective testnets.
+        #
+        #   @return [String]
+        required :chain, String
+
+        # @!method initialize(chain:)
+        #   Some parameter documentations has been truncated, see
+        #   {Privy::Models::Wallets::EarnIncentiveClaimRequestBody} for more details.
+        #
+        #   Input for claiming incentive rewards.
+        #
+        #   @param chain [String] The blockchain network on which to perform the incentive claim. Supported chains
+      end
+    end
+  end
+end

data/lib/privy/models/wallets/earn_incentive_reward_entry.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      class EarnIncentiveRewardEntry < Privy::Internal::Type::BaseModel
+        # @!attribute amount_claimed
+        #   Total amount already claimed, in smallest unit.
+        #
+        #   @return [String]
+        required :amount_claimed, String
+
+        # @!attribute amount_unclaimed
+        #   Amount available to claim on-chain but not yet claimed, in smallest unit.
+        #
+        #   @return [String]
+        required :amount_unclaimed, String
+
+        # @!attribute token_address
+        #   Address of the reward token.
+        #
+        #   @return [String]
+        required :token_address, String
+
+        # @!attribute token_symbol
+        #   Symbol of the reward token (e.g. "MORPHO").
+        #
+        #   @return [String]
+        required :token_symbol, String
+
+        # @!attribute token_decimals
+        #   Number of decimals for the reward token.
+        #
+        #   @return [Integer, nil]
+        optional :token_decimals, Integer
+
+        # @!method initialize(amount_claimed:, amount_unclaimed:, token_address:, token_symbol:, token_decimals: nil)
+        #   A reward token with claimed and unclaimed amounts.
+        #
+        #   @param amount_claimed [String] Total amount already claimed, in smallest unit.
+        #
+        #   @param amount_unclaimed [String] Amount available to claim on-chain but not yet claimed, in smallest unit.
+        #
+        #   @param token_address [String] Address of the reward token.
+        #
+        #   @param token_symbol [String] Symbol of the reward token (e.g. "MORPHO").
+        #
+        #   @param token_decimals [Integer] Number of decimals for the reward token.
+      end
+    end
+  end
+end

data/lib/privy/models/wallets/earn_incentive_rewards_query.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      class EarnIncentiveRewardsQuery < Privy::Internal::Type::BaseModel
+        # @!attribute chain
+        #   Chain name to fetch rewards for (e.g. "base", "ethereum").
+        #
+        #   @return [String]
+        required :chain, String
+
+        # @!method initialize(chain:)
+        #   Query parameters for fetching incentive rewards.
+        #
+        #   @param chain [String] Chain name to fetch rewards for (e.g. "base", "ethereum").
+      end
+    end
+  end
+end

data/lib/privy/models/wallets/earn_incentive_rewards_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      class EarnIncentiveRewardsResponse < Privy::Internal::Type::BaseModel
+        # @!attribute rewards
+        #   Reward tokens with their claimed and unclaimed amounts.
+        #
+        #   @return [Array<Privy::Models::Wallets::EarnIncentiveRewardEntry>]
+        required :rewards, -> { Privy::Internal::Type::ArrayOf[Privy::Wallets::EarnIncentiveRewardEntry] }
+
+        # @!method initialize(rewards:)
+        #   All incentive rewards for a wallet, with claimed and unclaimed amounts per
+        #   token.
+        #
+        #   @param rewards [Array<Privy::Models::Wallets::EarnIncentiveRewardEntry>] Reward tokens with their claimed and unclaimed amounts.
+      end
+    end
+  end
+end

data/lib/privy/models/wallets/earn_incetive_claim_reward_entry.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      class EarnIncetiveClaimRewardEntry < Privy::Internal::Type::BaseModel
+        # @!attribute amount
+        #   Claimable amount in base units.
+        #
+        #   @return [String]
+        required :amount, String
+
+        # @!attribute token_address
+        #   Address of the reward token.
+        #
+        #   @return [String]
+        required :token_address, String
+
+        # @!attribute token_symbol
+        #   Symbol of the reward token (e.g. "MORPHO").
+        #
+        #   @return [String]
+        required :token_symbol, String
+
+        # @!attribute token_decimals
+        #   Number of decimal places for the reward token.
+        #
+        #   @return [Integer, nil]
+        optional :token_decimals, Integer
+
+        # @!method initialize(amount:, token_address:, token_symbol:, token_decimals: nil)
+        #   A specific reward token and amount associated with an earn incentive claim.
+        #
+        #   @param amount [String] Claimable amount in base units.
+        #
+        #   @param token_address [String] Address of the reward token.
+        #
+        #   @param token_symbol [String] Symbol of the reward token (e.g. "MORPHO").
+        #
+        #   @param token_decimals [Integer] Number of decimal places for the reward token.
+      end
+    end
+  end
+end

data/lib/privy/models/wallets/earn_withdraw_action_response.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      class EarnWithdrawActionResponse < Privy::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the wallet action.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute asset_address
+        #   Underlying asset token address.
+        #
+        #   @return [String]
+        required :asset_address, String
+
+        # @!attribute caip2
+        #   CAIP-2 chain identifier.
+        #
+        #   @return [String]
+        required :caip2, String
+
+        # @!attribute created_at
+        #   ISO 8601 timestamp of when the wallet action was created.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute raw_amount
+        #   Base-unit amount of asset withdrawn (e.g. "1500000").
+        #
+        #   @return [String]
+        required :raw_amount, String
+
+        # @!attribute share_amount
+        #   Vault shares burned in base units. Populated after on-chain confirmation.
+        #
+        #   @return [String, nil]
+        required :share_amount, String, nil?: true
+
+        # @!attribute status
+        #   Status of a wallet action.
+        #
+        #   @return [Symbol, Privy::Models::Wallets::WalletActionStatus]
+        required :status, enum: -> { Privy::Wallets::WalletActionStatus }
+
+        # @!attribute type
+        #
+        #   @return [Symbol, Privy::Models::Wallets::EarnWithdrawActionResponse::Type]
+        required :type, enum: -> { Privy::Wallets::EarnWithdrawActionResponse::Type }
+
+        # @!attribute vault_address
+        #   ERC-4626 vault contract address.
+        #
+        #   @return [String]
+        required :vault_address, String
+
+        # @!attribute vault_id
+        #   The vault ID.
+        #
+        #   @return [String]
+        required :vault_id, String
+
+        # @!attribute wallet_id
+        #   The ID of the wallet involved in the action.
+        #
+        #   @return [String]
+        required :wallet_id, String
+
+        # @!attribute amount
+        #   Human-readable decimal amount of asset withdrawn (e.g. "1.5"). Only present when
+        #   the token is known in the asset registry.
+        #
+        #   @return [String, nil]
+        optional :amount, String
+
+        # @!attribute asset
+        #   Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in
+        #   the asset registry.
+        #
+        #   @return [String, nil]
+        optional :asset, String
+
+        # @!attribute decimals
+        #   Number of decimals for the underlying asset (e.g. 6 for USDC, 18 for ETH). Only
+        #   present when the token is known in the asset registry.
+        #
+        #   @return [Integer, nil]
+        optional :decimals, Integer
+
+        # @!attribute failure_reason
+        #   A description of why a wallet action (or a step within a wallet action) failed.
+        #
+        #   @return [Privy::Models::Wallets::FailureReason, nil]
+        optional :failure_reason, -> { Privy::Wallets::FailureReason }
+
+        # @!attribute steps
+        #   The steps of the wallet action. Only returned if `?include=steps` is provided.
+        #
+        #   @return [Array<Privy::Models::Wallets::EvmTransactionWalletActionStep, Privy::Models::Wallets::EvmUserOperationWalletActionStep, Privy::Models::Wallets::SvmTransactionWalletActionStep, Privy::Models::Wallets::TvmTransactionWalletActionStep, Privy::Models::Wallets::ExternalTransactionWalletActionStep, Privy::Models::Wallets::CustodianTransactionWalletActionStep>, nil]
+        optional :steps, -> { Privy::Internal::Type::ArrayOf[union: Privy::Wallets::WalletActionStep] }
+
+        # @!method initialize(id:, asset_address:, caip2:, created_at:, raw_amount:, share_amount:, status:, type:, vault_address:, vault_id:, wallet_id:, amount: nil, asset: nil, decimals: nil, failure_reason: nil, steps: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Privy::Models::Wallets::EarnWithdrawActionResponse} for more details.
+        #
+        #   Response for an earn withdraw action.
+        #
+        #   @param id [String] The ID of the wallet action.
+        #
+        #   @param asset_address [String] Underlying asset token address.
+        #
+        #   @param caip2 [String] CAIP-2 chain identifier.
+        #
+        #   @param created_at [Time] ISO 8601 timestamp of when the wallet action was created.
+        #
+        #   @param raw_amount [String] Base-unit amount of asset withdrawn (e.g. "1500000").
+        #
+        #   @param share_amount [String, nil] Vault shares burned in base units. Populated after on-chain confirmation.
+        #
+        #   @param status [Symbol, Privy::Models::Wallets::WalletActionStatus] Status of a wallet action.
+        #
+        #   @param type [Symbol, Privy::Models::Wallets::EarnWithdrawActionResponse::Type]
+        #
+        #   @param vault_address [String] ERC-4626 vault contract address.
+        #
+        #   @param vault_id [String] The vault ID.
+        #
+        #   @param wallet_id [String] The ID of the wallet involved in the action.
+        #
+        #   @param amount [String] Human-readable decimal amount of asset withdrawn (e.g. "1.5"). Only present when
+        #
+        #   @param asset [String] Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in t
+        #
+        #   @param decimals [Integer] Number of decimals for the underlying asset (e.g. 6 for USDC, 18 for ETH). Only
+        #
+        #   @param failure_reason [Privy::Models::Wallets::FailureReason] A description of why a wallet action (or a step within a wallet action) failed.
+        #
+        #   @param steps [Array<Privy::Models::Wallets::EvmTransactionWalletActionStep, Privy::Models::Wallets::EvmUserOperationWalletActionStep, Privy::Models::Wallets::SvmTransactionWalletActionStep, Privy::Models::Wallets::TvmTransactionWalletActionStep, Privy::Models::Wallets::ExternalTransactionWalletActionStep, Privy::Models::Wallets::CustodianTransactionWalletActionStep>] The steps of the wallet action. Only returned if `?include=steps` is provided.
+
+        # @see Privy::Models::Wallets::EarnWithdrawActionResponse#type
+        module Type
+          extend Privy::Internal::Type::Enum
+
+          EARN_WITHDRAW = :earn_withdraw
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/privy/models/wallets/earn_withdraw_request_body.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      class EarnWithdrawRequestBody < Privy::Internal::Type::BaseModel
+        # @!attribute vault_id
+        #   The ID of the vault to withdraw from.
+        #
+        #   @return [String]
+        required :vault_id, String
+
+        # @!attribute amount
+        #   Human-readable decimal amount to withdraw (e.g. "1.5" for 1.5 USDC). Exactly one
+        #   of `amount` or `raw_amount` must be provided.
+        #
+        #   @return [String, nil]
+        optional :amount, String
+
+        # @!attribute raw_amount
+        #   Amount in smallest unit to withdraw (e.g. "1500000" for 1.5 USDC with 6
+        #   decimals). Exactly one of `amount` or `raw_amount` must be provided.
+        #
+        #   @return [String, nil]
+        optional :raw_amount, String
+
+        # @!method initialize(vault_id:, amount: nil, raw_amount: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Privy::Models::Wallets::EarnWithdrawRequestBody} for more details.
+        #
+        #   Input for withdrawing assets from an ERC-4626 vault. Exactly one of `amount` or
+        #   `raw_amount` must be provided.
+        #
+        #   @param vault_id [String] The ID of the vault to withdraw from.
+        #
+        #   @param amount [String] Human-readable decimal amount to withdraw (e.g. "1.5" for 1.5 USDC). Exactly one
+        #
+        #   @param raw_amount [String] Amount in smallest unit to withdraw (e.g. "1500000" for 1.5 USDC with 6 decimals
+      end
+    end
+  end
+end

data/lib/privy/models/wallets/ethereum_earn_position_query.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      class EthereumEarnPositionQuery < Privy::Internal::Type::BaseModel
+        # @!attribute vault_id
+        #   The vault ID to get position for.
+        #
+        #   @return [String]
+        required :vault_id, String
+
+        # @!attribute include_archived
+        #   Include archived wallets in lookup. Defaults to false.
+        #
+        #   @return [Boolean, nil]
+        optional :include_archived, Privy::Internal::Type::Boolean
+
+        # @!method initialize(vault_id:, include_archived: nil)
+        #   Query parameters for fetching an earn vault position.
+        #
+        #   @param vault_id [String] The vault ID to get position for.
+        #
+        #   @param include_archived [Boolean] Include archived wallets in lookup. Defaults to false.
+      end
+    end
+  end
+end

data/lib/privy/models/wallets/ethereum_earn_position_response.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      class EthereumEarnPositionResponse < Privy::Internal::Type::BaseModel
+        # @!attribute asset
+        #   Asset metadata for an earn vault position.
+        #
+        #   @return [Privy::Models::Wallets::EarnAsset]
+        required :asset, -> { Privy::Wallets::EarnAsset }
+
+        # @!attribute assets_in_vault
+        #   Current asset value in the vault (realtime from ERC-4626), in smallest unit.
+        #
+        #   @return [String]
+        required :assets_in_vault, String
+
+        # @!attribute shares_in_vault
+        #   Current vault shares held (realtime from ERC-4626).
+        #
+        #   @return [String]
+        required :shares_in_vault, String
+
+        # @!attribute total_deposited
+        #   Total amount deposited into the vault, in smallest unit.
+        #
+        #   @return [String]
+        required :total_deposited, String
+
+        # @!attribute total_withdrawn
+        #   Total amount withdrawn from the vault, in smallest unit.
+        #
+        #   @return [String]
+        required :total_withdrawn, String
+
+        # @!method initialize(asset:, assets_in_vault:, shares_in_vault:, total_deposited:, total_withdrawn:)
+        #   A wallet's position in an earn vault.
+        #
+        #   @param asset [Privy::Models::Wallets::EarnAsset] Asset metadata for an earn vault position.
+        #
+        #   @param assets_in_vault [String] Current asset value in the vault (realtime from ERC-4626), in smallest unit.
+        #
+        #   @param shares_in_vault [String] Current vault shares held (realtime from ERC-4626).
+        #
+        #   @param total_deposited [String] Total amount deposited into the vault, in smallest unit.
+        #
+        #   @param total_withdrawn [String] Total amount withdrawn from the vault, in smallest unit.
+      end
+    end
+  end
+end

data/lib/privy/models/wallets/ethereum_earn_provider.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      # Supported earn provider protocols.
+      module EthereumEarnProvider
+        extend Privy::Internal::Type::Enum
+
+        MORPHO = :morpho
+        AAVE = :aave
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/privy/models/wallets/ethereum_earn_vault_details_response.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Privy
+  module Models
+    module Wallets
+      class EthereumEarnVaultDetailsResponse < Privy::Internal::Type::BaseModel
+        # @!attribute id
+        #   Vault identifier.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute app_apy
+        #   Annual percentage yield earned by the app from fee wrapper fees, in basis
+        #   points.
+        #
+        #   @return [Float, nil]
+        required :app_apy, Float, nil?: true
+
+        # @!attribute asset
+        #   Asset metadata for an earn vault position.
+        #
+        #   @return [Privy::Models::Wallets::EarnAsset]
+        required :asset, -> { Privy::Wallets::EarnAsset }
+
+        # @!attribute available_liquidity_usd
+        #   Available liquidity in USD.
+        #
+        #   @return [Float, nil]
+        required :available_liquidity_usd, Float, nil?: true
+
+        # @!attribute caip2
+        #   CAIP-2 chain identifier (e.g. "eip155:8453").
+        #
+        #   @return [String]
+        required :caip2, String
+
+        # @!attribute name
+        #   Human-readable vault name from the yield provider.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute provider
+        #   Supported earn provider protocols.
+        #
+        #   @return [Symbol, Privy::Models::Wallets::EthereumEarnProvider]
+        required :provider, enum: -> { Privy::Wallets::EthereumEarnProvider }
+
+        # @!attribute tvl_usd
+        #   Total value locked in USD.
+        #
+        #   @return [Float, nil]
+        required :tvl_usd, Float, nil?: true
+
+        # @!attribute user_apy
+        #   Current annual percentage yield in basis points (e.g. 500 for 5%). 1 basis point
+        #   = 0.01%.
+        #
+        #   @return [Float, nil]
+        required :user_apy, Float, nil?: true
+
+        # @!attribute vault_address
+        #   Onchain vault contract address.
+        #
+        #   @return [String]
+        required :vault_address, String
+
+        # @!method initialize(id:, app_apy:, asset:, available_liquidity_usd:, caip2:, name:, provider:, tvl_usd:, user_apy:, vault_address:)
+        #   Some parameter documentations has been truncated, see
+        #   {Privy::Models::Wallets::EthereumEarnVaultDetailsResponse} for more details.
+        #
+        #   Detailed vault information including current APY, liquidity, and asset metadata.
+        #
+        #   @param id [String] Vault identifier.
+        #
+        #   @param app_apy [Float, nil] Annual percentage yield earned by the app from fee wrapper fees, in basis points
+        #
+        #   @param asset [Privy::Models::Wallets::EarnAsset] Asset metadata for an earn vault position.
+        #
+        #   @param available_liquidity_usd [Float, nil] Available liquidity in USD.
+        #
+        #   @param caip2 [String] CAIP-2 chain identifier (e.g. "eip155:8453").
+        #
+        #   @param name [String] Human-readable vault name from the yield provider.
+        #
+        #   @param provider [Symbol, Privy::Models::Wallets::EthereumEarnProvider] Supported earn provider protocols.
+        #
+        #   @param tvl_usd [Float, nil] Total value locked in USD.
+        #
+        #   @param user_apy [Float, nil] Current annual percentage yield in basis points (e.g. 500 for 5%). 1 basis point
+        #
+        #   @param vault_address [String] Onchain vault contract address.
+      end
+    end
+  end
+end