Typescript SDK

The typescript SDK to interact with Ferra CLMM protocol

Getting started

Install Ferra CLMM SDK: npm install @ferra-xyz/clmm

Optional: npm install @mysten/sui

The Ferra CLMM npm package is located here: https://npmjs.com/package/@ferra-xyz/clmm

Initialize the Ferra CLMM SDK with default values using the Sui mainnet RPC

// Initilize CLMM instance
import { clmmMainnet, initFerraSDK }  from "@ferra-xyz/clmm"

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