Integration FAQ

Questions

• What is your infrastructure? Do you have SDK?

• How do you retrieve all the pools you have?

• How do you retrieve all the positions?

• How do I perform a swap from my code?

• How do I predict the result of the swap?

Indexer and SDK

SDK

Github - https://github.com/cryptoalgebra/tonco-sdk/

Examples and references

Github - https://github.com/cryptoalgebra/tonco-demo

Mainnet

• Explorer page: https://indexer.tonco.io
• GraphQL endpoint: https://indexer.tonco.io
• Router Contract - EQC_-t0nCnOFMdp7E7qPxAOCbCWGFz-e3pwxb6tTvFmshjt5

Testnet

• Explorer page: https://testnet-indexer.tonco.io
• GraphQL endpoint: https://testnet-indexer.tonco.io
• Router Contract - EQDnfag9lHlc0rS6YeI7WwRq-3ltcKSsYxLiXmveB7gNUzNO

Retrieve pool data

The best way to get all the pools and general information about them is to use our indexer.

// Some code
import { ApolloClient, InMemoryCache, gql} from "@apollo/client/core";
import { Command, OptionValues } from "commander";

export const POOLS_QUERY = gql`
query PoolsQuery { 
 pools {   
   name
   address
   jetton0 {
       address
       symbol
       decimals
   }
   jetton1 {
       address
       symbol
       decimals
   }
 }  
}
`;
async function queryPools(options: OptionValues) {


   const appoloClient = new ApolloClient({
       uri: "https://indexer.tonco.io/", 
       credentials: 'same-origin',
       cache: new InMemoryCache(),
   });
   const response = await appoloClient.query({ query: POOLS_QUERY });
   const appoloPoolList =  response.data.pools
   console.log(appoloPoolList);
}

Indexer is critical for our system, and we keep it highly available, however, we encourage caching the pool list.

Alternatively, if you don’t want to depend on our infrastructure, you can rescan the blockchain in search of messages POOL_INIT sent by the router

Retrieving positions

There are several ways to get all positions and positions per person.

Getting positions by index

If you want to manually scan and enumerate all the positions for a particular pool you can first use the method getPoolStateAndConfiguration and get "Number of active NFT positions" from it. Then iterate from 0 as the index of NFT and call get_nft_address_by_index()

Getting positions with NFT API's

Position NFT is a real NFT so you can use TonConsole Api and TonCenter API to get NFT address info and metadata. For position parameters, however, you would need to call the NFT get-method - GetPositionInfo()

Getting positions from TONCO indexer

Please address the GraphQL schema documents for more details - GraphQL Schema Getting collected fees - https://docs.tonco.io/technical-reference/indexer#position-data Here is a small snippet that uses our indexer

import { ApolloClient, InMemoryCache, gql} from "@apollo/client/core";
import { Address, TonClient4 } from "@ton/ton";
import { getHttpV4Endpoint } from "@orbs-network/ton-access";
import { PoolV3Contract } from "../wrappers/PoolV3Contract";

export const POSITION_QUERY = gql`
query PositionQuery($where: PositionWhere) {
    positions(where: $where) {
      id
      owner
      pool
      nftAddress      
      tickLower
      tickUpper
      liquidity
      feeGrowthInside0LastX128
      feeGrowthInside1LastX128
    }
}
`;

async function queryPositions(options: OptionValues) {

    const appoloClient = new ApolloClient({
        uri: "https://indexer.tonco.io/", // Replace with your GraphQL endpoint
        credentials: 'same-origin',
        cache: new InMemoryCache(),
    });

    const poolAddress  = Address.parse("EQD25vStEwc-h1QT1qlsYPQwqU5IiOhox5II0C_xsDNpMVo7")
    const ownerAddress = Address.parse("EQC2nUFN69DWcdgiuvSKXI6P3vHF9Gu_zW3OnQf0s5DgYBmJ")
    console.log(poolAddress.toRawString())
    console.log(ownerAddress.toString({bounceable: true}))

    const response = await appoloClient.query({ query: POSITION_QUERY, variables: {
        "where": {
            "pool" : poolAddress.toRawString(),
            "owner": ownerAddress.toString({bounceable: true})
        }
        } });
    const appoloPositionsList =  response.data.positions
    const client =  new TonClient4({ endpoint : await getHttpV4Endpoint() })
    const poolOpened = client.open(new PoolV3Contract(poolAddress))

    for (let [i, positionInfo] of appoloPositionsList.entries()) {
        console.log(`# ${i} :`);
        console.log(positionInfo);
        
        const fees = await poolOpened.getCollectedFees(positionInfo.tickLower, positionInfo.tickUpper, positionInfo.liquidity, positionInfo.feeGrowthInside0LastX128, positionInfo.feeGrowthInside1LastX128)
        console.log(`  Fees Jetton0 : ${fees.amount0}`)
        console.log(`  Fees Jetton1 : ${fees.amount1}`)

        const reserves = await poolOpened.getMintEstimate(positionInfo.tickLower, positionInfo.tickUpper, positionInfo.liquidity)
        console.log(`  Reserves Jetton0 : ${reserves.amount0}`)
        console.log(`  Reserves Jetton1 : ${reserves.amount1}`)

    }
}

Forming messages for the swap

Sending swap can be done with our SDK - https://github.com/cryptoalgebra/tonco-sdk

An example of swap preparation can be found here - https://github.com/cryptoalgebra/tonco-sdk/blob/36eb0d7feadfcdcd60583ebe4098eb25fcc02591/src/classes/PoolMessageManager.ts#L649

A swap request is created as a payload in the jetton transfer and is sent to the router. The general logic of the input parameters can be derived from the SDK example above and the doc of the pool swap message POOLV3_SWAP

Swap estimate

This question depends on your requirements, limitations, and infrastructure of choice. Here are 5 options

1. The simplest and most precise way is to call the pool contract get method - https://docs.tonco.io/technical-reference/contracts/pool#getswapestimategas
2. Download the pool contract code (code is immutable) and data and run this method in sandbox/blueprint. This would be the simplest and fastest way to make many calls. The general example you can find here - tonco-demo example of shard account
3. If you have ever implemented integration with other Algebra EVM projects written in your language of choice - then the output simulation can be bit-precise

4. You can use our Typescript implementation of user-side swap simulation. It includes the script that compares it with a direct contract call. Before actual blockchain execution please check that the estimates you made with TS match the contract call

# Usage example

git clone [email protected]:cryptoalgebra/tonco-demo.git 
cd tonco-demo
cd swap_simulate
npm install 
ts-node scripts/dowloadAndSimulate.ts

1. You can use our Kotlin implementation of user-side swap simulation.

# Usage example
# Expecting you have JVM and kotlinc 

git clone [email protected]:cryptoalgebra/tonco-demo.git 
cd tonco-demo
cd swap_kotlin
./run.sh