Introduction

Cetus-CLMM-SUI-SDK is the official software development kit (SDK) specifically designed for seamless integration with Cetus-CLMM. It provides developers with the necessary tools and resources to easily connect and interact with Cetus-CLMM, enabling the development of robust and efficient applications.

Getting Started

To integrate our SDK into your local project, please follow the example steps provided below. Please see details in document.

Prerequisites

npm i kk_cetus-sui-clmm-sdk

SDK Initialization

The SDK provides a convenient initialization method src/config/initCetusSDK for quick setup and configuration of the Cetus SDK.

Network Options

• mainnet (Production Network)
• testnet (Test Network)

Important Note

Before performing swaps or other asset-related operations, ensure:

• A wallet is properly configured

• The wallet has sufficient token balance for the intended operation

• After linking your wallet, you need to set it by cetusClmmSDK.setSenderAddress("YOUR_SUI_ADDRESS_HERE")

  import { CetusClmmSDK } from 'kk_cetus-sui-clmm-sdk'
  
  const sdk = CetusClmmSDK.createSDK({ env: 'mainnet' })
  sdk.setSenderAddress("YOUR_SUI_ADDRESS_HERE")

  If you wish to set your own SdkOptions, you can do so as follows:

  import { CetusClmmSDK, SdkOptions } from 'kk_cetus-sui-clmm-sdk'
  
  const options: SdkOptions = {...}
  const cetusClmmSDK = CetusClmmSDK.createCustomSDK(options)

Now, you can start using Cetus SDK.

Typescript Doc

You can view this typescript sdk in Cetus Development Documents.

LICENSE

CETUS-SUI-SDK released under the Apache license. See the LICENSE file for details.

More About Cetus

Use the following links to learn more about Cetus: Learn more about working with Cetus in the Cetus Documentation.

Join the Cetus community on Cetus Discord.