{"id":13572777,"url":"https://github.com/CetusProtocol/cetus-clmm-sui-sdk","last_synced_at":"2025-04-04T11:30:44.152Z","repository":{"id":163845299,"uuid":"610696958","full_name":"CetusProtocol/cetus-clmm-sui-sdk","owner":"CetusProtocol","description":"The clmm sdk on Sui.","archived":false,"fork":false,"pushed_at":"2024-07-15T12:05:01.000Z","size":1555,"stargazers_count":29,"open_issues_count":7,"forks_count":20,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-11-05T07:35:00.494Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CetusProtocol.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-07T09:50:35.000Z","updated_at":"2024-10-29T00:59:27.000Z","dependencies_parsed_at":null,"dependency_job_id":"17d2f33e-1b7e-4c45-9b5c-734bd6c98a56","html_url":"https://github.com/CetusProtocol/cetus-clmm-sui-sdk","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CetusProtocol%2Fcetus-clmm-sui-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CetusProtocol%2Fcetus-clmm-sui-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CetusProtocol%2Fcetus-clmm-sui-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CetusProtocol%2Fcetus-clmm-sui-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CetusProtocol","download_url":"https://codeload.github.com/CetusProtocol/cetus-clmm-sui-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247169901,"owners_count":20895375,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T15:00:19.590Z","updated_at":"2025-04-04T11:30:39.142Z","avatar_url":"https://github.com/CetusProtocol.png","language":"TypeScript","funding_links":[],"categories":["Products","**6\\. Detailed Data Tables of Financial Projects**","Client SDKs \u0026 Libraries"],"sub_categories":["MEV SDKs","**Table 1: Sui Ecosystem Financial Projects**","DeFi SDKs"],"readme":"\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n![NPM](https://img.shields.io/npm/l/%40cetusprotocol%2Fcetus-sui-clmm-sdk?registry_uri=https%3A%2F%2Fregistry.npmjs.com\u0026style=flat\u0026logo=npm\u0026logoColor=blue\u0026label=%40cetusprotocol\u0026labelColor=rgb\u0026color=fedcba\u0026cacheSeconds=3600\u0026link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40cetusprotocol%2Fcetus-sui-clmm-sdk)\n![npm](https://img.shields.io/npm/v/%40cetusprotocol%2Fcetus-sui-clmm-sdk?logo=npm\u0026logoColor=rgb)\n![GitHub Repo stars](https://img.shields.io/github/stars/CetusProtocol/cetus-clmm-sui-sdk?logo=github)\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca \u003e\n    \u003cimg src=\"https://archive.cetus.zone/assets/image/logo.png\" alt=\"Logo\" width=\"100\" height=\"100\"\u003e\n  \u003c/a\u003e\n\n  \u003ch3 align=\"center\"\u003eCetus-CLMM-SUI-SDK\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    Integrating Cetus-CLMM-SUI-SDK: A Comprehensive Guide, Please see details in document.\n    \u003cbr /\u003e\n    \u003ca href=\"https://cetus-1.gitbook.io/cetus-developer-docs/developer/dev-overview\"\u003e\u003cstrong\u003eExplore the document »\u003c/strong\u003e\u003c/a\u003e\n\u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/CetusProtocol/cetus-clmm-sui-sdk/tree/main/examples\"\u003eView Demo\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/CetusProtocol/cetus-clmm-sui-sdk/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n- [SDK configuration parameters](#sdk-configuration-parameters)\n- [Introduction](#introduction)\n- [Getting Started](#getting-started)\n  - [Prerequisites](#prerequisites)\n  - [Setting Up Configuration](#setting-up-configuration)\n  - [Features Available Right Now](#features-available-right-now)\n    - [Query data](#query-data)\n    - [Pool and Position (Liquidity)](#pool-and-position-liquidity)\n    - [Swap with Partner](#swap-with-partner)\n    - [Smart Router for Swap](#smart-router-for-swap)\n      - [Smart Router V1](#smart-router-v1)\n      - [Smart Router V2](#smart-router-v2)\n    - [Swap Pre-calculating Result Show](#swap-pre-calculating-result-show)\n    - [Conversion between liquidity, tickIndex, sqrtPrice, and coinAmount.](#conversion-between-liquidity-tickindex-sqrtprice-and-coinamount)\n- [LICENSE](#license)\n\n## SDK configuration parameters\n\n- The contract address available for reference [cetus-developer-docs](https://cetus-1.gitbook.io/cetus-developer-docs/developer/via-sdk/getting-started#latest-sdk-config).\n- `simulationAccount` used to simulate trades and obtain tick data.\n- *Notes: Please exercise caution when using a mainnet network account with assets as your `simulationAccount`.*\n\n\n## Introduction\n\nCetus-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.\n\n\n## Getting Started\nTo integrate our SDK into your local project, please follow the example steps provided below.\nPlease see details in document.\n### Prerequisites\n* npm\n    ```sh\n    npm i @cetusprotocol/cetus-sui-clmm-sdk\n    ```\n\n### Setting Up Configuration\n1. Initialize testnet (or mainnet) SdkOption\n\n\n    **NOTICE** \n    1. In this example, the contract address version may backward, please use the latest clmmpool and integrate address.\n    2. `simulationAccount` should be add an account address with a small amount of assets, it used to do estimated or other query object from.\n\n2. Instantiate one CetusClmmSDK\n\nNow, you can start using Cetus SDK.\n\n### Features Available Right Now\n\u003ca href=\"https://cetus-1.gitbook.io/cetus-developer-docs/developer/dev-overview\"\u003e\u003cstrong\u003e »»» See details in development document. \u003c/strong\u003e\u003c/a\u003e\n\u003cbr /\u003e\n\n1. Retrieve data\n1.1 Retrieve clmm pools\n1.2 Retrieve positions\n1.3 Retrieve reward\n1.4 Retrieve ticks\n2. Pools and postions\n2.1 Create clmm pool\n2.2 Open position\n2.3 Add liquidity\n2.4 Remove liquidity\n2.5 Close position\n2.6 Collect fees\n2.7 Collect rewards\n3. Swap\n3.1 Swap\n3.2 Partner swap\n3.3 Smart router v1 \n3.4 Smart router v2\n3.5 Price impact\n3.6 Minimum received \u0026 Maximum sold\n3.7 Fee\n4. Liquidity correlation calculation\n4.1 Liquidity correlation calculation\n\n## LICENSE\nCETUS-SUI-SDK released under the Apache license. See the [LICENSE](./LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCetusProtocol%2Fcetus-clmm-sui-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCetusProtocol%2Fcetus-clmm-sui-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCetusProtocol%2Fcetus-clmm-sui-sdk/lists"}