Class StargateCrossChainTrade

Abstract class for all cross-chain providers' trades.

Hierarchy

EvmCrossChainTrade
- StargateCrossChainTrade

Index

Constructors

Constructors

constructor

new StargateCrossChainTrade(crossChainTrade: {
    cryptoFeeToken: null | PriceToken<BlockchainName>;
    dstChainTrade: null | EvmOnChainTrade;
    feeInfo: FeeInfo;
    from: PriceTokenAmount<EvmBlockchainName>;
    gasData: GasData;
    priceImpact: null | number;
    slippageTolerance: number;
    srcChainTrade: null | EvmOnChainTrade;
    to: PriceTokenAmount<EvmBlockchainName>;
}, providerAddress: string, routePath: RubicStep[]): StargateCrossChainTrade
Parameters
- crossChainTrade: {
      cryptoFeeToken: null | PriceToken<BlockchainName>;
      dstChainTrade: null | EvmOnChainTrade;
      feeInfo: FeeInfo;
      from: PriceTokenAmount<EvmBlockchainName>;
      gasData: GasData;
      priceImpact: null | number;
      slippageTolerance: number;
      srcChainTrade: null | EvmOnChainTrade;
      to: PriceTokenAmount<EvmBlockchainName>;
  }
  - cryptoFeeToken: null | PriceToken<BlockchainName>
  - dstChainTrade: null | EvmOnChainTrade
  - feeInfo: FeeInfo
  - from: PriceTokenAmount<EvmBlockchainName>
  - gasData: GasData
  - priceImpact: null | number
  - slippageTolerance: number
  - srcChainTrade: null | EvmOnChainTrade
  - to: PriceTokenAmount<EvmBlockchainName>
- providerAddress: string
- routePath: RubicStep[]
Returns StargateCrossChainTrade
Overrides EvmCrossChainTrade.constructor
- Defined in src/features/cross-chain/calculation-manager/providers/stargate-provider/stargate-cross-chain-trade.ts:126

Properties

`Readonly` bridgeType

bridgeType: "stargate" = BRIDGE_TYPE.STARGATE

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.

`Readonly` slippageTolerance

slippageTolerance: number

`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: "stargate" = CROSS_CHAIN_TRADE_TYPE.STARGATE

Type of calculated cross-chain trade.

Accessors

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:46

fromBlockchain

get fromBlockchain(): "ETH" | "BSC" | "POLYGON" | "AVALANCHE" | "FANTOM" | "ARBITRUM" | "OPTIMISM" | "METIS" | "BASE"
Returns "ETH" | "BSC" | "POLYGON" | "AVALANCHE" | "FANTOM" | "ARBITRUM" | "OPTIMISM" | "METIS" | "BASE"
- Defined in src/features/cross-chain/calculation-manager/providers/stargate-provider/stargate-cross-chain-trade.ts:110

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:64

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:256

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:273

getContractParams

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

getTradeAmountRatio

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

getTradeInfo

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

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:287

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:146

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:156

`Static` getLayerZeroSwapData

getLayerZeroSwapData(from: PriceTokenAmount<EvmBlockchainName>, to: PriceTokenAmount<EvmBlockchainName>, tokenAmountMin?: string, receiverAddress?: string, dstData?: string): Promise<EvmEncodeConfig>
Parameters
- from: PriceTokenAmount<EvmBlockchainName>
- to: PriceTokenAmount<EvmBlockchainName>
- tokenAmountMin: string = to.stringWeiAmount
- Optional receiverAddress: string
- Optional dstData: string
Returns Promise<EvmEncodeConfig>
- Defined in src/features/cross-chain/calculation-manager/providers/stargate-provider/stargate-cross-chain-trade.ts:227

Class StargateCrossChainTrade

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

cryptoFeeToken: null | PriceToken<BlockchainName>

dstChainTrade: null | EvmOnChainTrade

feeInfo: FeeInfo

from: PriceTokenAmount<EvmBlockchainName>

gasData: GasData

priceImpact: null | number

slippageTolerance: number

srcChainTrade: null | EvmOnChainTrade

to: PriceTokenAmount<EvmBlockchainName>

providerAddress: string

routePath: RubicStep[]

Returns StargateCrossChainTrade

Properties

Readonly bridgeType

Readonly feeInfo

Readonly from

Readonly gasData

Readonly isAggregator

Readonly onChainSubtype

Readonly priceImpact

promotions

Readonly slippageTolerance

Readonly to

Readonly toTokenAmountMin

Readonly type

Accessors

estimatedGas

Returns null | BigNumber

fromBlockchain

Returns "ETH" | "BSC" | "POLYGON" | "AVALANCHE" | "FANTOM" | "ARBITRUM" | "OPTIMISM" | "METIS" | "BASE"

networkFee

Returns BigNumber

platformFee

Returns BigNumber

Methods

approve

Parameters

options: EvmBasicTransactionOptions

checkNeedApprove: boolean = true

amount: BigNumber | "infinity" = 'infinity'

Returns Promise<TransactionReceipt>

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>

getTradeAmountRatio

Parameters

fromUsd: BigNumber

Returns BigNumber

getTradeInfo

Returns TradeInfo

getUsdPrice

Parameters

Optional providerFeeToken: BigNumber

Returns BigNumber

needApprove

Returns Promise<boolean>

swap

`Readonly` bridgeType

`Readonly` feeInfo

`Readonly` from

`Readonly` gasData

`Readonly` isAggregator

`Readonly` onChainSubtype

`Readonly` priceImpact

`Readonly` slippageTolerance

`Readonly` to

`Readonly` toTokenAmountMin

`Readonly` type

`Optional` providerFeeToken: BigNumber

`Static` getLayerZeroSwapData

`Optional` receiverAddress: string

`Optional` dstData: string