SDK

SDK can be used to interact with our DEX programmatically. It provides an easy way to integrate your app with Invariant, PSP22 tokens and Wrapped AZERO.

Installation

Download

Published package can be found here.

Build

You can find build steps here.

Overview

The Invariant SDK comprises three distinct contracts:

DEX Contract (Invariant): This is the contract handling DEX functionality within the Invariant ecosystem.
Token Contract (PSP22): This contract is responsible for managing and implementing the PSP22 token standard within the Invariant protocol. Allows to deploy or load existing contracts.
Wrapped Native Currency Contract (Wrapped AZERO): This contract allows users to wrap the native currency.

Transactions and Queries

When working with contracts, developers can initiate interactions by calling methods from the corresponding contract class. The first parameter designates the account, and subsequent parameters act as entrypoint parameters.

Transactions: These involve invoking methods that result in changes to the blockchain state. Transactions typically alter the data stored on the blockchain and may include operations like transferring assets, updating records, or executing specific actions. Once the transaction will be confirmed it returns the hash. If the entrypoint has emitted any events, there will be also returned with the hash.
Queries: Queries are read-only interactions with the contract. They allow developers to retrieve information from the blockchain without modifying its state. Queries are useful for obtaining current contract state, or verifying certain conditions. Importantly, queries do not return a transaction hash; instead, they provide results in the form of structs from storage or estimated results of transaction.

Listening to Events

The Invariant class offers additional methods empowering developers to attach event listeners. This feature enables the execution of custom code based on contract activity, enhancing flexibility and customization in response to specific events.

Values and Helper functions

The SDK includes fundamental values and utility functions for application development. These encompass parameters such as maximum tick, maximum price, and calculations for price impact.

Contracts Metadata

Within the Contracts folder, developers can find deploy-ready contracts and metadata essential for interactions.

Wasm

The Wasm functionality is encapsulated within our custom npm package, which includes Rust structs and data exported to WebAssembly using wasm_bindgen. This integration facilitates the utilization of identical functions and data within the main Invariant contract.

Source

The Source directory consolidates all pieces into an easy-to-use interface. This organized structure simplifies the development process and provides developers with a centralized location for accessing essential resources.

Tests

End-to-end (E2E) tests are an essential component of our testing strategy. We have adopted the ts-mocha framework for our end-to-end testing needs. For assertion and expectation handling, we rely on the Chai assertion library. Our end-to-end tests encompass a comprehensive examination of the entire protocol. This includes testing all entrypoints of every contract within our protocol, ensuring that each contract behaves as expected under various conditions. Additionally, we thoroughly test our SDK math utilities to guarantee their accuracy and reliability.

Project Structure

📦sdk
 ┣ 📂contracts
 ┃ ┣ 📂invariant
 ┃ ┣ 📂psp22
 ┃ ┗ 📂wrapped-azero
 ┣ 📂src
 ┗ 📂tests

Types

Decimal

These types are utilized to represent decimal values, and it is worth noting that these decimal types are already exported from Rust through WebAssembly (Wasm) using wasm-bindgen. Each type in this collection comes with associated decimal scales and functionalities, allowing for precise and reliable handling of decimal calculations. Read more about decimals.

export type TokenAmount = bigint

export type Liquidity = bigint

export type FeeGrowth = bigint

export type SqrtPrice = bigint

export type Price = bigint

export type FixedPoint = bigint

export type Percentage = bigint

export type SecondsPerLiquidity = bigint

Network

Network serves as a convenient way to select the network on which various actions are performed. The enumeration includes options for 'local', 'mainnet', and 'testnet'. Users can switch between networks without the need of any code adjustments.

enum Network {
  Local,
  Testnet,
  Mainnet
}

Events

Code snippet introduces several event interfaces related to the Invariant, providing structured information about various actions. These events can be subscribed to using the Invariant, enabling users to receive updates when specific actions occur within the contract.

interface CreatePositionEvent {
  timestamp: bigint
  address: string
  pool: PoolKey
  liquidity: Liquidity
  lowerTick: bigint
  upperTick: bigint
  currentSqrtPrice: SqrtPrice
}

interface ChangeLiquidityEvent {
    timestamp: bigint,
    address: string,
    pool: PoolKey,
    deltaLiquidity: Liquidity,
    addLiquidity: boolean,
    lowerTick: bigint,
    upperTick: bigint,
    currentSqrtPrice: SqrtPrice,
}

interface CrossTickEvent {
  timestamp: bigint
  address: string
  pool: PoolKey
  indexes: bigint[]
}

interface RemovePositionEvent {
  timestamp: bigint
  address: string
  pool: PoolKey
  liquidity: Liquidity
  lowerTick: bigint
  upperTick: bigint
  currentSqrtPrice: SqrtPrice
}

interface SwapEvent {
  timestamp: bigint
  address: string
  pool: PoolKey
  amountIn: TokenAmount
  amountOut: TokenAmount
  fee: TokenAmount
  startSqrtPrice: SqrtPrice
  targetSqrtPrice: SqrtPrice
  xToY: boolean
}

Storage

These interfaces are essential for managing various aspects of the Invariant's storage. It is important to note that these interfaces are exported from Rust to TypeScript using wasm-bindgen, providing integration between the two languages. Read more about storage here.

interface InvariantConfig {
  admin: string
  protocolFee: Percentage
}

interface FeeTier {
  fee: Percentage
  tickSpacing: bigint
}

interface PoolKey {
  tokenX: string
  tokenY: string
  feeTier: FeeTier
}

interface Pool {
  liquidity: Liquidity
  sqrtPrice: SqrtPrice
  currentTickIndex: bigint
  feeGrowthGlobalX: FeeGrowth
  feeGrowthGlobalY: FeeGrowth
  feeProtocolTokenX: TokenAmount
  feeProtocolTokenY: TokenAmount
  startTimestamp: bigint
  lastTimestamp: bigint
  feeReceiver: string
  secondsPerLiquidityGlobal: SecondsPerLiquidity
}

interface Position {
  poolKey: PoolKey
  liquidity: Liquidity
  lowerTickIndex: bigint
  upperTickIndex: bigint
  feeGrowthInsideX: FeeGrowth
  feeGrowthInsideY: FeeGrowth
  lastBlockNumber: bigint
  tokensOwedX: TokenAmount
  tokensOwedY: TokenAmount
  secondsPerLiquidityInside: SecondsPerLiquidity
  createdAt: bigint
}

interface Tick {
  index: bigint
  sign: boolean
  liquidityChange: Liquidity
  liquidityGross: Liquidity
  sqrtPrice: SqrtPrice
  feeGrowthOutsideX: FeeGrowth
  feeGrowthOutsideY: FeeGrowth
  secondsOutside: bigint
  secondsPerLiquidityOutside: SecondsPerLiquidity
}

Usage Guide

Follow a step-by-step example demonstrating how to use the Invariant SDK, with each step accompanied by code snippets. The complete code for these examples is available here, ensuring a hands-on and comprehensive understanding of the SDK's functionality.

Select Network

Begin by specifying the network you intend to connect to using the Network enum. Identify your target network, whether it's the local development environment, the mainnet, or a testnet. The code is designed to work uniformly across all networks. Changing the network designation does not require any modifications to the code.

enum Network {
  Local,
  Testnet,
  Mainnet
}

Initlialize API

Running Web Assembly

SDK utilizes Web Assembly. In order to run WASM files in Node.js you have to add --experimental-wasm-modules flag.

Initiate the Polkadot API effortlessly with the provided initPolkadotApi function. Use the Network enum to specify your desired network.

// initialize api, use enum to specify the network
const api = await initPolkadotApi(Network.Local)

Transaction Signer

Utilize the versatile Keyring class to easily create and manage accounts. Initialize an account using your preferred method, whether it's using a provided mnemonic phrase or integrating your existing wallet.

// initialize account, you can use your own wallet by pasting mnemonic phase
const keyring = new Keyring({ type: 'sr25519' })
const account = keyring.addFromUri('//Alice')

PSP22 token

In the following TypeScript code, we demonstrate approach deploying and initializing a PSP22 token contracts using the PSP22.deploy method. Apart from the deployment and initialization, the code also demonstrates how to fetch token metadata. This can include details such as the token name, symbol, token decimal. Notably, a single instance of the PSP22 class proves sufficient for handling interactions with multiple tokens.

// deploy token, it will return tokens address
const TOKEN0_ADDRESS = await PSP22.deploy(api, account, 500n, 'CoinA', 'ACOIN', 12n)
const TOKEN1_ADDRESS = await PSP22.deploy(api, account, 500n, 'CoinB', 'BCOIN', 12n)

// load token by passing its address (you can use existing one), it allows you to interact with it
const psp22 = await PSP22.load(api, Network.Local)

// interact with token 0
const account0Balance = await psp22.balanceOf(account.address, TOKEN0_ADDRESS)
console.log(account0Balance)

// if you want to interact with different token,
// simply pass different contract address as an argument
const account1Balance = await psp22.balanceOf(account.address, TOKEN1_ADDRESS)
console.log(account1Balance)

// fetch token metadata for previously deployed token0
const token0Name = await psp22.tokenName(TOKEN0_ADDRESS)
const token0Symbol = await psp22.tokenSymbol(TOKEN0_ADDRESS)
const token0Decimals = await psp22.tokenDecimals(TOKEN0_ADDRESS)
console.log(token0Name, token0Symbol, token0Decimals)

// load diffrent token and load its metadata
const token1Name = await psp22.tokenName(TOKEN1_ADDRESS)
const token1Symbol = await psp22.tokenSymbol(TOKEN1_ADDRESS)
const token1Decimals = await psp22.tokenDecimals(TOKEN1_ADDRESS)
console.log(token1Name, token1Symbol, token1Decimals)

Output

500n
500n
CoinA ACOIN 12n
CoinB BCOIN 12n

Load DEX and tokens

Deploying and loading psp22 contracts

The deploy function serves as a one-stop solution for deploying PSP22 contracts. When invoked, returns a unique contract address. This address serves as a reference for the deployed contract. By providing the contract address returned during deployment, the load function dynamically adds all necessary methods to the specified contract. This dynamic loading capability ensures that the contract is equipped with the essential functionalities defined by the PSP22 standard.

Load the Invariant contract by providing the Polkadot API (api), specifying the network (e.g., Network.Local for local development), and indicating the Invariant contract address (INVARIANT_ADDRESS). Similarly, initialize the PSP22 token contract using the same approach. It's noteworthy that only a single instance of PSP22 is required to handle interactions with multiple tokens.

// load invariant contract
const invariant = await Invariant.load(api, Network.Local, INVARIANT_ADDRESS)

// load token contract
const psp22 = await PSP22.load(api, Network.Local)

Create pool

Big numbers

You can create custom decimals using the toDecimal syntax, where the first argument represents the numerical value (A), and the second argument indicates the power of 10 (B) in the formula A * 10^(-B). For example, toDecimal(3n, 2n) will result in a decimal equal to 0.03. For further details on supported types, please check the documentation here.

Why "n" is at the end of every number

Notice how we use "n" at the end of every number. "n" indicates that specified value is a BigInt, number with higher precision.

Token sorting

Tokens are sorted alphabetically when pool key is created, so make sure that you swap tokens in correct direction. Read more about pool keys here.

To create a new pool, a fee tier and pool key need to be prepared. The fee tier represents the desired fee for the pool, and the price needs to be converted to sqrt price because the entry points of the protocol accept it in this format. The pool key is constructed using the addresses of two tokens and the specified fee tier. Finally, the createPool function is called with the user's account, the pool key, and the initial square root price, resulting in the creation of a new pool. The transaction hash of the pool creation is then logged to the console.

// set fee tier, make sure that fee tier with specified parameters exists
const feeTier = newFeeTier(toPercentage(1n, 2n), 1n) // fee: 0.01 = 1%, tick spacing: 1

// set initial price of the pool, we set it to 1.00
// all endpoints only accept sqrt price so we need to convert it before passing it
const price = toPrice(1n, 0n)
const initSqrtPrice = priceToSqrtPrice(price)

// set pool key, make sure that pool with specified parameters does not exists
const poolKey = newPoolKey(TOKEN0_ADDRESS, TOKEN1_ADDRESS, feeTier)

const createPoolResult = await invariant.createPool(account, poolKey, initSqrtPrice)

console.log(createPoolResult.hash)

Output

0x4324eaff0c4da2d5082fa03c2ef0e0138ed60946525952645a9d8c4d50cb5ec2

Create position

How to calculate input amount

In order to calculate input amount, we have to multiply actual token amount you want to swap times 10 to the power of decimal. Let's say some token has decimal of 12 and we want to swap 6 actual tokens. Here is how we can calculate input amount: 6 * 10^12 = 6000000000000.

Creating position involves preparing parameters such as the amount of tokens, tick indexes for the desired price range, liquidity, slippage and approving token transfers. There is need to calculate desired liquidity based on specified token amounts. For this case there are provided functions getLiquidityByX or getLiquidityByY. The slippage parameter represents the acceptable price difference that can occur on the pool during the execution of the transaction.

// token y has 12 decimals and we want to add 8 actual tokens to our position
const tokenYAmount = 8n * 10n ** 12n

// set lower and upper tick indexes, we want to create position in range [-10, 10]
const lowerTickIndex = -10n
const upperTickIndex = 10n

// calculate amount of token x we need to give to create position
const { amount: tokenXAmount, l: positionLiquidity } = getLiquidityByY(
  tokenYAmount,
  lowerTickIndex,
  upperTickIndex,
  initSqrtPrice,
  true
)

// print amount of token x and y we need to give to create position based on parameteres we passed
console.log(tokenXAmount, tokenYAmount)

// approve transfers of both tokens
await psp22.approve(
  account,
  invariant.contract.address.toString(),
  tokenXAmount,
  poolKey.tokenX
)
await psp22.approve(
  account,
  invariant.contract.address.toString(),
  tokenYAmount,
  poolKey.tokenY
)

// create position
const createPositionResult = await invariant.createPosition(
  account,
  poolKey,
  lowerTickIndex,
  upperTickIndex,
  positionLiquidity,
  initSqrtPrice,
  0n
)
console.log(createPositionResult.hash) // print transaction hash
console.log(createPositionResult.events)

Output

7999999999880n 8000000000000n
0x652108bb36032bc386fec2eef3f483f29970db7bdbdc9a1a340e279abd626ee2
[
{
timestamp: 1706518611808n,
address: '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY',
pool: {
tokenX: '5EAYUj8RYow1MyDBGck67QsLZpeCe9AfZFADHxyobCzcySkm',
tokenY: '5FErzMMHprtUWLoAW8zdQoyeAPiBRT4UTt8DRBAV9QxQtBkk',
feeTier: [Object]
},
liquidity: 16004800319759905588483n,
lowerTick: -10n,
upperTick: 10n,
currentSqrtPrice: 1000000000000000000000000n
}
]

Swap tokens

Performing a swap requires: specifying the amount of tokens to be swapped or desired amount to receive from the swap (input token amount will be calculated durning the swap), approving the transfer of the token, estimating the result of the swap, direction, determining the allowed slippage, calculating the square root price limit based on slippage, and finally, executing the swap. It's essential to note that the swap tolerance is expressed in square root price (sqrtPrice) after the swap, rather than the amount of tokens.

Price impact and slippage

Price impact represents the change in price observed after the completion of a swap. It provides insight into how the executed swap influences the token price within the liquidity pool. A higher price impact indicates a more significant alteration in the token price post-swap.

Slippage refers to the difference between the estimated square root of price after a swap is initiated and the actual square root of price observed after the swap is executed. It quantifies the deviation between the expected and realized square roots of prices. Slippage does not imply an acceptable threshold solely in terms of token amounts.

While price impact focuses on the post-swap change in token price within the liquidity pool, slippage highlights the variance between the anticipated and actual prices during and after the swap process.

// we want to swap 6 token0
// token0 has 12 decimals so we need to multiply it by 10^12
const amount = 6n * 10n ** 12n

// approve token x transfer
await psp22.approve(account, invariant.contract.address.toString(), amount, poolKey.tokenX)

// get estimated result of swap
const quoteResult = await invariant.quote(poolKey, true, amount, true)

// slippage is a price change you are willing to accept,
// for examples if current price is 1 and your slippage is 1%, then price limit will be 1.01
const allowedSlippage = toPercentage(1n, 3n) // 0.001 = 0.1%

// calculate sqrt price limit based on slippage
const sqrtPriceLimit = calculateSqrtPriceAfterSlippage(
  quoteResult.targetSqrtPrice,
  allowedSlippage,
  false
)

const swapResult = await invariant.swap(account, poolKey, true, amount, true, sqrtPriceLimit)
console.log(swapResult.hash)
console.log(swapResult.events)

Output

0xd9cdfddb2c783f24a481811f0f9d7037e2f7202907f092986ecd98838db2b3cb
[
{
timestamp: 1706518411849n,
address: '5GrwvaEF5zXb26Fz9rcQpDWS57CtERHpNehXCPcNoHGKutQY',
pool: {
tokenX: '5CnMbWx8h1YKeWtKEECHBdMNjtwvDoeMqku7eX7i4YXmpbBV',
tokenY: '5ESbyMxcNAUBFfmNoHFFCzMkKRqKmY3jfaeqxfZa5mf75Bzx',
feeTier: [Object]
},
amountIn: 6000000000000n,
amountOut: 5937796254308n,
fee: 60000000000n,
startSqrtPrice: 1000000000000000000000000n,
targetSqrtPrice: 999628999041807638582903n,
xToY: true
} ]

List of Queries and Interfaces

Here are some possible queries and their corresponding TypeScript interfaces:

Get Tick

interface Tick {
  index: bigint
  sign: boolean
  liquidityChange: Liquidity
  liquidityGross: Liquidity
  sqrtPrice: SqrtPrice
  feeGrowthOutsideX: FeeGrowth
  feeGrowthOutsideY: FeeGrowth
  secondsOutside: bigint
  secondsPerLiquidityOutside: SecondsPerLiquidity
}

const tickState: Tick = await invariant.getTick(signer, poolKey, tickIndex)

Get Pool

interface Pool {
  liquidity: Liquidity
  sqrtPrice: SqrtPrice
  currentTickIndex: bigint
  feeGrowthGlobalX: FeeGrowth
  feeGrowthGlobalY: FeeGrowth
  feeProtocolTokenX: TokenAmount
  feeProtocolTokenY: TokenAmount
  startTimestamp: bigint
  lastTimestamp: bigint
  feeReceiver: string
  secondsPerLiquidityGlobal: SecondsPerLiquidity
}

const poolState: Pool = await invariant.getPool(signer, TOKEN0_ADDRESS, TOKEN1_ADDRESS, feeTier)

Get All Pools

const pools: Pool[] = await invariant.getPools(signer)

Position indexing

Remember that positions are indexed from 0. So if you create position, its index will be 0 and your next positions index will be 1.

Get Position

interface Position {
  poolKey: PoolKey
  liquidity: Liquidity
  lowerTickIndex: bigint
  upperTickIndex: bigint
  feeGrowthInsideX: FeeGrowth
  feeGrowthInsideY: FeeGrowth
  lastBlockNumber: bigint
  tokensOwedX: TokenAmount
  tokensOwedY: TokenAmount
  secondsPerLiquidityInside: SecondsPerLiquidity
  createdAt: bigint
}

const positionState: Position = await invariant.getPosition(signer, owner.address, positionIndex)

Get Positions

const positions: Position[] = await invariant.getPositions(signer, owner.address)

Query states and Calculate Fee

To query the state and calculate unclaimed fees belonging to the position, several functions are utilized. Positions, ticks, and pools are accessed to gather information about the state, and the calculateFee function is used to determine the amount of unclaimed tokens.

// query state
const pool: Pool = await invariant.getPool(TOKEN0_ADDRESS, TOKEN1_ADDRESS, feeTier)
const position: Position = await invariant.getPosition(account.address, 0n)
const lowerTick: Tick = await invariant.getTick(poolKey, position.lowerTickIndex)
const upperTickAfter: Tick = await invariant.getTick(poolKey, position.upperTickIndex)

// check amount of tokens is able to claim
const fees = calculateFee(pool, position, lowerTick, upperTickAfter)

// print amount of unclaimed x and y token
console.log(fees)

Output

{x: 59999999999n, y: 0n }

Claim fees

Fees from a specific position are claimed without closing the position. This process involves specifying the position ID (indexed from 0), calling the claimFee function, and then checking the balance of a specific token after claiming the fees.

// get balance of a specific token before claiming position fees and print it
const accountBalanceBeforeClaim = await psp22.balanceOf(account.address, poolKey.tokenX)
console.log(accountBalanceBeforeClaim)

// specify position id
const positionId = 0n
// claim fee
const claimFeeResult = await invariant.claimFee(account, positionId)
// print transaction hash
console.log(claimFeeResult.hash)

// get balance of a specific token after claiming position fees and print it
const accountBalanceAfterClaim = await psp22.balanceOf(account.address, poolKey.tokenX)
console.log(accountBalanceAfterClaim)

Output

999999999999999986000000000120n
0xead1fe084c904e7b1d0df2f3953c74d03cb90756caea46ae1e896c6956460105
999999999999999986060000000119n

Transfer position

The entrypoint facilitates the seamless transfer of positions between users. This functionality streamlines the process of reassigning ownership of a specific position to another account. The entrypoint takes two parameters: index of position to transfer, address of account to receive the position.

const positionToTransfer = await invariant.getPosition(account.address, 0n)

// Transfer position from account (signer) to receiver
await invariant.transferPosition(account, 0n, receiver.address)

const receiverPosition = await invariant.getPosition(receiver.address, 0n)
assert.deepEqual(positionToTransfer, receiverPosition)
console.log(receiverPosition)

Output

{
poolKey: {
tokenX: '5CfCkzb2YfGcBVVK5b1UNAyNYra7iAmPrPAZ7joeqbTpG77P',
tokenY: '5FAjg6DMbbFv9zo1QksGt9GtPGu2qwFXG6jYvdXgybrYJkmR',
feeTier: { fee: 10000000000n, tickSpacing: 1n }
},
liquidity: 16004800319759905588483n,
lowerTickIndex: -10n,
upperTickIndex: 10n,
feeGrowthInsideX: 37488752625000000000000n,
feeGrowthInsideY: 0n,
lastBlockNumber: 474n,
tokensOwedX: 0n,
tokensOwedY: 0n
}

Remove position

Position is removed from the protocol, and fees associated with that position are automatically claimed in the background. Here's a detailed description of the process:

// fetch user balances before removal
const accountToken0BalanceBeforeRemove = await psp22.balanceOf(account.address, poolKey.tokenX)
const accountToken1BalanceBeforeRemove = await psp22.balanceOf(account.address, TOKEN1_ADDRESS)
console.log(accountToken0BalanceBeforeRemove, accountToken1BalanceBeforeRemove)

// remove position
const removePositionResult = await invariant.removePosition(account, positionId)
console.log(removePositionResult.hash)

// get balance of a specific token after removing position
const accountToken0BalanceAfterRemove = await psp22.balanceOf(account.address, TOKEN0_ADDRESS)
const accountToken1BalanceAfterRemove = await psp22.balanceOf(account.address, TOKEN1_ADDRESS)

// print balances
console.log(accountToken0BalanceAfterRemove, accountToken1BalanceAfterRemove)

Output

999999999999999986060000000119n 999999999999999986060000000119n
0xe90dfeb5420b26c4f0ed2d5a77825a785a7e42106cc45f5a7d08c597f46c1171
999999999999999999999999999998n 999999999999999999999999999998n

Using AZERO via Wrapped AZERO

Why do you need to wrap AZERO

In order to use native token you have to wrap it to PSP22 token using Wrapped AZERO contract. After sending AZERO you will receive the same amount as a PSP22 token which you can use in our DEX. You can feely exchange them at 1:1 ratio.

Only use official Wrapped AZERO contract

You should only use official Wrapped AZERO contract. This address represents official testnet contract: 5EFDb7mKbougLtr5dnwd5KDfZ3wK55JPGPLiryKq4uRMPR46. Mainnet contract is not deployed yet.

// load wazero contract
const wazero = await WrappedAZERO.load(api, Network.Local, WAZERO_ADDRESS)

// get balance of account
const accountBalanceBefore = await wazero.balanceOf(account.address)
console.log(accountBalanceBefore)

// send AZERO using deposit method
await wazero.deposit(account, 1000n)

// you will receive WAZERO token which you can use as any other token,
// later you can exchange it back to AZERO at 1:1 ratio
const accountBalanceAfter = await wazero.balanceOf(account.address)
console.log(accountBalanceAfter)

Output

0n
1000n

Listen to Event

Invariant provides the capability to set up event listeners, allowing developers to respond to specific events within the contract. The event listener structs are detailed below, accompanied by a code snippet demonstrating how to set up listeners for each specific event type.

interface CreatePositionEvent {
  timestamp: bigint
  address: string
  pool: PoolKey
  liquidity: Liquidity
  lowerTick: bigint
  upperTick: bigint
  currentSqrtPrice: SqrtPrice
}

interface ChangeLiquidityEvent {
    timestamp: bigint,
    address: string,
    pool: PoolKey,
    deltaLiquidity: Liquidity,
    addLiquidity: boolean,
    lowerTick: bigint,
    upperTick: bigint,
    currentSqrtPrice: SqrtPrice,
}

interface CrossTickEvent {
  timestamp: bigint
  address: string
  pool: PoolKey
  indexes: bigint[]
}

interface RemovePositionEvent {
  timestamp: bigint
  address: string
  pool: PoolKey
  liquidity: Liquidity
  lowerTick: bigint
  upperTick: bigint
  currentSqrtPrice: SqrtPrice
}

interface SwapEvent {
  timestamp: bigint
  address: string
  pool: PoolKey
  amountIn: TokenAmount
  amountOut: TokenAmount
  fee: TokenAmount
  startSqrtPrice: SqrtPrice
  targetSqrtPrice: SqrtPrice
  xToY: boolean
}

Developers can define a handler function, such as the handler function in the code snippet, that takes an event parameter matching the structure of the respective event type (e.g., SwapEvent). This handler function enables developers to perform actions based on the event details.

const handler = (event: SwapEvent) => {
  // checking if swap was made on a specific pool
  if (event.poolKey === poolKey) {
    // do action
  }
}

The invariant.on method allows developers to subscribe to specific events, such as SwapEvent, by specifying the event type and providing the corresponding handler function.

// attach event listener to invariant contract and listen for swap events
invariant.on(InvariantEvent.SwapEvent, handler)

When event subscriptions are no longer needed, developers can use the invariant.off method to unsubscribe from specific events. This ensures efficient resource management and stops further notifications for the specified event type.

// remove event listener when it is no longer needed
invariant.off(InvariantEvent.SwapEvent, handler)

Installation​

Download​

Build​

Overview​

Transactions and Queries​

Listening to Events​

Values and Helper functions​

Contracts Metadata​

Wasm​

Source​

Tests​

Project Structure​

Types​

Decimal​

Network​

Events​

Storage​

Usage Guide​

Select Network​

Initlialize API​

Transaction Signer​

PSP22 token​

Load DEX and tokens​

Create pool​

Create position​

Swap tokens​

List of Queries and Interfaces​

Query states and Calculate Fee​

Claim fees​

Transfer position​

Remove position​

Using AZERO via Wrapped AZERO​

Listen to Event​

Installation

Download

Build

Overview

Transactions and Queries

Listening to Events

Values and Helper functions

Contracts Metadata

Wasm

Source

Tests

Project Structure

Types

Decimal

Network

Events

Storage

Usage Guide

Select Network

Initlialize API

Transaction Signer

PSP22 token

Load DEX and tokens

Create pool

Create position

Swap tokens

List of Queries and Interfaces

Query states and Calculate Fee

Claim fees

Transfer position

Remove position

Using AZERO via Wrapped AZERO

Listen to Event