Referencia (v1)

Referencia de métodos del SDK del DEX STON.fi v1: documentación completa de la API para interacciones con router y pool

Enrutador

dirección

Dirección del contrato Router

gasConstants

Getters

getPoolAddress

async getPoolAddress(
    provider: ContractProvider,
    params: {
      token0: Address | string;
      token1: Address | string;
    },
): Promise<Address>

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Nombre
Tipo
Descripción

token0

Address | string

La dirección de la billetera del router del primer Jetton

token1

Address | string

La dirección de la billetera del router del segundo Jetton

Resultado

Devuelve la dirección de un pool para un par específico de activos.

getPoolAddressByJettonMinters

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Nombre
Tipo
Descripción

token0

Address | string

La dirección del primer Jetton del pool Minter billetera

token1

Address | string

La dirección del segundo Jetton del pool Minter billetera

Resultado

Devuelve la dirección de un pool para un par específico de activos.

getPool

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Nombre
Tipo
Descripción

token0

Address | string

La dirección del primer Jetton del pool Minter billetera

token1

Address | string

La dirección del segundo Jetton del pool Minter billetera

Resultado

Devuelve una instancia de PoolV1 con las direcciones de tokens Jetton especificadas.

getRouterData

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Resultado

Devuelve una estructura que contiene el estado actual del router.

Nombre
Tipo
Descripción

isLocked

boolean

true si transfer_notification las operaciones están bloqueadas (swap, provide_lp)

adminAddress

Address

Dirección de la cuenta administradora del contrato

tempUpgrade

Cell

Una estructura que describe el estado del código del contrato y la actualización de administrador; los valores cero indican que no hay ninguna actualización pendiente

poolCode

Cell

Código del contrato del pool de liquidez del router

jettonLpWalletCode

Cell

Código del contrato de la billetera LP

lpAccountCode

Cell

Código del contrato de la cuenta LP

Operaciones

createSwapBody

Nombre
Tipo
Descripción

userWalletAddress

Address | string

Dirección del usuario

minAskAmount

bigint | number | string

Cantidad mínima de tokens recibidos (en unidades básicas del token)

askJettonWalletAddress

Address | string

Dirección de la billetera del router de los tokens a recibir

referralAddress

Address | string | undefined

dirección de referencia

getSwapJettonToJettonTxParams

Construir todos los datos necesarios para ejecutar una swap transacción

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Nombre
Tipo
Descripción

userWalletAddress

Address | string

Dirección del usuario

offerJettonAddress

Address | string

Jetton Minter dirección de un token a intercambiar

askJettonAddress

Address | string

Jetton Minter dirección de un token a recibir

offerAmount

bigint | number | string

Cantidad de tokens a intercambiar (en unidades básicas del token)

minAskAmount

bigint | number | string

Cantidad mínima de tokens a recibir (en unidades básicas del token)

referralAddress

Address | string | undefined

Dirección de referencia

gasAmount

bigint | number | string | undefined

Gas de la transacción

forwardGasAmount

bigint | number | string | undefined

Cantidad de gas a reenviar para la siguiente transacción (en nanoTons)

queryId

bigint | number | undefined

ID de consulta

Resultado

Nombre
Tipo
Descripción

to

Address

Dirección de la billetera Jetton del router para el token intercambiado

value

bigint

Cantidad recomendada de TON (en nanoTons) enviada como gas

body

Cell | null | undefined

Opcional Cell con datos para ser enviados

sendSwapJettonToJetton

getSwapJettonToTonTxParams

Construir todos los datos necesarios para ejecutar un jetton a ton swap transacción

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Nombre
Tipo
Descripción

userWalletAddress

Address | string

Dirección del usuario

offerJettonAddress

Address | string

Jetton Minter dirección de un token a intercambiar

proxyTon

PtonV1

instancia del contrato pTON

offerAmount

bigint | number | string

Cantidad de tokens a intercambiar (en unidades básicas del token)

minAskAmount

bigint | number | string

Cantidad mínima de tokens a recibir (en unidades básicas del token)

referralAddress

Address | string | undefined

Dirección de referencia

gasAmount

bigint | number | string | undefined

Gas de la transacción

forwardGasAmount

bigint | number | string | undefined

Cantidad de gas a reenviar para la siguiente transacción (en nanoTons)

queryId

bigint | number | undefined

ID de consulta

Resultado

Nombre
Tipo
Descripción

to

Address

Dirección de la billetera Jetton del router para el token intercambiado

value

bigint

Cantidad recomendada de TON (en nanoTons) enviada como gas

body

Cell | null | undefined

Opcional Cell con datos para ser enviados

sendSwapJettonToTon

getSwapTonToJettonTxParams

Construir todos los datos necesarios para ejecutar un ton a jetton swap transacción

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Nombre
Tipo
Descripción

userWalletAddress

Address | string

Dirección del usuario

proxyTon

PtonV1

instancia del contrato pTON

askJettonAddress

Address | string

Jetton Minter dirección de un token a recibir

offerAmount

bigint | number | string

Cantidad de tokens a intercambiar (en unidades básicas del token)

minAskAmount

bigint | number | string

Cantidad mínima de tokens a recibir (en unidades básicas del token)

referralAddress

Address | string | undefined

Dirección de referencia

forwardGasAmount

bigint | number | string | undefined

Cantidad de gas a reenviar para la siguiente transacción (en nanoTons)

queryId

bigint | number | undefined

ID de consulta

Resultado

Nombre
Tipo
Descripción

to

Address

Dirección de la billetera Jetton del router para el token intercambiado

value

bigint

Cantidad recomendada de TON (en nanoTons) enviada como gas

body

Cell | null | undefined

Opcional Cell con datos para ser enviados

sendSwapTonToJetton

createProvideLiquidityBody

Nombre
Tipo
Descripción

routerWalletAddress

Address | string

Dirección de la billetera de tokens Jetton del router

minLpOut

bigint | number | string

Cantidad mínima de tokens de liquidez creados (en unidades básicas del token)

getProvideLiquidityJettonTxParams

Reunir todos los datos necesarios para ejecutar un jetton provide_lp transacción

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Nombre
Tipo
Descripción

userWalletAddress

Address | string

Dirección del usuario

sendTokenAddress

Address | string

Dirección del primer token Jetton o de un contrato proxy ton

otherTokenAddress

Address | string

Dirección del segundo token Jetton

sendAmount

bigint | number | string

Cantidad del primer/segundo token depositado como liquidez (en unidades básicas del token)

minLpOut

bigint | number | string

Cantidad mínima de tokens de liquidez creados (en unidades básicas del token)

gasAmount

bigint | number | string | undefined

Gas de la transacción

forwardGasAmount

bigint | number | string | undefined

Cantidad de gas a reenviar para la siguiente transacción (en nanoTons)

queryId

bigint | number | undefined

ID de consulta

Resultado

Nombre
Tipo
Descripción

to

Address

Dirección de la billetera Jetton del router para el token intercambiado

value

bigint

Cantidad recomendada de TON (en nanoTons) enviada como gas

body

Cell | null | undefined

Opcional Cell con datos para ser enviados

sendProvideLiquidityJetton

getProvideLiquidityTonTxParams

Reunir todos los datos necesarios para ejecutar un proxy ton provide_lp transacción

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Nombre
Tipo
Descripción

userWalletAddress

Address | string

Dirección del usuario

proxyTon

PtonV1

instancia del contrato pTON

otherTokenAddress

Address | string

Dirección del segundo token Jetton

sendAmount

bigint | number | string

Cantidad del primer/segundo token depositado como liquidez (en unidades básicas del token)

minLpOut

bigint | number | string

Cantidad mínima de tokens de liquidez creados (en unidades básicas del token)

forwardGasAmount

bigint | number | string | undefined

Cantidad de gas a reenviar para la siguiente transacción (en nanoTons)

queryId

bigint | number | undefined

ID de consulta

Resultado

Nombre
Tipo
Descripción

to

Address

Dirección de la billetera Jetton del router para el token intercambiado

value

bigint

Cantidad recomendada de TON (en nanoTons) enviada como gas

body

Cell | null | undefined

Opcional Cell con datos para ser enviados

sendProvideLiquidityTon

Pool

dirección

Dirección del contrato Pool

gasConstants

Getters

getPoolData

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Resultado

Devuelve una estructura que contiene el estado actual del pool.

Nombre
Tipo
Descripción

reserve0

bigint

Cantidad del primer token (en unidades básicas del token)

reserve1

bigint

Cantidad del segundo token (en unidades básicas del token)

token0WalletAddress

Address

Dirección del primer token Jetton

token1WalletAddress

Address

Dirección del segundo token Jetton

lpFee

bigint

Valor de la comisión del pool de liquidez

protocolFee

bigint

Comisión del protocolo

refFee

bigint

Comisión de referencia

protocolFeeAddress

Address

Dirección para recibir las comisiones del protocolo

collectedToken0ProtocolFee

bigint

Cantidad de comisiones de protocolo acumuladas del primer token (en unidades básicas del token)

collectedToken1ProtocolFee

bigint

Cantidad de comisiones de protocolo acumuladas del segundo token (en unidades básicas del token)

Notas:

  • la proporción de la comisión es el valor de la comisión dividido por FEE_DIVIDER (10000); por lo tanto, una comisión del 1% tiene un valor de 100

getExpectedOutputs

Estimar el resultado esperado de la cantidad de tokens jettonWallet intercambiados por el otro tipo de tokens del pool

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Nombre
Tipo
Descripción

amount

bigint | number | string

Cantidad de tokens a intercambiar (en unidades básicas del token)

jettonWallet

Address | string

Dirección Jetton del token (debe ser igual a una de las direcciones Jetton del pool)

Resultado

Devuelve una estructura con el resultado esperado de un intercambio de tokens

Nombre
Tipo
Descripción

jettonToReceive

bigint

Cantidad de tokens recibidos (en unidades básicas del token)

protocolFeePaid

bigint

Cantidad de tokens pagados por comisiones del protocolo (en unidades básicas del token)

refFeePaid

bigint

Cantidad de tokens pagados por comisiones de referencia (en unidades básicas del token)

getExpectedTokens

Estimar una cantidad esperada de tokens LP acuñados al proporcionar liquidez.

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Nombre
Tipo
Descripción

amount0

bigint | number | string

Cantidad de tokens para el primer Jetton (en unidades básicas del token)

amount1

bigint | number | string

Cantidad de tokens para el segundo Jetton (en unidades básicas del token)

Resultado

Devuelve una cantidad estimada de tokens de liquidez a acuñar

getExpectedLiquidity

Estimar la liquidez esperada liberada al quemar tokens de liquidez.

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Nombre
Tipo
Descripción

jettonAmount

bigint | number | string

Cantidad de tokens de liquidez (en unidades básicas del token)

Resultado

Devuelve una estructura con la liquidez esperada liberada

Nombre
Tipo
Descripción

amount0

bigint

Cantidad de tokens para el primer Jetton (en unidades básicas del token)

amount1

bigint

Cantidad de tokens para el segundo Jetton (en unidades básicas del token)

getLpAccountAddress

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Nombre
Tipo
Descripción

ownerAddress

Address | string

Dirección de un usuario

Resultado

Function getLpAccountAddress devuelve la dirección de la cuenta lp de un usuario

getLpAccount

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Nombre
Tipo
Descripción

ownerAddress

Address | string

Dirección de un usuario

Resultado

devuelve una instancia de LpAccountV1

getJettonData

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Resultado

Devuelve una estructura con los datos de Jetton

Nombre
Tipo
Descripción

totalSupply

bigint

Suministro total de tokens (en unidades básicas del token)

isMintable

boolean

Si es acuñable

adminAddress

Address

Dirección del administrador

jettonContentUri

string

URI fuera de la cadena con datos de Jetton

jettonWalletCode

Cell

Código de la billetera Jetton LP

getWalletAddress

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

ownerAddress

Address | string

Dirección de un usuario

Resultado

devuelve una dirección de billetera lp calculada de un usuario

getJettonWallet

Argumentos

Nombre
Tipo
Descripción

ownerAddress

Address | string

Dirección de un usuario

Nombre
Tipo
Descripción

ownerAddress

Address | string

Dirección de un usuario

Resultado

Function getJettonWallet devuelve una JettonWallet instancia para una dirección devuelta por getWalletAddress

Operaciones

createCollectFeesBody

getCollectFeeTxParams

Construir todos los datos necesarios para ejecutar una collect_fees transacción.

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Nombre
Tipo
Descripción

gasAmount

bigint | number | string | undefined

Gas de la transacción

queryId

bigint | number | undefined

ID de consulta

Resultado

Nombre
Tipo
Descripción

to

Address

Dirección de la billetera Jetton del router para el token intercambiado

value

bigint

Cantidad recomendada de TON (en nanoTons) enviada como gas

body

Cell | null | undefined

Opcional Cell con datos para ser enviados

Notas:

  • parámetro es completamente opcional

  • el valor predeterminado para gasAmount es igual a 1.1 TON

sendCollectFees

createBurnBody

getBurnTxParams

Construir todos los datos necesarios para ejecutar una quema transacción.

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Nombre
Tipo
Descripción

amount

bigint | number | string

Tokens LP a quemar

responseAddress

Address | string

Dirección de excedentes

gasAmount

bigint | number | string | undefined

Gas de la transacción

queryId

bigint | number | undefined

ID de consulta

sendBurn

LpAccount

dirección

Dirección del contrato LpAccount

gasConstants

Getters

getLpAccountData

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Resultado

Devuelve una estructura que contiene el estado actual de la cuenta lp.

Nombre
Tipo
Descripción

userAddress

Address

Dirección del propietario

poolAddress

Address

Dirección del pool

amount0

bigint

Saldo del primer token Jetton (en unidades básicas del token)

amount1

bigint

Saldo del segundo token Jetton (en unidades básicas del token)

Operaciones

createRefundBody

getRefundTxParams

Construir todos los datos necesarios para ejecutar una refund_me transacción.

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Nombre
Tipo
Descripción

gasAmount

bigint | number | string | undefined

Gas de la transacción

queryId

bigint | number | undefined

ID de consulta

Resultado

Nombre
Tipo
Descripción

to

Address

Dirección de la billetera Jetton del router para el token intercambiado

value

bigint

Cantidad recomendada de TON (en nanoTons) enviada como gas

body

Cell | null | undefined

Opcional Cell con datos para ser enviados

sendRefund

createDirectAddLiquidityBody

getDirectAddLiquidityTxParams

Construir todos los datos necesarios para ejecutar una direct_add_liquidity transacción.

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Nombre
Tipo
Descripción

amount0

bigint | number | string

Cantidad de tokens Jetton del primer token (en unidades básicas del token)

amount1

bigint | number | string

Cantidad de tokens Jetton del segundo token (en unidades básicas del token)

minimumLpToMint

bigint | number | string | undefined

Cantidad mínima de tokens de liquidez recibidos (en unidades básicas del token)

gasAmount

bigint | number | string | undefined

Gas de la transacción

queryId

bigint | number | undefined

ID de consulta

Resultado

Nombre
Tipo
Descripción

to

Address

Dirección de la billetera Jetton del router para el token intercambiado

value

bigint

Cantidad recomendada de TON (en nanoTons) enviada como gas

body

Cell | null | undefined

Opcional Cell con datos para ser enviados

Notas:

  • la adición de liquidez fallará si un usuario debe recibir menos de minimumLpToMint tokens LP como resultado

  • el valor predeterminado para gasAmount es igual a 0.3 TON

sendDirectAddLiquidity

createResetGasBody

getResetGasTxParams

Construir todos los datos necesarios para ejecutar una reset_gas transacción.

Argumentos

Nombre
Tipo
Descripción

provider

ContractProvider

Instancia de @ton/core proveedor del contrato

Nombre
Tipo
Descripción

gasAmount

bigint | number | string | undefined

Gas de la transacción

queryId

bigint | number | undefined

ID de consulta

Resultado

Nombre
Tipo
Descripción

to

Address

Dirección de la billetera Jetton del router para el token intercambiado

value

bigint

Cantidad recomendada de TON (en nanoTons) enviada como gas

body

Cell | null | undefined

Opcional Cell con datos para ser enviados

Notas:

  • params es completamente opcional

  • el valor predeterminado para gasAmount es igual a 0.3 TON

sendResetGas

Última actualización