privy_ruby 0.2.0 → 0.3.0

data/rbi/privy/models/wallets/transaction_get_response.rbi

@@ -84,11 +84,8 @@ module Privy
           sig { returns(String) }
           attr_accessor :privy_transaction_id
 
-          sig do
-            returns(
-              Privy::Models::Wallets::TransactionGetResponse::Transaction::Status::TaggedSymbol
-            )
-          end
+          # Status of a blockchain transaction submitted by Privy.
+          sig { returns(Privy::BlockchainTransactionStatus::TaggedSymbol) }
           attr_accessor :status
 
           sig { returns(T.nilable(String)) }
@@ -116,8 +113,7 @@ module Privy
               details:
                 Privy::Models::Wallets::TransactionGetResponse::Transaction::Details::OrHash,
               privy_transaction_id: String,
-              status:
-                Privy::Models::Wallets::TransactionGetResponse::Transaction::Status::OrSymbol,
+              status: Privy::BlockchainTransactionStatus::OrSymbol,
               transaction_hash: T.nilable(String),
               wallet_id: String,
               sponsored: T::Boolean,
@@ -130,6 +126,7 @@ module Privy
             # Details of a wallet transaction, varying by transaction type.
             details:,
             privy_transaction_id:,
+            # Status of a blockchain transaction submitted by Privy.
             status:,
             transaction_hash:,
             wallet_id:,
@@ -146,8 +143,7 @@ module Privy
                 details:
                   Privy::Models::Wallets::TransactionGetResponse::Transaction::Details,
                 privy_transaction_id: String,
-                status:
-                  Privy::Models::Wallets::TransactionGetResponse::Transaction::Status::TaggedSymbol,
+                status: Privy::BlockchainTransactionStatus::TaggedSymbol,
                 transaction_hash: T.nilable(String),
                 wallet_id: String,
                 sponsored: T::Boolean,
@@ -176,70 +172,6 @@ module Privy
             def to_hash
             end
           end
-
-          module Status
-            extend Privy::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  Privy::Models::Wallets::TransactionGetResponse::Transaction::Status
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            BROADCASTED =
-              T.let(
-                :broadcasted,
-                Privy::Models::Wallets::TransactionGetResponse::Transaction::Status::TaggedSymbol
-              )
-            CONFIRMED =
-              T.let(
-                :confirmed,
-                Privy::Models::Wallets::TransactionGetResponse::Transaction::Status::TaggedSymbol
-              )
-            EXECUTION_REVERTED =
-              T.let(
-                :execution_reverted,
-                Privy::Models::Wallets::TransactionGetResponse::Transaction::Status::TaggedSymbol
-              )
-            FAILED =
-              T.let(
-                :failed,
-                Privy::Models::Wallets::TransactionGetResponse::Transaction::Status::TaggedSymbol
-              )
-            REPLACED =
-              T.let(
-                :replaced,
-                Privy::Models::Wallets::TransactionGetResponse::Transaction::Status::TaggedSymbol
-              )
-            FINALIZED =
-              T.let(
-                :finalized,
-                Privy::Models::Wallets::TransactionGetResponse::Transaction::Status::TaggedSymbol
-              )
-            PROVIDER_ERROR =
-              T.let(
-                :provider_error,
-                Privy::Models::Wallets::TransactionGetResponse::Transaction::Status::TaggedSymbol
-              )
-            PENDING =
-              T.let(
-                :pending,
-                Privy::Models::Wallets::TransactionGetResponse::Transaction::Status::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  Privy::Models::Wallets::TransactionGetResponse::Transaction::Status::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
         end
       end
     end

data/rbi/privy/models/wallets/transfer_action_response.rbi

@@ -0,0 +1,330 @@
+# typed: strong
+
+module Privy
+  module Models
+    module Wallets
+      class TransferActionResponse < Privy::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Privy::Wallets::TransferActionResponse,
+              Privy::Internal::AnyHash
+            )
+          end
+
+        # The ID of the wallet action.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # ISO 8601 timestamp of when the wallet action was created.
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # Recipient address.
+        sig { returns(String) }
+        attr_accessor :destination_address
+
+        # Amount received on the destination chain. For exact_output cross-chain
+        # transfers, set at creation (the guaranteed exact amount). For exact_input
+        # cross-chain transfers, null until fill confirmation.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :destination_amount
+
+        # Chain name (e.g. "base", "ethereum").
+        sig { returns(String) }
+        attr_accessor :source_chain
+
+        # Status of a wallet action.
+        sig { returns(Privy::Wallets::WalletActionStatus::TaggedSymbol) }
+        attr_accessor :status
+
+        sig do
+          returns(Privy::Wallets::TransferActionResponse::Type::TaggedSymbol)
+        end
+        attr_accessor :type
+
+        # The ID of the wallet involved in the action.
+        sig { returns(String) }
+        attr_accessor :wallet_id
+
+        # Whether the amount refers to the input token or output token.
+        sig { returns(T.nilable(Privy::AmountType::TaggedSymbol)) }
+        attr_reader :amount_type
+
+        sig { params(amount_type: Privy::AmountType::OrSymbol).void }
+        attr_writer :amount_type
+
+        # Destination asset for cross-asset transfers. Omitted for same-asset transfers.
+        sig { returns(T.nilable(String)) }
+        attr_reader :destination_asset
+
+        sig { params(destination_asset: String).void }
+        attr_writer :destination_asset
+
+        # Destination chain for cross-chain transfers. Omitted for same-chain transfers.
+        sig { returns(T.nilable(String)) }
+        attr_reader :destination_chain
+
+        sig { params(destination_chain: String).void }
+        attr_writer :destination_chain
+
+        # Estimated fee breakdown from the provider quote. Only present for cross-chain or
+        # cross-asset transfers. Populated after on-chain confirmation.
+        sig { returns(T.nilable(T::Array[Privy::FeeLineItem::Variants])) }
+        attr_accessor :estimated_fees
+
+        # Gas cost for a blockchain action. Includes both raw base-unit amount and a
+        # human-readable decimal string, plus the gas token symbol.
+        sig { returns(T.nilable(Privy::Gas)) }
+        attr_reader :estimated_gas
+
+        sig { params(estimated_gas: T.nilable(Privy::Gas::OrHash)).void }
+        attr_writer :estimated_gas
+
+        # 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
+
+        # Actual fees paid for the transfer. Populated after on-chain confirmation. Only
+        # present for cross-chain transfers.
+        sig { returns(T.nilable(T::Array[Privy::FeeLineItem::Variants])) }
+        attr_accessor :fees
+
+        # Gas cost for a blockchain action. Includes both raw base-unit amount and a
+        # human-readable decimal string, plus the gas token symbol.
+        sig { returns(T.nilable(Privy::Gas)) }
+        attr_reader :gas
+
+        sig { params(gas: T.nilable(Privy::Gas::OrHash)).void }
+        attr_writer :gas
+
+        # Decimal amount sent on the source chain (e.g. "1.5"). For exact_output
+        # cross-chain transfers, null until fill confirmation.
+        sig { returns(T.nilable(String)) }
+        attr_reader :source_amount
+
+        sig { params(source_amount: String).void }
+        attr_writer :source_amount
+
+        # Asset identifier (e.g. "usdc", "eth"). Present when the transfer was initiated
+        # with a named asset; omitted for custom-token transfers.
+        sig { returns(T.nilable(String)) }
+        attr_reader :source_asset
+
+        sig { params(source_asset: String).void }
+        attr_writer :source_asset
+
+        # Token contract address (EVM) or mint address (Solana). Present when the transfer
+        # was initiated with `asset_address`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :source_asset_address
+
+        sig { params(source_asset_address: String).void }
+        attr_writer :source_asset_address
+
+        # Number of decimals for the transferred token. Present when the transfer was
+        # initiated with `asset_address` and the decimals were resolved on-chain.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :source_asset_decimals
+
+        sig { params(source_asset_decimals: Integer).void }
+        attr_writer :source_asset_decimals
+
+        # 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 a transfer action.
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            destination_address: String,
+            destination_amount: T.nilable(String),
+            source_chain: String,
+            status: Privy::Wallets::WalletActionStatus::OrSymbol,
+            type: Privy::Wallets::TransferActionResponse::Type::OrSymbol,
+            wallet_id: String,
+            amount_type: Privy::AmountType::OrSymbol,
+            destination_asset: String,
+            destination_chain: String,
+            estimated_fees:
+              T.nilable(
+                T::Array[
+                  T.any(
+                    Privy::RelayerFee::OrHash,
+                    Privy::PrivyFee::OrHash,
+                    Privy::DeveloperFee::OrHash
+                  )
+                ]
+              ),
+            estimated_gas: T.nilable(Privy::Gas::OrHash),
+            failure_reason: Privy::Wallets::FailureReason::OrHash,
+            fees:
+              T.nilable(
+                T::Array[
+                  T.any(
+                    Privy::RelayerFee::OrHash,
+                    Privy::PrivyFee::OrHash,
+                    Privy::DeveloperFee::OrHash
+                  )
+                ]
+              ),
+            gas: T.nilable(Privy::Gas::OrHash),
+            source_amount: String,
+            source_asset: String,
+            source_asset_address: String,
+            source_asset_decimals: Integer,
+            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:,
+          # ISO 8601 timestamp of when the wallet action was created.
+          created_at:,
+          # Recipient address.
+          destination_address:,
+          # Amount received on the destination chain. For exact_output cross-chain
+          # transfers, set at creation (the guaranteed exact amount). For exact_input
+          # cross-chain transfers, null until fill confirmation.
+          destination_amount:,
+          # Chain name (e.g. "base", "ethereum").
+          source_chain:,
+          # Status of a wallet action.
+          status:,
+          type:,
+          # The ID of the wallet involved in the action.
+          wallet_id:,
+          # Whether the amount refers to the input token or output token.
+          amount_type: nil,
+          # Destination asset for cross-asset transfers. Omitted for same-asset transfers.
+          destination_asset: nil,
+          # Destination chain for cross-chain transfers. Omitted for same-chain transfers.
+          destination_chain: nil,
+          # Estimated fee breakdown from the provider quote. Only present for cross-chain or
+          # cross-asset transfers. Populated after on-chain confirmation.
+          estimated_fees: nil,
+          # Gas cost for a blockchain action. Includes both raw base-unit amount and a
+          # human-readable decimal string, plus the gas token symbol.
+          estimated_gas: nil,
+          # A description of why a wallet action (or a step within a wallet action) failed.
+          failure_reason: nil,
+          # Actual fees paid for the transfer. Populated after on-chain confirmation. Only
+          # present for cross-chain transfers.
+          fees: nil,
+          # Gas cost for a blockchain action. Includes both raw base-unit amount and a
+          # human-readable decimal string, plus the gas token symbol.
+          gas: nil,
+          # Decimal amount sent on the source chain (e.g. "1.5"). For exact_output
+          # cross-chain transfers, null until fill confirmation.
+          source_amount: nil,
+          # Asset identifier (e.g. "usdc", "eth"). Present when the transfer was initiated
+          # with a named asset; omitted for custom-token transfers.
+          source_asset: nil,
+          # Token contract address (EVM) or mint address (Solana). Present when the transfer
+          # was initiated with `asset_address`.
+          source_asset_address: nil,
+          # Number of decimals for the transferred token. Present when the transfer was
+          # initiated with `asset_address` and the decimals were resolved on-chain.
+          source_asset_decimals: nil,
+          # The steps of the wallet action. Only returned if `?include=steps` is provided.
+          steps: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              destination_address: String,
+              destination_amount: T.nilable(String),
+              source_chain: String,
+              status: Privy::Wallets::WalletActionStatus::TaggedSymbol,
+              type: Privy::Wallets::TransferActionResponse::Type::TaggedSymbol,
+              wallet_id: String,
+              amount_type: Privy::AmountType::TaggedSymbol,
+              destination_asset: String,
+              destination_chain: String,
+              estimated_fees: T.nilable(T::Array[Privy::FeeLineItem::Variants]),
+              estimated_gas: T.nilable(Privy::Gas),
+              failure_reason: Privy::Wallets::FailureReason,
+              fees: T.nilable(T::Array[Privy::FeeLineItem::Variants]),
+              gas: T.nilable(Privy::Gas),
+              source_amount: String,
+              source_asset: String,
+              source_asset_address: String,
+              source_asset_decimals: Integer,
+              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::TransferActionResponse::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          TRANSFER =
+            T.let(
+              :transfer,
+              Privy::Wallets::TransferActionResponse::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Privy::Wallets::TransferActionResponse::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/wallets/tvm_transaction_wallet_action_step.rbi

@@ -0,0 +1,113 @@
+# typed: strong
+
+module Privy
+  module Models
+    module Wallets
+      class TvmTransactionWalletActionStep < Privy::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Privy::Wallets::TvmTransactionWalletActionStep,
+              Privy::Internal::AnyHash
+            )
+          end
+
+        # CAIP-2 chain identifier for the Tron network.
+        sig { returns(String) }
+        attr_accessor :caip2
+
+        # Status of a TVM (Tron) step in a wallet action.
+        sig { returns(Privy::Wallets::TvmWalletActionStepStatus::TaggedSymbol) }
+        attr_accessor :status
+
+        # The Tron transaction ID. Null until broadcast.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :transaction_id
+
+        sig do
+          returns(
+            Privy::Wallets::TvmTransactionWalletActionStep::Type::TaggedSymbol
+          )
+        end
+        attr_accessor :type
+
+        # 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
+
+        # A wallet action step consisting of a TVM (Tron) transaction.
+        sig do
+          params(
+            caip2: String,
+            status: Privy::Wallets::TvmWalletActionStepStatus::OrSymbol,
+            transaction_id: T.nilable(String),
+            type:
+              Privy::Wallets::TvmTransactionWalletActionStep::Type::OrSymbol,
+            failure_reason: Privy::Wallets::FailureReason::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # CAIP-2 chain identifier for the Tron network.
+          caip2:,
+          # Status of a TVM (Tron) step in a wallet action.
+          status:,
+          # The Tron transaction ID. Null until broadcast.
+          transaction_id:,
+          type:,
+          # A description of why a wallet action (or a step within a wallet action) failed.
+          failure_reason: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              caip2: String,
+              status: Privy::Wallets::TvmWalletActionStepStatus::TaggedSymbol,
+              transaction_id: T.nilable(String),
+              type:
+                Privy::Wallets::TvmTransactionWalletActionStep::Type::TaggedSymbol,
+              failure_reason: Privy::Wallets::FailureReason
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend Privy::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Privy::Wallets::TvmTransactionWalletActionStep::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          TVM_TRANSACTION =
+            T.let(
+              :tvm_transaction,
+              Privy::Wallets::TvmTransactionWalletActionStep::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Privy::Wallets::TvmTransactionWalletActionStep::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/wallets/tvm_wallet_action_step_status.rbi

@@ -0,0 +1,62 @@
+# typed: strong
+
+module Privy
+  module Models
+    module Wallets
+      # Status of a TVM (Tron) step in a wallet action.
+      module TvmWalletActionStepStatus
+        extend Privy::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Privy::Wallets::TvmWalletActionStepStatus)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PREPARING =
+          T.let(
+            :preparing,
+            Privy::Wallets::TvmWalletActionStepStatus::TaggedSymbol
+          )
+        QUEUED =
+          T.let(
+            :queued,
+            Privy::Wallets::TvmWalletActionStepStatus::TaggedSymbol
+          )
+        PENDING =
+          T.let(
+            :pending,
+            Privy::Wallets::TvmWalletActionStepStatus::TaggedSymbol
+          )
+        CONFIRMED =
+          T.let(
+            :confirmed,
+            Privy::Wallets::TvmWalletActionStepStatus::TaggedSymbol
+          )
+        REJECTED =
+          T.let(
+            :rejected,
+            Privy::Wallets::TvmWalletActionStepStatus::TaggedSymbol
+          )
+        REVERTED =
+          T.let(
+            :reverted,
+            Privy::Wallets::TvmWalletActionStepStatus::TaggedSymbol
+          )
+        FAILED =
+          T.let(
+            :failed,
+            Privy::Wallets::TvmWalletActionStepStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Privy::Wallets::TvmWalletActionStepStatus::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/wallets/wallet_action_include.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Privy
+  module Models
+    WalletActionInclude = Wallets::WalletActionInclude
+
+    module Wallets
+      # Expandable relations to include on a wallet action response.
+      module WalletActionInclude
+        extend Privy::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Privy::Wallets::WalletActionInclude) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        STEPS = T.let(:steps, Privy::Wallets::WalletActionInclude::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Privy::Wallets::WalletActionInclude::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/privy/models/wallets/wallet_action_response.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module Privy
+  module Models
+    WalletActionResponse = Wallets::WalletActionResponse
+
+    module Wallets
+      # Response for a wallet action, discriminated on type.
+      module WalletActionResponse
+        extend Privy::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              Privy::Wallets::SwapActionResponse,
+              Privy::Wallets::TransferActionResponse,
+              Privy::Wallets::EarnDepositActionResponse,
+              Privy::Wallets::EarnWithdrawActionResponse,
+              Privy::Wallets::EarnIncentiveClaimActionResponse
+            )
+          end
+
+        sig do
+          override.returns(
+            T::Array[Privy::Wallets::WalletActionResponse::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end