privy_ruby 0.1.0 → 0.3.0

data/rbi/privy/models/wallets/earn_asset.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module Privy
+  module Models
+    module Wallets
+      class EarnAsset < Privy::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Privy::Wallets::EarnAsset, Privy::Internal::AnyHash)
+          end
+
+        # Token contract address.
+        sig { returns(String) }
+        attr_accessor :address
+
+        # Number of decimals for the asset (e.g. 6 for USDC).
+        sig { returns(Integer) }
+        attr_accessor :decimals
+
+        # Lowercase token symbol (e.g. "usdc").
+        sig { returns(String) }
+        attr_accessor :symbol
+
+        # Asset metadata for an earn vault position.
+        sig do
+          params(address: String, decimals: Integer, symbol: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Token contract address.
+          address:,
+          # Number of decimals for the asset (e.g. 6 for USDC).
+          decimals:,
+          # Lowercase token symbol (e.g. "usdc").
+          symbol:
+        )
+        end
+
+        sig do
+          override.returns(
+            { address: String, decimals: Integer, symbol: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/wallets/earn_deposit_action_response.rbi

@@ -0,0 +1,241 @@
+# typed: strong
+
+module Privy
+  module Models
+    module Wallets
+      class EarnDepositActionResponse < Privy::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Privy::Wallets::EarnDepositActionResponse,
+              Privy::Internal::AnyHash
+            )
+          end
+
+        # The ID of the wallet action.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Underlying asset token address.
+        sig { returns(String) }
+        attr_accessor :asset_address
+
+        # CAIP-2 chain identifier.
+        sig { returns(String) }
+        attr_accessor :caip2
+
+        # ISO 8601 timestamp of when the wallet action was created.
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # Base-unit amount of asset deposited (e.g. "1500000").
+        sig { returns(String) }
+        attr_accessor :raw_amount
+
+        # Vault shares received in base units. Populated after on-chain confirmation.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :share_amount
+
+        # Status of a wallet action.
+        sig { returns(Privy::Wallets::WalletActionStatus::TaggedSymbol) }
+        attr_accessor :status
+
+        sig do
+          returns(Privy::Wallets::EarnDepositActionResponse::Type::TaggedSymbol)
+        end
+        attr_accessor :type
+
+        # ERC-4626 vault contract address.
+        sig { returns(String) }
+        attr_accessor :vault_address
+
+        # The vault ID.
+        sig { returns(String) }
+        attr_accessor :vault_id
+
+        # The ID of the wallet involved in the action.
+        sig { returns(String) }
+        attr_accessor :wallet_id
+
+        # Human-readable decimal amount of asset deposited (e.g. "1.5"). Only present when
+        # the token is known in the asset registry.
+        sig { returns(T.nilable(String)) }
+        attr_reader :amount
+
+        sig { params(amount: String).void }
+        attr_writer :amount
+
+        # Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in
+        # the asset registry.
+        sig { returns(T.nilable(String)) }
+        attr_reader :asset
+
+        sig { params(asset: String).void }
+        attr_writer :asset
+
+        # 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.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :decimals
+
+        sig { params(decimals: Integer).void }
+        attr_writer :decimals
+
+        # A description of why a wallet action (or a step within a wallet action) failed.
+        sig { returns(T.nilable(Privy::Wallets::FailureReason)) }
+        attr_reader :failure_reason
+
+        sig do
+          params(failure_reason: Privy::Wallets::FailureReason::OrHash).void
+        end
+        attr_writer :failure_reason
+
+        # The steps of the wallet action. Only returned if `?include=steps` is provided.
+        sig do
+          returns(
+            T.nilable(T::Array[Privy::Wallets::WalletActionStep::Variants])
+          )
+        end
+        attr_reader :steps
+
+        sig do
+          params(
+            steps:
+              T::Array[
+                T.any(
+                  Privy::Wallets::EvmTransactionWalletActionStep::OrHash,
+                  Privy::Wallets::EvmUserOperationWalletActionStep::OrHash,
+                  Privy::Wallets::SvmTransactionWalletActionStep::OrHash,
+                  Privy::Wallets::TvmTransactionWalletActionStep::OrHash,
+                  Privy::Wallets::ExternalTransactionWalletActionStep::OrHash,
+                  Privy::Wallets::CustodianTransactionWalletActionStep::OrHash
+                )
+              ]
+          ).void
+        end
+        attr_writer :steps
+
+        # Response for an earn deposit action.
+        sig do
+          params(
+            id: String,
+            asset_address: String,
+            caip2: String,
+            created_at: Time,
+            raw_amount: String,
+            share_amount: T.nilable(String),
+            status: Privy::Wallets::WalletActionStatus::OrSymbol,
+            type: Privy::Wallets::EarnDepositActionResponse::Type::OrSymbol,
+            vault_address: String,
+            vault_id: String,
+            wallet_id: String,
+            amount: String,
+            asset: String,
+            decimals: Integer,
+            failure_reason: Privy::Wallets::FailureReason::OrHash,
+            steps:
+              T::Array[
+                T.any(
+                  Privy::Wallets::EvmTransactionWalletActionStep::OrHash,
+                  Privy::Wallets::EvmUserOperationWalletActionStep::OrHash,
+                  Privy::Wallets::SvmTransactionWalletActionStep::OrHash,
+                  Privy::Wallets::TvmTransactionWalletActionStep::OrHash,
+                  Privy::Wallets::ExternalTransactionWalletActionStep::OrHash,
+                  Privy::Wallets::CustodianTransactionWalletActionStep::OrHash
+                )
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the wallet action.
+          id:,
+          # Underlying asset token address.
+          asset_address:,
+          # CAIP-2 chain identifier.
+          caip2:,
+          # ISO 8601 timestamp of when the wallet action was created.
+          created_at:,
+          # Base-unit amount of asset deposited (e.g. "1500000").
+          raw_amount:,
+          # Vault shares received in base units. Populated after on-chain confirmation.
+          share_amount:,
+          # Status of a wallet action.
+          status:,
+          type:,
+          # ERC-4626 vault contract address.
+          vault_address:,
+          # The vault ID.
+          vault_id:,
+          # The ID of the wallet involved in the action.
+          wallet_id:,
+          # Human-readable decimal amount of asset deposited (e.g. "1.5"). Only present when
+          # the token is known in the asset registry.
+          amount: nil,
+          # Asset identifier (e.g. "usdc", "eth"). Only present when the token is known in
+          # the asset registry.
+          asset: nil,
+          # 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.
+          decimals: nil,
+          # A description of why a wallet action (or a step within a wallet action) failed.
+          failure_reason: nil,
+          # The steps of the wallet action. Only returned if `?include=steps` is provided.
+          steps: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              asset_address: String,
+              caip2: String,
+              created_at: Time,
+              raw_amount: String,
+              share_amount: T.nilable(String),
+              status: Privy::Wallets::WalletActionStatus::TaggedSymbol,
+              type:
+                Privy::Wallets::EarnDepositActionResponse::Type::TaggedSymbol,
+              vault_address: String,
+              vault_id: String,
+              wallet_id: String,
+              amount: String,
+              asset: String,
+              decimals: Integer,
+              failure_reason: Privy::Wallets::FailureReason,
+              steps: T::Array[Privy::Wallets::WalletActionStep::Variants]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend Privy::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Privy::Wallets::EarnDepositActionResponse::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EARN_DEPOSIT =
+            T.let(
+              :earn_deposit,
+              Privy::Wallets::EarnDepositActionResponse::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Privy::Wallets::EarnDepositActionResponse::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/wallets/earn_deposit_request_body.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module Privy
+  module Models
+    module Wallets
+      class EarnDepositRequestBody < Privy::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Privy::Wallets::EarnDepositRequestBody,
+              Privy::Internal::AnyHash
+            )
+          end
+
+        # The ID of the vault to deposit into.
+        sig { returns(String) }
+        attr_accessor :vault_id
+
+        # Human-readable decimal amount to deposit (e.g. "1.5" for 1.5 USDC). Exactly one
+        # of `amount` or `raw_amount` must be provided.
+        sig { returns(T.nilable(String)) }
+        attr_reader :amount
+
+        sig { params(amount: String).void }
+        attr_writer :amount
+
+        # Amount in smallest unit to deposit (e.g. "1500000" for 1.5 USDC with 6
+        # decimals). Exactly one of `amount` or `raw_amount` must be provided.
+        sig { returns(T.nilable(String)) }
+        attr_reader :raw_amount
+
+        sig { params(raw_amount: String).void }
+        attr_writer :raw_amount
+
+        # Input for depositing assets into an ERC-4626 vault. Exactly one of `amount` or
+        # `raw_amount` must be provided.
+        sig do
+          params(vault_id: String, amount: String, raw_amount: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # The ID of the vault to deposit into.
+          vault_id:,
+          # Human-readable decimal amount to deposit (e.g. "1.5" for 1.5 USDC). Exactly one
+          # of `amount` or `raw_amount` must be provided.
+          amount: nil,
+          # Amount in smallest unit to deposit (e.g. "1500000" for 1.5 USDC with 6
+          # decimals). Exactly one of `amount` or `raw_amount` must be provided.
+          raw_amount: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { vault_id: String, amount: String, raw_amount: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/wallets/earn_incentive_claim_action_response.rbi

@@ -0,0 +1,186 @@
+# typed: strong
+
+module Privy
+  module Models
+    module Wallets
+      class EarnIncentiveClaimActionResponse < Privy::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Privy::Wallets::EarnIncentiveClaimActionResponse,
+              Privy::Internal::AnyHash
+            )
+          end
+
+        # The ID of the wallet action.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # EVM chain name (e.g. "base", "ethereum").
+        sig { returns(String) }
+        attr_accessor :chain
+
+        # ISO 8601 timestamp of when the wallet action was created.
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # Claimed reward tokens. Populated after the preparation step fetches from Merkl.
+        sig do
+          returns(
+            T.nilable(T::Array[Privy::Wallets::EarnIncetiveClaimRewardEntry])
+          )
+        end
+        attr_accessor :rewards
+
+        # Status of a wallet action.
+        sig { returns(Privy::Wallets::WalletActionStatus::TaggedSymbol) }
+        attr_accessor :status
+
+        sig do
+          returns(
+            Privy::Wallets::EarnIncentiveClaimActionResponse::Type::TaggedSymbol
+          )
+        end
+        attr_accessor :type
+
+        # The ID of the wallet involved in the action.
+        sig { returns(String) }
+        attr_accessor :wallet_id
+
+        # A description of why a wallet action (or a step within a wallet action) failed.
+        sig { returns(T.nilable(Privy::Wallets::FailureReason)) }
+        attr_reader :failure_reason
+
+        sig do
+          params(failure_reason: Privy::Wallets::FailureReason::OrHash).void
+        end
+        attr_writer :failure_reason
+
+        # The steps of the wallet action. Only returned if `?include=steps` is provided.
+        sig do
+          returns(
+            T.nilable(T::Array[Privy::Wallets::WalletActionStep::Variants])
+          )
+        end
+        attr_reader :steps
+
+        sig do
+          params(
+            steps:
+              T::Array[
+                T.any(
+                  Privy::Wallets::EvmTransactionWalletActionStep::OrHash,
+                  Privy::Wallets::EvmUserOperationWalletActionStep::OrHash,
+                  Privy::Wallets::SvmTransactionWalletActionStep::OrHash,
+                  Privy::Wallets::TvmTransactionWalletActionStep::OrHash,
+                  Privy::Wallets::ExternalTransactionWalletActionStep::OrHash,
+                  Privy::Wallets::CustodianTransactionWalletActionStep::OrHash
+                )
+              ]
+          ).void
+        end
+        attr_writer :steps
+
+        # Response for an earn incentive claim action.
+        sig do
+          params(
+            id: String,
+            chain: String,
+            created_at: Time,
+            rewards:
+              T.nilable(
+                T::Array[Privy::Wallets::EarnIncetiveClaimRewardEntry::OrHash]
+              ),
+            status: Privy::Wallets::WalletActionStatus::OrSymbol,
+            type:
+              Privy::Wallets::EarnIncentiveClaimActionResponse::Type::OrSymbol,
+            wallet_id: String,
+            failure_reason: Privy::Wallets::FailureReason::OrHash,
+            steps:
+              T::Array[
+                T.any(
+                  Privy::Wallets::EvmTransactionWalletActionStep::OrHash,
+                  Privy::Wallets::EvmUserOperationWalletActionStep::OrHash,
+                  Privy::Wallets::SvmTransactionWalletActionStep::OrHash,
+                  Privy::Wallets::TvmTransactionWalletActionStep::OrHash,
+                  Privy::Wallets::ExternalTransactionWalletActionStep::OrHash,
+                  Privy::Wallets::CustodianTransactionWalletActionStep::OrHash
+                )
+              ]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the wallet action.
+          id:,
+          # EVM chain name (e.g. "base", "ethereum").
+          chain:,
+          # ISO 8601 timestamp of when the wallet action was created.
+          created_at:,
+          # Claimed reward tokens. Populated after the preparation step fetches from Merkl.
+          rewards:,
+          # Status of a wallet action.
+          status:,
+          type:,
+          # The ID of the wallet involved in the action.
+          wallet_id:,
+          # A description of why a wallet action (or a step within a wallet action) failed.
+          failure_reason: nil,
+          # The steps of the wallet action. Only returned if `?include=steps` is provided.
+          steps: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              chain: String,
+              created_at: Time,
+              rewards:
+                T.nilable(
+                  T::Array[Privy::Wallets::EarnIncetiveClaimRewardEntry]
+                ),
+              status: Privy::Wallets::WalletActionStatus::TaggedSymbol,
+              type:
+                Privy::Wallets::EarnIncentiveClaimActionResponse::Type::TaggedSymbol,
+              wallet_id: String,
+              failure_reason: Privy::Wallets::FailureReason,
+              steps: T::Array[Privy::Wallets::WalletActionStep::Variants]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend Privy::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Privy::Wallets::EarnIncentiveClaimActionResponse::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          EARN_INCENTIVE_CLAIM =
+            T.let(
+              :earn_incentive_claim,
+              Privy::Wallets::EarnIncentiveClaimActionResponse::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Privy::Wallets::EarnIncentiveClaimActionResponse::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/wallets/earn_incentive_claim_request_body.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module Privy
+  module Models
+    module Wallets
+      class EarnIncentiveClaimRequestBody < Privy::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Privy::Wallets::EarnIncentiveClaimRequestBody,
+              Privy::Internal::AnyHash
+            )
+          end
+
+        # 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.
+        sig { returns(String) }
+        attr_accessor :chain
+
+        # Input for claiming incentive rewards.
+        sig { params(chain: String).returns(T.attached_class) }
+        def self.new(
+          # 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.
+          chain:
+        )
+        end
+
+        sig { override.returns({ chain: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/wallets/earn_incentive_reward_entry.rbi

@@ -0,0 +1,78 @@
+# typed: strong
+
+module Privy
+  module Models
+    module Wallets
+      class EarnIncentiveRewardEntry < Privy::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Privy::Wallets::EarnIncentiveRewardEntry,
+              Privy::Internal::AnyHash
+            )
+          end
+
+        # Total amount already claimed, in smallest unit.
+        sig { returns(String) }
+        attr_accessor :amount_claimed
+
+        # Amount available to claim on-chain but not yet claimed, in smallest unit.
+        sig { returns(String) }
+        attr_accessor :amount_unclaimed
+
+        # Address of the reward token.
+        sig { returns(String) }
+        attr_accessor :token_address
+
+        # Symbol of the reward token (e.g. "MORPHO").
+        sig { returns(String) }
+        attr_accessor :token_symbol
+
+        # Number of decimals for the reward token.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :token_decimals
+
+        sig { params(token_decimals: Integer).void }
+        attr_writer :token_decimals
+
+        # A reward token with claimed and unclaimed amounts.
+        sig do
+          params(
+            amount_claimed: String,
+            amount_unclaimed: String,
+            token_address: String,
+            token_symbol: String,
+            token_decimals: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Total amount already claimed, in smallest unit.
+          amount_claimed:,
+          # Amount available to claim on-chain but not yet claimed, in smallest unit.
+          amount_unclaimed:,
+          # Address of the reward token.
+          token_address:,
+          # Symbol of the reward token (e.g. "MORPHO").
+          token_symbol:,
+          # Number of decimals for the reward token.
+          token_decimals: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              amount_claimed: String,
+              amount_unclaimed: String,
+              token_address: String,
+              token_symbol: String,
+              token_decimals: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/wallets/earn_incentive_rewards_query.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Privy
+  module Models
+    module Wallets
+      class EarnIncentiveRewardsQuery < Privy::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Privy::Wallets::EarnIncentiveRewardsQuery,
+              Privy::Internal::AnyHash
+            )
+          end
+
+        # Chain name to fetch rewards for (e.g. "base", "ethereum").
+        sig { returns(String) }
+        attr_accessor :chain
+
+        # Query parameters for fetching incentive rewards.
+        sig { params(chain: String).returns(T.attached_class) }
+        def self.new(
+          # Chain name to fetch rewards for (e.g. "base", "ethereum").
+          chain:
+        )
+        end
+
+        sig { override.returns({ chain: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end