Class: Privy::Models::SwapRequestBody

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/privy/models/swap_request_body.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

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(base_amount:, destination:, source:, amount_type: nil, slippage_bps: nil) ⇒ Object

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

Input for executing a token swap.

Parameters:

  • base_amount (String) —

    Amount in base units (e.g., wei for ETH). Must be a non-negative integer string.

  • destination (Privy::Models::SwapDestination) —

    The output side of a swap execution request.

  • source (Privy::Models::SwapSource) —

    The input side of a swap request, including token and chain.

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

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

  • slippage_bps (Float) (defaults to: nil) —

    Maximum slippage tolerance in basis points (e.g., 50 for 0.5%).




# File 'lib/privy/models/swap_request_body.rb', line 36

Instance Attribute Details

#amount_type ⇒ Symbol, ...

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

Returns:



28
 
# File 'lib/privy/models/swap_request_body.rb', line 28

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

#base_amount ⇒ String

Amount in base units (e.g., wei for ETH). Must be a non-negative integer string.

Returns:

  • (String) 


10
 
# File 'lib/privy/models/swap_request_body.rb', line 10

required :base_amount, String

#destination ⇒ Privy::Models::SwapDestination

The output side of a swap execution request.

Returns:



16
 
# File 'lib/privy/models/swap_request_body.rb', line 16

required :destination, -> { Privy::SwapDestination }

#slippage_bps ⇒ Float?

Maximum slippage tolerance in basis points (e.g., 50 for 0.5%).

Returns:

  • (Float, nil) 


34
 
# File 'lib/privy/models/swap_request_body.rb', line 34

optional :slippage_bps, Float

#source ⇒ Privy::Models::SwapSource

The input side of a swap request, including token and chain.

Returns:



22
 
# File 'lib/privy/models/swap_request_body.rb', line 22

required :source, -> { Privy::SwapSource }