website·Indexed 32 days ago
https://docs.dex.biatec.ioDeveloper documentation for the Biatec decentralized exchange, featuring the BiatecClammPoolClient and BiatecPoolProviderClient. The API provides tools for concentrated liquidity AMM (CLAMM) operations, including swapping, liquidity management, and a comprehensive suite of tick grid utility functions for price snapping, boundary calculation, and precision management.
const id = client.appId; // The ID of the app instance
const address = client.appAddress; // The app address
const name = client.appName; // The name of the app
const spec = client.appSpec; // The ARC-56 app spec
const algo = client.algorand; // Reference to the AlgorandClientBiatec CLAMM uses a canonical logarithmic tick grid to ensure liquidity is concentrated in shared pools rather than fragmented. The grid is absolute and decade-periodic, meaning boundaries are fixed and do not depend on market price or UI state.
There are three named tick widths:
wide: Anchors at 1, 2, 5 (approx 100% steps).normal: Recommended default. Ticks are approx 10% of the price.narrow: Ticks are approx 1% of the price.Lower precision results in wider ticks. This system ensures that a price (e.g., 1500) always falls into the same bin regardless of when or where it is calculated.
import { TICK_TYPES, DEFAULT_TICK_TYPE, TickType } from 'biatec-concentrated-liquidity-amm';
console.log(TICK_TYPES); // ['wide', 'normal', 'narrow']
console.log(DEFAULT_TICK_TYPE); // 'normal'const id = client.appId; // The ID of the app instance
const address = client.appAddress; // The app address
const name = client.appName; // The name of the app
const spec = client.appSpec; // The ARC-56 app spec being used
const algoClient = client.algorand; // Reference to the underlying AlgorandClientBiatecCLAMM uses a multi-tier fee system consisting of two primary categories:
E_ or ERR- (e.g., E_CONFIG, ERR-LOW-VER).BiatecClammPoolClient provides several read-only accessors to retrieve metadata about the linked application instance and the underlying Algorand client.const appId = client.appId; // The ID of the app instance
const appAddress = client.appAddress; // The app address
const appName = client.appName; // The name of the app
const appSpec = client.appSpec; // The ARC-56 app spec
const algoClient = client.algorand; // Reference to the AlgorandClient// Example of calculating concentrated liquidity based on asset amounts and price boundaries
const liquidity = calculateConcentratedLiquidity(assetAAmount, assetBAmount, priceMin, priceMax);AppPoolInfo object provides detailed information about a liquidity pool, including the assets involved, current price, and performance metrics (volume, fees, VWAP) across four distinct time periods (period1 through period4). All numeric properties are represented as bigint.interface AppPoolInfo {
assetA: bigint;
assetB: bigint;
verificationClass: bigint;
latestPrice: bigint;
// Period 1
period1Duration: bigint;
period1NowVolumeA: bigint;
period1NowVolumeB: bigint;
period1NowFeeA: bigint;
period1NowFeeB: bigint;
period1NowVwap: bigint;
period1NowTime: bigint;
period1PrevVolumeA: bigint;
period1PrevVolumeB: bigint;
period1PrevFeeA: bigint;
period1PrevFeeB: bigint;
period1PrevVwap: bigint;
period1PrevTime: bigint;
// Period 2
period2Duration: bigint;
period2NowVolumeA: bigint;
period2NowVolumeB: bigint;
period2NowFeeA: bigint;
period2NowFeeB: bigint;
period2NowVwap: bigint;
period2NowTime: bigint;
period2PrevVolumeA: bigint;
period2PrevVolumeB: bigint;
period2PrevFeeA: bigint;
period2PrevFeeB: bigint;
period2PrevVwap: bigint;
period2PrevTime: bigint;
// Period 3
period3Duration: bigint;
period3NowVolumeA: bigint;
period3NowVolumeB: bigint;
period3NowFeeA: bigint;
period3NowFeeB: bigint;
period3NowVwap: bigint;
period3NowTime: bigint;
period3PrevVolumeA: bigint;
period3PrevVolumeB: bigint;
period3PrevFeeA: bigint;
period3PrevFeeB: bigint;
period3PrevVwap: bigint;
period3PrevTime: bigint;
// Period 4
period4Duration: bigint;
period4NowVolumeA: bigint;
period4NowVolumeB: bigint;
period4NowFeeA: bigint;
period4NowFeeB: bigint;
period4NowVwap: bigint;
period4NowTime: bigint;
period4PrevVolumeA: bigint;
period4PrevVolumeB: bigint;
period4PrevFeeA: bigint;
period4PrevFeeB: bigint;
period4PrevVwap: bigint;
period4PrevTime: bigint;
}// Create B-ALGO staking pool
const stakingPool = await createStakingPool({
assetA: 0n, // ALGO
assetB: 0n, // ALGO
tokenName: 'B-ALGO',
});