CetusProtocol / cetus-clmm-sui-sdk

The clmm sdk on Sui.
Apache License 2.0
35 stars 25 forks source link

NPM npm GitHub Repo stars


Logo

Cetus-CLMM-SUI-SDK

Integrating Cetus-CLMM-SUI-SDK: A Comprehensive Guide, Please see details in document.
Explore the document »

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 @cetusprotocol/cetus-sui-clmm-sdk

Setting Up Configuration

Our SDK now includes a default initialization method that allows for quick generation of the Cetus SDK configuration. You can utilize the src/config/initCetusSDK method to swiftly initialize the configuration. You have the option to select either 'mainnet' or 'testnet' for the network.

  import { initCetusSDK } from '@cetusprotocol/cetus-sui-clmm-sdk'

  const cetusClmmSDK = initCetusSDK({network: 'mainnet})

If you wish to set your own full node URL and simulate address, you can do so as follows:

  import { initCetusSDK } from '@cetusprotocol/cetus-sui-clmm-sdk'

  const network = 'mainnnet';
  const fullNodeUrl = "https://..."
  const simulationAccount = "0x..."
  const cetusClmmSDK = initCetusSDK({network, fullNodeUrl, simulationAccount})

Now, you can start using Cetus SDK.

Typrscript 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.