@mmt-finance/amm-sui-sdk 0.0.1-beta

package/.eslintrc.json

@@ -0,0 +1,22 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true,
+    "node": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "plugins": ["@typescript-eslint"],
+  "rules": {
+    "@typescript-eslint/no-explicit-any": "warn",
+    "@typescript-eslint/no-unused-vars": ["warn", { "argsIgnorePattern": "^_" }]
+  }
+}

package/.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit ${1}

package/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "trailingComma": "all",
+  "singleQuote": true,
+  "printWidth": 100,
+  "tabWidth": 2
+}

package/README.md

@@ -0,0 +1,206 @@
+# AMM Sui SDK
+
+The Momentum SDK provides access to the Momentum DeFi protocols suite on Sui.
+
+## Installation
+
+```bash
+npm install @mmt-finance/amm-sui-sdk
+# or
+bun add @mmt-finance/amm-sui-sdk
+```
+
+### Initialization
+
+Initialize the SDK with your RPC endpoint and preferred network ('mainnet' | 'testnet').
+
+```typescript
+import { MmtAmmSdk } from '@mmt-finance/amm-sui-sdk';
+
+// Initialize for Mainnet
+const sdk = new MmtAmmSdk({
+  network: 'mainnet',
+  rpcEndpoint: 'https://fullnode.mainnet.sui.io:443',
+});
+
+// Or Initialize for Testnet
+const testnetSdk = new MmtAmmSdk({
+  network: 'testnet',
+  rpcEndpoint: 'https://fullnode.testnet.sui.io:443',
+});
+
+// Legacy initialization (defaults to mainnet) is also supported:
+// const sdk = new MmtAmmSdk('https://fullnode.mainnet.sui.io:443');
+```
+
+## Usage
+
+### 1. Create Pool
+
+Create a new Liquidity Pool.
+
+```typescript
+const txb = new Transaction();
+
+sdk.createPool({
+  isStable: false, // true for stable pool, false for uncorrelated
+  decimalsX: 9, // Decimals for Token X
+  decimalsY: 6, // Decimals for Token Y
+  txb,
+  typeX: '0x...::coin::X',
+  typeY: '0x...::coin::Y',
+});
+
+// Sign and execute `txb`
+```
+
+### 2. Create Pool and Add Liquidity (Single Transaction)
+
+Create a pool and add initial liquidity in the same transaction block.
+
+```typescript
+const txb = new Transaction();
+
+sdk.createPoolAndAddLiquidity({
+  isStable: false,
+  decimalsX: 9,
+  decimalsY: 6,
+  txb,
+  typeX: '0x...::coin::X',
+  typeY: '0x...::coin::Y',
+  // Liquidity Parameters
+  minAddAmountX: 90000000n, // Min amount of X to add (slippage)
+  minAddAmountY: 90000000n, // Min amount of Y to add (slippage)
+  coinX: '0x...' | TransactionArgument, // Coin Object ID or Argument (Full balance used)
+  coinY: '0x...' | TransactionArgument, // Coin Object ID or Argument (Full balance used)
+  // Optional: transferToAddress is supported in addLiquidity but strictly speaking createPoolAndAddLiquidity returns void/shares to sender in current SDK impl unless wrapper handles it.
+  // Checking SDK impl: returns undefined. Transfers to sender.
+  // SDK code removed transferToAddress from options in step 305?
+  // Let's check step 305 diff. Yes, transferToAddress was removed from interface.
+  // So I should remove it from README too.
+});
+```
+
+### 3. Basic Swap
+
+Perform a swap between two tokens in a specific pool.
+
+```typescript
+const txb = new Transaction();
+
+sdk.swap({
+  pool, // Pool object
+  inputCoinType: '0x...::coin::X',
+  inputCoinAmount: 1000000n,
+  inputCoin: txb.gas, // or other coin object
+  minReceived: 0n,
+  txb,
+  transferToAddress: '0x...',
+});
+```
+
+### 4. Swap with Route
+
+Perform a multi-hop swap across multiple pools.
+
+```typescript
+const txb = new Transaction();
+
+sdk.swapWithRoute({
+  pools: [pool1, pool2], // Array of Pool objects forming the route
+  inputCoinType: '0x...::coin::X',
+  inputCoinAmount: 1000000n,
+  inputCoin: txb.gas,
+  minReceived: 0n,
+  txb,
+  transferToAddress: '0x...',
+});
+```
+
+### 5. Add Liquidity
+
+Add liquidity to a pool (requires both tokens).
+
+```typescript
+const txb = new Transaction();
+
+sdk.addLiquidity({
+  pool,
+  amountX: 1000000n,
+  amountY: 2000000n,
+  minAddAmountX: 900000n,
+  minAddAmountY: 1800000n,
+  coinX: coinXObject,
+  coinY: coinYObject,
+  txb,
+  transferToAddress: '0x...',
+});
+```
+
+### 6. Single Sided Add Liquidity
+
+Add liquidity using only one type of token. The SDK will automatically swap the necessary amount to match the pool ratio.
+
+```typescript
+const txb = new Transaction();
+
+await sdk.addLiquiditySingleSided({
+  pool,
+  inputCoinType: '0x...::coin::X',
+  inputCoinAmount: 1000000n,
+  inputCoin: coinXObject,
+  tokenInDecimals: 9,
+  tokenOutDecimals: 6,
+  swapSlippageTolerance: 0.05, // 5%
+  txb,
+  transferToAddress: '0x...',
+});
+```
+
+### 7. Remove Liquidity
+
+Remove liquidity from a pool by burning LP tokens.
+
+```typescript
+const txb = new Transaction();
+
+sdk.removeLiquidity({
+  pool,
+  amount: 500000n,
+  mmtLpToken: lpTokenObject,
+  txb,
+  transferToAddress: '0x...',
+});
+```
+
+### 8. Helper: Get User LP Positions
+
+Fetch all LP positions for a specific user and pool.
+
+```typescript
+const positions = await sdk.getUserLpPositions({
+  pool,
+  userAddress: '0x...',
+});
+```
+
+## Types
+
+Key interfaces used in the SDK:
+
+- **Pool**: Represents an AMM pool state.
+- **CreatePoolOptions**: Options for creating a pool.
+- **CreatePoolAndAddLiquidityOptions**: Options for creating a pool with initial liquidity.
+- **SwapOptions / SwapWithRouteOptions**: Options for swapping.
+- **AddLiquidityOptions / RemoveLiquidityOptions**: Options for liquidity management.
+
+Import them from:
+
+```typescript
+import {
+  Pool,
+  CreatePoolOptions,
+  CreatePoolAndAddLiquidityOptions,
+  SwapOptions,
+} from '@mmt-finance/amm-sui-sdk';
+```