QuoteRequest
Hierarchy
↳
QuoteRequest
Table of contents
Properties
- bridgeWithGas
- disableSwapping
- excludeBridges
- excludeDexes
- fromAmount
- fromChainId
- fromTokenAddress
- includeBridges
- includeDexes
- isContractCall
- maxUserTxs
- recipient
- singleTxOnly
- sort
- toChainId
- toTokenAddress
- uniqueRoutesPerBridge
- userAddress
Properties
bridgeWithGas
• Optional bridgeWithGas: boolean
include gas transfer with bridging tx
Inherited from
QuotePreferences.bridgeWithGas
Defined in
socket-v2-sdk/src/client/models/QuoteRequest.ts:20
disableSwapping
• Optional disableSwapping: boolean
Flag to specify if routes that have dex swap should be ignored.
Inherited from
QuotePreferences.disableSwapping
Defined in
socket-v2-sdk/src/client/models/SocketPreferences.ts:5
excludeBridges
• Optional excludeBridges: BridgeName[]
Specify Bridges that should be excluded in routes. This option will be ignored if includeBridges is specified.
Inherited from
QuotePreferences.excludeBridges
Defined in
socket-v2-sdk/src/client/models/SocketPreferences.ts:15
excludeDexes
• Optional excludeDexes: Dexes[]
Specify Dexes that should be excluded in routes. This option will be ignored if includeDexes is specified.
Inherited from
Defined in
socket-v2-sdk/src/client/models/SocketPreferences.ts:10
fromAmount
• fromAmount: string
Amount of sending tokens.
Defined in
socket-v2-sdk/src/client/models/QuoteRequest.ts:33
fromChainId
• fromChainId: number
Chain id of source chain.
Defined in
socket-v2-sdk/src/client/models/QuoteRequest.ts:25
fromTokenAddress
• fromTokenAddress: string
Token address on source chain.
Defined in
socket-v2-sdk/src/client/models/QuoteRequest.ts:27
includeBridges
• Optional includeBridges: BridgeName[]
Specify Bridges that should be included in routes.
Inherited from
QuotePreferences.includeBridges
Defined in
socket-v2-sdk/src/client/models/SocketPreferences.ts:12
includeDexes
• Optional includeDexes: Dexes[]
Specify Dexes that should be included in routes.
Inherited from
Defined in
socket-v2-sdk/src/client/models/SocketPreferences.ts:7
isContractCall
• Optional isContractCall: boolean
Only get quotes with that are compatible with contracts
Inherited from
QuotePreferences.isContractCall
Defined in
socket-v2-sdk/src/client/models/QuoteRequest.ts:18
maxUserTxs
• Optional maxUserTxs: string
Maximum number of transactions. This option will be ignored if singleTxOnly is marked as true.
Inherited from
Defined in
socket-v2-sdk/src/client/models/QuoteRequest.ts:16
recipient
• Optional recipient: string
Address of recipient. This will be used to check approvals.
Defined in
socket-v2-sdk/src/client/models/QuoteRequest.ts:37
singleTxOnly
• Optional singleTxOnly: boolean
Only get quotes with one user transaction to bridge.
Inherited from
Defined in
socket-v2-sdk/src/client/models/SocketPreferences.ts:17
sort
• Optional sort: SortOptions
Param to sort routes based on.
Inherited from
Defined in
socket-v2-sdk/src/client/models/QuoteRequest.ts:13
toChainId
• toChainId: number
Chain id of destination chain.
Defined in
socket-v2-sdk/src/client/models/QuoteRequest.ts:29
toTokenAddress
• toTokenAddress: string
Token address on destination chain.
Defined in
socket-v2-sdk/src/client/models/QuoteRequest.ts:31
uniqueRoutesPerBridge
• Optional uniqueRoutesPerBridge: boolean
Flag to return only best route per bridge using the sort criteria
Inherited from
QuotePreferences.uniqueRoutesPerBridge
Defined in
socket-v2-sdk/src/client/models/QuoteRequest.ts:11
userAddress
• userAddress: string
Address of user. This will be used to check approvals.