clanker-sdk 3.1.13 → 3.3.0

package/dist/index.d.mts

@@ -16,6 +16,8 @@ interface VaultConfig {
 interface PoolConfig {
     pairedToken: Address;
     initialMarketCapInPairedToken: bigint;
+    initialMarketCap?: string;
+    tickIfToken0IsNewToken: number;
 }
 interface InitialBuyConfig {
     pairedTokenPoolFee: 10000;
@@ -28,6 +30,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 +51,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 +78,8 @@ declare class Clanker {
     private readonly factoryAddress;
     private readonly publicClient;
     constructor(config: ClankerConfig);
-    private calculateTick;
+    private getQuoteTokenDecimals;
+    private calculateTickForQuoteToken;
     private handleError;
     deploy(config: DeploymentConfig): Promise<Address>;
     /**

package/dist/index.d.ts

@@ -16,6 +16,8 @@ interface VaultConfig {
 interface PoolConfig {
     pairedToken: Address;
     initialMarketCapInPairedToken: bigint;
+    initialMarketCap?: string;
+    tickIfToken0IsNewToken: number;
 }
 interface InitialBuyConfig {
     pairedTokenPoolFee: 10000;
@@ -28,6 +30,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 +51,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 +78,8 @@ declare class Clanker {
     private readonly factoryAddress;
     private readonly publicClient;
     constructor(config: ClankerConfig);
-    private calculateTick;
+    private getQuoteTokenDecimals;
+    private calculateTickForQuoteToken;
     private handleError;
     deploy(config: DeploymentConfig): Promise<Address>;
     /**

package/dist/index.js

@@ -524,6 +524,15 @@ var Clanker_v3_1_abi = [
 ];
 
 // src/index.ts
+var ERC20_DECIMALS_ABI = [
+  {
+    inputs: [],
+    name: "decimals",
+    outputs: [{ type: "uint8", name: "" }],
+    stateMutability: "view",
+    type: "function"
+  }
+];
 var Clanker = class {
   wallet;
   factoryAddress;
@@ -533,13 +542,47 @@ var Clanker = class {
     this.publicClient = config.publicClient;
     this.factoryAddress = config.factoryAddress ?? CLANKER_FACTORY_V3_1;
   }
-  // Get paired token decimals
-  calculateTick() {
-    let desiredPrice = 1e-10;
+  // Get quote token decimals
+  async getQuoteTokenDecimals(quoteToken) {
+    try {
+      const decimals = await (0, import_actions.readContract)(this.publicClient, {
+        address: quoteToken,
+        abi: ERC20_DECIMALS_ABI,
+        functionName: "decimals"
+      });
+      return decimals;
+    } catch (error) {
+      console.warn(`Failed to fetch decimals for quote token ${quoteToken}, defaulting to 18:`, error);
+      return 18;
+    }
+  }
+  // Calculate tick based on quote token and token ordering
+  async calculateTickForQuoteToken(quoteToken, marketCap) {
+    const quoteDecimals = await this.getQuoteTokenDecimals(quoteToken);
+    console.log("Quote token decimals:", quoteDecimals);
+    const tokenDecimals = 18;
+    const totalSupply = BigInt(1e11) * BigInt(10) ** BigInt(tokenDecimals);
+    const priceInQuoteToken = Number(marketCap) / Number(totalSupply);
+    console.log("Price in quote token:", priceInQuoteToken);
+    console.log("Market cap in quote token units:", Number(marketCap) / 10 ** quoteDecimals);
     const logBase = 1.0001;
     const tickSpacing = 200;
-    const rawTick = Math.log(desiredPrice) / Math.log(logBase);
+    const dummyTokenAddress = "0xffffffffffffffffffffffffffffffffffffffff";
+    const isToken0 = dummyTokenAddress.toLowerCase() < quoteToken.toLowerCase();
+    console.log("Is new token token0?", isToken0);
+    const priceForTick = isToken0 ? priceInQuoteToken : 1 / priceInQuoteToken;
+    let rawTick = Math.floor(Math.log(priceForTick) / Math.log(logBase));
+    if (!isToken0) {
+      rawTick = -rawTick;
+    }
+    console.log("Raw tick (before spacing):", rawTick);
     const initialTick = Math.floor(rawTick / tickSpacing) * tickSpacing;
+    console.log("Final tick (rounded to spacing):", initialTick);
+    const actualPrice = Math.pow(logBase, isToken0 ? initialTick : -initialTick);
+    console.log("Actual price from tick:", actualPrice);
+    const finalPrice = isToken0 ? actualPrice : 1 / actualPrice;
+    const actualMarketCap = finalPrice * Number(totalSupply) / Math.pow(10, tokenDecimals);
+    console.log("Actual market cap in quote token:", actualMarketCap);
     return initialTick;
   }
   handleError(error) {
@@ -552,6 +595,10 @@ var Clanker = class {
     }
     try {
       const rewardsConfig = config.rewardsConfig;
+      const tick = await this.calculateTickForQuoteToken(
+        config.poolConfig.pairedToken,
+        config.poolConfig.initialMarketCapInPairedToken
+      );
       const deploymentData = {
         tokenConfig: {
           name: config.tokenConfig.name,
@@ -568,7 +615,7 @@ var Clanker = class {
         },
         poolConfig: {
           pairedToken: config.poolConfig.pairedToken,
-          tickIfToken0IsNewToken: this.calculateTick()
+          tickIfToken0IsNewToken: tick
         },
         initialBuyConfig: {
           pairedTokenPoolFee: config.initialBuyConfig?.pairedTokenPoolFee ?? 1e4,
@@ -587,7 +634,7 @@ var Clanker = class {
         abi: Clanker_v3_1_abi,
         functionName: "deployToken",
         args: [deploymentData],
-        value: config.initialBuyConfig?.pairedTokenSwapAmountOutMinimum || BigInt(0),
+        value: BigInt(0),
         chain: this.publicClient.chain,
         account: this.wallet.account
       });
@@ -618,6 +665,9 @@ var Clanker = class {
       throw new Error("Wallet account not configured");
     }
     const deployerAddress = this.wallet.account.address;
+    const quoteToken = config.pool?.quoteToken ?? WETH_ADDRESS;
+    const quoteDecimals = await this.getQuoteTokenDecimals(quoteToken);
+    console.log("Quote token decimals:", quoteDecimals);
     const deploymentConfig = {
       tokenConfig: {
         name: config.name,
@@ -638,9 +688,10 @@ 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.parseUnits)(config.pool?.initialMarketCap ?? "10", quoteDecimals),
+        tickIfToken0IsNewToken: 0
+        // Will be calculated in deploy() based on quote token
       },
       vaultConfig: config.vault ? {
         vaultPercentage: config.vault.percentage,

package/dist/index.mjs

@@ -1,10 +1,10 @@
 // src/index.ts
 import {
-  parseEther,
+  parseUnits,
   stringify,
   parseEventLogs
 } from "viem";
-import { simulateContract, writeContract } from "viem/actions";
+import { simulateContract, writeContract, readContract } from "viem/actions";
 
 // src/constants.ts
 var WETH_ADDRESS = "0x4200000000000000000000000000000000000006";
@@ -504,6 +504,15 @@ var Clanker_v3_1_abi = [
 ];
 
 // src/index.ts
+var ERC20_DECIMALS_ABI = [
+  {
+    inputs: [],
+    name: "decimals",
+    outputs: [{ type: "uint8", name: "" }],
+    stateMutability: "view",
+    type: "function"
+  }
+];
 var Clanker = class {
   wallet;
   factoryAddress;
@@ -513,13 +522,47 @@ var Clanker = class {
     this.publicClient = config.publicClient;
     this.factoryAddress = config.factoryAddress ?? CLANKER_FACTORY_V3_1;
   }
-  // Get paired token decimals
-  calculateTick() {
-    let desiredPrice = 1e-10;
+  // Get quote token decimals
+  async getQuoteTokenDecimals(quoteToken) {
+    try {
+      const decimals = await readContract(this.publicClient, {
+        address: quoteToken,
+        abi: ERC20_DECIMALS_ABI,
+        functionName: "decimals"
+      });
+      return decimals;
+    } catch (error) {
+      console.warn(`Failed to fetch decimals for quote token ${quoteToken}, defaulting to 18:`, error);
+      return 18;
+    }
+  }
+  // Calculate tick based on quote token and token ordering
+  async calculateTickForQuoteToken(quoteToken, marketCap) {
+    const quoteDecimals = await this.getQuoteTokenDecimals(quoteToken);
+    console.log("Quote token decimals:", quoteDecimals);
+    const tokenDecimals = 18;
+    const totalSupply = BigInt(1e11) * BigInt(10) ** BigInt(tokenDecimals);
+    const priceInQuoteToken = Number(marketCap) / Number(totalSupply);
+    console.log("Price in quote token:", priceInQuoteToken);
+    console.log("Market cap in quote token units:", Number(marketCap) / 10 ** quoteDecimals);
     const logBase = 1.0001;
     const tickSpacing = 200;
-    const rawTick = Math.log(desiredPrice) / Math.log(logBase);
+    const dummyTokenAddress = "0xffffffffffffffffffffffffffffffffffffffff";
+    const isToken0 = dummyTokenAddress.toLowerCase() < quoteToken.toLowerCase();
+    console.log("Is new token token0?", isToken0);
+    const priceForTick = isToken0 ? priceInQuoteToken : 1 / priceInQuoteToken;
+    let rawTick = Math.floor(Math.log(priceForTick) / Math.log(logBase));
+    if (!isToken0) {
+      rawTick = -rawTick;
+    }
+    console.log("Raw tick (before spacing):", rawTick);
     const initialTick = Math.floor(rawTick / tickSpacing) * tickSpacing;
+    console.log("Final tick (rounded to spacing):", initialTick);
+    const actualPrice = Math.pow(logBase, isToken0 ? initialTick : -initialTick);
+    console.log("Actual price from tick:", actualPrice);
+    const finalPrice = isToken0 ? actualPrice : 1 / actualPrice;
+    const actualMarketCap = finalPrice * Number(totalSupply) / Math.pow(10, tokenDecimals);
+    console.log("Actual market cap in quote token:", actualMarketCap);
     return initialTick;
   }
   handleError(error) {
@@ -532,6 +575,10 @@ var Clanker = class {
     }
     try {
       const rewardsConfig = config.rewardsConfig;
+      const tick = await this.calculateTickForQuoteToken(
+        config.poolConfig.pairedToken,
+        config.poolConfig.initialMarketCapInPairedToken
+      );
       const deploymentData = {
         tokenConfig: {
           name: config.tokenConfig.name,
@@ -548,7 +595,7 @@ var Clanker = class {
         },
         poolConfig: {
           pairedToken: config.poolConfig.pairedToken,
-          tickIfToken0IsNewToken: this.calculateTick()
+          tickIfToken0IsNewToken: tick
         },
         initialBuyConfig: {
           pairedTokenPoolFee: config.initialBuyConfig?.pairedTokenPoolFee ?? 1e4,
@@ -567,7 +614,7 @@ var Clanker = class {
         abi: Clanker_v3_1_abi,
         functionName: "deployToken",
         args: [deploymentData],
-        value: config.initialBuyConfig?.pairedTokenSwapAmountOutMinimum || BigInt(0),
+        value: BigInt(0),
         chain: this.publicClient.chain,
         account: this.wallet.account
       });
@@ -598,6 +645,9 @@ var Clanker = class {
       throw new Error("Wallet account not configured");
     }
     const deployerAddress = this.wallet.account.address;
+    const quoteToken = config.pool?.quoteToken ?? WETH_ADDRESS;
+    const quoteDecimals = await this.getQuoteTokenDecimals(quoteToken);
+    console.log("Quote token decimals:", quoteDecimals);
     const deploymentConfig = {
       tokenConfig: {
         name: config.name,
@@ -618,9 +668,10 @@ var Clanker = class {
         originatingChainId: BigInt(this.publicClient.chain.id)
       },
       poolConfig: {
-        pairedToken: WETH_ADDRESS,
-        // WETH on Base
-        initialMarketCapInPairedToken: parseEther("10")
+        pairedToken: quoteToken,
+        initialMarketCapInPairedToken: parseUnits(config.pool?.initialMarketCap ?? "10", quoteDecimals),
+        tickIfToken0IsNewToken: 0
+        // Will be calculated in deploy() based on quote token
       },
       vaultConfig: config.vault ? {
         vaultPercentage: config.vault.percentage,

package/package.json

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