Class TronBridgersCrossChainTrade

Abstract class for all cross-chain providers' trades.

Hierarchy

TronCrossChainTrade
- TronBridgersCrossChainTrade

Index

Constructors

constructor

new TronBridgersCrossChainTrade(crossChainTrade: {
    contractAddress: string;
    feeInfo: FeeInfo;
    from: PriceTokenAmount<"TRON">;
    slippage: number;
    to: PriceTokenAmount<"ETH" | "BSC" | "POLYGON" | "FANTOM">;
    toTokenAmountMin: BigNumber;
}, providerAddress: string, routePath: RubicStep[]): TronBridgersCrossChainTrade
Parameters
- crossChainTrade: {
      contractAddress: string;
      feeInfo: FeeInfo;
      from: PriceTokenAmount<"TRON">;
      slippage: number;
      to: PriceTokenAmount<"ETH" | "BSC" | "POLYGON" | "FANTOM">;
      toTokenAmountMin: BigNumber;
  }
  - contractAddress: string
  - feeInfo: FeeInfo
  - from: PriceTokenAmount<"TRON">
  - slippage: number
  - to: PriceTokenAmount<"ETH" | "BSC" | "POLYGON" | "FANTOM">
  - toTokenAmountMin: BigNumber
- providerAddress: string
- routePath: RubicStep[]
Returns TronBridgersCrossChainTrade
Overrides TronCrossChainTrade.constructor
- Defined in src/features/cross-chain/calculation-manager/providers/bridgers-provider/tron-bridgers-trade/tron-bridgers-cross-chain-trade.ts:55

Properties

`Readonly` bridgeType

bridgeType: "bridgers" = BRIDGE_TYPE.BRIDGERS

Contains bridge provider's type used in route.

`Readonly` feeInfo

feeInfo: FeeInfo

Swap fee information.

`Readonly` from

from: PriceTokenAmount<"TRON">

Token to sell with input amount.

`Readonly` isAggregator

isAggregator: false = false

True, if provider is aggregator.

`Readonly` onChainSubtype

onChainSubtype: {
from: undefined;
to: undefined;
} = ...

Contains on-chain providers' type used in route.

Type declaration

from: undefined
to: undefined

`Readonly` priceImpact

priceImpact: null | number

promotions

promotions: string[] = []

Promotions array.

`Readonly` to

to: PriceTokenAmount<"ETH" | "BSC" | "POLYGON" | "FANTOM">

Token to get with output amount.

`Readonly` toTokenAmountMin

toTokenAmountMin: BigNumber

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

`Readonly` type

type: "bridgers" = CROSS_CHAIN_TRADE_TYPE.BRIDGERS

Type of calculated cross-chain trade.

Accessors

apiFromAddress

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

networkFee

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

platformFee

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

Methods

approve

approve(options: TronTransactionOptions, checkNeedApprove?: boolean, amount?: BigNumber | "infinity"): Promise<string>
Sends approve transaction with connected wallet.
Parameters
- options: TronTransactionOptions
  
  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<string>
Inherited from TronCrossChainTrade.approve
- Defined in src/features/cross-chain/calculation-manager/providers/common/tron-cross-chain-trade/tron-cross-chain-trade.ts:32

checkBlockchainRequirements

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

encode

encode(options: Omit<EncodeTransactionOptions, "receiverAddress"> & Required<Pick<EncodeTransactionOptions, "receiverAddress">>): Promise<TronTransactionConfig>
Builds transaction config, with encoded data.
Parameters
- options: Omit<EncodeTransactionOptions, "receiverAddress"> & Required<Pick<EncodeTransactionOptions, "receiverAddress">>
  
  Encode transaction options.
Returns Promise<TronTransactionConfig>
Inherited from TronCrossChainTrade.encode
- Defined in src/features/cross-chain/calculation-manager/providers/common/tron-cross-chain-trade/tron-cross-chain-trade.ts:113

encodeApprove

encodeApprove(tokenAddress: string, spenderAddress: string, value: BigNumber | "infinity", options?: TronTransactionOptions): Promise<TronTransactionConfig>
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: TronTransactionOptions = {}
  
  Additional options.
Returns Promise<TronTransactionConfig>
Inherited from TronCrossChainTrade.encodeApprove
- Defined in src/features/cross-chain/calculation-manager/providers/common/tron-cross-chain-trade/tron-cross-chain-trade.ts:135

getTradeAmountRatio

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

getTradeInfo

getTradeInfo(): TradeInfo
Returns TradeInfo
Overrides TronCrossChainTrade.getTradeInfo
- Defined in src/features/cross-chain/calculation-manager/providers/bridgers-provider/tron-bridgers-trade/tron-bridgers-cross-chain-trade.ts:179

getUsdPrice

getUsdPrice(): BigNumber
Returns BigNumber
Inherited from TronCrossChainTrade.getUsdPrice
- Defined in src/features/cross-chain/calculation-manager/providers/common/tron-cross-chain-trade/tron-cross-chain-trade.ts:148

needApprove

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

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

swap

swap(options: Omit<SwapTransactionOptions, "receiverAddress"> & Required<Pick<SwapTransactionOptions, "receiverAddress">>): 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 trade.swap({ onConfirm });
```
Parameters
- options: Omit<SwapTransactionOptions, "receiverAddress"> & Required<Pick<SwapTransactionOptions, "receiverAddress">>
  
  Transaction options.
Returns Promise<string>
Overrides TronCrossChainTrade.swap
- Defined in src/features/cross-chain/calculation-manager/providers/bridgers-provider/tron-bridgers-trade/tron-bridgers-cross-chain-trade.ts:78

Class TronBridgersCrossChainTrade

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

crossChainTrade: { contractAddress: string; feeInfo: FeeInfo; from: PriceTokenAmount<"TRON">; slippage: number; to: PriceTokenAmount<"ETH" | "BSC" | "POLYGON" | "FANTOM">; toTokenAmountMin: BigNumber; }

contractAddress: string

feeInfo: FeeInfo

from: PriceTokenAmount<"TRON">

slippage: number

to: PriceTokenAmount<"ETH" | "BSC" | "POLYGON" | "FANTOM">

toTokenAmountMin: BigNumber

providerAddress: string

routePath: RubicStep[]

Returns TronBridgersCrossChainTrade

Properties

Readonly bridgeType

Readonly feeInfo

Readonly from

Readonly isAggregator

Readonly onChainSubtype

Type declaration

from: undefined

to: undefined

Readonly priceImpact

promotions

Readonly to

Readonly toTokenAmountMin

Readonly type

Accessors

apiFromAddress

Parameters

value: null | string

Returns void

networkFee

Returns BigNumber

platformFee

Returns BigNumber

Methods

approve

Parameters

options: TronTransactionOptions

checkNeedApprove: boolean = true

amount: BigNumber | "infinity" = 'infinity'

Returns Promise<string>

checkBlockchainRequirements

Returns Promise<boolean>

encode

Parameters

options: Omit<EncodeTransactionOptions, "receiverAddress"> & Required<Pick<EncodeTransactionOptions, "receiverAddress">>

Returns Promise<TronTransactionConfig>

encodeApprove

Returns

Parameters

tokenAddress: string

spenderAddress: string

value: BigNumber | "infinity"

options: TronTransactionOptions = {}

Returns Promise<TronTransactionConfig>

getTradeAmountRatio

Parameters

fromUsd: BigNumber

Returns BigNumber

getTradeInfo

Returns TradeInfo

getUsdPrice

Returns BigNumber

needApprove

Returns Promise<boolean>

swap

Example

Parameters

options: Omit<SwapTransactionOptions, "receiverAddress"> & Required<Pick<SwapTransactionOptions, "receiverAddress">>

Returns Promise<string>

Settings

crossChainTrade: {
contractAddress: string;
feeInfo: FeeInfo;
from: PriceTokenAmount<"TRON">;
slippage: number;
to: PriceTokenAmount<"ETH" | "BSC" | "POLYGON" | "FANTOM">;
toTokenAmountMin: BigNumber;
}

`Readonly` bridgeType

`Readonly` feeInfo

`Readonly` from

`Readonly` isAggregator

`Readonly` onChainSubtype

`Readonly` priceImpact

`Readonly` to

`Readonly` toTokenAmountMin

`Readonly` type