@meteora-ag/dynamic-bonding-curve-sdk 1.0.0

package/docs.md

@@ -0,0 +1,317 @@
+# Dynamic Bonding Curve SDK: Function Documentation
+
+## Table of Contents
+
+- [Partner Functions](#partner-functions)
+
+    - [createConfig](#createConfig)
+    - [createConstantProductConfigWithLockVesting](#createConstantProductConfigWithLockVesting)
+    - [createConstantProductConfigWithoutLockVesting](#createConstantProductConfigWithoutLockVesting)
+    - [createPartnerMetadata](#createPartnerMetadata)
+    - [claimTradingFee](#claimTradingFee)
+    - [partnerWithdrawSurplus](#partnerWithdrawSurplus)
+    - [withdrawLeftover](#withdrawLeftover)
+
+- [Pool Functions](#pool-functions)
+
+    - [createPool](#createPool)
+    - [createPoolMetadata](#createPoolMetadata)
+    - [swap](#swap)
+    - [swapQuote](#swapQuote)
+
+- [Migration Functions](#migration-functions)
+
+    - [createDammMigrationMetadata](#createDammMigrationMetadata)
+    - [createLocker](#createLocker)
+    - [migrateToDammV1](#migrateToDammV1)
+    - [lockDammV1LpToken](#lockDammV1LpToken)
+    - [claimDammV1LpToken](#claimDammV1LpToken)
+    - [migrateToDammV2](#migrateToDammV2)
+
+- [Helper Functions](#helper-functions)
+
+    - [getPool](#getPool)
+    - [getPools](#getPools)
+    - [getPoolConfig](#getPoolConfig)
+    - [getPoolMigrationQuoteThreshold](#getPoolMigrationQuoteThreshold)
+    - [getPoolMetadata](#getPoolMetadata)
+    - [getPartnerMetadata](#getPartnerMetadata)
+    - [getDammV1MigrationMetadata](#getDammV1MigrationMetadata)
+    - [getLockedLpTokenAmount](#getLockedLpTokenAmount)
+
+---
+
+## Partner Functions
+
+### createConfig
+
+Creates a new configuration key that will dictate the behavior of all pools created with this key.
+
+#### Function
+
+```typescript
+async createConfig(createConfigParam: CreateConfigParam): Promise<Transaction>
+```
+
+#### Parameters
+
+```typescript
+interface CreateConfigParam {
+    payer: PublicKey
+    config: PublicKey
+    feeClaimer: PublicKey
+    leftoverReceiver: PublicKey
+    quoteMint: PublicKey
+    poolFees: {
+        baseFee: {
+            cliffFeeNumerator: BN
+            numberOfPeriod: number
+            reductionFactor: BN
+            periodFrequency: BN
+            feeSchedulerMode: number
+        }
+        dynamicFee: {
+            binStep: number
+            binStepU128: BN
+            filterPeriod: number
+            decayPeriod: number
+            reductionFactor: number
+            variableFeeControl: number
+            maxVolatilityAccumulator: number
+        }
+    }
+    activationType: number
+    collectFeeMode: number
+    migrationOption: number
+    tokenType: number
+    tokenDecimal: number
+    migrationQuoteThreshold: BN
+    partnerLpPercentage: number
+    creatorLpPercentage: number
+    partnerLockedLpPercentage: number
+    creatorLockedLpPercentage: number
+    sqrtStartPrice: BN
+    lockedVesting: {
+        amountPerPeriod: BN
+        cliffDurationFromMigrationTime: BN
+        frequency: BN
+        numberOfPeriod: BN
+        cliffUnlockAmount: BN
+    }
+    migrationFeeOption: number
+    tokenSupply: {
+        preMigrationTokenSupply: BN
+        postMigrationTokenSupply: BN
+    }
+    padding: BN[]
+    curve: {
+        sqrtPrice: BN
+        liquidity: BN
+    }[]
+}
+```
+
+#### Returns
+
+A transaction that can be partially signed and sent to the network.
+
+#### Example
+
+```typescript
+const transaction = await client.partners.createConfig({
+    payer: wallet.publicKey,
+    config: config.publicKey,
+    feeClaimer: wallet.publicKey,
+    leftoverReceiver: wallet.publicKey,
+    quoteMint: new PublicKey('So11111111111111111111111111111111111111112'),
+    poolFees: {
+        baseFee: {
+            cliffFeeNumerator: new BN('2500000'),
+            numberOfPeriod: 0,
+            reductionFactor: new BN('0'),
+            periodFrequency: new BN('0'),
+            feeSchedulerMode: FeeSchedulerMode.Linear,
+        },
+        dynamicFee: {
+            binStep: 1,
+            binStepU128: new BN('1844674407370955'),
+            filterPeriod: 10,
+            decayPeriod: 120,
+            reductionFactor: 1000,
+            variableFeeControl: 100000,
+            maxVolatilityAccumulator: 100000,
+        },
+    },
+    activationType: 0,
+    collectFeeMode: 0,
+    migrationOption: 0
+    tokenType: 0,
+    tokenDecimal: 9,
+    migrationQuoteThreshold: new BN('1000000000'),
+    partnerLpPercentage: 25,
+    creatorLpPercentage: 25,
+    partnerLockedLpPercentage: 25,
+    creatorLockedLpPercentage: 25,
+    sqrtStartPrice: new BN('58333726687135158'),
+    lockedVesting: {
+        amountPerPeriod: new BN('0'),
+        cliffDurationFromMigrationTime: new BN('0'),
+        frequency: new BN('0'),
+        numberOfPeriod: new BN('0'),
+        cliffUnlockAmount: new BN('0'),
+    },
+    migrationFeeOption: 0,
+    tokenSupply: {
+        preMigrationTokenSupply: new BN('10000000000000000000'),
+        postMigrationTokenSupply: new BN('10000000000000000000'),
+    },
+    padding: [
+        new BN(0),
+        new BN(0),
+        new BN(0),
+        new BN(0),
+        new BN(0),
+        new BN(0),
+        new BN(0),
+    ],
+    curve: [
+        {
+            sqrtPrice: new BN('233334906748540631'),
+            liquidity: new BN('622226417996106429201027821619672729'),
+        },
+        {
+            sqrtPrice: new BN('79226673521066979257578248091'),
+            liquidity: new BN('1'),
+        },
+    ],
+})
+```
+
+---
+
+## Pool Functions
+
+### createPool
+
+Creates a new pool with the configuration key.
+
+#### Function
+
+```typescript
+async createPool(createPoolParam: CreatePoolParam): Promise<Transaction>
+```
+
+#### Parameters
+
+```typescript
+interface CreatePoolParam {
+    quoteMint: PublicKey
+    baseMint: PublicKey
+    config: PublicKey
+    baseTokenType: number
+    quoteTokenType: number
+    name: string
+    symbol: string
+    uri: string
+    creator: PublicKey
+}
+```
+
+#### Returns
+
+A transaction that requires signatures from both the creator's wallet and the baseMint keypair before being submitted to the network.
+
+#### Example
+
+```typescript
+const transaction = await client.pools.createPool({
+    quoteMint: new PublicKey('So11111111111111111111111111111111111111112'),
+    baseMint: new PublicKey('JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN'),
+    config: config.publicKey,
+    baseTokenType: 0,
+    quoteTokenType: 0,
+    name: 'Jupiter',
+    symbol: 'JUP',
+    uri: 'https://jup.ag',
+    creator: wallet.publicKey,
+})
+```
+
+---
+
+### swap
+
+Swaps between base and quote or quote and base.
+
+#### Function
+
+```typescript
+async swap(pool: PublicKey, swapParam: SwapParam): Promise<Transaction>
+```
+
+#### Parameters
+
+```typescript
+interface SwapParam {
+    owner: PublicKey
+    amountIn: BN
+    minimumAmountOut: BN
+    swapBaseForQuote: boolean
+}
+```
+
+#### Returns
+
+A transaction that can be signed and sent to the network.
+
+#### Example
+
+```typescript
+const transaction = await client.pools.swap(poolAddress, {
+    owner: wallet.publicKey,
+    amountIn: new BN(1000000000),
+    minimumAmountOut: new BN(0),
+    swapBaseForQuote: false,
+})
+```
+
+---
+
+### swapQuote
+
+Swaps between base and quote or quote and base.
+
+#### Function
+
+```typescript
+swapQuote(swapQuoteParam: SwapQuoteParam): Promise<QuoteResult>
+```
+
+#### Parameters
+
+```typescript
+interface SwapQuoteParam {
+    virtualPool: VirtualPool
+    config: PoolConfig
+    swapBaseForQuote: boolean
+    amountIn: BN
+    hasReferral: boolean
+    currentPoint: BN
+}
+```
+
+#### Returns
+
+The quote result of the swap.
+
+#### Example
+
+```typescript
+const quote = client.pools.swapQuote({
+    virtualPool,
+    swapBaseForQuote,
+    amountIn,
+    hasReferral,
+    currentPoint,
+})
+```

package/eslint.config.mjs

@@ -0,0 +1,4 @@
+import { config } from "@meteora-ag/ts-sdk-config/base";
+
+/** @type {import("eslint").Linter.Config} */
+export default config;

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@meteora-ag/dynamic-bonding-curve-sdk",
+  "version": "1.0.0",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "source": "src/index.ts",
+  "types": "dist/index.d.ts",
+  "author": "Dann Wee <dann@raccoons.dev>",
+  "keywords": [
+    "meteora-ag",
+    "dynamic-bonding-curve",
+    "damm-v1",
+    "damm-v2",
+    "dynamic-vaults"
+  ],
+  "description": "A Typescript SDK for interacting with the Dynamic Bonding Curve on Meteora.",
+  "license": "MIT",
+  "type": "module",
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts",
+    "clean": "rm -rf node_modules dist"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "devDependencies": {
+    "@meteora-ag/ts-sdk-config": "*",
+    "@types/bun": "latest",
+    "eslint": "^9.24.0",
+    "tsup": "^8.4.0",
+    "tsx": "^4.19.3"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "@coral-xyz/anchor": "^0.31.0",
+    "@solana/spl-token": "^0.4.13",
+    "@solana/web3.js": "^1.98.0",
+    "solana-bankrun": "^0.4.0"
+  }
+}