clanker-sdk 4.2.14 → 4.2.15

package/dist/cli/cli.js

@@ -10397,8 +10397,19 @@ async function deployV3(opts, jsonMode) {
 
 // src/cli/commands/rewards.ts
 function registerRewardsCommand(program2) {
-  const rewards = program2.command("rewards").description("Manage LP rewards for a token");
-  rewards.command("claim").description("Claim LP rewards").requiredOption("--token <address>", "token address").option("--recipient <address>", "reward recipient address (defaults to wallet)").action(async (_opts, command) => {
+  const rewards = program2.command("rewards").description("Check and claim creator rewards (LP fees) for a token");
+  rewards.command("claim").description("Claim accumulated fees for a specific reward token (e.g. WETH, USDT)").requiredOption(
+    "--token <address>",
+    "reward token to claim (the fee token address, e.g. WETH \u2014 not the clanker token)"
+  ).option("--recipient <address>", "reward recipient address (defaults to wallet)").addHelpText(
+    "after",
+    `
+Examples:
+  $ clanker rewards claim --token 0x4200000000000000000000000000000000000006
+  $ clanker rewards claim --token 0x4200000000000000000000000000000000000006 --chain bsc
+  $ clanker rewards claim --token <WETH_ADDRESS> --recipient 0xYourAddr --dry-run
+`
+  ).action(async (_opts, command) => {
     const globalOpts = command.parent?.parent?.opts();
     const localOpts = command.opts();
     const jsonMode = globalOpts.json ?? false;
@@ -10423,7 +10434,18 @@ function registerRewardsCommand(program2) {
       process.exit(1);
     }
   });
-  rewards.command("available").description("Check available (claimable) rewards").requiredOption("--token <address>", "token address").option("--recipient <address>", "reward recipient address (defaults to wallet)").action(async (_opts, command) => {
+  rewards.command("available").description("Check claimable fee balance for a specific reward token").requiredOption(
+    "--token <address>",
+    "reward token to check (the fee token address, e.g. WETH \u2014 not the clanker token)"
+  ).option("--recipient <address>", "reward recipient address (defaults to wallet)").addHelpText(
+    "after",
+    `
+Examples:
+  $ clanker rewards available --token 0x4200000000000000000000000000000000000006
+  $ clanker rewards available --token 0x4200000000000000000000000000000000000006 --chain bsc
+  $ clanker rewards available --token <WETH_ADDRESS> --recipient 0xSomeAddr
+`
+  ).action(async (_opts, command) => {
     const globalOpts = command.parent?.parent?.opts();
     const localOpts = command.opts();
     const jsonMode = globalOpts.json ?? false;
@@ -10454,7 +10476,13 @@ function registerRewardsCommand(program2) {
       process.exit(1);
     }
   });
-  rewards.command("info").description("Show reward admins and recipients for a token").requiredOption("--token <address>", "token address").action(async (_opts, command) => {
+  rewards.command("info").description("Show reward admins and recipients for a clanker token").requiredOption("--token <address>", "clanker token address").addHelpText(
+    "after",
+    `
+Example:
+  $ clanker rewards info --token 0xe75785C92cc93938160e0BE449073A1C35521010
+`
+  ).action(async (_opts, command) => {
     const globalOpts = command.parent?.parent?.opts();
     const localOpts = command.opts();
     const jsonMode = globalOpts.json ?? false;
@@ -10472,7 +10500,13 @@ function registerRewardsCommand(program2) {
       process.exit(1);
     }
   });
-  rewards.command("update-recipient").description("Update a reward recipient").requiredOption("--token <address>", "token address").requiredOption("--index <n>", "reward index").requiredOption("--new-recipient <address>", "new recipient address").action(async (_opts, command) => {
+  rewards.command("update-recipient").description("Update who receives rewards for a clanker token").requiredOption("--token <address>", "clanker token address").requiredOption("--index <n>", "reward position index (0-based)").requiredOption("--new-recipient <address>", "new recipient address").addHelpText(
+    "after",
+    `
+Example:
+  $ clanker rewards update-recipient --token 0xClankerToken --index 0 --new-recipient 0xNewAddr
+`
+  ).action(async (_opts, command) => {
     const globalOpts = command.parent?.parent?.opts();
     const localOpts = command.opts();
     const jsonMode = globalOpts.json ?? false;
@@ -10508,7 +10542,13 @@ function registerRewardsCommand(program2) {
       process.exit(1);
     }
   });
-  rewards.command("update-admin").description("Update a reward admin").requiredOption("--token <address>", "token address").requiredOption("--index <n>", "reward index").requiredOption("--new-admin <address>", "new admin address").action(async (_opts, command) => {
+  rewards.command("update-admin").description("Update who can manage rewards for a clanker token").requiredOption("--token <address>", "clanker token address").requiredOption("--index <n>", "reward position index (0-based)").requiredOption("--new-admin <address>", "new admin address").addHelpText(
+    "after",
+    `
+Example:
+  $ clanker rewards update-admin --token 0xClankerToken --index 0 --new-admin 0xNewAdmin
+`
+  ).action(async (_opts, command) => {
     const globalOpts = command.parent?.parent?.opts();
     const localOpts = command.opts();
     const jsonMode = globalOpts.json ?? false;

package/dist/cli/commands/rewards.js

@@ -8084,8 +8084,19 @@ function resolvePublicClient(opts) {
 
 // src/cli/commands/rewards.ts
 function registerRewardsCommand(program) {
-  const rewards = program.command("rewards").description("Manage LP rewards for a token");
-  rewards.command("claim").description("Claim LP rewards").requiredOption("--token <address>", "token address").option("--recipient <address>", "reward recipient address (defaults to wallet)").action(async (_opts, command) => {
+  const rewards = program.command("rewards").description("Check and claim creator rewards (LP fees) for a token");
+  rewards.command("claim").description("Claim accumulated fees for a specific reward token (e.g. WETH, USDT)").requiredOption(
+    "--token <address>",
+    "reward token to claim (the fee token address, e.g. WETH \u2014 not the clanker token)"
+  ).option("--recipient <address>", "reward recipient address (defaults to wallet)").addHelpText(
+    "after",
+    `
+Examples:
+  $ clanker rewards claim --token 0x4200000000000000000000000000000000000006
+  $ clanker rewards claim --token 0x4200000000000000000000000000000000000006 --chain bsc
+  $ clanker rewards claim --token <WETH_ADDRESS> --recipient 0xYourAddr --dry-run
+`
+  ).action(async (_opts, command) => {
     const globalOpts = command.parent?.parent?.opts();
     const localOpts = command.opts();
     const jsonMode = globalOpts.json ?? false;
@@ -8110,7 +8121,18 @@ function registerRewardsCommand(program) {
       process.exit(1);
     }
   });
-  rewards.command("available").description("Check available (claimable) rewards").requiredOption("--token <address>", "token address").option("--recipient <address>", "reward recipient address (defaults to wallet)").action(async (_opts, command) => {
+  rewards.command("available").description("Check claimable fee balance for a specific reward token").requiredOption(
+    "--token <address>",
+    "reward token to check (the fee token address, e.g. WETH \u2014 not the clanker token)"
+  ).option("--recipient <address>", "reward recipient address (defaults to wallet)").addHelpText(
+    "after",
+    `
+Examples:
+  $ clanker rewards available --token 0x4200000000000000000000000000000000000006
+  $ clanker rewards available --token 0x4200000000000000000000000000000000000006 --chain bsc
+  $ clanker rewards available --token <WETH_ADDRESS> --recipient 0xSomeAddr
+`
+  ).action(async (_opts, command) => {
     const globalOpts = command.parent?.parent?.opts();
     const localOpts = command.opts();
     const jsonMode = globalOpts.json ?? false;
@@ -8141,7 +8163,13 @@ function registerRewardsCommand(program) {
       process.exit(1);
     }
   });
-  rewards.command("info").description("Show reward admins and recipients for a token").requiredOption("--token <address>", "token address").action(async (_opts, command) => {
+  rewards.command("info").description("Show reward admins and recipients for a clanker token").requiredOption("--token <address>", "clanker token address").addHelpText(
+    "after",
+    `
+Example:
+  $ clanker rewards info --token 0xe75785C92cc93938160e0BE449073A1C35521010
+`
+  ).action(async (_opts, command) => {
     const globalOpts = command.parent?.parent?.opts();
     const localOpts = command.opts();
     const jsonMode = globalOpts.json ?? false;
@@ -8159,7 +8187,13 @@ function registerRewardsCommand(program) {
       process.exit(1);
     }
   });
-  rewards.command("update-recipient").description("Update a reward recipient").requiredOption("--token <address>", "token address").requiredOption("--index <n>", "reward index").requiredOption("--new-recipient <address>", "new recipient address").action(async (_opts, command) => {
+  rewards.command("update-recipient").description("Update who receives rewards for a clanker token").requiredOption("--token <address>", "clanker token address").requiredOption("--index <n>", "reward position index (0-based)").requiredOption("--new-recipient <address>", "new recipient address").addHelpText(
+    "after",
+    `
+Example:
+  $ clanker rewards update-recipient --token 0xClankerToken --index 0 --new-recipient 0xNewAddr
+`
+  ).action(async (_opts, command) => {
     const globalOpts = command.parent?.parent?.opts();
     const localOpts = command.opts();
     const jsonMode = globalOpts.json ?? false;
@@ -8195,7 +8229,13 @@ function registerRewardsCommand(program) {
       process.exit(1);
     }
   });
-  rewards.command("update-admin").description("Update a reward admin").requiredOption("--token <address>", "token address").requiredOption("--index <n>", "reward index").requiredOption("--new-admin <address>", "new admin address").action(async (_opts, command) => {
+  rewards.command("update-admin").description("Update who can manage rewards for a clanker token").requiredOption("--token <address>", "clanker token address").requiredOption("--index <n>", "reward position index (0-based)").requiredOption("--new-admin <address>", "new admin address").addHelpText(
+    "after",
+    `
+Example:
+  $ clanker rewards update-admin --token 0xClankerToken --index 0 --new-admin 0xNewAdmin
+`
+  ).action(async (_opts, command) => {
     const globalOpts = command.parent?.parent?.opts();
     const localOpts = command.opts();
     const jsonMode = globalOpts.json ?? false;

package/dist/v3/index.d.ts

@@ -877,7 +877,7 @@ declare class Clanker {
         }];
         readonly stateMutability: "view";
         readonly type: "function";
-    }], "renounceOwnership" | "transferOwnership" | "claimRewards" | "deployToken" | "deployTokenWithCustomTeamRewardRecipient" | "deployTokenZeroSupply" | "initialize" | "setAdmin" | "setDeprecated" | "updateLiquidityLocker" | "updateVault"> & {
+    }], "deployToken" | "renounceOwnership" | "transferOwnership" | "updateLiquidityLocker" | "setDeprecated" | "claimRewards" | "setAdmin" | "deployTokenWithCustomTeamRewardRecipient" | "deployTokenZeroSupply" | "initialize" | "updateVault"> & {
         error?: undefined;
     }) | ({
         result?: undefined;
@@ -4519,7 +4519,7 @@ declare class Clanker {
      * @param requestorAddress Requestor for the deployment. Various admins will fall back to this.
      * @returns Abi transaction
      */
-    deploySimulate(token: ClankerTokenV3, account?: Account): Promise<(viem.SimulateContractReturnType<ClankerFactory, "renounceOwnership" | "transferOwnership" | "claimRewards" | "deployToken" | "deployTokenWithCustomTeamRewardRecipient" | "deployTokenZeroSupply" | "initialize" | "setAdmin" | "setDeprecated" | "updateLiquidityLocker" | "updateVault" | "claimTeamFees" | "setExtension" | "setHook" | "setLocker" | "setMevModule" | "setTeamFeeRecipient"> & {
+    deploySimulate(token: ClankerTokenV3, account?: Account): Promise<(viem.SimulateContractReturnType<ClankerFactory, "deployToken" | "renounceOwnership" | "transferOwnership" | "updateLiquidityLocker" | "setDeprecated" | "claimRewards" | "setAdmin" | "deployTokenWithCustomTeamRewardRecipient" | "deployTokenZeroSupply" | "initialize" | "updateVault" | "claimTeamFees" | "setExtension" | "setHook" | "setLocker" | "setMevModule" | "setTeamFeeRecipient"> & {
         error?: undefined;
     }) | ({
         result?: undefined;

package/dist/v4/index.d.ts

@@ -332,7 +332,7 @@ declare class Clanker {
         readonly outputs: readonly [];
         readonly stateMutability: "nonpayable";
         readonly type: "function";
-    }], "addDepositor" | "claim" | "renounceOwnership" | "storeFees" | "transferOwnership"> & {
+    }], "claim" | "renounceOwnership" | "transferOwnership" | "addDepositor" | "storeFees"> & {
         error?: undefined;
     }) | ({
         result?: undefined;
@@ -1507,7 +1507,7 @@ declare class Clanker {
      * @param account Optional account for the deployer
      * @returns Abi transaction
      */
-    deploySimulate(token: ClankerTokenV4, account?: Account): Promise<(viem.SimulateContractReturnType<ClankerFactory, "renounceOwnership" | "transferOwnership" | "claimRewards" | "deployToken" | "deployTokenWithCustomTeamRewardRecipient" | "deployTokenZeroSupply" | "initialize" | "setAdmin" | "setDeprecated" | "updateLiquidityLocker" | "updateVault" | "claimTeamFees" | "setExtension" | "setHook" | "setLocker" | "setMevModule" | "setTeamFeeRecipient"> & {
+    deploySimulate(token: ClankerTokenV4, account?: Account): Promise<(viem.SimulateContractReturnType<ClankerFactory, "deployToken" | "renounceOwnership" | "transferOwnership" | "updateLiquidityLocker" | "setDeprecated" | "claimRewards" | "setAdmin" | "deployTokenWithCustomTeamRewardRecipient" | "deployTokenZeroSupply" | "initialize" | "updateVault" | "claimTeamFees" | "setExtension" | "setHook" | "setLocker" | "setMevModule" | "setTeamFeeRecipient"> & {
         error?: undefined;
     }) | ({
         result?: undefined;

package/package.json

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