clanker-sdk 3.1.13 → 3.2.0

package/dist/index.d.mts

@@ -16,6 +16,7 @@ interface VaultConfig {
 interface PoolConfig {
     pairedToken: Address;
     initialMarketCapInPairedToken: bigint;
+    initialMarketCap?: string;
 }
 interface InitialBuyConfig {
     pairedTokenPoolFee: 10000;
@@ -28,6 +29,13 @@ interface RewardsConfig {
     interfaceAdmin: Address;
     interfaceRewardRecipient: Address;
 }
+interface DeploymentConfig {
+    tokenConfig: TokenConfig;
+    vaultConfig?: VaultConfig;
+    poolConfig: PoolConfig;
+    initialBuyConfig?: InitialBuyConfig;
+    rewardsConfig: RewardsConfig;
+}
 interface ClankerConfig {
     wallet: WalletClient;
     publicClient: PublicClient;
@@ -42,46 +50,13 @@ interface SimpleTokenConfig {
         percentage: number;
         durationInDays: number;
     };
+    pool?: {
+        quoteToken?: Address;
+        initialMarketCap?: string;
+    };
     metadata?: IClankerMetadata;
     context?: IClankerSocialContext;
 }
-interface DeploymentConfig {
-    tokenConfig: TokenConfig;
-    vaultConfig?: VaultConfig;
-    poolConfig: PoolConfig;
-    initialBuyConfig?: InitialBuyConfig;
-    rewardsConfig: RewardsConfig;
-}
-interface DeploymentConfig {
-    tokenConfig: {
-        name: string;
-        symbol: string;
-        salt: `0x${string}`;
-        image: string;
-        metadata: IClankerMetadata;
-        context: IClankerSocialContext;
-        originatingChainId: bigint;
-    };
-    poolConfig: {
-        pairedToken: Address;
-        initialMarketCapInPairedToken: bigint;
-    };
-    vaultConfig?: {
-        vaultPercentage: number;
-        vaultDuration: bigint;
-    };
-    initialBuyConfig?: {
-        pairedTokenPoolFee: 10000;
-        pairedTokenSwapAmountOutMinimum: bigint;
-    };
-    rewardsConfig: {
-        creatorReward: bigint;
-        creatorAdmin: Address;
-        creatorRewardRecipient: Address;
-        interfaceAdmin: Address;
-        interfaceRewardRecipient: Address;
-    };
-}
 interface IClankerMetadata {
     description?: string;
     socialMediaUrls?: {
@@ -102,7 +77,9 @@ declare class Clanker {
     private readonly factoryAddress;
     private readonly publicClient;
     constructor(config: ClankerConfig);
+    private getTokenDecimals;
     private calculateTick;
+    private calculateTickFromMarketCap;
     private handleError;
     deploy(config: DeploymentConfig): Promise<Address>;
     /**

package/dist/index.d.ts

@@ -16,6 +16,7 @@ interface VaultConfig {
 interface PoolConfig {
     pairedToken: Address;
     initialMarketCapInPairedToken: bigint;
+    initialMarketCap?: string;
 }
 interface InitialBuyConfig {
     pairedTokenPoolFee: 10000;
@@ -28,6 +29,13 @@ interface RewardsConfig {
     interfaceAdmin: Address;
     interfaceRewardRecipient: Address;
 }
+interface DeploymentConfig {
+    tokenConfig: TokenConfig;
+    vaultConfig?: VaultConfig;
+    poolConfig: PoolConfig;
+    initialBuyConfig?: InitialBuyConfig;
+    rewardsConfig: RewardsConfig;
+}
 interface ClankerConfig {
     wallet: WalletClient;
     publicClient: PublicClient;
@@ -42,46 +50,13 @@ interface SimpleTokenConfig {
         percentage: number;
         durationInDays: number;
     };
+    pool?: {
+        quoteToken?: Address;
+        initialMarketCap?: string;
+    };
     metadata?: IClankerMetadata;
     context?: IClankerSocialContext;
 }
-interface DeploymentConfig {
-    tokenConfig: TokenConfig;
-    vaultConfig?: VaultConfig;
-    poolConfig: PoolConfig;
-    initialBuyConfig?: InitialBuyConfig;
-    rewardsConfig: RewardsConfig;
-}
-interface DeploymentConfig {
-    tokenConfig: {
-        name: string;
-        symbol: string;
-        salt: `0x${string}`;
-        image: string;
-        metadata: IClankerMetadata;
-        context: IClankerSocialContext;
-        originatingChainId: bigint;
-    };
-    poolConfig: {
-        pairedToken: Address;
-        initialMarketCapInPairedToken: bigint;
-    };
-    vaultConfig?: {
-        vaultPercentage: number;
-        vaultDuration: bigint;
-    };
-    initialBuyConfig?: {
-        pairedTokenPoolFee: 10000;
-        pairedTokenSwapAmountOutMinimum: bigint;
-    };
-    rewardsConfig: {
-        creatorReward: bigint;
-        creatorAdmin: Address;
-        creatorRewardRecipient: Address;
-        interfaceAdmin: Address;
-        interfaceRewardRecipient: Address;
-    };
-}
 interface IClankerMetadata {
     description?: string;
     socialMediaUrls?: {
@@ -102,7 +77,9 @@ declare class Clanker {
     private readonly factoryAddress;
     private readonly publicClient;
     constructor(config: ClankerConfig);
+    private getTokenDecimals;
     private calculateTick;
+    private calculateTickFromMarketCap;
     private handleError;
     deploy(config: DeploymentConfig): Promise<Address>;
     /**

package/dist/index.js

@@ -28,7 +28,16 @@ var import_actions = require("viem/actions");
 
 // src/constants.ts
 var WETH_ADDRESS = "0x4200000000000000000000000000000000000006";
-var CLANKER_FACTORY_V3_1 = "0x2A787b2362021cC3eEa3C24C4748a6cD5B687382";
+var CLANKER_FACTORY_V3_1 = "0x0000000000000000000000000000000000000000";
+var ERC20_DECIMALS_ABI = [
+  {
+    "inputs": [],
+    "name": "decimals",
+    "outputs": [{ "type": "uint8", "name": "" }],
+    "stateMutability": "view",
+    "type": "function"
+  }
+];
 
 // src/abis/Clanker_V3_1.ts
 var Clanker_v3_1_abi = [
@@ -533,9 +542,36 @@ var Clanker = class {
     this.publicClient = config.publicClient;
     this.factoryAddress = config.factoryAddress ?? CLANKER_FACTORY_V3_1;
   }
-  // Get paired token decimals
+  // Fetch token decimals from contract
+  async getTokenDecimals(tokenAddress) {
+    try {
+      const decimals = await (0, import_actions.readContract)(this.publicClient, {
+        address: tokenAddress,
+        abi: ERC20_DECIMALS_ABI,
+        functionName: "decimals"
+      });
+      return decimals;
+    } catch (error) {
+      console.warn(`Failed to fetch decimals for token ${tokenAddress}, defaulting to 18:`, error);
+      return 18;
+    }
+  }
+  // Fallback tick calculation with default price
   calculateTick() {
-    let desiredPrice = 1e-10;
+    const desiredPrice = 1e-10;
+    const logBase = 1.0001;
+    const tickSpacing = 200;
+    const rawTick = Math.log(desiredPrice) / Math.log(logBase);
+    const initialTick = Math.floor(rawTick / tickSpacing) * tickSpacing;
+    return initialTick;
+  }
+  // Calculate tick based on desired market cap and token decimals
+  async calculateTickFromMarketCap(marketCap, quoteToken) {
+    const quoteDecimals = await this.getTokenDecimals(quoteToken);
+    const marketCapBigInt = (0, import_viem.parseEther)(marketCap);
+    const adjustedMarketCap = Number((0, import_viem.formatUnits)(marketCapBigInt, quoteDecimals));
+    const totalSupply = 1e6;
+    const desiredPrice = adjustedMarketCap / totalSupply;
     const logBase = 1.0001;
     const tickSpacing = 200;
     const rawTick = Math.log(desiredPrice) / Math.log(logBase);
@@ -618,18 +654,20 @@ var Clanker = class {
       throw new Error("Wallet account not configured");
     }
     const deployerAddress = this.wallet.account.address;
+    const quoteToken = config.pool?.quoteToken ?? WETH_ADDRESS;
+    const initialTick = config.pool?.initialMarketCap ? await this.calculateTickFromMarketCap(config.pool.initialMarketCap, quoteToken) : this.calculateTick();
     const deploymentConfig = {
       tokenConfig: {
         name: config.name,
         symbol: config.symbol,
-        salt: config.salt || "0x0000000000000000000000000000000000000000000000000000000000000000",
-        image: config.image || "https://ipfs.io/ipfs/QmcjfTeK3tpK3MVCQuvEaXvSscrqbL3MwsEo8LdBTWabY4",
-        metadata: config.metadata || {
+        salt: config.salt ?? "0x0000000000000000000000000000000000000000000000000000000000000000",
+        image: config.image ?? "https://ipfs.io/ipfs/QmcjfTeK3tpK3MVCQuvEaXvSscrqbL3MwsEo8LdBTWabY4",
+        metadata: config.metadata ?? {
           description: "Clanker Token",
           socialMediaUrls: [],
           auditUrls: []
         },
-        context: config.context || {
+        context: config.context ?? {
           interface: "Clanker SDK",
           platform: "Clanker",
           messageId: "Clanker SDK",
@@ -638,9 +676,9 @@ var Clanker = class {
         originatingChainId: BigInt(this.publicClient.chain.id)
       },
       poolConfig: {
-        pairedToken: WETH_ADDRESS,
-        // WETH on Base
-        initialMarketCapInPairedToken: (0, import_viem.parseEther)("10")
+        pairedToken: quoteToken,
+        initialMarketCapInPairedToken: (0, import_viem.parseEther)(config.pool?.initialMarketCap ?? "10"),
+        initialMarketCap: config.pool?.initialMarketCap
       },
       vaultConfig: config.vault ? {
         vaultPercentage: config.vault.percentage,

package/dist/index.mjs

@@ -2,13 +2,23 @@
 import {
   parseEther,
   stringify,
-  parseEventLogs
+  parseEventLogs,
+  formatUnits
 } from "viem";
-import { simulateContract, writeContract } from "viem/actions";
+import { simulateContract, writeContract, readContract } from "viem/actions";
 
 // src/constants.ts
 var WETH_ADDRESS = "0x4200000000000000000000000000000000000006";
-var CLANKER_FACTORY_V3_1 = "0x2A787b2362021cC3eEa3C24C4748a6cD5B687382";
+var CLANKER_FACTORY_V3_1 = "0x0000000000000000000000000000000000000000";
+var ERC20_DECIMALS_ABI = [
+  {
+    "inputs": [],
+    "name": "decimals",
+    "outputs": [{ "type": "uint8", "name": "" }],
+    "stateMutability": "view",
+    "type": "function"
+  }
+];
 
 // src/abis/Clanker_V3_1.ts
 var Clanker_v3_1_abi = [
@@ -513,9 +523,36 @@ var Clanker = class {
     this.publicClient = config.publicClient;
     this.factoryAddress = config.factoryAddress ?? CLANKER_FACTORY_V3_1;
   }
-  // Get paired token decimals
+  // Fetch token decimals from contract
+  async getTokenDecimals(tokenAddress) {
+    try {
+      const decimals = await readContract(this.publicClient, {
+        address: tokenAddress,
+        abi: ERC20_DECIMALS_ABI,
+        functionName: "decimals"
+      });
+      return decimals;
+    } catch (error) {
+      console.warn(`Failed to fetch decimals for token ${tokenAddress}, defaulting to 18:`, error);
+      return 18;
+    }
+  }
+  // Fallback tick calculation with default price
   calculateTick() {
-    let desiredPrice = 1e-10;
+    const desiredPrice = 1e-10;
+    const logBase = 1.0001;
+    const tickSpacing = 200;
+    const rawTick = Math.log(desiredPrice) / Math.log(logBase);
+    const initialTick = Math.floor(rawTick / tickSpacing) * tickSpacing;
+    return initialTick;
+  }
+  // Calculate tick based on desired market cap and token decimals
+  async calculateTickFromMarketCap(marketCap, quoteToken) {
+    const quoteDecimals = await this.getTokenDecimals(quoteToken);
+    const marketCapBigInt = parseEther(marketCap);
+    const adjustedMarketCap = Number(formatUnits(marketCapBigInt, quoteDecimals));
+    const totalSupply = 1e6;
+    const desiredPrice = adjustedMarketCap / totalSupply;
     const logBase = 1.0001;
     const tickSpacing = 200;
     const rawTick = Math.log(desiredPrice) / Math.log(logBase);
@@ -598,18 +635,20 @@ var Clanker = class {
       throw new Error("Wallet account not configured");
     }
     const deployerAddress = this.wallet.account.address;
+    const quoteToken = config.pool?.quoteToken ?? WETH_ADDRESS;
+    const initialTick = config.pool?.initialMarketCap ? await this.calculateTickFromMarketCap(config.pool.initialMarketCap, quoteToken) : this.calculateTick();
     const deploymentConfig = {
       tokenConfig: {
         name: config.name,
         symbol: config.symbol,
-        salt: config.salt || "0x0000000000000000000000000000000000000000000000000000000000000000",
-        image: config.image || "https://ipfs.io/ipfs/QmcjfTeK3tpK3MVCQuvEaXvSscrqbL3MwsEo8LdBTWabY4",
-        metadata: config.metadata || {
+        salt: config.salt ?? "0x0000000000000000000000000000000000000000000000000000000000000000",
+        image: config.image ?? "https://ipfs.io/ipfs/QmcjfTeK3tpK3MVCQuvEaXvSscrqbL3MwsEo8LdBTWabY4",
+        metadata: config.metadata ?? {
           description: "Clanker Token",
           socialMediaUrls: [],
           auditUrls: []
         },
-        context: config.context || {
+        context: config.context ?? {
           interface: "Clanker SDK",
           platform: "Clanker",
           messageId: "Clanker SDK",
@@ -618,9 +657,9 @@ var Clanker = class {
         originatingChainId: BigInt(this.publicClient.chain.id)
       },
       poolConfig: {
-        pairedToken: WETH_ADDRESS,
-        // WETH on Base
-        initialMarketCapInPairedToken: parseEther("10")
+        pairedToken: quoteToken,
+        initialMarketCapInPairedToken: parseEther(config.pool?.initialMarketCap ?? "10"),
+        initialMarketCap: config.pool?.initialMarketCap
       },
       vaultConfig: config.vault ? {
         vaultPercentage: config.vault.percentage,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clanker-sdk",
-  "version": "3.1.13",
+  "version": "3.2.0",
   "description": "SDK for deploying tokens using Clanker",
   "main": "dist/index.js",
   "module": "dist/index.mjs",