clanker-sdk 4.0.21 → 4.0.22

package/README.md

@@ -1,6 +1,6 @@
 # Clanker SDK
 
-The official TypeScript SDK for deploying tokens on Base using Clanker.
+The official TypeScript SDK for deploying tokens using Clanker.
 
 ## Installation
 
@@ -31,12 +31,13 @@ This will guide you through the token deployment process step by step.
 
 1. Create a `.env` file with your configuration:
 ```env
-PRIVATE_KEY=your_private_key_here
-FACTORY_ADDRESS=factory_contract_address_here
+PRIVATE_KEY=<your_private_key_here>
 ```
 
 2. Create a deployment script:
 ```typescript
+// deploy-script.ts
+
 import { Clanker } from 'clanker-sdk';
 import { createPublicClient, createWalletClient, http, PublicClient } from 'viem';
 import { privateKeyToAccount } from 'viem/accounts';
@@ -48,28 +49,23 @@ dotenv.config();
 
 // Validate environment variables
 const PRIVATE_KEY = process.env.PRIVATE_KEY as `0x${string}`;
-const FACTORY_ADDRESS = process.env.FACTORY_ADDRESS as `0x${string}`;
-const RPC_URL = process.env.RPC_URL;
 
-if (!PRIVATE_KEY || !FACTORY_ADDRESS) {
-  throw new Error("Missing required environment variables. Please create a .env file with PRIVATE_KEY and FACTORY_ADDRESS");
+if (!PRIVATE_KEY) {
+  throw new Error("Missing PRIVATE_KEY environment variable.");
 }
 
 // Initialize wallet with private key
 const account = privateKeyToAccount(PRIVATE_KEY);
 
-// Create transport with optional custom RPC
-const transport = RPC_URL ? http(RPC_URL) : http();
-
 const publicClient = createPublicClient({
   chain: base,
-  transport,
+  transport: http(),
 }) as PublicClient;
 
 const wallet = createWalletClient({
   account,
   chain: base,
-  transport,
+  transport: http(),
 });
 
 // Initialize Clanker SDK
@@ -109,7 +105,7 @@ async function deployToken() {
       durationInDays: 30, // 30-day vesting period
     },
     devBuy: {
-      ethAmount: "0", // No initial buy
+      ethAmount: 0, // No initial buy
     },
     rewardsConfig: {
       creatorReward: 75, // 75% creator reward
@@ -141,7 +137,7 @@ deployToken().catch(console.error);
 
 3. Run the deployment script:
 ```bash
-bun examples/deploy.ts
+bun deploy-script.ts
 ```
 
 ## Configuration Options
@@ -178,17 +174,38 @@ See the [examples](./examples) directory for more deployment scenarios:
 - `deploy-token.ts`: Advanced token deployment with all options
 - `deploy-full-sdk.ts`: Full SDK usage example
 
-## Development
+# SDK Development
+
+## Setup
 
+The SDK uses bun for development. Install bun following their instructions here: [https://bun.sh](https://bun.sh).
+
+Once bun is installed, the project is ready for development
 ```bash
 # Install dependencies
 bun i
 
-# Build
-bun run build
+# Run Examples
+# bun <path_to_example>
+bun examples/v4/availableRewards.ts
 
-# Test
+# Run Tests
 bun test
+
+# Lint
+bun lint
+```
+
+Publishing the package
+```bash
+# Log into npm
+bunx npm login
+
+# Dry run publishing
+bun publish-package --dry-run
+
+# Publish
+bun publish-package
 ```
 
 ## License

package/dist/cli/cli.js

@@ -4300,7 +4300,8 @@ var init_Clanker6 = __esm({
 });
 
 // src/utils/clankers.ts
-var CLANKERS;
+import { base as base2, baseSepolia as baseSepolia2 } from "viem/chains";
+var CLANKERS, Chains, ClankerDeployments;
 var init_clankers = __esm({
   "src/utils/clankers.ts"() {
     "use strict";
@@ -4313,38 +4314,89 @@ var init_clankers = __esm({
     init_Clanker6();
     CLANKERS = {
       clanker_v0: {
-        // @note - this is a same as `proxy` in legacy uses
         abi: Clanker_v0_abi,
+        chainId: base2.id,
         type: "proxy",
-        address: "0x250c9FB2b411B48273f69879007803790A6AeA47"
+        address: "0x250c9FB2b411B48273f69879007803790A6AeA47",
+        related: void 0
       },
       clanker_v1: {
-        // @note - this is a same as `clanker` in legacy uses
         abi: Clanker_v1_abi,
+        chainId: base2.id,
         type: "clanker",
-        address: "0x9B84fcE5Dcd9a38d2D01d5D72373F6b6b067c3e1"
+        address: "0x9B84fcE5Dcd9a38d2D01d5D72373F6b6b067c3e1",
+        related: void 0
       },
       clanker_v2: {
         abi: Clanker_v2_abi,
+        chainId: base2.id,
         type: "clanker_v2",
-        address: "0x732560fa1d1A76350b1A500155BA978031B53833"
+        address: "0x732560fa1d1A76350b1A500155BA978031B53833",
+        related: {
+          locker: "0x618A9840691334eE8d24445a4AdA4284Bf42417D"
+        }
       },
       clanker_v3: {
         abi: Clanker_v3_abi,
+        chainId: base2.id,
         type: "clanker_v3",
-        address: "0x375C15db32D28cEcdcAB5C03Ab889bf15cbD2c5E"
+        address: "0x375C15db32D28cEcdcAB5C03Ab889bf15cbD2c5E",
+        related: {
+          locker: "0x5eC4f99F342038c67a312a166Ff56e6D70383D86"
+        }
       },
       clanker_v3_1: {
         abi: Clanker_v3_1_abi,
+        chainId: base2.id,
         type: "clanker_v3_1",
-        address: "0x2A787b2362021cC3eEa3C24C4748a6cD5B687382"
+        address: "0x2A787b2362021cC3eEa3C24C4748a6cD5B687382",
+        related: {
+          locker: "0x33e2Eda238edcF470309b8c6D228986A1204c8f9",
+          vault: "0x42A95190B4088C88Dd904d930c79deC1158bF09D"
+        }
       },
       clanker_v4: {
         abi: Clanker_v4_abi,
+        chainId: base2.id,
         type: "clanker_v4",
-        address: "0xE85A59c628F7d27878ACeB4bf3b35733630083a9"
+        address: "0xE85A59c628F7d27878ACeB4bf3b35733630083a9",
+        related: {
+          locker: "0x29d17C1A8D851d7d4cA97FAe97AcAdb398D9cCE0",
+          vault: "0x8E845EAd15737bF71904A30BdDD3aEE76d6ADF6C",
+          airdrop: "0x56Fa0Da89eD94822e46734e736d34Cab72dF344F",
+          devbuy: "0x1331f0788F9c08C8F38D52c7a1152250A9dE00be",
+          mevModule: "0xE143f9872A33c955F23cF442BB4B1EFB3A7402A2",
+          feeLocker: "0xF3622742b1E446D92e45E22923Ef11C2fcD55D68",
+          feeStaticHook: "0xDd5EeaFf7BD481AD55Db083062b13a3cdf0A68CC",
+          feeDynamicHook: "0x34a45c6B61876d739400Bd71228CbcbD4F53E8cC"
+        }
+      },
+      clanker_v4_sepolia: {
+        abi: Clanker_v4_abi,
+        chainId: baseSepolia2.id,
+        type: "clanker_v4",
+        address: "0xE85A59c628F7d27878ACeB4bf3b35733630083a9",
+        related: {
+          locker: "0x33e2Eda238edcF470309b8c6D228986A1204c8f9",
+          vault: "0xcC80d1226F899a78fC2E459a1500A13C373CE0A5",
+          airdrop: "0x29d17C1A8D851d7d4cA97FAe97AcAdb398D9cCE0",
+          devbuy: "0x691f97752E91feAcD7933F32a1FEdCeDae7bB59c",
+          mevModule: "0x71DB365E93e170ba3B053339A917c11024e7a9d4",
+          feeLocker: "0x42A95190B4088C88Dd904d930c79deC1158bF09D",
+          feeStaticHook: "0x3eC2a26b6eF16c288561692AE8D9681fa773A8cc",
+          feeDynamicHook: "0xE63b0A59100698f379F9B577441A561bAF9828cc"
+        }
       }
     };
+    Chains = [...new Set(Object.values(CLANKERS).map(({ chainId }) => chainId))];
+    ClankerDeployments = Object.values(CLANKERS).reduce(
+      (agg, cur) => {
+        if (!agg[cur.chainId]) agg[cur.chainId] = {};
+        agg[cur.chainId][cur.type] = cur;
+        return agg;
+      },
+      {}
+    );
   }
 });
 
@@ -4761,7 +4813,7 @@ import {
   parseEventLogs as parseEventLogs2
 } from "viem";
 import { call } from "viem/actions";
-import { base as base2 } from "viem/chains";
+import { base as base3 } from "viem/chains";
 function buildTokenV4(cfg, chainId, salt) {
   const feeConfig = cfg.feeConfig;
   const { hook, poolData } = encodeFeeConfig(feeConfig);
@@ -4856,6 +4908,7 @@ function buildTokenV4(cfg, chainId, salt) {
     args: [deploymentConfig]
   });
   return {
+    type: "v4",
     transaction: {
       to: CLANKER_FACTORY_V4,
       data: deployCalldata,
@@ -4891,7 +4944,7 @@ async function withVanityAddress(cfg, chainId) {
   };
 }
 async function simulateDeploy(cfg, account, publicClient) {
-  const chain = publicClient.chain || base2;
+  const chain = publicClient.chain || base3;
   const { transaction } = "transaction" in cfg ? cfg : buildTokenV4(cfg, chain.id);
   try {
     const { data } = await call(publicClient, {
@@ -5010,10 +5063,10 @@ var init_v4 = __esm({
   }
 });
 
-// src/abi/ClankerFeeLocker.ts
+// src/abi/v4/ClankerFeeLocker.ts
 var ClankerFeeLocker_abi;
 var init_ClankerFeeLocker = __esm({
-  "src/abi/ClankerFeeLocker.ts"() {
+  "src/abi/v4/ClankerFeeLocker.ts"() {
     "use strict";
     init_esm_shims();
     ClankerFeeLocker_abi = [
@@ -5022,6 +5075,8 @@ var init_ClankerFeeLocker = __esm({
         stateMutability: "nonpayable",
         type: "constructor"
       },
+      { inputs: [], name: "ClaimAmountTooHigh", type: "error" },
+      { inputs: [], name: "InvalidRecipient", type: "error" },
       { inputs: [], name: "NoFeesToClaim", type: "error" },
       {
         inputs: [{ internalType: "address", name: "owner", type: "address" }],
@@ -5039,6 +5094,7 @@ var init_ClankerFeeLocker = __esm({
         name: "SafeERC20FailedOperation",
         type: "error"
       },
+      { inputs: [], name: "TransferFailed", type: "error" },
       { inputs: [], name: "Unauthorized", type: "error" },
       {
         anonymous: false,
@@ -5195,8 +5251,84 @@ var init_availableFees = __esm({
   }
 });
 
+// src/utils/errors.ts
+import { BaseError, ContractFunctionRevertedError, InsufficientFundsError } from "viem";
+var ClankerError, ErrorMapping, understandError;
+var init_errors = __esm({
+  "src/utils/errors.ts"() {
+    "use strict";
+    init_esm_shims();
+    ClankerError = class _ClankerError extends Error {
+      constructor(error, data) {
+        super(data.label);
+        this.error = error;
+        this.data = data;
+      }
+      static unknown(e, name) {
+        return new _ClankerError(e, {
+          type: "unknown",
+          label: "Something went wrong",
+          rawName: name || "unknown"
+        });
+      }
+    };
+    ErrorMapping = {
+      NoFeesToClaim: {
+        type: "state",
+        label: "No fees to claim",
+        rawName: "NoFeesToClaim"
+      }
+    };
+    understandError = (e) => {
+      if (!(e instanceof Error)) return ClankerError.unknown(new Error(`${e}`));
+      if (!(e instanceof BaseError)) return ClankerError.unknown(e);
+      const revertError = e.walk((e2) => e2 instanceof ContractFunctionRevertedError);
+      if (revertError instanceof ContractFunctionRevertedError) {
+        const errorName = revertError.data?.errorName ?? "";
+        const mapping = ErrorMapping[errorName];
+        if (!mapping) return ClankerError.unknown(e, errorName);
+        return new ClankerError(e, mapping);
+      }
+      const fundsError = e.walk((e2) => e2 instanceof InsufficientFundsError);
+      if (fundsError instanceof InsufficientFundsError) {
+        return new ClankerError(fundsError, {
+          type: "caller",
+          label: "Insufficient funds.",
+          rawName: "InsufficientFundsError"
+        });
+      }
+      return ClankerError.unknown(e);
+    };
+  }
+});
+
+// src/utils/write-clanker-contracts.ts
+import { simulateContract, writeContract } from "viem/actions";
+var writeClankerContract;
+var init_write_clanker_contracts = __esm({
+  "src/utils/write-clanker-contracts.ts"() {
+    "use strict";
+    init_esm_shims();
+    init_errors();
+    writeClankerContract = async (client, wallet, tx, options) => {
+      if (options?.simulate) {
+        try {
+          await simulateContract(client, tx);
+        } catch (e) {
+          return { txHash: void 0, error: understandError(e) };
+        }
+      }
+      try {
+        const txHash = await writeContract(wallet, tx);
+        return { txHash, error: void 0 };
+      } catch (e) {
+        return { txHash: void 0, error: understandError(e) };
+      }
+    };
+  }
+});
+
 // src/fees/claim.ts
-import { encodeFunctionData as encodeFunctionData3 } from "viem";
 var claimRewards;
 var init_claim = __esm({
   "src/fees/claim.ts"() {
@@ -5204,18 +5336,19 @@ var init_claim = __esm({
     init_esm_shims();
     init_ClankerFeeLocker();
     init_constants();
-    claimRewards = (feeOwnerAddress, tokenAddress) => {
-      const claimRewardsCalldata = encodeFunctionData3({
-        abi: ClankerFeeLocker_abi,
-        functionName: "claim",
-        args: [feeOwnerAddress, tokenAddress]
-      });
-      return {
-        transaction: {
-          to: CLANKER_FEE_LOCKER_V4,
-          data: claimRewardsCalldata
-        }
-      };
+    init_write_clanker_contracts();
+    claimRewards = async (client, wallet, feeOwnerAddress, tokenAddress, options) => {
+      return writeClankerContract(
+        client,
+        wallet,
+        {
+          address: CLANKER_FEE_LOCKER_V4,
+          abi: ClankerFeeLocker_abi,
+          functionName: "claim",
+          args: [feeOwnerAddress, tokenAddress]
+        },
+        options
+      );
     };
   }
 });
@@ -5223,7 +5356,7 @@ var init_claim = __esm({
 // src/utils/validation-schema.ts
 import { isAddress as isAddress2, isHex } from "viem";
 import { z } from "zod";
-var isHexRefinement, isAddressRefinement, clankerConfigSchema, tokenConfigSchema, vaultConfigSchema, poolConfigSchema, initialBuyConfigSchema, rewardsConfigSchema, deploymentConfigSchema;
+var isHexRefinement, isAddressRefinement, tokenConfigSchema, vaultConfigSchema, poolConfigSchema, initialBuyConfigSchema, rewardsConfigSchema, deploymentConfigSchema;
 var init_validation_schema = __esm({
   "src/utils/validation-schema.ts"() {
     "use strict";
@@ -5231,10 +5364,6 @@ var init_validation_schema = __esm({
     init_validation();
     isHexRefinement = (val) => isHex(val);
     isAddressRefinement = (val) => isAddress2(val);
-    clankerConfigSchema = z.object({
-      publicClient: z.any().optional(),
-      wallet: z.any().optional()
-    });
     tokenConfigSchema = z.object({
       name: z.string().min(1, "Name is required"),
       symbol: z.string().min(1, "Symbol is required"),
@@ -5361,9 +5490,6 @@ function validateConfig(config2) {
   if (typeof config2 === "object" && config2 !== null && "pairedTokenPoolFee" in config2 && "pairedTokenSwapAmountOutMinimum" in config2) {
     return initialBuyConfigSchema.safeParse(config2);
   }
-  if (typeof config2 === "object" && config2 !== null && "publicClient" in config2) {
-    return clankerConfigSchema.safeParse(config2);
-  }
   return {
     success: false,
     error: {
@@ -5493,33 +5619,27 @@ var init_index = __esm({
     init_v4();
     init_availableFees();
     init_claim();
-    init_validation();
     init_builders();
     init_constants();
     init_extensions();
     init_vanityAddress();
     init_types();
+    init_clankers();
     init_merkleTree();
     init_validation();
     Clanker = class {
       wallet;
       publicClient;
+      simulate;
       /**
        * Creates a new instance of the Clanker SDK
        * @param config - Optional configuration object containing wallet and public client
        * @throws {Error} If the provided configuration is invalid
        */
       constructor(config2) {
-        if (config2) {
-          const validationResult = validateConfig(config2);
-          if (!validationResult.success) {
-            throw new Error(
-              `Invalid Clanker configuration: ${JSON.stringify(validationResult.error?.format())}`
-            );
-          }
-          this.wallet = config2.wallet;
-          this.publicClient = config2.publicClient;
-        }
+        this.wallet = config2?.wallet;
+        this.publicClient = config2?.publicClient;
+        this.simulate = !!config2?.simulateBeforeWrite;
       }
       /**
        * Collects rewards from a token
@@ -5527,8 +5647,12 @@ var init_index = __esm({
        * @returns Promise resolving to the transaction hash
        * @throws {Error} If wallet client or public client is not configured
        */
-      claimRewards(feeOwnerAddress, tokenAddress) {
-        return claimRewards(feeOwnerAddress, tokenAddress);
+      async claimRewards(feeOwnerAddress, tokenAddress) {
+        if (!this.wallet) throw new Error("Wallet client required");
+        if (!this.publicClient) throw new Error("Public client required");
+        return claimRewards(this.publicClient, this.wallet, feeOwnerAddress, tokenAddress, {
+          simulate: this.simulate
+        });
       }
       /**
        * Checks the available fees for a token
@@ -5537,22 +5661,12 @@ var init_index = __esm({
        * @returns Promise resolving to the transaction hash
        * @throws {Error} If wallet client or public client is not configured
        */
-      async availableFees(feeOwnerAddress, tokenAddress) {
+      async availableRewards(feeOwnerAddress, tokenAddress) {
         if (!this.publicClient) {
           throw new Error("Public client required for checking available fees");
         }
         return availableFees(this.publicClient, feeOwnerAddress, tokenAddress);
       }
-      /**
-       * Builds V4 token deployment data without actually deploying
-       * @param cfg - Token configuration for V4 deployment
-       * @returns Object containing transaction data, target address, and network info
-       */
-      buildV4(cfg) {
-        const chainId = this.publicClient?.chain?.id || 8453;
-        const result = buildTokenV4(cfg, chainId);
-        return result;
-      }
       /**
        * Generates a vanity address for a V4 token deployment
        * @param cfg - Token configuration for V4 deployment
@@ -5569,45 +5683,29 @@ var init_index = __esm({
        * @returns Promise resolving to the address of the deployed token
        * @throws {Error} If wallet client or public client is not configured
        */
-      async simulateDeployTokenV4(cfg, account) {
+      async simulateDeployToken(cfg, account) {
         const acc = account || this.wallet?.account;
-        if (!acc) {
-          throw new Error("Account or wallet client required for simulation");
-        }
-        if (!this.publicClient) {
-          throw new Error("Public client required for deployment");
-        }
+        if (!acc) throw new Error("Account or wallet client required for simulation");
+        if (!this.publicClient) throw new Error("Public client required for deployment");
         return simulateDeploy(cfg, acc, this.publicClient);
       }
       /**
-       * Deploys a token using the V4 protocol
-       * @param cfg - Token configuration for V4 deployment or pre-built deployment data
-       * @returns Promise resolving to the address of the deployed token
-       * @throws {Error} If wallet client or public client is not configured
-       */
-      async deployTokenV4(cfg) {
-        if (!this.wallet) {
-          throw new Error("Wallet client required for deployment");
-        }
-        if (!this.publicClient) {
-          throw new Error("Public client required for deployment");
-        }
-        return deployTokenV4(cfg, this.wallet, this.publicClient);
-      }
-      /**
-       * Deploys a token using the V3 protocol
+       * Deploys a token
        * @param cfg - Token configuration for V3 deployment
        * @returns Promise resolving to the address of the deployed token
        * @throws {Error} If wallet client or public client is not configured
        */
       async deployToken(cfg) {
-        if (!this.wallet) {
-          throw new Error("Wallet client required for deployment");
-        }
-        if (!this.publicClient) {
-          throw new Error("Public client required for deployment");
+        if (!this.wallet) throw new Error("Wallet client required for deployment");
+        if (!this.publicClient) throw new Error("Public client required for deployment");
+        switch (cfg.type) {
+          case "v4":
+            return deployTokenV4(cfg, this.wallet, this.publicClient);
+          case "v3":
+            return deployTokenV3(cfg, this.wallet, this.publicClient);
+          default:
+            throw new Error("Invalid config type");
         }
-        return deployTokenV3(cfg, this.wallet, this.publicClient);
       }
     };
   }
@@ -5629,7 +5727,7 @@ import {
   http
 } from "viem";
 import { privateKeyToAccount } from "viem/accounts";
-import { base as base3 } from "viem/chains";
+import { base as base4 } from "viem/chains";
 async function createClanker() {
   const PRIVATE_KEY = process.env.PRIVATE_KEY;
   const FACTORY_ADDRESS = process.env.FACTORY_ADDRESS;
@@ -6010,12 +6108,12 @@ RPC_URL=your_custom_rpc_url (if not provided, will use default Base RPC)
     try {
       const transport = RPC_URL ? http(RPC_URL) : http();
       const publicClient = createPublicClient({
-        chain: base3,
+        chain: base4,
         transport
       });
       const walletClient = createWalletClient({
         account,
-        chain: base3,
+        chain: base4,
         transport
       });
       const clanker = new Clanker({
@@ -6025,6 +6123,7 @@ RPC_URL=your_custom_rpc_url (if not provided, will use default Base RPC)
       console.log("\n\u{1F504} Preparing deployment configuration...");
       const quoteToken = answers.pairedTokenChoice === "WETH" ? WETH_ADDRESS2 : answers.pairedTokenChoice === "USDC" ? USDC_ADDRESS : answers.customPairedToken;
       const tokenConfig = {
+        type: "v3",
         name: answers.name,
         symbol: answers.symbol,
         image: answers.image,
@@ -6048,8 +6147,7 @@ RPC_URL=your_custom_rpc_url (if not provided, will use default Base RPC)
           durationInDays: parseInt(answers.vaultConfig.durationInDays, 10)
         } : void 0,
         devBuy: answers.devBuy.ethAmount !== "0" ? {
-          ethAmount: Number(answers.devBuy.ethAmount),
-          maxSlippage: answers.devBuy.maxSlippage
+          ethAmount: Number(answers.devBuy.ethAmount)
         } : void 0,
         rewardsConfig: {
           creatorReward: answers.rewardsConfig.creatorReward === "CUSTOM" ? Number(answers.rewardsConfig.customCreatorReward) : Number(answers.rewardsConfig.creatorReward),