Skip to content

Commit 12bd01f

Browse files
mPaellamPaella
authored
plugin: spl token (#32)
* plugin: spl token * lint * get_solana_token_balance_by_mint_address * better
1 parent a27bcdb commit 12bd01f

16 files changed

+445
-5
lines changed

‎typescript/packages/plugins/solana-nfts/package.json

+1-3
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,10 @@
1919
"@metaplex-foundation/umi-bundle-defaults": "0.9.2",
2020
"@metaplex-foundation/umi-web3js-adapters": "0.8.10",
2121
"@solana/web3.js": "catalog:",
22-
"viem": "catalog:",
2322
"zod": "catalog:"
2423
},
2524
"peerDependencies": {
26-
"@goat-sdk/core": "workspace:*",
27-
"viem": "catalog:"
25+
"@goat-sdk/core": "workspace:*"
2826
},
2927
"homepage": "https://ohmygoat.dev",
3028
"repository": {

‎typescript/packages/plugins/spl-token/package.json

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"name": "@goat-sdk/plugin-spl-token",
3+
"version": "0.0.1",
4+
"files": ["dist/**/*", "README.md", "package.json"],
5+
"scripts": {
6+
"build": "tsup",
7+
"clean": "rm -rf dist",
8+
"test": "vitest run --passWithNoTests"
9+
},
10+
"sideEffects": false,
11+
"main": "./dist/index.js",
12+
"module": "./dist/index.mjs",
13+
"types": "./dist/index.d.ts",
14+
"dependencies": {
15+
"@goat-sdk/core": "workspace:*",
16+
"@solana/web3.js": "catalog:",
17+
"@solana/spl-token": "0.4.9",
18+
"zod": "catalog:"
19+
},
20+
"peerDependencies": {
21+
"@goat-sdk/core": "workspace:*"
22+
},
23+
"homepage": "https://ohmygoat.dev",
24+
"repository": {
25+
"type": "git",
26+
"url": "git+https://github.com/goat-sdk/goat.git"
27+
},
28+
"license": "MIT",
29+
"bugs": {
30+
"url": "https://github.com/goat-sdk/goat/issues"
31+
},
32+
"keywords": ["ai", "agents", "web3"]
33+
}

‎typescript/packages/plugins/spl-token/src/index.ts

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
export * from "./plugin";
2+
export * from "./tokens";

‎typescript/packages/plugins/spl-token/src/methods/balance.ts

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
import { getAssociatedTokenAddressSync } from "@solana/spl-token";
2+
import { type Connection, PublicKey } from "@solana/web3.js";
3+
4+
export async function balanceOf(connection: Connection, walletAddress: string, tokenAddress: string) {
5+
const tokenAccount = getAssociatedTokenAddressSync(new PublicKey(tokenAddress), new PublicKey(walletAddress));
6+
const balance = await connection.getTokenAccountBalance(tokenAccount);
7+
return balance;
8+
}

‎typescript/packages/plugins/spl-token/src/methods/transfer.ts

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
import type { SolanaWalletClient } from "@goat-sdk/core";
2+
import {
3+
createAssociatedTokenAccountInstruction,
4+
createTransferCheckedInstruction,
5+
getAssociatedTokenAddressSync,
6+
} from "@solana/spl-token";
7+
import { type Connection, PublicKey, type TransactionInstruction } from "@solana/web3.js";
8+
import type { SolanaNetwork } from "../tokens";
9+
import { doesAccountExist } from "../utils/doesAccountExist";
10+
import { getTokenByMintAddress } from "../utils/getTokenByMintAddress";
11+
12+
export async function transfer(
13+
connection: Connection,
14+
network: SolanaNetwork,
15+
walletClient: SolanaWalletClient,
16+
to: string,
17+
tokenMintAddress: string,
18+
amount: string,
19+
) {
20+
const token = getTokenByMintAddress(tokenMintAddress, network);
21+
if (!token) {
22+
throw new Error(`Token with mint address ${tokenMintAddress} not found`);
23+
}
24+
25+
const tokenMintPublicKey = new PublicKey(tokenMintAddress);
26+
const fromPublicKey = new PublicKey(walletClient.getAddress());
27+
const toPublicKey = new PublicKey(to);
28+
29+
const fromTokenAccount = getAssociatedTokenAddressSync(tokenMintPublicKey, fromPublicKey);
30+
const toTokenAccount = getAssociatedTokenAddressSync(tokenMintPublicKey, toPublicKey);
31+
32+
const fromAccountExists = await doesAccountExist(connection, fromTokenAccount);
33+
const toAccountExists = await doesAccountExist(connection, toTokenAccount);
34+
35+
if (!fromAccountExists) {
36+
throw new Error(`From account ${fromTokenAccount.toBase58()} does not exist`);
37+
}
38+
39+
const instructions: TransactionInstruction[] = [];
40+
41+
if (!toAccountExists) {
42+
instructions.push(
43+
createAssociatedTokenAccountInstruction(fromPublicKey, toTokenAccount, toPublicKey, tokenMintPublicKey),
44+
);
45+
}
46+
instructions.push(
47+
createTransferCheckedInstruction(
48+
fromTokenAccount,
49+
tokenMintPublicKey,
50+
toTokenAccount,
51+
fromPublicKey,
52+
BigInt(amount) * BigInt(10) ** BigInt(token.decimals),
53+
token.decimals,
54+
),
55+
);
56+
57+
return await walletClient.sendTransaction({ instructions });
58+
}

‎typescript/packages/plugins/spl-token/src/parameters.ts

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
import { z } from "zod";
2+
import { splTokenSymbolSchema } from "./tokens";
3+
4+
export const getTokenMintAddressBySymbolParametersSchema = z.object({
5+
symbol: splTokenSymbolSchema.describe("The symbol of the token to get the mint address of"),
6+
});
7+
8+
export const getTokenBalanceByMintAddressParametersSchema = z.object({
9+
walletAddress: z.string().describe("The address to get the balance of"),
10+
mintAddress: z.string().describe("The mint address of the token to get the balance of"),
11+
});
12+
13+
export const transferTokenByMintAddressParametersSchema = z.object({
14+
mintAddress: z.string().describe("The mint address of the token to transfer"),
15+
to: z.string().describe("The address to transfer the token to"),
16+
amount: z.string().describe("The amount of tokens to transfer"),
17+
});

‎typescript/packages/plugins/spl-token/src/plugin.ts

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
import type { Plugin, SolanaWalletClient } from "@goat-sdk/core";
2+
import type { Connection } from "@solana/web3.js";
3+
import type { SolanaNetwork, Token } from "./tokens";
4+
import { getTokensForNetwork } from "./utils/getTokensForNetwork";
5+
import { getTools } from "./utils/getTools";
6+
7+
export function splToken({
8+
connection,
9+
network,
10+
}: { connection: Connection; network: SolanaNetwork }): Plugin<SolanaWalletClient> {
11+
return {
12+
name: "splToken",
13+
supportsSmartWallets: () => false,
14+
supportsChain: (chain) => chain.type === "solana",
15+
getTools: async () => getTools(connection, network),
16+
};
17+
}

‎typescript/packages/plugins/spl-token/src/tokens.ts

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
import { z } from "zod";
2+
3+
export type SolanaNetwork = "devnet" | "mainnet";
4+
5+
export const splTokenSymbolSchema = z.enum(["USDC"]);
6+
export type SplTokenSymbol = z.infer<typeof splTokenSymbolSchema>;
7+
8+
export type Token = {
9+
decimals: number;
10+
symbol: SplTokenSymbol;
11+
name: string;
12+
mintAddresses: Record<SolanaNetwork, string | null>;
13+
};
14+
15+
export type NetworkSpecificToken = Omit<Token, "mintAddresses"> & {
16+
network: SolanaNetwork;
17+
mintAddress: string;
18+
};
19+
20+
export const USDC: Token = {
21+
decimals: 6,
22+
symbol: splTokenSymbolSchema.Enum.USDC,
23+
name: "USDC",
24+
mintAddresses: {
25+
devnet: "4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU",
26+
mainnet: "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
27+
},
28+
};
29+
30+
export const SPL_TOKENS: Token[] = [USDC];

‎typescript/packages/plugins/spl-token/src/utils/doesAccountExist.ts

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
import type { Connection, PublicKey } from "@solana/web3.js";
2+
3+
export async function doesAccountExist(connection: Connection, address: PublicKey) {
4+
const account = await connection.getAccountInfo(address);
5+
return account != null;
6+
}

‎typescript/packages/plugins/spl-token/src/utils/getTokenByMintAddress.ts

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
import { SPL_TOKENS, type SolanaNetwork } from "../tokens";
2+
import { getTokensForNetwork } from "./getTokensForNetwork";
3+
4+
export function getTokenByMintAddress(mintAddress: string, network: SolanaNetwork) {
5+
const tokensForNetwork = getTokensForNetwork(network, SPL_TOKENS);
6+
const token = tokensForNetwork.find((token) => token.mintAddress === mintAddress);
7+
return token || null;
8+
}

‎typescript/packages/plugins/spl-token/src/utils/getTokenMintAddressBySymbol.ts

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
import { SPL_TOKENS, type SolanaNetwork, type SplTokenSymbol } from "../tokens";
2+
import { getTokensForNetwork } from "./getTokensForNetwork";
3+
4+
export function getTokenMintAddressBySymbol(symbol: SplTokenSymbol, network: SolanaNetwork) {
5+
const tokensForNetwork = getTokensForNetwork(network, SPL_TOKENS);
6+
const token = tokensForNetwork.find((token) => [token.symbol, token.symbol.toLowerCase()].includes(symbol));
7+
return token?.mintAddress || null;
8+
}

‎typescript/packages/plugins/spl-token/src/utils/getTokensForNetwork.ts

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
import type { NetworkSpecificToken, SolanaNetwork, Token } from "../tokens";
2+
3+
export function getTokensForNetwork(network: SolanaNetwork, tokens: Token[]) {
4+
const result: NetworkSpecificToken[] = [];
5+
6+
for (const token of tokens) {
7+
const mintAddress = token.mintAddresses[network];
8+
if (mintAddress) {
9+
result.push({
10+
decimals: token.decimals,
11+
symbol: token.symbol,
12+
name: token.name,
13+
network,
14+
mintAddress,
15+
});
16+
}
17+
}
18+
19+
return result;
20+
}

‎typescript/packages/plugins/spl-token/src/utils/getTools.ts

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
import type { DeferredTool, SolanaWalletClient } from "@goat-sdk/core";
2+
import type { Connection } from "@solana/web3.js";
3+
import type { z } from "zod";
4+
import { balanceOf } from "../methods/balance";
5+
import { transfer } from "../methods/transfer";
6+
import {
7+
getTokenBalanceByMintAddressParametersSchema,
8+
getTokenMintAddressBySymbolParametersSchema,
9+
transferTokenByMintAddressParametersSchema,
10+
} from "../parameters";
11+
import type { SolanaNetwork } from "../tokens";
12+
import { getTokenMintAddressBySymbol } from "./getTokenMintAddressBySymbol";
13+
14+
export function getTools(connection: Connection, network: SolanaNetwork): DeferredTool<SolanaWalletClient>[] {
15+
const tools: DeferredTool<SolanaWalletClient>[] = [];
16+
17+
tools.push({
18+
name: "get_token_mint_address_by_symbol",
19+
description: "This {{tool}} gets the mint address of an SPL token by its symbol",
20+
parameters: getTokenMintAddressBySymbolParametersSchema,
21+
method: async (
22+
walletClient: SolanaWalletClient,
23+
parameters: z.infer<typeof getTokenMintAddressBySymbolParametersSchema>,
24+
) => getTokenMintAddressBySymbol(parameters.symbol, network),
25+
});
26+
27+
tools.push({
28+
name: "get_token_balance_by_mint_address",
29+
description:
30+
"This {{tool}} gets the balance of an SPL token by its mint address. Use get_token_mint_address_by_symbol to get the mint address first.",
31+
parameters: getTokenBalanceByMintAddressParametersSchema,
32+
method: async (
33+
walletClient: SolanaWalletClient,
34+
parameters: z.infer<typeof getTokenBalanceByMintAddressParametersSchema>,
35+
) => balanceOf(connection, parameters.walletAddress, parameters.mintAddress),
36+
});
37+
38+
tools.push({
39+
name: "transfer_token_by_mint_address",
40+
description:
41+
"This {{tool}} transfers an SPL token by its mint address. Use get_token_mint_address_by_symbol to get the mint address first.",
42+
parameters: transferTokenByMintAddressParametersSchema,
43+
method: async (
44+
walletClient: SolanaWalletClient,
45+
parameters: z.infer<typeof transferTokenByMintAddressParametersSchema>,
46+
) => transfer(connection, network, walletClient, parameters.to, parameters.mintAddress, parameters.amount),
47+
});
48+
49+
return tools;
50+
}

‎typescript/packages/plugins/spl-token/tsconfig.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"$schema": "https://json.schemastore.org/tsconfig",
3+
"extends": "../../../tsconfig.base.json",
4+
"include": ["src/**/*"],
5+
"exclude": ["node_modules", "dist"]
6+
}

‎typescript/packages/plugins/spl-token/tsup.config.ts

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
import { defineConfig } from "tsup";
2+
import { treeShakableConfig } from "../../../tsup.config.base";
3+
4+
export default defineConfig({
5+
...treeShakableConfig,
6+
});

0 commit comments

Comments
 (0)