Class SquidrouterCrossChainTrade

Calculated DeBridge cross-chain trade.

Hierarchy

EvmCrossChainTrade
- SquidrouterCrossChainTrade

Index

Constructors

constructor

new SquidrouterCrossChainTrade(crossChainTrade: {
    allowanceTarget: string;
    cryptoFeeToken: PriceTokenAmount<BlockchainName>;
    feeInfo: FeeInfo;
    from: PriceTokenAmount<EvmBlockchainName>;
    gasData: GasData;
    onChainSubtype: OnChainSubtype;
    onChainTrade: null | EvmOnChainTrade;
    priceImpact: null | number;
    slippage: number;
    to: PriceTokenAmount<EvmBlockchainName>;
    transactionRequest: SquidrouterTransactionRequest;
}, providerAddress: string, routePath: RubicStep[]): SquidrouterCrossChainTrade
Parameters
- crossChainTrade: {
      allowanceTarget: string;
      cryptoFeeToken: PriceTokenAmount<BlockchainName>;
      feeInfo: FeeInfo;
      from: PriceTokenAmount<EvmBlockchainName>;
      gasData: GasData;
      onChainSubtype: OnChainSubtype;
      onChainTrade: null | EvmOnChainTrade;
      priceImpact: null | number;
      slippage: number;
      to: PriceTokenAmount<EvmBlockchainName>;
      transactionRequest: SquidrouterTransactionRequest;
  }
  - allowanceTarget: string
  - cryptoFeeToken: PriceTokenAmount<BlockchainName>
  - feeInfo: FeeInfo
  - from: PriceTokenAmount<EvmBlockchainName>
  - gasData: GasData
  - onChainSubtype: OnChainSubtype
  - onChainTrade: null | EvmOnChainTrade
  - priceImpact: null | number
  - slippage: number
  - to: PriceTokenAmount<EvmBlockchainName>
  - transactionRequest: SquidrouterTransactionRequest
- providerAddress: string
- routePath: RubicStep[]
Returns SquidrouterCrossChainTrade
Overrides EvmCrossChainTrade.constructor
- Defined in src/features/cross-chain/calculation-manager/providers/squidrouter-provider/squidrouter-cross-chain-trade.ts:126

Properties

`Readonly` allowanceTarget

allowanceTarget: string

`Readonly` bridgeType

bridgeType: "squidrouter" = BRIDGE_TYPE.SQUIDROUTER

Contains bridge provider's type used in route.

`Readonly` feeInfo

feeInfo: FeeInfo

Swap fee information.

`Readonly` from

from: PriceTokenAmount<EvmBlockchainName>

Token to sell with input amount.

`Readonly` gasData

gasData: GasData

Gas fee info in source blockchain.

`Readonly` isAggregator

isAggregator: false = false

True, if provider is aggregator.

`Readonly` onChainSubtype

onChainSubtype: OnChainSubtype = ...

Contains on-chain providers' type used in route.

`Readonly` priceImpact

priceImpact: null | number

promotions

promotions: string[] = []

Promotions array.

squidrouterRequestId

squidrouterRequestId: undefined | string

`Readonly` to

to: PriceTokenAmount<EvmBlockchainName>

Token to get with output amount.

`Readonly` toTokenAmountMin

toTokenAmountMin: BigNumber

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

`Readonly` type

type: "squidrouter" = CROSS_CHAIN_TRADE_TYPE.SQUIDROUTER

Type of calculated cross-chain trade.

Accessors

apiFromAddress

set apiFromAddress(value: null | string): void
Parameters
- value: null | string
Returns void
Inherited from EvmCrossChainTrade.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
Inherited from EvmCrossChainTrade.estimatedGas
- 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 EvmCrossChainTrade.networkFee
- Defined in src/features/cross-chain/calculation-manager/providers/common/cross-chain-trade.ts:99

platformFee

get platformFee(): BigNumber
Returns BigNumber
Inherited from EvmCrossChainTrade.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>
Inherited from EvmCrossChainTrade.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 EvmCrossChainTrade.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>
Inherited from EvmCrossChainTrade.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>
Inherited from EvmCrossChainTrade.encodeApprove
- Defined in src/features/cross-chain/calculation-manager/providers/common/emv-cross-chain-trade/evm-cross-chain-trade.ts:318

getContractParams

getContractParams(options: GetContractParamsOptions): Promise<ContractParams>
Parameters
- options: GetContractParamsOptions
Returns Promise<ContractParams>
Overrides EvmCrossChainTrade.getContractParams
- Defined in src/features/cross-chain/calculation-manager/providers/squidrouter-provider/squidrouter-cross-chain-trade.ts:194

getData

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

getTradeAmountRatio

getTradeAmountRatio(fromUsd: BigNumber): BigNumber
Parameters
- fromUsd: BigNumber
Returns BigNumber
- Defined in src/features/cross-chain/calculation-manager/providers/squidrouter-provider/squidrouter-cross-chain-trade.ts:249

getTradeInfo

getTradeInfo(): TradeInfo
Returns TradeInfo
Overrides EvmCrossChainTrade.getTradeInfo
- Defined in src/features/cross-chain/calculation-manager/providers/squidrouter-provider/squidrouter-cross-chain-trade.ts:256

getUsdPrice

getUsdPrice(providerFeeToken?: BigNumber): BigNumber
Parameters
- Optional providerFeeToken: BigNumber
Returns BigNumber
Inherited from EvmCrossChainTrade.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 EvmCrossChainTrade.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>
Inherited from EvmCrossChainTrade.swap
- Defined in src/features/cross-chain/calculation-manager/providers/common/emv-cross-chain-trade/evm-cross-chain-trade.ts:200

Class SquidrouterCrossChainTrade

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

allowanceTarget: string

cryptoFeeToken: PriceTokenAmount<BlockchainName>

feeInfo: FeeInfo

from: PriceTokenAmount<EvmBlockchainName>

gasData: GasData

onChainSubtype: OnChainSubtype

onChainTrade: null | EvmOnChainTrade

priceImpact: null | number

slippage: number

to: PriceTokenAmount<EvmBlockchainName>

transactionRequest: SquidrouterTransactionRequest

providerAddress: string

routePath: RubicStep[]

Returns SquidrouterCrossChainTrade

Properties

Readonly allowanceTarget

Readonly bridgeType

Readonly feeInfo

Readonly from

Readonly gasData

Readonly isAggregator

Readonly onChainSubtype

Readonly priceImpact

promotions

squidrouterRequestId

Readonly to

Readonly toTokenAmountMin

Readonly 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>

getContractParams

Parameters

options: GetContractParamsOptions

Returns Promise<ContractParams>

getData

Parameters

fromAddress: string

options: SwapTransactionOptions = {}

Returns Promise<EvmTransactionOptions>

getTradeAmountRatio

`Readonly` allowanceTarget

`Readonly` bridgeType

`Readonly` feeInfo

`Readonly` from

`Readonly` gasData

`Readonly` isAggregator

`Readonly` onChainSubtype

`Readonly` priceImpact

`Readonly` to

`Readonly` toTokenAmountMin

`Readonly` type

`Optional` providerFeeToken: BigNumber