feat: added Clanker typescript action support by gtspencer · Pull Request #825 · coinbase/agentkit

gtspencer · 2025-08-14T16:42:45Z

Clanker Action Provider

Description

This action adds Clanker token deployment support to the typescript implementation of AgentKit.

Although Clanker already has an agent that deploys tokens, their open library and protocol allows anyone to launch a "Clank" token and be recognized by their ecosystem.

Tests

Chatbot: langchain-cdp-chatbot
Network: Base Mainnet
Setup: Add ClankerActionProvider to the chatbot

Prompt: Can you clank a token with name [CDP Clanker], and symbol [CDPC] and image hosted at [https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQF6hcTTU1A8Ymi2VldXqCsPkBu_ltAhIKiRg&s]?  vest 10%, locked for 30 days, and then vested for 30 days.  do this on base-mainnet

Response:
-------------------
Internal address: 0xE8D165388b13c460F02f4dC922309450a9bF6f22
Clanker token deployed at 0x15E91EAF0848c8FEfE8c287923B5A78E254A76eb!  View the transaction at 0xf67befc5da942288a7bb4baee2cbbc1a09853e62552e736aa272b91e09f918fa
-------------------
The Clanker token has been successfully deployed with the name "CDP Clanker" and symbol "CDPC." You can view the transaction [here](https://etherscan.io/tx/0xf67befc5da942288a7bb4baee2cbbc1a09853e62552e736aa272b91e09f918fa). The token address is 0x15E91EAF0848c8FEfE8c287923B5A78E254A76eb.
-------------------

Checklist

A couple of things to include in your PR for completeness:

Added documentation to all relevant README.md files
Added a changelog entry

cb-heimdall · 2025-08-14T16:42:50Z

✅ Heimdall Review Status

Requirement Status More Info

Reviews

✅ 1/1

Denominator calculation

Show calculation

1 if user is bot 0

1 if user is external 0

2 if repo is sensitive 0

From .codeflow.yml 1

Additional review requirements

Show calculation

Max	0

0

From CODEOWNERS 0

Global minimum 0

Max 1

1

1 if commit is unverified 0

Sum 1

Accident

phdargen · 2025-09-01T05:35:56Z

+/**
+ * Clanker Action Provider
+ *
+ * This file contains the implementation of the ClankerActionProvider,
+ * which provides actions for clanker operations.
+ *
+ * @module clanker
+ */
+


Please remove in accordance with code style elsewhere

phdargen · 2025-09-01T05:36:58Z

+   * @returns True if the network is supported
+   */
+  supportsNetwork(network: Network): boolean {
+    // all protocol networks


remove comment

phdargen · 2025-09-01T05:37:26Z

+/**
+ * Exports for clanker action provider
+ *
+ * @module clanker
+ */
+


please remove

phdargen · 2025-09-01T05:37:36Z

+
+// depending on usage, you might export the factory like this:
+// export { clankerActionProviderFactory } from "./clankerActionProvider";


remove this too

phdargen · 2025-09-01T05:40:33Z

+  tokenName: z.string().min(1).max(100),
+
+  /**
+   * Symbol of token (lets keep it short <= 10)
+   */
+  tokenSymbol: z.string().min(1).max(10),


out of curiosity, are the max character limits enforced by the protocol/sdk or a choice by you?

Enforced by me, happy to remove it!

phdargen · 2025-09-01T05:42:29Z

+ * @param networkId - The network to Clank on (this will most likely be Base, unless the action implementation is extended to include other networks)
+ * @returns The Clanker implementation
+ */
+export async function makeClanker(walletProvider: EvmWalletProvider, networkId: string) {


please rename makeClanker -> createClankerClient

The "clankerBridge" notation is also misleading, please move the file utils/clankerBridge.ts -> utils.ts

phdargen · 2025-09-01T05:44:17Z

+  const wallet = createWalletClient({
+    account,
+    chain: NETWORK_ID_TO_VIEM_CHAIN[networkId],
+    transport: http(),


This should use transport as configured in walletProvider:

Suggested change

transport: http(),

transport: http(publicClient.transport.url)

phdargen · 2025-09-01T05:57:23Z

+
+      expect(makeClankerMock).toHaveBeenCalledWith(expect.any(Object), expect.any(String));
+    });
+  });


Missing dedicated supportsNetwork test block like other providers

describe("supportsNetwork", () => { it("should return true for base-mainnet with evm protocol", () => { expect(provider.supportsNetwork({ protocolFamily: "evm", networkId: "base-mainnet" })).toBe(true); }); it("should return false for non-base networks", () => { expect(provider.supportsNetwork({ protocolFamily: "evm", networkId: "ethereum-mainnet" })).toBe(false); }); });

phdargen · 2025-09-01T06:05:07Z

+    description: `
+This tool will launch a token (called a Clanker, named after the token launch protocol).
+Clanker tokens can only be launched when your network ID is 'base-mainnet'.
+  `,


Description is too brief and misses important details. Suggestion:

Suggested change

description: `

This tool will launch a token (called a Clanker, named after the token launch protocol).

Clanker tokens can only be launched when your network ID is 'base-mainnet'.

`,

description: `

This tool will launch a Clanker token using the Clanker SDK.

It takes the following inputs:

- tokenName: The name of the deployed token

- tokenSymbol: The symbol of the deployed token

- image: A normal or ipfs URL pointing to the image of the token

- vaultPercentage: The percentage of the token supply to allocate to a vault accessible to the deployed after the lockup period with optional vesting

- lockDuration_Days: The lock duration of the tokens in the vault (in days) (minimum 7 days)

- vestingDuration_Days: The duration (in days) that the token should vest after lockup period, vesting is linear.

`,

phdargen · 2025-09-01T06:10:35Z

+    const res = await clanker.deploy(tokenConfig);
+
+    if ("error" in res) {
+      return `There was an error deploying the clanker token: ${res}`;
+    }
+
+    const { txHash } = res;
+
+    const confirmed = await res.waitForTransaction();
+    if ("error" in confirmed) {
+      return `There was an error confirming the clanker token deployment: ${confirmed}`;
+    }


Please wrap main logic in try-catch

phdargen · 2025-09-01T06:11:55Z

+
+    const { address } = confirmed;
+
+    return `Clanker token deployed at ${address}!  View the transaction at ${txHash}`;


Could add link to deployed coin here, https://clanker.world/clanker/

phdargen · 2025-09-01T06:20:02Z

+export const ClankTokenSchema = z.object({
+  /**
+   * Name of token
+   */
+  tokenName: z.string().min(1).max(100),
+
+  /**
+   * Symbol of token (lets keep it short <= 10)
+   */
+  tokenSymbol: z.string().min(1).max(10),
+
+  /**
+   * String URL pointing to image
+   */
+  image: z.string().url(),
+
+  /**
+   * Percentage of token for deployer initially locked


Please remove all the TSDoc comments and use describe() on the Zod fields instead. Suggestion:

Suggested change

export const ClankTokenSchema = z.object({

/**

* Name of token

*/

tokenName: z.string().min(1).max(100),

/**

* Symbol of token (lets keep it short <= 10)

*/

tokenSymbol: z.string().min(1).max(10),

/**

* String URL pointing to image

*/

image: z.string().url(),

/**

* Percentage of token for deployer initially locked

export const ClankTokenSchema = z

.object({

tokenName: z.string().min(1).max(100).describe("The name of the token (max 100 characters)"),

tokenSymbol: z.string().min(1).max(10).describe("The symbol of the token (max 10 characters)"),

image: z.string().url().describe("Normal or ipfs URL pointing to the token image"),

vaultPercentage: z.number().min(0).max(99).describe("Percentage of token supply allocated to a vault that can be claimed by deployer after lockup period with optional vesting"),

lockDuration_Days: z.number().min(7).describe("Lockup duration of token (in days), minimum 7 days"),

vestingDuration_Days: z.number().min(0).describe("Vesting duration of token after lockup has passed (in days). Vesting is linear over the duration"),

})

.strip()

.describe("Instructions for deploying a Clanker token");

phdargen · 2025-09-01T06:37:33Z

+  /**
+   * Percentage of token for deployer initially locked
+   */
+  vestingPercentage: z.number().min(0).max(99),


Seems max percentage for vault is 90%, not 99%. See: https://github.com/clanker-devco/clanker-sdk/blob/e82ee2af17301012a1d32c21e215068a84fba590/src/config/clankerTokenV4.ts#L125C1-L126C1.

Notation "vestingPercentage" also misleading, should be vaultPercentage

phdargen · 2025-09-01T06:55:05Z

+ * Creates the client Clanker expects from the EvmWalletProvider
+ *
+ * @param walletProvider - The wallet provider instance for blockchain interactions
+ * @param networkId - The network to Clank on (this will most likely be Base, unless the action implementation is extended to include other networks)


remove "(this will most likely be Base, unless the action implementation is extended to include other networks)"

phdargen · 2025-09-01T07:27:33Z

+    const tokenConfig = {
+      name: args.tokenName,
+      symbol: args.tokenSymbol,
+      image: args.image,


Please add optional metadata field with description and socialMediaUrls, see https://www.npmjs.com/package/clanker-sdk and https://github.com/clanker-devco/clanker-sdk/blob/e82ee2af17301012a1d32c21e215068a84fba590/src/utils/zod-onchain.ts#L7.

phdargen · 2025-09-01T07:28:42Z

+      symbol: args.tokenSymbol,
+      image: args.image,
+      context: {
+        interface: "Clanker SDK",


add optional arg to shemas to set interface, should default to "CDP AgentKit"

phdargen · 2025-09-01T07:29:28Z

+        platform: "Clanker",
+        messageId: "Deploy Example",
+        id: "TKN-1",


should also be optional args, not hardcoded. Can default to "".

phdargen · 2025-09-01T07:37:38Z

Hi @gtspencer, thanks for your contribution. That's a great addition! Please have a look at my comments above, hope we can get this in soon

Note: Please avoid force-pushing all your code changes into the same commit. Instead, push new commits so I can review what changed more easily.

phdargen · 2025-09-01T07:56:18Z

+├── schemas.ts                      # Action schemas and types
+├── index.ts                        # Package exports
+├── utils/
+│   ├── clankerBridge.ts            # Helprs to wrap the EVMWalletProvider in the type the Clanker SDK expects


Helprs -> Helpers

gtspencer · 2025-09-02T22:04:17Z

hey @phdargen , just made those requested changes! let me know if there's anything else!

phdargen · 2025-09-03T12:09:16Z

+├── utils/
+│   ├── clankerBridge.ts            # Helpers to wrap the EVMWalletProvider in the type the Clanker SDK expects


-> utils.ts

phdargen · 2025-09-03T12:09:49Z

+      tokenName: "Test Token",
+      tokenSymbol: "TT",
+      image: "https://test.com/image.png",
+      vestingPercentage: 10,


-> vaultPercentage

phdargen · 2025-09-03T13:16:17Z

+  supportsNetwork(network: Network): boolean {
+    return network.protocolFamily === "evm" && network.networkId == "base-mainnet";
+  }


Lets include all supported networks:

Suggested change

supportsNetwork(network: Network): boolean {

return network.protocolFamily === "evm" && network.networkId == "base-mainnet";

}

supportsNetwork = (network: Network) =>

network.networkId === "base-mainnet" || network.networkId === "base-sepolia" || network.networkId === "arbitrum-mainnet";

phdargen · 2025-09-03T13:22:58Z

+      description: args.description,
+      socialMediaUrls: args.socialMediaUrls,


needs to be wrapped in metadata field:

Suggested change

description: args.description,

socialMediaUrls: args.socialMediaUrls,

metadata: {

description: args.description,

socialMediaUrls: args.socialMediaUrls,

},

phdargen · 2025-09-03T13:23:40Z

+        percentage: args.vaultPercentage,
+        lockupDuration: lockDuration,
+        vestingDuration: vestingDuration,
+      },


add:
chainId: Number(network.chainId) as 8453 | 84532 | 42161 | undefined,

phdargen · 2025-09-03T13:24:50Z

+    if (!networkId || networkId !== "base-mainnet") {
+      return `Can't Clank token; network must be Base Mainnet`;
+    }


please change to:

Suggested change

if (!networkId || networkId !== "base-mainnet") {

return `Can't Clank token; network must be Base Mainnet`;

}

if (!this.supportsNetwork(network)) {

return `Can't Clank token; network ${networkId} is not supported`;

}

phdargen · 2025-09-03T13:25:58Z

+#### Example
+```
+Prompt: Can you clank a token with name [CDP Clanker], and symbol [CDPC] and image hosted at [https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcQF6hcTTU1A8Ymi2VldXqCsPkBu_ltAhIKiRg&s]?  vest 10%, locked for 30 days, and then vested for 30 days.  do this on base-mainnet
+```
+
+```
+-------------------
+Internal address: 0xE8D165388b13c460F02f4dC922309450a9bF6f22
+Clanker token deployed at 0x15E91EAF0848c8FEfE8c287923B5A78E254A76eb!  View the transaction at 0xf67befc5da942288a7bb4baee2cbbc1a09853e62552e736aa272b91e09f918fa
+-------------------
+The Clanker token has been successfully deployed with the name "CDP Clanker" and symbol "CDPC." You can view the transaction [here](https://etherscan.io/tx/0xf67befc5da942288a7bb4baee2cbbc1a09853e62552e736aa272b91e09f918fa). The token address is 0x15E91EAF0848c8FEfE8c287923B5A78E254A76eb.
+-------------------
+```


not needed here, please remove

phdargen · 2025-09-03T13:30:25Z

Hi @gtspencer, thanks for the update!

The action failed in my test as the tokenConfig format is wrong, see above.
Otherwise, lets add some more supported networks (see above), then this should be good to go

gtspencer · 2025-09-04T15:39:24Z

@phdargen apologies, should have caught those sooner! Just updated and think its good to go!

phdargen · 2025-09-05T10:20:29Z

No worries @gtspencer, thanks for the quick fixes!

This is reviewed and tested @CarsonRoscoe

@phdargen apologies, should have caught those sooner! Just updated and think its good to go!

CarsonRoscoe

Thank you @gtspencer for the contribution! And thanks @phdargen for the review.

This looks good to me!

gtspencer requested a review from murrlincoln as a code owner August 14, 2025 16:42

github-actions Bot added documentation Improvements or additions to documentation action provider New action provider typescript labels Aug 14, 2025

gtspencer force-pushed the feat/clanker-action-module branch 3 times, most recently from be629f1 to 97da2b1 Compare August 15, 2025 15:17

CarsonRoscoe previously approved these changes Aug 15, 2025

View reviewed changes

gtspencer force-pushed the feat/clanker-action-module branch from 94e3d49 to cc79e82 Compare August 20, 2025 18:14

feat: clanker typescript action provider

c059efc

gtspencer force-pushed the feat/clanker-action-module branch from 28d2442 to c059efc Compare August 21, 2025 17:26

phdargen reviewed Sep 1, 2025

View reviewed changes

gtspencer added 2 commits September 2, 2025 17:56

requested changes

56d17f4

fix tests

09ff73c

phdargen reviewed Sep 3, 2025

View reviewed changes

fix config format and readme

2945d10

CarsonRoscoe approved these changes Sep 5, 2025

View reviewed changes

CarsonRoscoe merged commit c55cefa into coinbase:main Sep 5, 2025
25 checks passed

github-actions Bot mentioned this pull request Sep 5, 2025

chore: version typescript packages #745

Open

CarsonRoscoe mentioned this pull request Sep 5, 2025

chore: version typescript packages #837

Merged


		// depending on usage, you might export the factory like this:
		// export { clankerActionProviderFactory } from "./clankerActionProvider";

	transport: http(),
	transport: http(publicClient.transport.url)

-    description: `
-This tool will launch a token (called a Clanker, named after the token launch protocol).
-Clanker tokens can only be launched when your network ID is 'base-mainnet'.
-  `,
+    description: `
+This tool will launch a Clanker token using the Clanker SDK.
+It takes the following inputs:
+- tokenName: The name of the deployed token
+- tokenSymbol: The symbol of the deployed token
+- image: A normal or ipfs URL pointing to the image of the token
+- vaultPercentage: The percentage of the token supply to allocate to a vault accessible to the deployed after the lockup period with optional vesting
+- lockDuration_Days: The lock duration of the tokens in the vault (in days) (minimum 7 days)
+- vestingDuration_Days: The duration (in days) that the token should vest after lockup period, vesting is linear.
+  `,


		const { address } = confirmed;

		return `Clanker token deployed at ${address}! View the transaction at ${txHash}`;

		├── utils/
		│ ├── clankerBridge.ts # Helpers to wrap the EVMWalletProvider in the type the Clanker SDK expects

		description: args.description,
		socialMediaUrls: args.socialMediaUrls,

Conversation

gtspencer commented Aug 14, 2025

Clanker Action Provider

Description

Tests

Checklist

Uh oh!

cb-heimdall commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Heimdall Review Status

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

phdargen Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

phdargen Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

phdargen Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

phdargen commented Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gtspencer commented Sep 2, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

phdargen commented Sep 3, 2025

Uh oh!

gtspencer commented Sep 4, 2025

Uh oh!

phdargen commented Sep 5, 2025

Uh oh!

cb-heimdall commented Aug 14, 2025 •

edited

Loading

phdargen Sep 1, 2025 •

edited

Loading

phdargen Sep 1, 2025 •

edited

Loading

phdargen Sep 1, 2025 •

edited

Loading

phdargen commented Sep 1, 2025 •

edited

Loading