Class: Privy::Models::Wallets::SwapActionResponse

Inherits:

Internal::Type::BaseModel

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

Defined in:

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

Defined Under Namespace

Modules: Type

Instance Attribute Summary

• #caip2 ⇒ String

  CAIP-2 chain identifier for the swap.

• #created_at ⇒ Time

  ISO 8601 timestamp of when the wallet action was created.

• #destination_address ⇒ String^?

  Recipient address on the destination chain.

• #destination_caip2 ⇒ String^?

  Destination chain CAIP-2 identifier.

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

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

  Gas cost for a blockchain action.

• #id ⇒ String

  The ID of the wallet action.

• #input_amount ⇒ String^?

  Exact base-unit amount of input token.

• #input_token ⇒ String

  Token address or "native" for the token being sold.

• #output_amount ⇒ String^?

  Exact base-unit amount of output token.

• #output_token ⇒ String

  Token address or "native" for the token being bought.

• #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::SwapActionResponse::Type
• #wallet_id ⇒ String

  The ID of the wallet involved in the action.

Instance Method Summary

• #initialize(id:, caip2:, created_at:, input_amount:, input_token:, output_amount:, output_token:, status:, type:, wallet_id:, destination_address: nil, destination_caip2: nil, estimated_fees: nil, estimated_gas: nil, failure_reason: nil, fees: nil, gas: nil, steps: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see SwapActionResponse 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:, caip2:, created_at:, input_amount:, input_token:, output_amount:, output_token:, status:, type:, wallet_id:, destination_address: nil, destination_caip2: nil, estimated_fees: nil, estimated_gas: nil, failure_reason: nil, fees: nil, gas: nil, steps: nil) ⇒ Object

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

Response for a swap action.

Parameters:

• id (String) —

  The ID of the wallet action.

• caip2 (String) —

  CAIP-2 chain identifier for the swap.

• created_at (Time) —

  ISO 8601 timestamp of when the wallet action was created.

• input_amount (String, nil) —

  Exact base-unit amount of input token. Populated after on-chain confirmation.

• input_token (String) —

  Token address or "native" for the token being sold.

• output_amount (String, nil) —

  Exact base-unit amount of output token. Populated after on-chain confirmation.

• output_token (String) —

  Token address or "native" for the token being bought.

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

  Status of a wallet action.

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

  The ID of the wallet involved in the action.

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

  Recipient address on the destination chain. Present for cross-chain swaps. May d

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

  Destination chain CAIP-2 identifier. Present for cross-chain swaps.

• 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 sw

• 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 swap. Populated after on-chain confirmation. Only prese

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

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

• 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/swap_action_response.rb', line 120

Instance Attribute Details

#caip2 ⇒ String

CAIP-2 chain identifier for the swap.

Parameters:

• value (String)

Returns:

• (String)

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

required :caip2, String

#created_at ⇒ Time

ISO 8601 timestamp of when the wallet action was created.

Parameters:

• value (Time)

Returns:

• (Time)

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

required :created_at, Time

#destination_address ⇒ String^?

Recipient address on the destination chain. Present for cross-chain swaps. May differ from the source wallet address when swapping between chain types (e.g. EVM to Solana).

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :destination_address, String

#destination_caip2 ⇒ String^?

Destination chain CAIP-2 identifier. Present for cross-chain swaps.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/privy/models/wallets/swap_action_response.rb', line 78

optional :destination_caip2, 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 swaps. 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/swap_action_response.rb', line 85

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/swap_action_response.rb', line 92

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/swap_action_response.rb', line 98

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

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

Actual fees paid for the swap. Populated after on-chain confirmation. Only present for cross-chain swaps.

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/swap_action_response.rb', line 105

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/swap_action_response.rb', line 112

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

#id ⇒ String

The ID of the wallet action.

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#input_amount ⇒ String^?

Exact base-unit amount of input token. Populated after on-chain confirmation.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :input_amount, String, nil?: true

#input_token ⇒ String

Token address or "native" for the token being sold.

Parameters:

• value (String)

Returns:

• (String)

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

required :input_token, String

#output_amount ⇒ String^?

Exact base-unit amount of output token. Populated after on-chain confirmation.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :output_amount, String, nil?: true

#output_token ⇒ String

Token address or "native" for the token being bought.

Parameters:

• value (String)

Returns:

• (String)

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

required :output_token, 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/swap_action_response.rb', line 53

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/swap_action_response.rb', line 118

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

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

Parameters:

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

Returns:

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

# File 'lib/privy/models/wallets/swap_action_response.rb', line 58

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

#wallet_id ⇒ String

The ID of the wallet involved in the action.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/privy/models/wallets/swap_action_response.rb', line 64

required :wallet_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/privy/models/wallets/swap_action_response.rbs', line 96

def to_hash: -> {