Orchestration functions are plain-english wrappers for the function defined in Data and Computation.

Functions suffixed with WithData are synchronous, and require token reserves to be passed in as arguments. Functions without the suffix are asychronous, and require token addresses to be passed in as arguments.

tradeExactEthForTokensWithData

The function facilitates trading an exact amount of ETH for a specified token.

Function Signature

export function tradeExactEthForTokensWithData(reserves: OptionalReserves, ethAmount: BigNumberish): TradeDetails
Copy

Input Parameters

Example Usage

const tradeDetails: TradeDetails = tradeExactEthForTokensWithData(reserves, '1000000000000000000')
Copy

tradeExactEthForTokens

The function facilitates trading an exact amount of ETH for a specified token.

Function Signature

export async function tradeExactEthForTokens(
  tokenAddress: string,
  ethAmount: BigNumberish,
  chainIdOrProvider?: ChainIdOrProvider
): Promise<TradeDetails>
Copy

Input Parameters

Example Usage

const tradeDetails: TradeDetails = await tradeExactEthForTokens(tokenAddress, '1000000000000000000')
Copy

tradeEthForExactTokensWithData

The function facilitates trading ETH for an exact amount of a specified token.

Function Signature

export function tradeEthForExactTokensWithData(reserves: OptionalReserves, tokenAmount: BigNumberish): TradeDetails
Copy

Input Parameters

Example Usage

const tradeDetails: TradeDetails = tradeEthForExactTokensWithData(reserves, '1000000000000000000')
Copy

tradeEthForExactTokens

The function facilitates trading ETH for an exact amount of a specified token.

Function Signature

export async function tradeEthForExactTokens(
  tokenAddress: string,
  tokenAmount: BigNumberish,
  chainIdOrProvider?: ChainIdOrProvider
): Promise<TradeDetails>
Copy

Input Parameters

Example Usage

const tradeDetails: TradeDetails = await tradeEthForExactTokens(tokenAddress, '1000000000000000000')
Copy

tradeExactTokensForEthWithData

The function facilitates trading an exact amount of a specified token for ETH.

Function Signature

export function tradeExactTokensForEthWithData(reserves: OptionalReserves, tokenAmount: BigNumberish): TradeDetails
Copy

Input Parameters

Example Usage

const tradeDetails: TradeDetails = tradeExactTokensForEthWithData(reserves, '1000000000000000000')
Copy

tradeExactTokensForEth

The function facilitates trading an exact amount of a specified token for ETH.

Function Signature

export async function tradeExactTokensForEth(
  tokenAddress: string,
  tokenAmount: BigNumberish,
  chainIdOrProvider?: ChainIdOrProvider
): Promise<TradeDetails>
Copy

Input Parameters

Example Usage

const tradeDetails: TradeDetails = await tradeExactTokensForEth(tokenAddress, '1000000000000000000')
Copy

tradeTokensForExactEthWithData

The function facilitates trading a specified token for an exact amount of ETH.

Function Signature

export function tradeTokensForExactEthWithData(reserves: OptionalReserves, ethAmount: BigNumberish): TradeDetails
Copy

Input Parameters

Example Usage

const tradeDetails: TradeDetails = tradeTokensForExactEthWithData(reserves, '1000000000000000000')
Copy

tradeTokensForExactEth

The function facilitates trading a specified token for an exact amount of ETH.

Function Signature

export async function tradeTokensForExactEth(
  tokenAddress: string,
  ethAmount: BigNumberish,
  chainIdOrProvider?: ChainIdOrProvider
): Promise<TradeDetails>
Copy

Input Parameters

Example Usage

const tradeDetails: TradeDetails = await tradeTokensForExactEth(tokenAddress, '1000000000000000000')
Copy

tradeExactTokensForTokensWithData

The function facilitates trading an exact amount of a specified token for another token.

Function Signature

export function tradeExactTokensForTokensWithData(
  reservesInput: OptionalReserves,
  reservesOutput: OptionalReserves,
  tokenAmount: BigNumberish
): TradeDetails
Copy

Input Parameters

Example Usage

const tradeDetails: TradeDetails = tradeExactTokensForTokensWithData(
  reservesInput,
  reservesOutput,
  '1000000000000000000'
)
Copy

tradeExactTokensForTokens

The function facilitates trading an exact amount of a specified token for another token.

Function Signature

export async function tradeExactTokensForTokens(
  tokenAddressInput: string,
  tokenAddressOutput: string,
  tokenAmount: BigNumberish,
  chainIdOrProvider?: ChainIdOrProvider
): Promise<TradeDetails>
Copy

Input Parameters

Example Usage

const tradeDetails: TradeDetails = await tradeExactTokensForTokens(
  tokenAddressInput,
  tokenAddressOutput,
  '1000000000000000000'
)
Copy

tradeTokensForExactTokensWithData

The function facilitates trading a specified token for an exact amount of another token.

Function Signature

export function tradeTokensForExactTokensWithData(
  reservesInput: OptionalReserves,
  reservesOutput: OptionalReserves,
  tokenAmount: BigNumberish
): TradeDetails
Copy

Input Parameters

Example Usage

const tradeDetails: TradeDetails = tradeTokensForExactTokensWithData(
  reservesInput,
  reservesOutput,
  '1000000000000000000'
)
Copy

tradeTokensForExactTokens

The function facilitates trading an exact amount of a specified token for another token.

Function Signature

export async function tradeTokensForExactTokens(
  tokenAddressInput: string,
  tokenAddressOutput: string,
  tokenAmount: BigNumberish,
  chainIdOrProvider?: ChainIdOrProvider
): Promise<TradeDetails>
Copy

Input Parameters

Example Usage

const tradeDetails: TradeDetails = await tradeTokensForExactTokens(
  tokenAddressInput,
  tokenAddressOutput,
  '1000000000000000000'
)
Copy