pontem-network / liquidswap-sdk

Typescript SDK to work with Liquidswap contracts

LiquidSwap SDK

Table of Contents

1. Installation
2. Usage
3. Roadmap
4. Contributing
5. License

The typescript SDK for Liquidswap.

Installation

For NPM:

npm i @pontem/liquidswap-sdk

For Yarn:

yarn add @pontem/liquidswap-sdk

(back to top)

Usage

Init SDK

import { SDK, convertValueToDecimal } from '@pontem/liquidswap-sdk';

const sdk = new SDK({
  nodeUrl: 'https://fullnode.mainnet.aptoslabs.com/v1', // Node URL, required
  /**
    networkOptions is optional

    networkOptions: {
      nativeToken: '0x1::aptos_coin::AptosCoin', - Type of Native network token
      modules: {
        Scripts:
          '0x190d44266241744264b964a37b8f09863167a12d3e70cda39376cfb4e3561e12::scripts_v2',  - This module is used for Swap
        CoinInfo: '0x1::coin::CoinInfo', - Type of base CoinInfo module
        CoinStore: '0x1::coin::CoinStore', - Type of base CoinStore module
      },
      resourceAccount: '0x05a97986a9d031c4567e15b797be516910cfcb4156312482efc6a19c0a30c948',
      moduleAccount: '0x190d44266241744264b964a37b8f09863167a12d3e70cda39376cfb4e3561e12',
      moduleAccountV05: '0x163df34fccbf003ce219d3f1d9e70d140b60622cb9dd47599c25fb2f797ba6e',
      resourceAccountV05: '0x61d2c22a6cb7831bee0f48363b0eec92369357aece0d1142062f7d5d85c7bef8'
    }
  */
})

Convert 15 coins to Decimal type with 8 decimals (coins like APTOS, BTC, etc);

// convertValueToDecimal return Decimal type;
const decimalValue = convertValueToDecimal(15, 8); // 1500000000 (15 coin with 8 decimals)
or
const decimalValue2 = convertValueToDecimal('0.005', 8); // 500000 (0.005 coin with 8 decimals)

Swap EXACTLY 1 APTOS to SLIPPAGED layerzero USDT amount

(async () => {
  // Get USDT amount
  try {
    const output = await sdk.Swap.calculateRates({
      fromToken: '0x1::aptos_coin::AptosCoin', // full 'from' token address
      toToken: '0xf22bede237a07e121b56d91a491eb7bcdfd1f5907926a9e58338f964a01b17fa::asset::USDT', // full 'to' token address layerzero USDT
      amount: 100000000, // 1 APTOS, or you can use convertValueToDecimal(1, 8)
      curveType: 'uncorrelated', // can be 'uncorrelated' or 'stable'
      interactiveToken: 'from', // which token is 'base' to calculate other token rate.
      version: 0
    })
    console.log(output) // '4304638' (4.304638 USDT)

    // Generate TX payload for swap 1 APTOS to maximum 4.304638 USDT
    // and minimum 4.283115 USDT (with slippage -0.5%)
    const txPayload = sdk.Swap.createSwapTransactionPayload({
      fromToken: '0x1::aptos_coin::AptosCoin',
      toToken: '0xf22bede237a07e121b56d91a491eb7bcdfd1f5907926a9e58338f964a01b17fa::asset::USDT', // layerzero USDT
      fromAmount: 100000000, // 1 APTOS, or you can use convertValueToDecimal(1, 8)
      toAmount: 4304638, // 4.304638 USDT, or you can use convertValueToDecimal(4.304638, 6)
      interactiveToken: 'from',
      slippage: 0.005, // 0.5% (1 - 100%, 0 - 0%)
      stableSwapType: 'high',
      curveType: 'uncorrelated',
      version: 0
    })
    console.log(txPayload);
  } catch(e) {
    console.log(e)
  }

  /**
   Output:
  {
      type: 'entry_function_payload',
      function: '0x190d44266241744264b964a37b8f09863167a12d3e70cda39376cfb4e3561e12::scripts_v2::swap',
      type_arguments: [
        '0x1::aptos_coin::AptosCoin',
        '0xae478ff7d83ed072dbc5e264250e67ef58f57c99d89b447efd8a0a2e8b2be76e::coin::T',
        '0x190d44266241744264b964a37b8f09863167a12d3e70cda39376cfb4e3561e12::curves::Uncorrelated'
      ],
      arguments: [ '100000000', '4283115' ]
    }

  */
})()

Get EXACTLY 1 USDT and send SLIPPAGED APTOS amount

(async () => {
  // Get APTOS amount
  try {
    const amount = await sdk.Swap.calculateRates({
      fromToken: '0x1::aptos_coin::AptosCoin',
      toToken: '0xf22bede237a07e121b56d91a491eb7bcdfd1f5907926a9e58338f964a01b17fa::asset::USDT',
      amount: 1000000, // 1 layerzero USDT
      interactiveToken: 'to',
      curveType: 'uncorrelated',
      version: 0
    })
    console.log(amount) // '23211815' ('0.23211815' APTOS)

    // Generate TX payload for get EXACTLY 1 USDT
    // and minimum send 0.23327874 (with slippage +0.5%)
    const txPayload = sdk.Swap.createSwapTransactionPayload({
      fromToken: '0x1::aptos_coin::AptosCoin',
      toToken: '0xf22bede237a07e121b56d91a491eb7bcdfd1f5907926a9e58338f964a01b17fa::asset::USDT',
      fromAmount: convertValueToDecimal(0.23211815, 8), // 0.23211815 APTOS,
      toAmount: convertValueToDecimal(1, 6), // 1 layerzero USDT,
      interactiveToken: 'to',
      slippage: 0.005, // 0.5% (1 - 100%, 0 - 0%)
      stableSwapType: 'hign',
      curveType: 'uncorrelated',
      version: 0
    })
    console.log(txPayload);
  } catch (e) {
    console.log(e);
  }

  /**
   Output:
  {
      type: 'entry_function_payload',
      function: '0x190d44266241744264b964a37b8f09863167a12d3e70cda39376cfb4e3561e12::scripts_v2::swap_into',
      type_arguments: [
        '0x1::aptos_coin::AptosCoin',
        '0xf22bede237a07e121b56d91a491eb7bcdfd1f5907926a9e58338f964a01b17fa::asset::USDT',
        '0x190d44266241744264b964a37b8f09863167a12d3e70cda39376cfb4e3561e12::curves::Uncorrelated'
      ],
      arguments: [ '23327874', '1000000' ]
    }
  */
})()

Swap EXACTLY 1 APTOS to wormhole WETH with curve - 'stable', stableSwapType - 'normal' and 0.5% slippage

(async () => {
  // Get WETH amount
  try {
    const amount = await sdk.Swap.calculateRates({
      fromToken: '0x1::aptos_coin::AptosCoin',
      toToken: '0xcc8a89c8dce9693d354449f1f73e60e14e347417854f029db5bc8e7454008abb::coin::T', // wormhole WETH (whWETH)
      amount: 100000000, // 1 APTOS
      interactiveToken: 'from',
      curveType: 'stable',
      version: 0
    })
    console.log(amount) // '175257' ('0.00175257' whWETH)

    // Generate TX payload to swap 1 APTOS to
    // and minimum send 0.00174381 (with slippage -0.5%)
    const txPayload = sdk.Swap.createSwapTransactionPayload({
      fromToken: '0x1::aptos_coin::AptosCoin',
      toToken: '0xf22bede237a07e121b56d91a491eb7bcdfd1f5907926a9e58338f964a01b17fa::asset::USDT',
      fromAmount: convertValueToDecimal(1, 8), // 1 Aptos
      toAmount: convertValueToDecimal(0.00175257, 8), // 0.00175257 whWETH,
      interactiveToken: 'from',
      slippage: 0.005, // 0.5% (1 - 100%, 0 - 0%)
      stableSwapType: 'normal',
      curveType: 'stable',
      version: 0
    })
    console.log(txPayload);
  } catch (e) {
    console.log(e);
  }

  /**
   Output:
  {
      type: 'entry_function_payload',
      function: '0x190d44266241744264b964a37b8f09863167a12d3e70cda39376cfb4e3561e12::scripts_v2::swap_unchecked',
      type_arguments: [
        '0x1::aptos_coin::AptosCoin',
        '0xcc8a89c8dce9693d354449f1f73e60e14e347417854f029db5bc8e7454008abb::coin::T',
        '0x190d44266241744264b964a37b8f09863167a12d3e70cda39376cfb4e3561e12::curves::Stable'
      ],
      arguments: [ '100000000', '174381' ]
    }
  */
})()

Get EXACTLY 1 USDA and send SLIPPAGED APTOS amount with curve - 'stable', stableSwapType - 'high' and 0.5% slippage

(async () => {
  // Get APTOS amount
  try {
    const amount = await sdk.Swap.calculateRates({
      fromToken: '0x1::aptos_coin::AptosCoin',
      toToken: '0x1000000fa32d122c18a6a31c009ce5e71674f22d06a581bb0a15575e6addadcc::usda::USDA', // USDA
      amount: 1000000, // 1 USDA
      interactiveToken: 'to',
      curveType: 'stable',
      version: 0
    })
    console.log(amount) // '12356861' ('0.12356861' APTOS)

    // Generate TX payload to swap 1 APTOS to
    // and minimum send 0.12418645 (with slippage +0.5%)
    const txPayload = sdk.Swap.createSwapTransactionPayload({
      fromToken: '0x1::aptos_coin::AptosCoin',
      toToken: '0x1000000fa32d122c18a6a31c009ce5e71674f22d06a581bb0a15575e6addadcc::usda::USDA',
      fromAmount: convertValueToDecimal(0.12356861, 8), // 0.12356861 APTOS
      toAmount: convertValueToDecimal(1, 6), // 1 USDA,
      interactiveToken: 'to',
      slippage: 0.005, // 0.5% (1 - 100%, 0 - 0%)
      stableSwapType: 'high',
      curveType: 'stable',
      version: 0
    })
    console.log(txPayload);
  } catch (e) {
    console.log(e);
  }

  /**
   Output:
  {
      type: 'entry_function_payload',
      function: '0x190d44266241744264b964a37b8f09863167a12d3e70cda39376cfb4e3561e12::scripts_v2::swap_into',
      type_arguments: [
        '0x1::aptos_coin::AptosCoin',
        '0x1000000fa32d122c18a6a31c009ce5e71674f22d06a581bb0a15575e6addadcc::usda::USDA',
        '0x190d44266241744264b964a37b8f09863167a12d3e70cda39376cfb4e3561e12::curves::Stable'
      ],
      arguments: [ '12418645', '1000000' ]
    }
  */
})()

Check Pool Existence

(async() => {
  const output = await sdk.Liquidity.checkPoolExistence({
    fromToken: "0x1::aptos_coin::AptosCoin",
    toToken: "0xf22bede237a07e121b56d91a491eb7bcdfd1f5907926a9e58338f964a01b17fa::asset::USDC",
    curveType: 'uncorrelated',
    version: 0
  });

  console.log(output); // true
})

Pools v.0.5: Swap 0.8 LayerZero USDT to LayerZero USDC

(async () => {
  // Get USDT amount
  try {
    const output = await sdk.Swap.calculateRates({
      fromToken: '0xf22bede237a07e121b56d91a491eb7bcdfd1f5907926a9e58338f964a01b17fa::asset::USDC', //layerzero USDC
      toToken: '0xf22bede237a07e121b56d91a491eb7bcdfd1f5907926a9e58338f964a01b17fa::asset::USDT', // layerzero USDT
      amount: 800000, // 0.8 USDC, or you can use convertValueToDecimal(0.8, 6)
      curveType: 'stable', // can be 'uncorrelated' or 'stable'
      interactiveToken: 'from', // which token is 'base' to calculate other token rate.
      version: 0.5 // optional, version could be only 0 or 0.5. If not provided version is 0
    })
    console.log(output) // '601018' (0.601018 USDT)

    // Generate TX payload for swap 0.8 USDC to maximum 0.601018 USDT
    // and minimum 0.598013 USDT (with slippage -0.5%)
    const txPayload = sdk.Swap.createSwapTransactionPayload({
      fromToken: '0xf22bede237a07e121b56d91a491eb7bcdfd1f5907926a9e58338f964a01b17fa::asset::USDC',
      toToken: '0xf22bede237a07e121b56d91a491eb7bcdfd1f5907926a9e58338f964a01b17fa::asset::USDT', // layerzero USDT
      fromAmount: 800000, // 0.8 USDT, or you can use convertValueToDecimal(0.8, 6)
      toAmount: 601018, // 0.601018 USDC, or you can use convertValueToDecimal(0.601018, 6)
      interactiveToken: 'from',
      slippage: 0.005, // 0.5% (1 - 100%, 0 - 0%)
      stableSwapType: 'high',
      curveType: 'stable',
      version: 0.5,
    })
    console.log(txPayload);
  } catch(e) {
    console.log(e)
  }

  /**
   Output:
   {
      "arguments": [
        "800000",
        "598013"
      ],
      "function": "0x163df34fccbf003ce219d3f1d9e70d140b60622cb9dd47599c25fb2f797ba6e::scripts::swap",
      "type": "entry_function_payload",
      "type_arguments": [
        "0xf22bede237a07e121b56d91a491eb7bcdfd1f5907926a9e58338f964a01b17fa::asset::USDC",
        "0xf22bede237a07e121b56d91a491eb7bcdfd1f5907926a9e58338f964a01b17fa::asset::USDT",
        "0x163df34fccbf003ce219d3f1d9e70d140b60622cb9dd47599c25fb2f797ba6e::curves::Stable"
      ]
    }
  */
})()

Creating Liquidity Pool for pair APTOS / lzUSDC

(async () => {
  //get USDC amount
  const { rate, receiveLp } = await sdk.Liquidity.calculateRateAndMinReceivedLP({
    fromToken: TokensMapping.APTOS,
    toToken: TokensMapping.USDC,
    amount: 100000000, // 1 APTOS
    curveType: 'uncorrelated',
    interactiveToken: 'from',
    slippage: 0.005,
    version: 0
  });
  console.log(rate) // '4472498' ('4.472498' USDC)
  console.log(receiveLp) // '19703137' ('19.703137' Minimum Received LP)

  const payload = await sdk.Liquidity.createAddLiquidityPayload({
    fromToken: TokensMapping.APTOS,
    toToken: TokensMapping.USDC,
    fromAmount: 100000000, // 1 APTOS
    toAmount: 4472498, // '4.472498' USDC)
    interactiveToken: 'from',
    slippage: 0.005,
    stableSwapType: 'normal',
    curveType: 'uncorrelated',
    version: 0
  })

  console.log(payload);
  /**
   * {
      type: 'entry_function_payload',
      function: '0x190d44266241744264b964a37b8f09863167a12d3e70cda39376cfb4e3561e12::scripts_v2::add_liquidity',
      type_arguments: [
        "0xf22bede237a07e121b56d91a491eb7bcdfd1f5907926a9e58338f964a01b17fa::asset::USDC",
        "0x1::aptos_coin::AptosCoin",
        "0x190d44266241744264b964a37b8f09863167a12d3e70cda39376cfb4e3561e12::curves::Uncorrelated",
      ],
      arguments: ['100000000', '99500000', '4472498', '4450136'],
    }
  * */
})

Calculate Output Burn for x and y coin with slippage and without slippage

(async()=> {
  const output = await sdk.Liquidity.calculateOutputBurn({
    fromToken: "0x1::aptos_coin::AptosCoin",
    toToken: "0xf22bede237a07e121b56d91a491eb7bcdfd1f5907926a9e58338f964a01b17fa::asset::USDC",
    slippage: 0.005,
    curveType: 'uncorrelated',
    burnAmount: 100000,
    version: 0
  });

  console.log(output);
  /**
   * {
   *   x: '504061',
       y: '22430',
      withoutSlippage: {
        x: '506594',
        y: '22543'
      }
    }
  * */
})

Create Burn Liquidity payload

(async() => {
  const output = await sdk.Liquidity.createBurnLiquidityPayload({
    fromToken: "0x1::aptos_coin::AptosCoin",
    toToken: "0xf22bede237a07e121b56d91a491eb7bcdfd1f5907926a9e58338f964a01b17fa::asset::USDC",
    slippage: 0.005,
    curveType: 'uncorrelated',
    burnAmount: 100000,
    version: 0
  });

  console.log(output);

  /**
   *
   {
     type: 'entry_function_payload',
    function: '0x190d44266241744264b964a37b8f09863167a12d3e70cda39376cfb4e3561e12::scripts_v2::remove_liquidity',
    type_arguments: [
      '0xf22bede237a07e121b56d91a491eb7bcdfd1f5907926a9e58338f964a01b17fa::asset::USDC',
      '0x1::aptos_coin::AptosCoin',
      '0x190d44266241744264b964a37b8f09863167a12d3e70cda39376cfb4e3561e12::curves::Uncorrelated'
    ],
    arguments: [ '100000', '22411', '504489' ]
  }
  * */
})

More examples

More examples you can find in the following directory: src/tests/.

Code examples to work with Aptos SDK can be found in the examples directory.

(back to top)

Roadmap

• Update to work with the Contract v3
• Prepare transaction payload
• Swap: unstable / stable (normal and high gas)
• Liquidity: add / redeem LP
• Pools: check pool / create pool
• Examples with Aptos SDK
• Staking: stake / harvest / unstake
• Concentrated Liquidity: swap, add, burn

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL v3 License. See LICENSE for more information.

(back to top)

liquidswap-sdk's Issues

[Feature Request] Let's match uniswap naming

Current version contains calculateRates func, yet would be good to have getAmountIn/getAmountOut funcs.
Can be just new functions that call calculateRates inside.

Execution failed in 0xa277f7024ded2cd788072f035beaec108a01f7f305b1868c5d34a64da228662d::liquidity_pool::register at code offset 19

Do you guys have any idea how to make the register pool work? I tried blow but it failed with error: "Execution failed in 0xa277f7024ded2cd788072f035beaec108a01f7f305b1868c5d34a64da228662d::liquidity_pool::register at code offset 19"

const rawTxn = await client.generateTransaction(aliceAccount.address(), {
        function: `0xa277f7024ded2cd788072f035beaec108a01f7f305b1868c5d34a64da228662d::scripts_v2::register_pool`,
        type_arguments: [
            "0xa277f7024ded2cd788072f035beaec108a01f7f305b1868c5d34a64da228662d::doge_coin::DogeCoin",
            "0x1::aptos_coin::AptosCoin",
            "0xa277f7024ded2cd788072f035beaec108a01f7f305b1868c5d34a64da228662d::curves::Uncorrelated"
        ],
        arguments: []
    });

    const bcsTxn = await client.signTransaction(aliceAccount, rawTxn);
    const pendingTxn = await client.submitTransaction(bcsTxn);

    console.log(pendingTxn);

[Feature Request] Add changelog

Developers need to see all changes for easier supporting of their products.

[error] txnPayload must return type_arguments &

Expected Behavior

1. The createSwapTransactionPayload functon should return type_arguments
2. Type should be entry_function_payload not script_function_payload

{
  "type": "entry_function_payload",
  "function": "0x43417434fd869edee76cca2a4d2301e528a1551b1d719b75c350c3c97d15b8b9::scripts::swap",
  "type_arguments": [
    "0x1::aptos_coin::AptosCoin",
    "0x43417434fd869edee76cca2a4d2301e528a1551b1d719b75c350c3c97d15b8b9::coins::USDT",
    "0x43417434fd869edee76cca2a4d2301e528a1551b1d719b75c350c3c97d15b8b9::lp::LP<0x1::aptos_coin::AptosCoin, 0x43417434fd869edee76cca2a4d2301e528a1551b1d719b75c350c3c97d15b8b9::coins::USDT>"
  ],
  "arguments": [
    "0x43417434fd869edee76cca2a4d2301e528a1551b1d719b75c350c3c97d15b8b9",
    "10000",
    "24917"
  ]
}

Actual Behavior

{
  "type": "script_function_payload",
  "function": "0x43417434fd869edee76cca2a4d2301e528a1551b1d719b75c350c3c97d15b8b9::scripts::swap",
  "typeArguments": [
    "0x1::aptos_coin::AptosCoin",
    "0x43417434fd869edee76cca2a4d2301e528a1551b1d719b75c350c3c97d15b8b9::coins::USDT",
    "0x43417434fd869edee76cca2a4d2301e528a1551b1d719b75c350c3c97d15b8b9::lp::LP<0x1::aptos_coin::AptosCoin, 0x43417434fd869edee76cca2a4d2301e528a1551b1d719b75c350c3c97d15b8b9::coins::USDT>"
  ],
  "arguments": [
    "0x43417434fd869edee76cca2a4d2301e528a1551b1d719b75c350c3c97d15b8b9",
    "10000",
    "24917"
  ]
}

Steps to Reproduce the Problem

1. Call createSwapTransactionPayload fuction with its parameters.

Specifications

• Version:
• Platform:

How to calculate the x and y output amount according to the LP balance when redeeming liquidity?

Can you add a function to return the x and y output amount according to the LP balance when redeeming liquidity like calculateRates when swap?

The isSortedSymbols is not returning correct order

When using the isSortedSymbols, the register won't work.

[Feature Request] moduleAddress is not clear param

Let's rename moduleAddress param and add default value.

Get help to use pontem sdk

Expected Behavior

Expected Behavior => usdtRate = string

Actual Behavior

I try to develop a dapp that uses pontem sdk. I try to follow the example from GitHub, but I can't get the correct result. Even though I just want to get the rate of apt, it told me apt doesn't exist.May team tech tell me how to solve it?

Aptos Coin Rename In README example

Expected Behavior

Aptos coin Address should be

0x1::aptos_coin::AptosCoin

Actual Behavior

It uses

 0x1::test_coin::TestCoin

Steps to Reproduce the Problem

In Documentation Example

Specifications

• Version:
• Platform:

[Feature Request] Python SDK

Let's make the python-sdk for liquid swap.

I have done some example here.

https://github.com/WayneAl/liquidswap-sdk/tree/python-sdk/python_sdk

missing function: get list of pools with x y coin info

The SDK has no function to get a list of all pools that also tells which pool supports which tokens.

[Feature request] Let' do example with Aptos SDK

Current README doesn't constains example with Aptos SDK, let's do it.

[Feature Request] Default configuration

Expected Behavior

Would be good to have default config related to nativeToken, modules during initialization of SDK.

const sdk = new SDK({
  nodeUrl: 'https://fullnode.devnet.aptoslabs.com', // Node URL
})

Actual Behavior

const sdk = new SDK({
  nodeUrl: 'https://fullnode.devnet.aptoslabs.com', // Node URL
  networkOptions: {
    nativeToken: '0x1::test_coin::TestCoin', // Type of Native network token
    modules: {
      Scripts:
        '0x43417434fd869edee76cca2a4d2301e528a1551b1d719b75c350c3c97d15b8b9::scripts', // This module is used for Swap
      CoinInfo: '0x1::coin::CoinInfo', // Type of base CoinInfo module
      CoinStore: '0x1::coin::CoinStore', // Type of base CoinStore module
    },
  }
})

incorrect constants

liquidswap-sdk/src/constants/index.ts

Line 19 in 7457ae2

LiquidityPool: `${RESOURCES_ACCOUNT}::liquidity_pool`,

should be ${MODULES_ACCOUNT}::liquidity_poo

[Feature Request] Missing functions

We have to implement the following funcs:

• Create Pool.
• Remove liquidity.
• Add liquidity.
• Quotes before add liquidity or burn liquidity.
• Check if pool ever exists.