Getting Started

The TypeScript SDK to interact with Ferra DAMM (Dynamic Automated Market Maker) protocol.

Installation

Install Ferra DAMM SDK:

npm install @ferra-labs/damm

Optional:

npm install @mysten/sui

Initialize SDK

Initialize the Ferra DAMM SDK with default values using the Sui mainnet RPC:

import { dammMainnet, initFerraSDK } from "@ferra-labs/damm"

const useFerraSDK = (address: string) => {
  return useMemo(
    () =>
      initFerraSDK({
        network: 'beta', // can be 'mainnet' or 'testnet', 'beta'
        fullNodeUrl: 'YOUR_RPC_FULL_NODE',
        wallet: 'YOUR_WALLET_ADDRESS',
      }),
    [address]
  );
};

Get Coin Assets & Balances

Query wallet coin data directly from the SDK instance.

Get Coin Assets

Returns detailed coin objects (object IDs, balances) for a wallet:

// All coins
const allAssets = await sdk.getOwnerCoinAssets('0xYourAddress')

// Specific coin type
const suiAssets = await sdk.getOwnerCoinAssets(
  '0xYourAddress',
  '0x2::sui::SUI'
)

// Force refresh (skip cache)
const freshAssets = await sdk.getOwnerCoinAssets('0xYourAddress', null, true)

allAssets.forEach(asset => {
  console.log({
    coinType: asset.coinAddress,
    objectId: asset.coinObjectId,
    balance: asset.balance.toString()
  })
})

Get Coin Balances

Returns aggregated balances (lighter than getOwnerCoinAssets):

// All coin balances
const balances = await sdk.getOwnerCoinBalances('0xYourAddress')

// Single coin balance
const suiBalance = await sdk.getOwnerCoinBalances(
  '0xYourAddress',
  '0x2::sui::SUI'
)

balances.forEach(b => {
  console.log(`${b.coinType}: ${b.totalBalance}`)
})