@mmt-finance/clmm-sui-sdk 1.0.0-beta.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 rize
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,88 @@
+# MMT Finance CLMM SDK
+
+`@mmt-finance/clmm-sdk` is the official TypeScript SDK for integrating with
+MMT Finance CLMM for developers. Please visit
+[MMT Developer Docs](https://developers.mmt.finance/clmm-sdk/integrations)
+for detailed guideline.
+
+## Getting Started
+
+### Installation
+
+```sh
+npm i @mmt-finance/clmm-sdk
+```
+
+### Configuration
+
+Our SDK has pre-configured network settings that allows you to connect to MMT CLMM
+on both mainnet and testnet.
+You can utilize the src/sdk NEW method to swiftly initialize the configuration.
+
+```typescript
+import { MmtSDK } from '@mmt-finance/clmm-sdk';
+
+const mmtClmmSDK = MmtSDK.NEW({
+  network: 'mainnet',
+});
+```
+
+Now, you can start using MMT SDK.
+
+### Supported Features
+
+- [Retrieve pool data](https://developers.mmt.finance/features/read-pool-data)
+- [Retrieve user data](https://developers.mmt.finance/features/read-user-data)
+- [Swap](https://developers.mmt.finance/features/swap)
+- [Open and Add Liquidity](https://developers.mmt.finance/features/open-and-add-liquidity)
+- [Position Management](https://developers.mmt.finance/features/position-management)
+- [Claim Fees and Rewards](https://developers.mmt.finance/features/claim-fees-and-rewards)
+- [Close Position](https://developers.mmt.finance/features/close-position)
+
+For a full detailed technical integration doc, please visit
+[MMT Developer Docs](https://developers.mmt.finance/clmm-sdk/integrations).
+
+### Examples
+
+A comprehensive set of examples has been provided to demonstrate the fundamental usage of the SDK.
+Please refer to the detailed guidelines for further information [example](examples/README.md)
+
+## Development Guidelines
+
+To ensure the quality, maintainability, and consistency of the SDK, we follow a strict set of development guidelines. All contributors are expected to adhere to these standards.
+
+### 1. Code Style & Linting
+
+We enforce code style using **ESLint** (based on Airbnb config) and **Prettier**.
+
+- **Linting**: Run `yarn run lint` to check for issues.
+- **Formatting**: Run `yarn run prettier:fix` to automatically format code.
+- **IDE Setup**: Configure your editor to run Prettier on save and display ESLint errors.
+
+### 2. Naming Conventions
+
+- **Files**: kebab-case (e.g., `pool-utils.ts`, `clmm-sdk.ts`).
+- **Classes/Interfaces/Types**: PascalCase (e.g., `ClmmSdk`, `PoolConfig`).
+- **Variables/Functions**: camelCase (e.g., `getPoolData`, `tokenAmount`).
+- **Constants**: UPPER_SNAKE_CASE for global constants (e.g., `MAX_TICK_INDEX`).
+- **Private Members**: Private functions or properties should start with `_` (e.g., `_internalCalculate`).
+
+### 3. Function Parameters
+
+- **Object Params**: Use an object (interface) for arguments if a function takes more than 3 parameters.
+
+### 4. Git & Commits
+
+We use husky & commitlint.
+Format: `<type>(<scope>): <description>`
+
+- **feat**: A new feature
+- **fix**: A bug fix
+- **docs**: Documentation only changes
+- **style**: Changes that do not affect the meaning of the code (white-space, formatting, etc)
+- **refactor**: A code change that neither fixes a bug nor adds a feature
+- **perf**: A code change that improves performance
+- **test**: Adding missing tests or correcting existing tests
+- **chore**: Changes to the build process or auxiliary tools
+
+Example: `feat(pool): add support for fetching tick data`

package/dist/package.json

@@ -0,0 +1,84 @@
+{
+    "name": "@mmt-finance/clmm-sui-sdk",
+    "version": "1.0.0-beta.1",
+    "description": "Momentum SDK to access the Momentum CLMM",
+    "type": "commonjs",
+    "author": "Momentum Finance",
+    "license": "MIT",
+    "files": [
+        "dist/**/*",
+        "src/**/*",
+        "tsconfig.json"
+    ],
+    "exclude": [
+        "src/scripts/**/*"
+    ],
+    "source": "./src/index.ts",
+    "types": "./dist/index.d.ts",
+    "main": "./dist/index.js",
+    "module": "./dist/index.mjs",
+    "devDependencies": {
+        "@anatine/esbuild-decorators": "^0.2.19",
+        "@commitlint/config-conventional": "^19.7.1",
+        "@mysten/sui": "1.28.2",
+        "@types/bn.js": "^5.1.5",
+        "@types/jest": "^29.5.14",
+        "@types/node": "^20.14.11",
+        "@typescript-eslint/eslint-plugin": "^6.19.1",
+        "@typescript-eslint/parser": "^6.19.1",
+        "bn.js": "^5.2.1",
+        "branch-name-lint": "^2.1.1",
+        "commitlint": "^19.7.1",
+        "decimal.js": "^10.5.0",
+        "eslint": "^8.56.0",
+        "eslint-config-airbnb-base": "^15.0.0",
+        "eslint-config-airbnb-typescript": "^17.1.0",
+        "eslint-config-prettier": "^9.1.0",
+        "eslint-import-resolver-alias": "^1.1.2",
+        "eslint-import-resolver-typescript": "^3.6.1",
+        "eslint-plugin-import": "^2.29.1",
+        "eslint-plugin-prettier": "^5.1.3",
+        "eslint-plugin-unused-imports": "^3.0.0",
+        "husky": "^9.1.7",
+        "jest": "^29.7.0",
+        "lint-staged": "^16.2.7",
+        "prettier": "^3.5.3",
+        "ts-jest": "^29.2.6",
+        "ts-node": "^10.9.2",
+        "tsconfig-paths": "^4.2.0",
+        "tsup": "^8.3.5",
+        "typescript": "^5.5.3",
+        "yalc": "^1.0.0-pre.53"
+    },
+    "scripts": {
+        "prepare": "husky",
+        "build": "rm -rf dist && yarn generate-claim-routes && tsc --project tsconfig.build.json",
+        "lint": "eslint . --ext .ts,.tsx",
+        "lint-fix": "eslint . --ext .ts,.tsx --fix",
+        "start": "ts-node -r tsconfig-paths/register scripts/index.ts",
+        "test": "jest",
+        "prettier:fix": "npx prettier --write '**/*.{js,ts,json}' --log-level error",
+        "release": "yarn build && yarn publish",
+        "scripts": "ts-node",
+        "generate-claim-routes": "ts-node scripts/get-claim-routes.ts"
+    },
+    "lint-staged": {
+        "*.{ts,tsx}": [
+            "eslint --fix",
+            "prettier --write"
+        ],
+        "*.{js,json,md}": [
+            "prettier --write"
+        ]
+    },
+    "peerDependencies": {
+        "@mysten/sui": "^1.28.2",
+        "axios": "^1.4.0",
+        "bn.js": "^5.2.1",
+        "decimal.js": "^10.4.3"
+    },
+    "dependencies": {
+        "@syntsugar/cc-graph": "^0.1.1",
+        "tslib": "^2.8.1"
+    }
+}

package/dist/src/config.d.ts

@@ -0,0 +1,48 @@
+export declare const MainnetConfig: {
+    clmm: {
+        packageId: string;
+        publishedAt: string;
+        aclId: string;
+        adminCapId: string;
+        slippageCheckPackageId: string;
+        globalConfigId: string;
+        versionId: string;
+        mvrName: string;
+    };
+    mmtApiUrl: string;
+    suiClientUrl: string;
+    mvrEndpoint: string;
+};
+export declare const TestnetConfig: {
+    clmm: {
+        packageId: string;
+        publishedAt: string;
+        aclId: string;
+        adminCapId: string;
+        slippageCheckPackageId: string;
+        globalConfigId: string;
+        versionId: string;
+        mvrName: string;
+    };
+    mmtApiUrl: string;
+    suiClientUrl: string;
+    mvrEndpoint: string;
+};
+export declare class Config {
+    static getDefaultConfig(network: string): {
+        clmm: {
+            packageId: string;
+            publishedAt: string;
+            aclId: string;
+            adminCapId: string;
+            slippageCheckPackageId: string;
+            globalConfigId: string;
+            versionId: string;
+            mvrName: string;
+        };
+        mmtApiUrl: string;
+        suiClientUrl: string;
+        mvrEndpoint: string;
+    };
+}
+//# sourceMappingURL=config.d.ts.map

package/dist/src/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa;;;;;;;;;;;;;;CAczB,CAAC;AAEF,eAAO,MAAM,aAAa;;;;;;;;;;;;;;CAczB,CAAC;AACF,qBAAa,MAAM;IACjB,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM;;;;;;;;;;;;;;;CASxC"}

package/dist/src/config.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Config = exports.TestnetConfig = exports.MainnetConfig = void 0;
+exports.MainnetConfig = {
+    clmm: {
+        packageId: '0xcf60a40f45d46fc1e828871a647c1e25a0915dec860d2662eb10fdb382c3c1d1',
+        publishedAt: '0x70285592c97965e811e0c6f98dccc3a9c2b4ad854b3594faab9597ada267b860',
+        aclId: '0xe7f25417d58cd086a64e3daed2ef04d065b606458becce33871f6d3e8b35db9d',
+        adminCapId: '0x11d573677fee08613bc4e089252945753445ad710ac3e8e4b61d4f8281907118',
+        slippageCheckPackageId: '0x8add2f0f8bc9748687639d7eb59b2172ba09a0172d9e63c029e23a7dbdb6abe6',
+        globalConfigId: '0x9889f38f107f5807d34c547828f4a1b4d814450005a4517a58a1ad476458abfc',
+        versionId: '0x2375a0b1ec12010aaea3b2545acfa2ad34cfbba03ce4b59f4c39e1e25eed1b2a',
+        mvrName: '@mmt/clmm-core',
+    },
+    mmtApiUrl: 'https://api.mmt.finance',
+    suiClientUrl: 'https://fullnode.mainnet.sui.io',
+    mvrEndpoint: 'https://mainnet.mvr.mystenlabs.com',
+};
+exports.TestnetConfig = {
+    clmm: {
+        packageId: '0xd7c99e1546b1fc87a6489afdc08bcece4ae1340cbd8efd2ab152ad71dea0f0f2',
+        publishedAt: '0xd7c99e1546b1fc87a6489afdc08bcece4ae1340cbd8efd2ab152ad71dea0f0f2',
+        aclId: '0xb3ffc02f50b866b8b29a3b6005f21d16ad386e33c20d384ee21610ba754ba899',
+        adminCapId: '0x6a271f877a36c75e48120af09124fed1ce3464caf3254307f7ded086ff2120c9',
+        slippageCheckPackageId: '0xfd6a45c396a90811fd93efaf585cc95c29aecd079c87822893f1e97e3fee8c50',
+        globalConfigId: '0x3c4385bf373c7997a953ee548f45188d9f1ca4284ec835467688d8ee276e1af7',
+        versionId: '0x83ea3e3e7384efd6b524ff973e4b627cd84d190c45d3f4fd9f5f4fc6c95fd26b',
+        mvrName: '',
+    },
+    mmtApiUrl: 'https://api-dev.mmt.finance',
+    suiClientUrl: 'https://fullnode.testnet.sui.io:443',
+    mvrEndpoint: 'https://testnet.mvr.mystenlabs.com',
+};
+class Config {
+    static getDefaultConfig(network) {
+        const config = network === 'mainnet' ? exports.MainnetConfig : exports.TestnetConfig;
+        return {
+            clmm: config.clmm,
+            mmtApiUrl: config.mmtApiUrl,
+            suiClientUrl: config.suiClientUrl,
+            mvrEndpoint: config.mvrEndpoint,
+        };
+    }
+}
+exports.Config = Config;
+//# sourceMappingURL=config.js.map

package/dist/src/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":";;;AAAa,QAAA,aAAa,GAAG;IAC3B,IAAI,EAAE;QACJ,SAAS,EAAE,oEAAoE;QAC/E,WAAW,EAAE,oEAAoE;QACjF,KAAK,EAAE,oEAAoE;QAC3E,UAAU,EAAE,oEAAoE;QAChF,sBAAsB,EAAE,oEAAoE;QAC5F,cAAc,EAAE,oEAAoE;QACpF,SAAS,EAAE,oEAAoE;QAC/E,OAAO,EAAE,gBAAgB;KAC1B;IACD,SAAS,EAAE,yBAAyB;IACpC,YAAY,EAAE,iCAAiC;IAC/C,WAAW,EAAE,oCAAoC;CAClD,CAAC;AAEW,QAAA,aAAa,GAAG;IAC3B,IAAI,EAAE;QACJ,SAAS,EAAE,oEAAoE;QAC/E,WAAW,EAAE,oEAAoE;QACjF,KAAK,EAAE,oEAAoE;QAC3E,UAAU,EAAE,oEAAoE;QAChF,sBAAsB,EAAE,oEAAoE;QAC5F,cAAc,EAAE,oEAAoE;QACpF,SAAS,EAAE,oEAAoE;QAC/E,OAAO,EAAE,EAAE;KACZ;IACD,SAAS,EAAE,6BAA6B;IACxC,YAAY,EAAE,qCAAqC;IACnD,WAAW,EAAE,oCAAoC;CAClD,CAAC;AACF,MAAa,MAAM;IACjB,MAAM,CAAC,gBAAgB,CAAC,OAAe;QACrC,MAAM,MAAM,GAAG,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,qBAAa,CAAC,CAAC,CAAC,qBAAa,CAAC;QACrE,OAAO;YACL,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,WAAW,EAAE,MAAM,CAAC,WAAW;SAChC,CAAC;IACJ,CAAC;CACF;AAVD,wBAUC"}

package/dist/src/constants/claim-routes.d.ts

@@ -0,0 +1,2 @@
+export declare const CLAIM_ROUTES: Record<string, Record<string, string[]>>;
+//# sourceMappingURL=claim-routes.d.ts.map

package/dist/src/constants/claim-routes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"claim-routes.d.ts","sourceRoot":"","sources":["../../../src/constants/claim-routes.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAqmBjE,CAAC"}