Class Dex

Dex class for interacting with decentralized exchange contracts on TON Provides functionality for liquidity operations, swaps, and simulation

See

LiquidityPool

Index

Constructors

constructor

new Dex(client: TonClient, address: Address): Dex
Creates a new Dex instance
Parameters
- client: TonClient
  The TON client instance
- address: Address
  The address of the Dex contract
Returns Dex
- Defined in sdk/Dex.ts:25

Accessors

address

get address(): Address
Returns the address of this Dex contract instance

Returns Address
The TON address of the Dex contract
- Defined in sdk/Dex.ts:34

Methods

getLatest

getLatest(): Promise<
    {
        balance: bigint;
        blockId: { seqno: number; shard: string; workchain: number };
        data: null | Dex$Data;
        lastTransaction: null | { hash: string; lt: string };
        state: "active" | "uninitialized" | "frozen";
        timestamp: number;
    },
>
Fetches the latest state of the Dex contract from the blockchain

Returns Promise<
    {
        balance: bigint;
        blockId: { seqno: number; shard: string; workchain: number };
        data: null | Dex$Data;
        lastTransaction: null | { hash: string; lt: string };
        state: "active" | "uninitialized" | "frozen";
        timestamp: number;
    },
>
Contract state including parsed contract data, balance and last transaction

See
Dex$Data
- Defined in sdk/Dex.ts:45

simulateDexSwap

simulateDexSwap(
amountIn: string | number | bigint,
directionIn: boolean,
): Promise<SwapSimulationOutput>
Simulates a swap using the current state of this Dex instance
Parameters
- amountIn: string | number | bigint
  Amount of input token to swap
- directionIn: boolean
  Direction flag: true for token0 to token1 swap, false for token1 to token0 swap
Returns Promise<SwapSimulationOutput>
Simulation result
Throws
If unable to fetch the DEX state
See
- SwapSimulationInput
- SwapSimulationOutput
- Defined in sdk/Dex.ts:238

`Static`buildAddLiquidityJetton

buildAddLiquidityJetton(opts: BuildAddLiquidityJettonOptions): Cell
Builds a message body for adding Jetton liquidity to a pool
Parameters
- opts: BuildAddLiquidityJettonOptions
  Options for the liquidity addition
Returns Cell
Cell containing the message body for the Jetton transfer with add liquidity payload

See
BuildAddLiquidityJettonOptions
- Defined in sdk/Dex.ts:103

`Static`buildAddLiquidityTon

buildAddLiquidityTon(opts: BuildAddLiquidityTonOptions): Cell
Builds a message body for adding TON (native currency) liquidity to a pool
Parameters
- opts: BuildAddLiquidityTonOptions
  Options for the TON liquidity addition
Returns Cell
Cell containing the message body for the TON liquidity addition

See
BuildAddLiquidityTonOptions
- Defined in sdk/Dex.ts:145

`Static`buildJettonSwap

buildJettonSwap(
    minOutput: bigint,
    destination: Address,
    forwardTonAmount?: bigint,
    forwardPayload?: Slice,
): Slice
Builds a payload for swapping Jetton tokens
Parameters
- minOutput: bigint
  Minimum amount of output tokens to receive
- destination: Address
  Destination address for output tokens
- OptionalforwardTonAmount: bigint = 0n
  TON to forward with output tokens
- OptionalforwardPayload: Slice
  Optional payload to forward
Returns Slice
Slice containing the payload for the Jetton swap

See
SwapOpPayload
- Defined in sdk/Dex.ts:213

`Static`buildTonSwap

buildTonSwap(
    minOutput: bigint,
    destination: Address,
    amountIn: bigint,
    forwardTonAmount?: bigint,
    forwardPayload?: Slice,
    queryId?: bigint,
): Cell
Builds a message body for swapping TON to tokens
Parameters
- minOutput: bigint
  Minimum amount of tokens to receive
- destination: Address
  Destination address for output tokens
- amountIn: bigint
  Amount of TON to swap
- OptionalforwardTonAmount: bigint = 0n
  TON to forward with output tokens
- OptionalforwardPayload: Slice
  Optional payload to forward
- OptionalqueryId: bigint = 1n
  Query ID for the operation
Returns Cell
Cell containing the message body for the TON swap

See
SwapOpPayload
- Defined in sdk/Dex.ts:176

`Static`getLatestState

getLatestState(
    client: TonClient,
    address: Address,
): Promise<
    {
        balance: bigint;
        blockId: { seqno: number; shard: string; workchain: number };
        data: null | Dex$Data;
        lastTransaction: null | { hash: string; lt: string };
        state: "active" | "uninitialized" | "frozen";
        timestamp: number;
    },
>
Static method to fetch the latest state of a Dex contract without instantiating the class
Parameters
- client: TonClient
  The TON client instance
- address: Address
  The address of the Dex contract
Returns Promise<
    {
        balance: bigint;
        blockId: { seqno: number; shard: string; workchain: number };
        data: null | Dex$Data;
        lastTransaction: null | { hash: string; lt: string };
        state: "active" | "uninitialized" | "frozen";
        timestamp: number;
    },
>
Contract state including parsed contract data, balance and last transaction

See
Dex$Data
- Defined in sdk/Dex.ts:75

`Static`simulateAddLiquidityPair

simulateAddLiquidityPair(
input: AddLiquidityPairSimulationInput,
): AddLiquidityPairSimulationOutput
Static method to simulate adding liquidity to calculate the required paired amount
Parameters
- input: AddLiquidityPairSimulationInput
Returns AddLiquidityPairSimulationOutput
Simulation result with paired amount and new reserves
See
- AddLiquidityPairSimulationInput
- AddLiquidityPairSimulationOutput
- Defined in sdk/Dex.ts:199

`Static`simulateSwap

simulateSwap(input: SwapSimulationInput): SwapSimulationOutput
Static method to simulate a swap without instantiating the class
Parameters
- input: SwapSimulationInput
  Parameters for the swap simulation
Returns SwapSimulationOutput
Simulation result
See
- Defined in sdk/Dex.ts:267

Class Dex

See

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Dex

Accessors

address

Returns Address

Methods

getLatest

Returns Promise< { balance: bigint; blockId: { seqno: number; shard: string; workchain: number }; data: null | Dex$Data; lastTransaction: null | { hash: string; lt: string }; state: "active" | "uninitialized" | "frozen"; timestamp: number; },>

See

simulateDexSwap

Parameters

Returns Promise<SwapSimulationOutput>

Throws

See

StaticbuildAddLiquidityJetton

Parameters

Returns Cell

See

StaticbuildAddLiquidityTon

Parameters

Returns Cell

See

StaticbuildJettonSwap

Parameters

Returns Slice

See

StaticbuildTonSwap

Parameters

Returns Cell

See

StaticgetLatestState

Parameters

Returns Promise< { balance: bigint; blockId: { seqno: number; shard: string; workchain: number }; data: null | Dex$Data; lastTransaction: null | { hash: string; lt: string }; state: "active" | "uninitialized" | "frozen"; timestamp: number; },>

See

StaticsimulateAddLiquidityPair

Parameters

Returns AddLiquidityPairSimulationOutput

See

StaticsimulateSwap

Parameters

Returns SwapSimulationOutput

See

Settings

On This Page

Returns Promise<
{
balance: bigint;
blockId: { seqno: number; shard: string; workchain: number };
data: null | Dex$Data;
lastTransaction: null | { hash: string; lt: string };
state: "active" | "uninitialized" | "frozen";
timestamp: number;
},
>

`Static`buildAddLiquidityJetton

`Static`buildAddLiquidityTon

`Static`buildJettonSwap

`Static`buildTonSwap

`Static`getLatestState

Returns Promise<
{
balance: bigint;
blockId: { seqno: number; shard: string; workchain: number };
data: null | Dex$Data;
lastTransaction: null | { hash: string; lt: string };
state: "active" | "uninitialized" | "frozen";
timestamp: number;
},
>

`Static`simulateAddLiquidityPair

`Static`simulateSwap