Class OnChainTrade`Abstract`

Abstract class for all instant trade providers' trades.

Hierarchy

OnChainTrade

Index

Properties

`Readonly` `Abstract` feeInfo

feeInfo: FeeInfo

`Readonly` `Abstract` from

from: PriceTokenAmount<BlockchainName>

Token to sell with input amount.

`Readonly` `Abstract` path

path: readonly Token<BlockchainName>[]

`Readonly` `Abstract` slippageTolerance

slippageTolerance: number

`Readonly` `Abstract` to

to: PriceTokenAmount<BlockchainName>

Token to get with output amount.

Accessors

apiFromAddress

set apiFromAddress(value: null | string): void
Parameters
- value: null | string
Returns void
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/on-chain-trade.ts:49

priceImpact

get priceImpact(): null | number
Price impact, based on tokens' usd prices.

Returns null | number
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/on-chain-trade.ts:85

toTokenAmountMin

get toTokenAmountMin(): PriceTokenAmount<BlockchainName>
Minimum amount of output token user can get.

Returns PriceTokenAmount<BlockchainName>
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/on-chain-trade.ts:61

`Abstract` type

get type(): "SOLANA" | "LIFI" | "BRIDGERS" | "SQUIDROUTER" | "RANGO" | "OPEN_OCEAN" | "SYNAPSE" | "10K_SWAP" | "AERODROME" | "ACRYPTOS" | "ALDRIN_EXCHANGE" | "ALGEBRA" | "ALGEBRA_INTEGRAL" | "ANNEX" | "APE_SWAP" | "ARTH_SWAP" | "ASTRO_SWAP" | "ASCENT" | "AURORA_SWAP" | "AVNU" | "BABY_SWAP" | "BALANCER" | "BASE_SWAP" | "BEAM_SWAP" | "BI_SWAP" | "CAMELOT" | "CHERRY_SWAP" | "CLAIM_SWAP" | "CREMA_FINANCE" | "CRO_SWAP" | "CRONA_SWAP" | "CROPPER_FINANCE" | "CROW_FI" | "CRO_DEX" | "CURVE" | "DEFI_PLAZA" | "DEFI_SWAP" | "DFYN" | "DLN" | "DODO" | "DRAGON_SWAP" | "DYSTOPIA" | "ECHO_DEX" | "EDDY_FINANCE" | "ELK" | "FENIX_V2" | "FENIX_V3" | "FINKUJIRA" | "FUSIONX" | "HONEY_SWAP" | "HORIZONDEX" | "JET_SWAP" | "JOE" | "JUPITER" | "JUPITER_SWAP" | "J_SWAP" | "KIM" | "KYBER_SWAP" | "KUJATA" | "LUA_SWAP" | "MACARON" | "MAVERICK" | "MDEX" | "MERLIN_SWAP" | "MESH_SWAP" | "MM_FINANCE" | "MOJITO_SWAP" | "MUTE_SWAP" | "NET_SWAP" | "NATIVE_ROUTER" | "ODOS" | "OKC_SWAP" | "OKU_SWAP" | "ONE_INCH" | "ONE_MOON" | "ONE_SOL" | "OMNIDEX" | "OOLONG_SWAP" | "ORCA_SWAP" | "OSMOSIS_SWAP" | "PANCAKE_SWAP" | "PANCAKE_SWAP_V3" | "PANGOLIN" | "PARA_SWAP" | "PEGASYS" | "PHOTON_SWAP" | "POLYDEX" | "PITEAS" | "QUICK_SWAP" | "QUICK_SWAP_V3" | "PULSEX_V1" | "PULSEX_V2" | "RAYDIUM" | "REF_FINANCE" | "REN_BTC" | "ROUTER_SWAP" | "SABER_STABLE_SWAP" | "SAROS_SWAP" | "SERUM" | "SHIBA_SWAP" | "SMOOTHY" | "SOLAR_BEAM" | "SPACEFI_SWAP" | "SPIRIT_SWAP" | "SPL_TOKEN_SWAP" | "SPOOKY_SWAP" | "SOUL_SWAP" | "STELLA_SWAP" | "SUN_SWAP" | "SURFDEX" | "SUSHI_SWAP" | "SYNC_SWAP" | "SILK_SWAP" | "SYMBIOSIS_SWAP" | "TRADER" | "TRISOLARIS" | "IZUMI" | "UBE_SWAP" | "UNISWAP_V2" | "UNI_SWAP_V3" | "VERSE" | "VIPER_SWAP" | "VOLTAGE_SWAP" | "VOOI" | "VVS_FINANCE" | "WAGYU_SWAP" | "WANNA_SWAP" | "WAULT_SWAP" | "WOO_FI" | "WRAPPED" | "WYND" | "YUZU_SWAP" | "XY_DEX" | "ZAPPY" | "ZIP_SWAP" | "ZRX" | "ZETA_SWAP"
Type of instant trade provider.

Returns "SOLANA" | "LIFI" | "BRIDGERS" | "SQUIDROUTER" | "RANGO" | "OPEN_OCEAN" | "SYNAPSE" | "10K_SWAP" | "AERODROME" | "ACRYPTOS" | "ALDRIN_EXCHANGE" | "ALGEBRA" | "ALGEBRA_INTEGRAL" | "ANNEX" | "APE_SWAP" | "ARTH_SWAP" | "ASTRO_SWAP" | "ASCENT" | "AURORA_SWAP" | "AVNU" | "BABY_SWAP" | "BALANCER" | "BASE_SWAP" | "BEAM_SWAP" | "BI_SWAP" | "CAMELOT" | "CHERRY_SWAP" | "CLAIM_SWAP" | "CREMA_FINANCE" | "CRO_SWAP" | "CRONA_SWAP" | "CROPPER_FINANCE" | "CROW_FI" | "CRO_DEX" | "CURVE" | "DEFI_PLAZA" | "DEFI_SWAP" | "DFYN" | "DLN" | "DODO" | "DRAGON_SWAP" | "DYSTOPIA" | "ECHO_DEX" | "EDDY_FINANCE" | "ELK" | "FENIX_V2" | "FENIX_V3" | "FINKUJIRA" | "FUSIONX" | "HONEY_SWAP" | "HORIZONDEX" | "JET_SWAP" | "JOE" | "JUPITER" | "JUPITER_SWAP" | "J_SWAP" | "KIM" | "KYBER_SWAP" | "KUJATA" | "LUA_SWAP" | "MACARON" | "MAVERICK" | "MDEX" | "MERLIN_SWAP" | "MESH_SWAP" | "MM_FINANCE" | "MOJITO_SWAP" | "MUTE_SWAP" | "NET_SWAP" | "NATIVE_ROUTER" | "ODOS" | "OKC_SWAP" | "OKU_SWAP" | "ONE_INCH" | "ONE_MOON" | "ONE_SOL" | "OMNIDEX" | "OOLONG_SWAP" | "ORCA_SWAP" | "OSMOSIS_SWAP" | "PANCAKE_SWAP" | "PANCAKE_SWAP_V3" | "PANGOLIN" | "PARA_SWAP" | "PEGASYS" | "PHOTON_SWAP" | "POLYDEX" | "PITEAS" | "QUICK_SWAP" | "QUICK_SWAP_V3" | "PULSEX_V1" | "PULSEX_V2" | "RAYDIUM" | "REF_FINANCE" | "REN_BTC" | "ROUTER_SWAP" | "SABER_STABLE_SWAP" | "SAROS_SWAP" | "SERUM" | "SHIBA_SWAP" | "SMOOTHY" | "SOLAR_BEAM" | "SPACEFI_SWAP" | "SPIRIT_SWAP" | "SPL_TOKEN_SWAP" | "SPOOKY_SWAP" | "SOUL_SWAP" | "STELLA_SWAP" | "SUN_SWAP" | "SURFDEX" | "SUSHI_SWAP" | "SYNC_SWAP" | "SILK_SWAP" | "SYMBIOSIS_SWAP" | "TRADER" | "TRISOLARIS" | "IZUMI" | "UBE_SWAP" | "UNISWAP_V2" | "UNI_SWAP_V3" | "VERSE" | "VIPER_SWAP" | "VOLTAGE_SWAP" | "VOOI" | "VVS_FINANCE" | "WAGYU_SWAP" | "WANNA_SWAP" | "WAULT_SWAP" | "WOO_FI" | "WRAPPED" | "WYND" | "YUZU_SWAP" | "XY_DEX" | "ZAPPY" | "ZIP_SWAP" | "ZRX" | "ZETA_SWAP"
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/on-chain-trade.ts:56

Methods

`Abstract` approve

approve(options: BasicTransactionOptions, checkNeedApprove?: boolean, amount?: BigNumber | "infinity"): Promise<unknown>
Sends approve transaction with connected wallet.
Parameters
- options: BasicTransactionOptions
  
  Transaction options.
- Optional checkNeedApprove: boolean
  
  If true, first allowance is checked.
- Optional amount: BigNumber | "infinity"
  
  Amount of tokens in approval window in spending cap field
Returns Promise<unknown>
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/on-chain-trade.ts:125

`Abstract` encode

encode(options: EncodeTransactionOptions): Promise<unknown>
Builds transaction config, with encoded data.
Parameters
- options: EncodeTransactionOptions
  
  Encode transaction options.
Returns Promise<unknown>
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/on-chain-trade.ts:164

`Abstract` encodeApprove

encodeApprove(tokenAddress: string, spenderAddress: string, value: BigNumber | "infinity", options?: BasicTransactionOptions): Promise<unknown>
Builds encoded approve transaction config.

Returns
Encoded approve transaction config.
Parameters
- tokenAddress: string
  
  Address of the smart-contract corresponding to the token.
- spenderAddress: string
  
  Wallet or contract address to approve.
- value: BigNumber | "infinity"
  
  Token amount to approve in wei.
- Optional options: BasicTransactionOptions
  
  Additional options.
Returns Promise<unknown>
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/on-chain-trade.ts:139

getTradeInfo

getTradeInfo(): TradeInfo
Returns TradeInfo
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/on-chain-trade.ts:246

needApprove

needApprove(fromAddress?: string): Promise<boolean>
Returns true, if allowance is not enough.
Parameters
- Optional fromAddress: string
Returns Promise<boolean>
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/on-chain-trade.ts:95

`Abstract` swap

swap(options?: SwapTransactionOptions): Promise<string>
Sends swap transaction with connected wallet. If user has not enough allowance, then approve transaction will be called first.

Example
```
const onConfirm = (hash: string) => console.log(hash);
const receipt = await trades[TRADE_TYPE.UNISWAP_V2].swap({ onConfirm });
```
Parameters
- Optional options: SwapTransactionOptions
  
  Transaction options.
Returns Promise<string>
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/on-chain-trade.ts:158

Class OnChainTradeAbstract

Hierarchy

Index

Properties

Accessors

Methods

Properties

Readonly Abstract feeInfo

Readonly Abstract from

Readonly Abstract path

Readonly Abstract slippageTolerance

Readonly Abstract to

Accessors

apiFromAddress

Parameters

value: null | string

Returns void

priceImpact

Returns null | number

toTokenAmountMin

Returns PriceTokenAmount<BlockchainName>

Abstract type

Methods

Abstract approve

Parameters

options: BasicTransactionOptions

Optional checkNeedApprove: boolean

Optional amount: BigNumber | "infinity"

Returns Promise<unknown>

Abstract encode

Parameters

options: EncodeTransactionOptions

Returns Promise<unknown>

Abstract encodeApprove

Returns

Parameters

tokenAddress: string

spenderAddress: string

value: BigNumber | "infinity"

Optional options: BasicTransactionOptions

Returns Promise<unknown>

getTradeInfo

Returns TradeInfo

needApprove

Parameters

Optional fromAddress: string

Returns Promise<boolean>

Abstract swap

Example

Parameters

Optional options: SwapTransactionOptions

Returns Promise<string>

Settings

Member Visibility

Theme

Class OnChainTrade`Abstract`

`Readonly` `Abstract` feeInfo

`Readonly` `Abstract` from

`Readonly` `Abstract` path

`Readonly` `Abstract` slippageTolerance

`Readonly` `Abstract` to

`Abstract` type

`Abstract` approve

`Optional` checkNeedApprove: boolean

`Optional` amount: BigNumber | "infinity"

`Abstract` encode

`Abstract` encodeApprove

`Optional` options: BasicTransactionOptions

`Optional` fromAddress: string

`Abstract` swap

`Optional` options: SwapTransactionOptions