Class: Privy::Models::Wallets::TransferActionResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Privy::Models::Wallets::TransferActionResponse

Defined in:

lib/privy/models/wallets/transfer_action_response.rb,
sig/privy/models/wallets/transfer_action_response.rbs

Defined Under Namespace

Modules: Type

Instance Attribute Summary

• #amount_type ⇒ Symbol, ...

  Whether the amount refers to the input token or output token.

• #created_at ⇒ Time

  ISO 8601 timestamp of when the wallet action was created.

• #destination_address ⇒ String

  Recipient address.

• #destination_amount ⇒ String^?

  Amount received on the destination chain.

• #destination_asset ⇒ String^?

  Destination asset for cross-asset transfers.

• #destination_chain ⇒ String^?

  Destination chain for cross-chain transfers.

• #estimated_fees ⇒ Array<Privy::Models::RelayerFee, Privy::Models::PrivyFee, Privy::Models::DeveloperFee>^?

  Estimated fee breakdown from the provider quote.

• #estimated_gas ⇒ Privy::Models::Gas^?

  Gas cost for a blockchain action.

• #failure_reason ⇒ Privy::Models::Wallets::FailureReason^?

  A description of why a wallet action (or a step within a wallet action) failed.

• #fees ⇒ Array<Privy::Models::RelayerFee, Privy::Models::PrivyFee, Privy::Models::DeveloperFee>^?

  Actual fees paid for the transfer.

• #gas ⇒ Privy::Models::Gas^?

  Gas cost for a blockchain action.

• #id ⇒ String

  The ID of the wallet action.

• #source_amount ⇒ String^?

  Decimal amount sent on the source chain (e.g. "1.5").

• #source_asset ⇒ String^?

  Asset identifier (e.g. "usdc", "eth").

• #source_asset_address ⇒ String^?

  Token contract address (EVM) or mint address (Solana).

• #source_asset_decimals ⇒ Integer^?

  Number of decimals for the transferred token.

• #source_chain ⇒ String

  Chain name (e.g. "base", "ethereum").

• #status ⇒ Symbol, Privy::Models::Wallets::WalletActionStatus

  Status of a wallet action.

• #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.

• #type ⇒ Symbol, Privy::Models::Wallets::TransferActionResponse::Type
• #wallet_id ⇒ String

  The ID of the wallet involved in the action.

Instance Method Summary

• #initialize(id:, created_at:, destination_address:, destination_amount:, source_chain:, status:, type:, wallet_id:, amount_type: nil, destination_asset: nil, destination_chain: nil, estimated_fees: nil, estimated_gas: nil, failure_reason: nil, fees: nil, gas: nil, source_amount: nil, source_asset: nil, source_asset_address: nil, source_asset_decimals: nil, steps: nil) ⇒ Object constructor

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

• #to_hash ⇒ {

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:, created_at:, destination_address:, destination_amount:, source_chain:, status:, type:, wallet_id:, amount_type: nil, destination_asset: nil, destination_chain: nil, estimated_fees: nil, estimated_gas: nil, failure_reason: nil, fees: nil, gas: nil, source_amount: nil, source_asset: nil, source_asset_address: nil, source_asset_decimals: nil, steps: nil) ⇒ Object

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

Response for a transfer action.

Parameters:

• id (String) —

  The ID of the wallet action.

• created_at (Time) —

  ISO 8601 timestamp of when the wallet action was created.

• destination_address (String) —

  Recipient address.

• destination_amount (String, nil) —

  Amount received on the destination chain. For exact_output cross-chain transfers

• source_chain (String) —

  Chain name (e.g. "base", "ethereum").

• status (Symbol, Privy::Models::Wallets::WalletActionStatus) —

  Status of a wallet action.

• type (Symbol, Privy::Models::Wallets::TransferActionResponse::Type)
• wallet_id (String) —

  The ID of the wallet involved in the action.

• amount_type (Symbol, Privy::Models::AmountType) (defaults to: nil) —

  Whether the amount refers to the input token or output token.

• destination_asset (String) (defaults to: nil) —

  Destination asset for cross-asset transfers. Omitted for same-asset transfers.

• destination_chain (String) (defaults to: nil) —

  Destination chain for cross-chain transfers. Omitted for same-chain transfers.

• estimated_fees (Array<Privy::Models::RelayerFee, Privy::Models::PrivyFee, Privy::Models::DeveloperFee>, nil) (defaults to: nil) —

  Estimated fee breakdown from the provider quote. Only present for cross-chain or

• estimated_gas (Privy::Models::Gas, nil) (defaults to: nil) —

  Gas cost for a blockchain action. Includes both raw base-unit amount and a human

• failure_reason (Privy::Models::Wallets::FailureReason) (defaults to: nil) —

  A description of why a wallet action (or a step within a wallet action) failed.

• fees (Array<Privy::Models::RelayerFee, Privy::Models::PrivyFee, Privy::Models::DeveloperFee>, nil) (defaults to: nil) —

  Actual fees paid for the transfer. Populated after on-chain confirmation. Only p

• gas (Privy::Models::Gas, nil) (defaults to: nil) —

  Gas cost for a blockchain action. Includes both raw base-unit amount and a human

• source_amount (String) (defaults to: nil) —

  Decimal amount sent on the source chain (e.g. "1.5"). For exact_output cross-cha

• source_asset (String) (defaults to: nil) —

  Asset identifier (e.g. "usdc", "eth"). Present when the transfer was initiated w

• source_asset_address (String) (defaults to: nil) —

  Token contract address (EVM) or mint address (Solana). Present when the transfer

• source_asset_decimals (Integer) (defaults to: nil) —

  Number of decimals for the transferred token. Present when the transfer was init

• 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>) (defaults to: nil) —

  The steps of the wallet action. Only returned if ?include=steps is provided.

# File 'lib/privy/models/wallets/transfer_action_response.rb', line 142

Instance Attribute Details

#amount_type ⇒ Symbol, ...

Whether the amount refers to the input token or output token.

Returns:

• (Symbol, Privy::Models::AmountType, nil)

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

optional :amount_type, enum: -> { Privy::AmountType }

#created_at ⇒ Time

ISO 8601 timestamp of when the wallet action was created.

Parameters:

• value (Time)

Returns:

• (Time)

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

required :created_at, Time

#destination_address ⇒ String

Recipient address.

Parameters:

• value (String)

Returns:

• (String)

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

required :destination_address, String

#destination_amount ⇒ String^?

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.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/privy/models/wallets/transfer_action_response.rb', line 31

required :destination_amount, String, nil?: true

#destination_asset ⇒ String^?

Destination asset for cross-asset transfers. Omitted for same-asset transfers.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :destination_asset, String

#destination_chain ⇒ String^?

Destination chain for cross-chain transfers. Omitted for same-chain transfers.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/privy/models/wallets/transfer_action_response.rb', line 72

optional :destination_chain, String

#estimated_fees ⇒ Array<Privy::Models::RelayerFee, Privy::Models::PrivyFee, Privy::Models::DeveloperFee>^?

Estimated fee breakdown from the provider quote. Only present for cross-chain or cross-asset transfers. Populated after on-chain confirmation.

Parameters:

• value (::Array[Privy::Models::fee_line_item], nil)

Returns:

• (Array<Privy::Models::RelayerFee, Privy::Models::PrivyFee, Privy::Models::DeveloperFee>, nil)

# File 'lib/privy/models/wallets/transfer_action_response.rb', line 79

optional :estimated_fees, -> { Privy::Internal::Type::ArrayOf[union: Privy::FeeLineItem] }, nil?: true

#estimated_gas ⇒ Privy::Models::Gas^?

Gas cost for a blockchain action. Includes both raw base-unit amount and a human-readable decimal string, plus the gas token symbol.

Parameters:

• value (Privy::Gas, nil)

Returns:

• (Privy::Models::Gas, nil)

# File 'lib/privy/models/wallets/transfer_action_response.rb', line 86

optional :estimated_gas, -> { Privy::Gas }, nil?: true

#failure_reason ⇒ Privy::Models::Wallets::FailureReason^?

A description of why a wallet action (or a step within a wallet action) failed.

Returns:

• (Privy::Models::Wallets::FailureReason, nil)

# File 'lib/privy/models/wallets/transfer_action_response.rb', line 92

optional :failure_reason, -> { Privy::Wallets::FailureReason }

#fees ⇒ Array<Privy::Models::RelayerFee, Privy::Models::PrivyFee, Privy::Models::DeveloperFee>^?

Actual fees paid for the transfer. Populated after on-chain confirmation. Only present for cross-chain transfers.

Parameters:

• value (::Array[Privy::Models::fee_line_item], nil)

Returns:

• (Array<Privy::Models::RelayerFee, Privy::Models::PrivyFee, Privy::Models::DeveloperFee>, nil)

# File 'lib/privy/models/wallets/transfer_action_response.rb', line 99

optional :fees, -> { Privy::Internal::Type::ArrayOf[union: Privy::FeeLineItem] }, nil?: true

#gas ⇒ Privy::Models::Gas^?

Gas cost for a blockchain action. Includes both raw base-unit amount and a human-readable decimal string, plus the gas token symbol.

Parameters:

• value (Privy::Gas, nil)

Returns:

• (Privy::Models::Gas, nil)

# File 'lib/privy/models/wallets/transfer_action_response.rb', line 106

optional :gas, -> { Privy::Gas }, nil?: true

#id ⇒ String

The ID of the wallet action.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/privy/models/wallets/transfer_action_response.rb', line 11

required :id, String

#source_amount ⇒ String^?

Decimal amount sent on the source chain (e.g. "1.5"). For exact_output cross-chain transfers, null until fill confirmation.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/privy/models/wallets/transfer_action_response.rb', line 113

optional :source_amount, String

#source_asset ⇒ String^?

Asset identifier (e.g. "usdc", "eth"). Present when the transfer was initiated with a named asset; omitted for custom-token transfers.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/privy/models/wallets/transfer_action_response.rb', line 120

optional :source_asset, String

#source_asset_address ⇒ String^?

Token contract address (EVM) or mint address (Solana). Present when the transfer was initiated with asset_address.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/privy/models/wallets/transfer_action_response.rb', line 127

optional :source_asset_address, String

#source_asset_decimals ⇒ Integer^?

Number of decimals for the transferred token. Present when the transfer was initiated with asset_address and the decimals were resolved on-chain.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/privy/models/wallets/transfer_action_response.rb', line 134

optional :source_asset_decimals, Integer

#source_chain ⇒ String

Chain name (e.g. "base", "ethereum").

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/privy/models/wallets/transfer_action_response.rb', line 37

required :source_chain, String

#status ⇒ Symbol, Privy::Models::Wallets::WalletActionStatus

Status of a wallet action.

Parameters:

• value (Privy::Models::Wallets::wallet_action_status)

Returns:

• (Symbol, Privy::Models::Wallets::WalletActionStatus)

# File 'lib/privy/models/wallets/transfer_action_response.rb', line 43

required :status, enum: -> { Privy::Wallets::WalletActionStatus }

#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.

Returns:

• (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)

# File 'lib/privy/models/wallets/transfer_action_response.rb', line 140

optional :steps, -> { Privy::Internal::Type::ArrayOf[union: Privy::Wallets::WalletActionStep] }

#type ⇒ Symbol, Privy::Models::Wallets::TransferActionResponse::Type

Parameters:

• value (Privy::Models::Wallets::TransferActionResponse::type_)

Returns:

• (Symbol, Privy::Models::Wallets::TransferActionResponse::Type)

# File 'lib/privy/models/wallets/transfer_action_response.rb', line 48

required :type, enum: -> { Privy::Wallets::TransferActionResponse::Type }

#wallet_id ⇒ String

The ID of the wallet involved in the action.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/privy/models/wallets/transfer_action_response.rb', line 54

required :wallet_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/privy/models/wallets/transfer_action_response.rbs', line 120

def to_hash: -> {