clanker-sdk 3.6.0 → 3.8.0

package/dist/index.d.mts

@@ -78,8 +78,14 @@ interface IClankerSocialContext {
     id?: string;
 }
 
+/** Lightweight container for a pre-built deploy transaction */
+type PreparedDeployTx = {
+    to: Address;
+    data: `0x${string}`;
+    value: bigint;
+};
 declare class Clanker {
-    private readonly wallet;
+    private readonly wallet?;
     private readonly factoryAddress;
     private readonly publicClient;
     constructor(config: ClankerConfig);
@@ -89,12 +95,10 @@ declare class Clanker {
     private calculateTickForQuoteToken;
     private handleError;
     deploy(config: DeploymentConfig): Promise<Address>;
-    /**
-     * Simplified token deployment method for easier user experience
-     * @param config Simple configuration for token deployment
-     * @returns Deployed token address
-     */
-    deployToken(config: SimpleTokenConfig): Promise<Address>;
+    private buildDeploymentConfig;
+    /** Creates calldata + value without asking the wallet to sign/send. */
+    prepareDeployToken(cfg: SimpleTokenConfig): Promise<PreparedDeployTx>;
+    deployToken(cfg: SimpleTokenConfig): Promise<Address>;
 }
 
-export { Clanker, type ClankerConfig, type DeploymentConfig, type IClankerMetadata, type IClankerSocialContext, type InitialBuyConfig, type PoolConfig, type RewardsConfig, type SimpleTokenConfig, type TokenConfig, type VaultConfig };
+export { Clanker, type ClankerConfig, type DeploymentConfig, type IClankerMetadata, type IClankerSocialContext, type InitialBuyConfig, type PoolConfig, type PreparedDeployTx, type RewardsConfig, type SimpleTokenConfig, type TokenConfig, type VaultConfig };

package/dist/index.d.ts

@@ -78,8 +78,14 @@ interface IClankerSocialContext {
     id?: string;
 }
 
+/** Lightweight container for a pre-built deploy transaction */
+type PreparedDeployTx = {
+    to: Address;
+    data: `0x${string}`;
+    value: bigint;
+};
 declare class Clanker {
-    private readonly wallet;
+    private readonly wallet?;
     private readonly factoryAddress;
     private readonly publicClient;
     constructor(config: ClankerConfig);
@@ -89,12 +95,10 @@ declare class Clanker {
     private calculateTickForQuoteToken;
     private handleError;
     deploy(config: DeploymentConfig): Promise<Address>;
-    /**
-     * Simplified token deployment method for easier user experience
-     * @param config Simple configuration for token deployment
-     * @returns Deployed token address
-     */
-    deployToken(config: SimpleTokenConfig): Promise<Address>;
+    private buildDeploymentConfig;
+    /** Creates calldata + value without asking the wallet to sign/send. */
+    prepareDeployToken(cfg: SimpleTokenConfig): Promise<PreparedDeployTx>;
+    deployToken(cfg: SimpleTokenConfig): Promise<Address>;
 }
 
-export { Clanker, type ClankerConfig, type DeploymentConfig, type IClankerMetadata, type IClankerSocialContext, type InitialBuyConfig, type PoolConfig, type RewardsConfig, type SimpleTokenConfig, type TokenConfig, type VaultConfig };
+export { Clanker, type ClankerConfig, type DeploymentConfig, type IClankerMetadata, type IClankerSocialContext, type InitialBuyConfig, type PoolConfig, type PreparedDeployTx, type RewardsConfig, type SimpleTokenConfig, type TokenConfig, type VaultConfig };

package/dist/index.js

@@ -684,7 +684,7 @@ var Clanker = class {
     throw new Error(`Deployment failed: ${message}`);
   }
   async deploy(config) {
-    if (!this.wallet.account) {
+    if (!this.wallet?.account) {
       throw new Error("Wallet account not configured");
     }
     try {
@@ -749,33 +749,32 @@ var Clanker = class {
       this.handleError(error);
     }
   }
-  /**
-   * Simplified token deployment method for easier user experience
-   * @param config Simple configuration for token deployment
-   * @returns Deployed token address
-   */
-  async deployToken(config) {
-    if (!this.wallet.account) {
-      throw new Error("Wallet account not configured");
-    }
-    const deployerAddress = this.wallet.account.address;
-    const quoteToken = config.pool?.quoteToken ?? WETH_ADDRESS;
+  async buildDeploymentConfig(cfg) {
+    const quoteToken = cfg.pool?.quoteToken ?? WETH_ADDRESS;
     const quoteDecimals = await this.getQuoteTokenDecimals(quoteToken);
     console.log("Quote token decimals:", quoteDecimals);
+    const marketCap = (0, import_viem.parseUnits)(
+      cfg.pool?.initialMarketCap ?? "100",
+      quoteDecimals
+    );
+    const tick = await this.calculateTickForQuoteToken(
+      quoteToken,
+      marketCap
+    );
     let initialBuyConfig = {
       pairedTokenPoolFee: 1e4,
       // Default to 1%
       pairedTokenSwapAmountOutMinimum: BigInt(0),
       ethAmount: void 0
     };
-    if (config.devBuy) {
-      const ethAmount = (0, import_viem.parseEther)(config.devBuy.ethAmount);
+    if (cfg.devBuy) {
+      const ethAmount = (0, import_viem.parseEther)(cfg.devBuy.ethAmount);
       const { fee, sqrtPriceX96 } = await this.findMostLiquidPool(quoteToken);
       const minOutput = this.calculateMinimumOutput(
         ethAmount,
         sqrtPriceX96,
         quoteDecimals,
-        config.devBuy.maxSlippage ?? 5
+        cfg.devBuy.maxSlippage ?? 5
       );
       initialBuyConfig = {
         pairedTokenPoolFee: fee,
@@ -783,41 +782,43 @@ var Clanker = class {
         ethAmount
       };
       console.log("Dev buy configuration:", {
-        ethAmount: config.devBuy.ethAmount,
+        ethAmount: cfg.devBuy.ethAmount,
         fee,
         minOutput: minOutput.toString()
       });
     }
-    const deploymentConfig = {
+    const deployerAddress = this.wallet?.account?.address ?? "0x0000000000000000000000000000000000000000";
+    return {
       tokenConfig: {
-        name: config.name,
-        symbol: config.symbol,
-        salt: config.salt || "0x0000000000000000000000000000000000000000000000000000000000000000",
-        image: config.image || "https://ipfs.io/ipfs/QmcjfTeK3tpK3MVCQuvEaXvSscrqbL3MwsEo8LdBTWabY4",
-        metadata: config.metadata || {
+        name: cfg.name,
+        symbol: cfg.symbol,
+        salt: cfg.salt || "0x0000000000000000000000000000000000000000000000000000000000000000",
+        image: cfg.image || "https://ipfs.io/ipfs/QmcjfTeK3tpK3MVCQuvEaXvSscrqbL3MwsEo8LdBTWabY4",
+        metadata: JSON.stringify(cfg.metadata || {
           description: "Clanker Token",
           socialMediaUrls: [],
           auditUrls: []
-        },
-        context: config.context || {
+        }),
+        context: JSON.stringify(cfg.context || {
           interface: "Clanker SDK",
           platform: "Clanker",
           messageId: "Clanker SDK",
           id: "Clanker SDK"
-        },
+        }),
         originatingChainId: BigInt(this.publicClient.chain.id)
       },
       poolConfig: {
         pairedToken: quoteToken,
-        initialMarketCapInPairedToken: (0, import_viem.parseUnits)(
-          config.pool?.initialMarketCap ?? "100",
-          quoteDecimals
-        )
+        tickIfToken0IsNewToken: tick,
+        initialMarketCapInPairedToken: marketCap
+      },
+      vaultConfig: cfg.vault ? {
+        vaultPercentage: cfg.vault.percentage,
+        vaultDuration: BigInt(cfg.vault.durationInDays * 24 * 60 * 60)
+      } : {
+        vaultPercentage: 0,
+        vaultDuration: 0n
       },
-      vaultConfig: config.vault ? {
-        vaultPercentage: config.vault.percentage,
-        vaultDuration: BigInt(config.vault.durationInDays * 24 * 60 * 60)
-      } : void 0,
       initialBuyConfig,
       rewardsConfig: {
         creatorReward: BigInt(40),
@@ -828,7 +829,43 @@ var Clanker = class {
         interfaceRewardRecipient: deployerAddress
       }
     };
-    return this.deploy(deploymentConfig);
+  }
+  /** Creates calldata + value without asking the wallet to sign/send. */
+  async prepareDeployToken(cfg) {
+    const deploymentConfig = await this.buildDeploymentConfig(cfg);
+    const { request } = await (0, import_actions.simulateContract)(this.publicClient, {
+      address: this.factoryAddress,
+      abi: Clanker_v3_1_abi,
+      functionName: "deployToken",
+      args: [deploymentConfig],
+      value: deploymentConfig.initialBuyConfig?.ethAmount ?? 0n,
+      chain: this.publicClient.chain,
+      // give Viem *some* account for simulation
+      account: this.wallet?.account ?? deploymentConfig.rewardsConfig.creatorAdmin
+    });
+    return {
+      to: this.factoryAddress,
+      data: request.data,
+      value: request.value ?? 0n
+    };
+  }
+  async deployToken(cfg) {
+    if (!this.wallet) throw new Error("Wallet client required for deployToken");
+    if (!this.wallet.account) throw new Error("Wallet account required for deployToken");
+    const tx = await this.prepareDeployToken(cfg);
+    const hash = await this.wallet.sendTransaction({
+      ...tx,
+      account: this.wallet.account,
+      chain: this.publicClient.chain
+    });
+    const receipt = await this.publicClient.waitForTransactionReceipt({ hash });
+    const [log] = (0, import_viem.parseEventLogs)({
+      abi: Clanker_v3_1_abi,
+      eventName: "TokenCreated",
+      logs: receipt.logs
+    });
+    if (!log) throw new Error("No deployment event found");
+    return log.args.tokenAddress;
   }
 };
 // Annotate the CommonJS export names for ESM import in node:

package/dist/index.mjs

@@ -665,7 +665,7 @@ var Clanker = class {
     throw new Error(`Deployment failed: ${message}`);
   }
   async deploy(config) {
-    if (!this.wallet.account) {
+    if (!this.wallet?.account) {
       throw new Error("Wallet account not configured");
     }
     try {
@@ -730,33 +730,32 @@ var Clanker = class {
       this.handleError(error);
     }
   }
-  /**
-   * Simplified token deployment method for easier user experience
-   * @param config Simple configuration for token deployment
-   * @returns Deployed token address
-   */
-  async deployToken(config) {
-    if (!this.wallet.account) {
-      throw new Error("Wallet account not configured");
-    }
-    const deployerAddress = this.wallet.account.address;
-    const quoteToken = config.pool?.quoteToken ?? WETH_ADDRESS;
+  async buildDeploymentConfig(cfg) {
+    const quoteToken = cfg.pool?.quoteToken ?? WETH_ADDRESS;
     const quoteDecimals = await this.getQuoteTokenDecimals(quoteToken);
     console.log("Quote token decimals:", quoteDecimals);
+    const marketCap = parseUnits(
+      cfg.pool?.initialMarketCap ?? "100",
+      quoteDecimals
+    );
+    const tick = await this.calculateTickForQuoteToken(
+      quoteToken,
+      marketCap
+    );
     let initialBuyConfig = {
       pairedTokenPoolFee: 1e4,
       // Default to 1%
       pairedTokenSwapAmountOutMinimum: BigInt(0),
       ethAmount: void 0
     };
-    if (config.devBuy) {
-      const ethAmount = parseEther(config.devBuy.ethAmount);
+    if (cfg.devBuy) {
+      const ethAmount = parseEther(cfg.devBuy.ethAmount);
       const { fee, sqrtPriceX96 } = await this.findMostLiquidPool(quoteToken);
       const minOutput = this.calculateMinimumOutput(
         ethAmount,
         sqrtPriceX96,
         quoteDecimals,
-        config.devBuy.maxSlippage ?? 5
+        cfg.devBuy.maxSlippage ?? 5
       );
       initialBuyConfig = {
         pairedTokenPoolFee: fee,
@@ -764,41 +763,43 @@ var Clanker = class {
         ethAmount
       };
       console.log("Dev buy configuration:", {
-        ethAmount: config.devBuy.ethAmount,
+        ethAmount: cfg.devBuy.ethAmount,
         fee,
         minOutput: minOutput.toString()
       });
     }
-    const deploymentConfig = {
+    const deployerAddress = this.wallet?.account?.address ?? "0x0000000000000000000000000000000000000000";
+    return {
       tokenConfig: {
-        name: config.name,
-        symbol: config.symbol,
-        salt: config.salt || "0x0000000000000000000000000000000000000000000000000000000000000000",
-        image: config.image || "https://ipfs.io/ipfs/QmcjfTeK3tpK3MVCQuvEaXvSscrqbL3MwsEo8LdBTWabY4",
-        metadata: config.metadata || {
+        name: cfg.name,
+        symbol: cfg.symbol,
+        salt: cfg.salt || "0x0000000000000000000000000000000000000000000000000000000000000000",
+        image: cfg.image || "https://ipfs.io/ipfs/QmcjfTeK3tpK3MVCQuvEaXvSscrqbL3MwsEo8LdBTWabY4",
+        metadata: JSON.stringify(cfg.metadata || {
           description: "Clanker Token",
           socialMediaUrls: [],
           auditUrls: []
-        },
-        context: config.context || {
+        }),
+        context: JSON.stringify(cfg.context || {
           interface: "Clanker SDK",
           platform: "Clanker",
           messageId: "Clanker SDK",
           id: "Clanker SDK"
-        },
+        }),
         originatingChainId: BigInt(this.publicClient.chain.id)
       },
       poolConfig: {
         pairedToken: quoteToken,
-        initialMarketCapInPairedToken: parseUnits(
-          config.pool?.initialMarketCap ?? "100",
-          quoteDecimals
-        )
+        tickIfToken0IsNewToken: tick,
+        initialMarketCapInPairedToken: marketCap
+      },
+      vaultConfig: cfg.vault ? {
+        vaultPercentage: cfg.vault.percentage,
+        vaultDuration: BigInt(cfg.vault.durationInDays * 24 * 60 * 60)
+      } : {
+        vaultPercentage: 0,
+        vaultDuration: 0n
       },
-      vaultConfig: config.vault ? {
-        vaultPercentage: config.vault.percentage,
-        vaultDuration: BigInt(config.vault.durationInDays * 24 * 60 * 60)
-      } : void 0,
       initialBuyConfig,
       rewardsConfig: {
         creatorReward: BigInt(40),
@@ -809,7 +810,43 @@ var Clanker = class {
         interfaceRewardRecipient: deployerAddress
       }
     };
-    return this.deploy(deploymentConfig);
+  }
+  /** Creates calldata + value without asking the wallet to sign/send. */
+  async prepareDeployToken(cfg) {
+    const deploymentConfig = await this.buildDeploymentConfig(cfg);
+    const { request } = await simulateContract(this.publicClient, {
+      address: this.factoryAddress,
+      abi: Clanker_v3_1_abi,
+      functionName: "deployToken",
+      args: [deploymentConfig],
+      value: deploymentConfig.initialBuyConfig?.ethAmount ?? 0n,
+      chain: this.publicClient.chain,
+      // give Viem *some* account for simulation
+      account: this.wallet?.account ?? deploymentConfig.rewardsConfig.creatorAdmin
+    });
+    return {
+      to: this.factoryAddress,
+      data: request.data,
+      value: request.value ?? 0n
+    };
+  }
+  async deployToken(cfg) {
+    if (!this.wallet) throw new Error("Wallet client required for deployToken");
+    if (!this.wallet.account) throw new Error("Wallet account required for deployToken");
+    const tx = await this.prepareDeployToken(cfg);
+    const hash = await this.wallet.sendTransaction({
+      ...tx,
+      account: this.wallet.account,
+      chain: this.publicClient.chain
+    });
+    const receipt = await this.publicClient.waitForTransactionReceipt({ hash });
+    const [log] = parseEventLogs({
+      abi: Clanker_v3_1_abi,
+      eventName: "TokenCreated",
+      logs: receipt.logs
+    });
+    if (!log) throw new Error("No deployment event found");
+    return log.args.tokenAddress;
   }
 };
 export {

package/package.json

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