Crossmint Balance API Plugin

typescript/examples/vercel-ai/crossmint-smart-wallets/package.json

@@ -10,11 +10,11 @@
     "author": "",
     "license": "MIT",
     "dependencies": {
-        "@ai-sdk/openai": "^1.0.4",
+        "@ai-sdk/openai": "^1.0.13",
         "@goat-sdk/adapter-vercel-ai": "workspace:*",
         "@goat-sdk/core": "workspace:*",
-        "@goat-sdk/plugin-erc20": "workspace:*",
         "@goat-sdk/crossmint": "workspace:*",
+        "@goat-sdk/plugin-erc20": "workspace:*",
         "@goat-sdk/wallet-evm": "workspace:*",
         "ai": "catalog:",
         "dotenv": "^16.4.5",

typescript/examples/vercel-ai/viem/index.ts

@@ -36,4 +36,4 @@ const walletClient = createWalletClient({
     });
 
     console.log(result.text);
-})();
+})();

typescript/examples/vercel-ai/viem/package.json

@@ -20,4 +20,4 @@
         "dotenv": "^16.4.5",
         "viem": "2.21.49"
     }
-}
+}

typescript/packages/wallets/crossmint/src/currencies.ts

@@ -0,0 +1,36 @@
+export const SOLANA_SUPPORTED_CURRENCIES = ["eurc", "bonk", "wif", "mother", "sol", "usdc"] as const;
+
+export const EVM_SUPPORTED_CURRENCIES = [
+    "eth",
+    "matic",
+    "pol",
+    "chz",
+    "avax",
+    "xai",
+    "fuel",
+    "vic",
+    "usdc",
+    "usdce",
+    "busd",
+    "usdxm",
+    "weth",
+    "degen",
+    "brett",
+    "toshi",
+    "eurc",
+    "bnb",
+    "sfuel",
+] as const;
+
+export const OTHER_CHAIN_SUPPORTED_CURRENCIES = ["sui", "sei", "ada", "apt"] as const;
+
+export const SUPPORTED_CURRENCIES = [
+    ...EVM_SUPPORTED_CURRENCIES,
+    ...SOLANA_SUPPORTED_CURRENCIES,
+    ...OTHER_CHAIN_SUPPORTED_CURRENCIES,
+] as const;
+
+export type SupportedEVMCurrency = (typeof EVM_SUPPORTED_CURRENCIES)[number];
+export type SupportedSolanaCurrency = (typeof SOLANA_SUPPORTED_CURRENCIES)[number];
+export type SupportedOtherCurrency = (typeof OTHER_CHAIN_SUPPORTED_CURRENCIES)[number];
+export type SupportedCurrency = (typeof SUPPORTED_CURRENCIES)[number];

typescript/packages/wallets/crossmint/src/index.ts

@@ -1,7 +1,8 @@
 import { CrossmintApiClient } from "@crossmint/common-sdk-base";
-import { faucetPlugin, mintPlugin } from "./plugins";
+import { balancePlugin, faucetPlugin, mintPlugin } from "./plugins";
 import { walletsPlugin } from "./plugins/wallets.plugin";
 import { custodialFactory, smartWalletFactory } from "./wallets";
+
 function crossmint(apiKey: string) {
     const apiClient = new CrossmintApiClient(
         {
@@ -21,6 +22,7 @@ function crossmint(apiKey: string) {
         custodial: custodialFactory(apiClient),
         smartwallet: smartWalletFactory(apiClient),
         faucet: faucetPlugin(apiClient),
+        balance: balancePlugin(apiClient),
         mint: mintPlugin(apiClient),
         wallets: walletsPlugin(apiClient),
     };

typescript/packages/wallets/crossmint/src/plugins/balance.plugin.ts

@@ -0,0 +1,19 @@
+import type { CrossmintApiClient } from "@crossmint/common-sdk-base";
+import { Chain, PluginBase, WalletClientBase } from "@goat-sdk/core";
+import { TokenBalanceService } from "./balance.service";
+
+export class BalancePlugin extends PluginBase<WalletClientBase> {
+    constructor(client: CrossmintApiClient) {
+        super("balance", [new TokenBalanceService(client)]);
+    }
+
+    supportsChain(chain: Chain) {
+        return chain.type === "evm" || chain.type === "solana" || chain.type === "sui" || chain.type === "aptos";
+    }
+}
+
+export function balancePlugin(client: CrossmintApiClient) {
+    return () => {
+        return new BalancePlugin(client);
+    };
+}

typescript/packages/wallets/crossmint/src/plugins/balance.service.ts

@@ -0,0 +1,65 @@
+import { CrossmintApiClient } from "@crossmint/common-sdk-base";
+import { Tool, WalletClientBase, createToolParameters } from "@goat-sdk/core";
+import { EVMWalletClient } from "@goat-sdk/wallet-evm";
+import { z } from "zod";
+import { SUPPORTED_CURRENCIES } from "../currencies";
+
+export class TokenBalanceParameters extends createToolParameters(
+    z.object({
+        wallet: z.string().describe("The address to get balances for"),
+        currencies: z.array(z.enum(SUPPORTED_CURRENCIES)).min(1).describe("The currencies to get balances for"),
+        chains: z.array(z.string()).optional().describe("The specific chains to query"),
+    }),
+) {}
+
+export interface TokenBalance {
+    currency: string;
+    decimals: number;
+    balances: {
+        [chain: string]: string;
+        total: string;
+    };
+}
+
+export interface GetWalletBalanceResponse {
+    balances: TokenBalance[];
+}
+
+export class TokenBalanceService {
+    constructor(private readonly client: CrossmintApiClient) {}
+
+    @Tool({
+        description: "Get the token balances of the current wallet",
+    })
+    async getBalance(walletClient: WalletClientBase, parameters: TokenBalanceParameters) {
+        const wallet = parameters.wallet ?? walletClient.getAddress();
+
+        let resolvedWalletAddress: string;
+        if (walletClient instanceof EVMWalletClient) {
+            resolvedWalletAddress = await walletClient.resolveAddress(wallet);
+        } else {
+            resolvedWalletAddress = wallet;
+        }
+
+        const queryParams = new URLSearchParams();
+        queryParams.append("currencies", parameters.currencies.join(","));
+
+        if (parameters.chains && parameters.chains.length > 0) {
+            queryParams.append("chains", parameters.chains.join(","));
+        }
+
+        const endpoint = `/api/v1-alpha2/wallets/${encodeURIComponent(resolvedWalletAddress)}/balances`;
+        const url = `${this.client.baseUrl}${endpoint}${queryParams.toString() ? `?${queryParams}` : ""}`;
+
+        const response = await fetch(url, {
+            method: "GET",
+            headers: this.client.authHeaders,
+        });
+
+        if (!response.ok) {
+            throw new Error(`Failed to get balances: ${await response.text()}`);
+        }
+
+        return (await response.json()) as GetWalletBalanceResponse;
+    }
+}

typescript/packages/wallets/crossmint/src/plugins/index.ts

@@ -1,2 +1,3 @@
 export * from "./faucet.plugin";
+export * from "./balance.plugin";
 export * from "./mint.plugin";