Class CreateExchangeRequest

Constructors

constructor

Properties

amount chainId deadline? fromAddress maxHops? optimistic? policy? slippagePercent? tokenInAddress tokenOutAddress tradeType attributeTypeMap discriminator

Methods

getAttributeTypeMap

Constructors

constructor

Properties

amount

amount: string

Amount in the smallest unit of the token

chainId

chainId: number

The chain ID. Must be a supported chain.

Optional deadline

deadline?: number

Latest time swap can execute. Default is 15 minutes

fromAddress

fromAddress: string

The public address that will sign and submit the transaction. If you provide one of a pla_... or acc_... it will be converted to the corresponding address.

Optional maxHops

maxHops?: number

Maximum hops allowed in optimal route. Default is 2

Optional optimistic

optimistic?: boolean

Set to true to indicate that the transactionIntent request should be resolved as soon as possible, after the transactionIntent is created and simulated and before it arrives on chain.

Optional policy

policy?: string

ID of the Policy that defines the gas sponsorship strategy (starts with pol_). If no Policy is provided, the own Account native token funds will be used to pay for gas.

Optional slippagePercent

slippagePercent?: number

The percentage of slippage tolerance. Default = 0.1. Max = 50. Min = 0

tokenInAddress

tokenInAddress: string

Token address or 'native' to sell

tokenOutAddress

tokenOutAddress: string

Token address or 'native' to buy

tradeType

tradeType: TradeType

Static Readonly attributeTypeMap

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...

Type declaration

  • baseName: string
  • format: string
  • name: string
  • type: string

Static Readonly discriminator

discriminator: undefined | string = undefined

Methods

Static getAttributeTypeMap

  • getAttributeTypeMap(): {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

  • Returns {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

Settings

Member Visibility

Theme

On This Page

constructoramountchainIddeadlinefromAddressmaxHopsoptimisticpolicyslippagePercenttokenInAddresstokenOutAddresstradeTypeattributeTypeMapdiscriminatorgetAttributeTypeMap