Skip to content

NautilusOSS/BiatecCLAMM

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Biatec

First gold and silver coins in usage at 500 BC to 100 BC around Bratislava area were minted with label BIATEC. Slovak National Bank used the Biatec coin image on the official slovak fiat currency before EUR was adopted.

We believe that Algorand and whole AVM ecosystem provides new form of digital identity and payments solutions. The brand name Biatec creates for us historic narrative as we live now the historic moments of early crypto adoption.

Algorand is novel distributed ledger technology (DLT) which does not fork because of efficiency of PPoS. It provides instant transaction finality, sub 3 second economic finality and has highest AMM swap throughput. Users do not pay for failed transactions and each transfer of value even in milions costs less then a penny.

www.biatec.io

Biatec DEX

We are building DEX like solution which will utilize the Automated Market Maker smart contracts, mainly the Concentrated liquidity AMM algorithm.

This work has been performed with support from the Algorand Foundation xGov Grants Program - xGov#80.

Biatec Concentrated Liquidity Smart Contract

This repo is dedicated to Biatec CL AMM Smart contract.

Tests

Tests

NPM package

npm i biatec-concentrated-liquidity-amm

Examples

Retrieve deployed app IDs

import { getConfig } from 'biatec-concentrated-liquidity-amm';

const { configAppId, identityAppId, poolProviderAppId } = getConfig('testnet-v1.0');

Supported genesis IDs are mainnet-v1.0, voimain-v1.0, and testnet-v1.0. The helper throws if you pass an unsupported network so deployments stay explicit.

Add liquidity

import {clientBiatecClammPool, clammAddLiquiditySender} from "biatec-concentrated-liquidity-amm"

const client = clientBiatecClammPool({
  appId: .. ,
  sender: ..;
  algod: ..;
})
const txId = await clammAddLiquiditySender({
  clientBiatecClammPool,
  account: TransactionSignerAccount,
  algod: algosdk.Algodv2,

  appBiatecConfigProvider: bigint,
  appBiatecIdentityProvider: bigint,
  assetA: bigint,
  assetB: bigint,
  assetLP: bigint,

  assetADeposit: bigint,
  assetBDeposit: bigint,
})

SWAP

import {clientBiatecClammPool, clammSwapSender} from "biatec-concentrated-liquidity-amm"

const client = clientBiatecClammPool({
  appId: .. ,
  sender: ..;
  algod: ..;
})
const txId = await clammSwapSender({
  clientBiatecClammPool: BiatecClammPoolClient;
  account: TransactionSignerAccount;
  algod: algosdk.Algodv2;

  appBiatecConfigProvider: bigint;
  appBiatecIdentityProvider: bigint;
  assetA: bigint;
  assetB: bigint;
  assetLP: bigint;

  assetADeposit: bigint;
  assetBDeposit: bigint;
})

Remove liquidity and collect fees

import {clientBiatecClammPool, clammRemoveLiquiditySender} from "biatec-concentrated-liquidity-amm"

const client = clientBiatecClammPool({
  appId: .. ,
  sender: ..;
  algod: ..;
})
const txId = await clammRemoveLiquiditySender({
  clientBiatecClammPool: BiatecClammPoolClient;
  account: TransactionSignerAccount;
  algod: algosdk.Algodv2;

  appBiatecConfigProvider: bigint;
  appBiatecIdentityProvider: bigint;
  assetA: bigint;
  assetB: bigint;
  assetLP: bigint;

  lpToSend: bigint;
})

Staking Pools (NEW)

BiatecCLAMM now supports staking pools where asset A and asset B are the same token. This enables creation of interest-bearing tokens like B-ALGO, B-USDC, etc.

Creating a Native Token Staking Pool (B-ALGO)

import { clammCreateSender } from 'biatec-concentrated-liquidity-amm';

await poolProviderClient.send.setNativeTokenName({
  args: {
    appBiatecConfigProvider: configAppId,
    nativeTokenName: 'Algo',
  },
  appReferences: [configAppId],
});

const poolClient = await clammCreateSender({
  transactionSigner: signerAccount,
  clientBiatecPoolProvider: poolProviderClient,
  appBiatecConfigProvider: configAppId,
  assetA: 0n, // Native token (ALGO)
  assetB: 0n, // Same as asset A
  fee: 0n, // No fee
  verificationClass: 0,
  priceMin: BigInt(SCALE),
  priceMax: BigInt(SCALE),
  currentPrice: BigInt(SCALE),
});

Distributing Staking Rewards

import { clammDistributeExcessAssetsSender } from 'biatec-concentrated-liquidity-amm';

// After rewards accrue to the pool (e.g., from consensus rewards)
// Note: rewardsAmount should already be in asset decimals (e.g., microAlgos)
// Convert to base scale (9 decimals) by multiplying with scale factor
const rewardsInBaseScale = (rewardsAmount * BigInt(SCALE)) / BigInt(assetDecimals);

const txId = await clammDistributeExcessAssetsSender({
  algod,
  account: executiveSigner,
  amountA: rewardsInBaseScale, // Amount in base scale (9 decimals)
  amountB: 0n,
  appBiatecConfigProvider: configAppId,
  assetA: 0n,
  assetB: 0n,
  clientBiatecClammPool: poolClient,
});

For complete documentation, see docs/staking-pools.md.

Key Features:

  • Create Interest-Bearing Tokens: Build B-ALGO, B-USDC, or any B-{TOKEN}
  • Support Multi-Chain Networks: Works with ALGO, VOI, ARAMID chains
  • Distribute Rewards to LP Holders: Share staking rewards, interest, or fees
  • Enable Flexible Use Cases: Power lending protocols, yield aggregation, revenue sharing

Use Cases:

  1. Native Token Staking: B-ALGO pools for staking ALGO with consensus rewards
  2. Asset Staking: B-USDC pools for lending protocol interest
  3. Revenue Sharing: Distribute protocol fees to token holders
  4. Yield Aggregation: Combine multiple yield sources

Documentation

Comprehensive documentation is available in the docs/ folder:

Core Documentation

Technical Details

Security

Key Resources

  • 📖 Error Troubleshooting: See error-codes.md for solutions
  • 🔐 Security Best Practices: Review integration-guide.md before deployment
  • 🧪 Testing: Examples in __test__/ folder show proper usage patterns
  • 🛡️ Audit Reports: Six AI security audits in audits/ folder

Security Considerations

⚠️ Important Security Notices:

  1. Price Oracle Usage: Never use single pool VWAP as sole price source. See integration guide for safe patterns.
  2. Slippage Protection: Always enforce minimum slippage (≥0.5%). Never use minimumToReceive = 0.
  3. Identity Verification: All operations require proper KYC verification class.
  4. LP Token Rounding: Small rounding losses (< 0.0001%) are expected. See liquidity-rounding.md.

Multiple security audits have been conducted. Review the audits/ folder before mainnet deployment.

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 92.0%
  • C# 6.3%
  • JavaScript 1.5%
  • Other 0.2%