Class EvmCrossChainTrade`Abstract`

Abstract class for all cross-chain providers' trades.

Index

Properties

`Readonly` `Abstract` bridgeType

bridgeType: BridgeType

Contains bridge provider's type used in route.

`Readonly` `Abstract` feeInfo

feeInfo: FeeInfo

Swap fee information.

`Readonly` `Abstract` from

from: PriceTokenAmount<EvmBlockchainName>

Token to sell with input amount.

`Readonly` `Abstract` gasData

gasData: GasData

Gas fee info in source blockchain.

`Readonly` `Abstract` isAggregator

isAggregator: boolean

True, if provider is aggregator.

`Readonly` `Abstract` onChainSubtype

onChainSubtype: OnChainSubtype

Contains on-chain providers' type used in route.

promotions

promotions: string[] = []

Promotions array.

`Readonly` `Abstract` to

to: PriceTokenAmount<BlockchainName>

Token to get with output amount.

`Readonly` `Abstract` toTokenAmountMin

toTokenAmountMin: BigNumber

Minimum amount of output token user will get in Eth units.

`Readonly` `Abstract` type

type: CrossChainTradeType

Type of calculated cross-chain trade.

Accessors

apiFromAddress

set apiFromAddress(value: null | string): void
Parameters
- value: null | string
Returns void
Inherited from CrossChainTrade.apiFromAddress
- Defined in src/features/cross-chain/calculation-manager/providers/common/cross-chain-trade.ts:144

estimatedGas

get estimatedGas(): null | BigNumber
Gets gas fee in source blockchain.

Returns null | BigNumber
- Defined in src/features/cross-chain/calculation-manager/providers/common/emv-cross-chain-trade/evm-cross-chain-trade.ts:57

networkFee

get networkFee(): BigNumber
Returns BigNumber
Inherited from CrossChainTrade.networkFee
- Defined in src/features/cross-chain/calculation-manager/providers/common/cross-chain-trade.ts:99

platformFee

get platformFee(): BigNumber
Returns BigNumber
Inherited from CrossChainTrade.platformFee
- Defined in src/features/cross-chain/calculation-manager/providers/common/cross-chain-trade.ts:105

Methods

approve

approve(options: EvmBasicTransactionOptions, checkNeedApprove?: boolean, amount?: BigNumber | "infinity"): Promise<TransactionReceipt>
Sends approve transaction with connected wallet.
Parameters
- options: EvmBasicTransactionOptions
  
  Transaction options.
- checkNeedApprove: boolean = true
  
  If true, first allowance is checked.
- amount: BigNumber | "infinity" = 'infinity'
  
  Amount of tokens in approval window in spending cap field
Returns Promise<TransactionReceipt>
Overrides CrossChainTrade.approve
- Defined in src/features/cross-chain/calculation-manager/providers/common/emv-cross-chain-trade/evm-cross-chain-trade.ts:75

checkBlockchainRequirements

checkBlockchainRequirements(): Promise<boolean>
Returns Promise<boolean>
Inherited from CrossChainTrade.checkBlockchainRequirements
- Defined in src/features/cross-chain/calculation-manager/providers/common/cross-chain-trade.ts:238

encode

encode(options: EncodeTransactionOptions): Promise<EvmEncodeConfig>
Builds transaction config, with encoded data.
Parameters
- options: EncodeTransactionOptions
  
  Encode transaction options.
Returns Promise<EvmEncodeConfig>
Overrides CrossChainTrade.encode
- Defined in src/features/cross-chain/calculation-manager/providers/common/emv-cross-chain-trade/evm-cross-chain-trade.ts:301

encodeApprove

encodeApprove(tokenAddress: string, spenderAddress: string, value: BigNumber | "infinity", options?: EvmTransactionOptions): Promise<TransactionConfig>
Build 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.
- options: EvmTransactionOptions = {}
  
  Additional options.
Returns Promise<TransactionConfig>
Overrides CrossChainTrade.encodeApprove
- Defined in src/features/cross-chain/calculation-manager/providers/common/emv-cross-chain-trade/evm-cross-chain-trade.ts:318

getData

getData(fromAddress: string, options?: SwapTransactionOptions): Promise<EvmTransactionOptions>
Parameters
- fromAddress: string
- options: SwapTransactionOptions = {}
Returns Promise<EvmTransactionOptions>
- Defined in src/features/cross-chain/calculation-manager/providers/common/emv-cross-chain-trade/evm-cross-chain-trade.ts:163

`Abstract` getTradeInfo

getTradeInfo(): TradeInfo
Returns TradeInfo
Inherited from CrossChainTrade.getTradeInfo
- Defined in src/features/cross-chain/calculation-manager/providers/common/cross-chain-trade.ts:333

getUsdPrice

getUsdPrice(providerFeeToken?: BigNumber): BigNumber
Parameters
- Optional providerFeeToken: BigNumber
Returns BigNumber
Overrides CrossChainTrade.getUsdPrice
- Defined in src/features/cross-chain/calculation-manager/providers/common/emv-cross-chain-trade/evm-cross-chain-trade.ts:332

needApprove

needApprove(): Promise<boolean>
Returns true, if allowance is not enough.

Returns Promise<boolean>
Inherited from CrossChainTrade.needApprove
- Defined in src/features/cross-chain/calculation-manager/providers/common/cross-chain-trade.ts:156

swap

swap(options?: SwapTransactionOptions): Promise<string>
Returns
txHash(srcTxHash) | never
Parameters
- options: SwapTransactionOptions = {}
Returns Promise<string>
Overrides CrossChainTrade.swap
- Defined in src/features/cross-chain/calculation-manager/providers/common/emv-cross-chain-trade/evm-cross-chain-trade.ts:200

Class EvmCrossChainTradeAbstract

Hierarchy

Index

Properties

Accessors

Methods

Properties

Readonly Abstract bridgeType

Readonly Abstract feeInfo

Readonly Abstract from

Readonly Abstract gasData

Readonly Abstract isAggregator

Readonly Abstract onChainSubtype

promotions

Readonly Abstract to

Readonly Abstract toTokenAmountMin

Readonly Abstract type

Accessors

apiFromAddress

Parameters

value: null | string

Returns void

estimatedGas

Returns null | BigNumber

networkFee

Returns BigNumber

platformFee

Returns BigNumber

Methods

approve

Parameters

options: EvmBasicTransactionOptions

checkNeedApprove: boolean = true

amount: BigNumber | "infinity" = 'infinity'

Returns Promise<TransactionReceipt>

checkBlockchainRequirements

Returns Promise<boolean>

encode

Parameters

options: EncodeTransactionOptions

Returns Promise<EvmEncodeConfig>

encodeApprove

Returns

Parameters

tokenAddress: string

spenderAddress: string

value: BigNumber | "infinity"

options: EvmTransactionOptions = {}

Returns Promise<TransactionConfig>

getData

Parameters

fromAddress: string

options: SwapTransactionOptions = {}

Returns Promise<EvmTransactionOptions>

Abstract getTradeInfo

Returns TradeInfo

getUsdPrice

Parameters

Optional providerFeeToken: BigNumber

Returns BigNumber

needApprove

Returns Promise<boolean>

swap

Returns

Parameters

options: SwapTransactionOptions = {}

Returns Promise<string>

Settings

Member Visibility

Theme

Class EvmCrossChainTrade`Abstract`

`Readonly` `Abstract` bridgeType

`Readonly` `Abstract` feeInfo

`Readonly` `Abstract` from

`Readonly` `Abstract` gasData

`Readonly` `Abstract` isAggregator

`Readonly` `Abstract` onChainSubtype

`Readonly` `Abstract` to

`Readonly` `Abstract` toTokenAmountMin

`Readonly` `Abstract` type

`Abstract` getTradeInfo

`Optional` providerFeeToken: BigNumber