Class OpenOceanTrade

Abstract class for all instant trade providers' trades.

Hierarchy

AggregatorEvmOnChainTrade
- OpenOceanTrade

Index

Constructors

constructor

new OpenOceanTrade(tradeStruct: OpenOceanTradeStruct, providerAddress: string): OpenOceanTrade
Parameters
- tradeStruct: OpenOceanTradeStruct
- providerAddress: string
Returns OpenOceanTrade
Overrides AggregatorEvmOnChainTrade.constructor
- Defined in src/features/on-chain/calculation-manager/providers/aggregators/open-ocean/open-ocean-trade.ts:62

Properties

`Readonly` feeInfo

feeInfo: FeeInfo

`Readonly` from

from: PriceTokenAmount<EvmBlockchainName>

Token to sell with input amount.

`Readonly` gasFeeInfo

gasFeeInfo: null | GasFeeInfo

Gas fee info, including gas limit and gas price.

`Readonly` path

path: readonly Token<BlockchainName>[]

`Readonly` permit2ApproveConfig

permit2ApproveConfig: Permit2ApproveConfig = ...

Filled if approve goes through permit2 contract

`Readonly` slippageTolerance

slippageTolerance: number

`Readonly` to

to: PriceTokenAmount<EvmBlockchainName>

Token to get with output amount.

`Readonly` type

type: "OPEN_OCEAN" = ON_CHAIN_TRADE_TYPE.OPEN_OCEAN

`Readonly` useProxy

useProxy: boolean

True, if trade must be swapped through on-chain proxy contract.

`Static` `Readonly` nativeAddress

nativeAddress: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE" = '0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE'

Accessors

dexContractAddress

get dexContractAddress(): string
Returns string
Overrides AggregatorEvmOnChainTrade.dexContractAddress
- Defined in src/features/on-chain/calculation-manager/providers/aggregators/open-ocean/open-ocean-trade.ts:54

priceImpact

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

Returns null | number
Inherited from AggregatorEvmOnChainTrade.priceImpact
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/on-chain-trade.ts:79

toTokenAmountMin

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

Returns PriceTokenAmount<BlockchainName>
Overrides AggregatorEvmOnChainTrade.toTokenAmountMin
- Defined in src/features/on-chain/calculation-manager/providers/aggregators/open-ocean/open-ocean-trade.ts:58

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 AggregatorEvmOnChainTrade.approve
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/evm-on-chain-trade/evm-on-chain-trade.ts:151

encode

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

encodeApprove

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

encodeDirect

encodeDirect(options: EncodeTransactionOptions): Promise<EvmEncodeConfig>
Encodes trade to swap it directly through dex contract.
Parameters
- options: EncodeTransactionOptions
  
  Encode options.
Returns Promise<EvmEncodeConfig>
Inherited from AggregatorEvmOnChainTrade.encodeDirect
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/evm-on-chain-trade/evm-on-chain-trade.ts:356

getTradeInfo

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

getTxConfigAndCheckAmount

getTxConfigAndCheckAmount(options: EncodeTransactionOptions): Promise<EvmEncodeConfig>
Parameters
- options: EncodeTransactionOptions
Returns Promise<EvmEncodeConfig>
Inherited from AggregatorEvmOnChainTrade.getTxConfigAndCheckAmount
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-aggregator/aggregator-evm-on-chain-trade-abstract.ts:9

needApprove

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

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
- options: SwapTransactionOptions = {}
  
  Transaction options.
Returns Promise<string>
Inherited from AggregatorEvmOnChainTrade.swap
- Defined in src/features/on-chain/calculation-manager/providers/common/on-chain-trade/evm-on-chain-trade/evm-on-chain-trade.ts:238

Class OpenOceanTrade

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

tradeStruct: OpenOceanTradeStruct

providerAddress: string

Returns OpenOceanTrade

Properties

Readonly feeInfo

Readonly from

Readonly gasFeeInfo

Readonly path

Readonly permit2ApproveConfig

Readonly slippageTolerance

Readonly to

Readonly type

Readonly useProxy

Static Readonly nativeAddress

Accessors

dexContractAddress

Returns string

priceImpact

Returns null | number

toTokenAmountMin

Returns PriceTokenAmount<BlockchainName>

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>

encodeDirect

Parameters

options: EncodeTransactionOptions

Returns Promise<EvmEncodeConfig>

getTradeInfo

Returns TradeInfo

getTxConfigAndCheckAmount

Parameters

options: EncodeTransactionOptions

Returns Promise<EvmEncodeConfig>

needApprove

Parameters

Optional fromAddress: string

Returns Promise<boolean>

swap

Example

Parameters

options: SwapTransactionOptions = {}

Returns Promise<string>

Settings

Member Visibility

Theme

`Readonly` feeInfo

`Readonly` from

`Readonly` gasFeeInfo

`Readonly` path

`Readonly` permit2ApproveConfig

`Readonly` slippageTolerance

`Readonly` to

`Readonly` type

`Readonly` useProxy

`Static` `Readonly` nativeAddress

`Optional` fromAddress: string