|
| 1 | +import { |
| 2 | + type Commitment, |
| 3 | + type ConfirmOptions, |
| 4 | + type Connection, |
| 5 | + PublicKey, |
| 6 | + sendAndConfirmTransaction, |
| 7 | + type Signer, |
| 8 | + Transaction, |
| 9 | +} from "@solana/web3.js"; |
| 10 | +import { z } from "zod"; |
| 11 | +import type { Plugin, SolanaWalletClient } from "@goat-sdk/core"; |
| 12 | +import { |
| 13 | + ASSOCIATED_TOKEN_PROGRAM_ID, |
| 14 | + createAssociatedTokenAccountInstruction, |
| 15 | + createTransferInstruction, |
| 16 | + getAccount, |
| 17 | + getAssociatedTokenAddressSync, |
| 18 | + getOrCreateAssociatedTokenAccount, |
| 19 | + TOKEN_PROGRAM_ID, |
| 20 | + TokenAccountNotFoundError, |
| 21 | + TokenInvalidAccountOwnerError, |
| 22 | + TokenInvalidMintError, |
| 23 | + TokenInvalidOwnerError, |
| 24 | +} from "@solana/spl-token"; |
| 25 | + |
| 26 | +export function splTransfer(connection: Connection): Plugin<SolanaWalletClient> { |
| 27 | + return { |
| 28 | + name: "spl_transfer", |
| 29 | + supportsSmartWallets: () => false, |
| 30 | + supportsChain: (chain) => chain.type === "solana", |
| 31 | + getTools: async () => { |
| 32 | + return [ |
| 33 | + { |
| 34 | + name: "transfer_spl_token", |
| 35 | + description: |
| 36 | + "This {{tool}} sends an SPL token (e.g. USDC) from your wallet to an address on a Solana chain.", |
| 37 | + parameters: transferSplTokenParametersSchema, |
| 38 | + method: transferSplTokenMethod(connection), |
| 39 | + }, |
| 40 | + ]; |
| 41 | + }, |
| 42 | + }; |
| 43 | +} |
| 44 | + |
| 45 | +const transferSplTokenParametersSchema = z.object({ |
| 46 | + recipientAddress: z.string().describe("The address to send the SPL token to"), |
| 47 | + tokenMintAddress: z.string().describe("The address of the SPL token to send"), |
| 48 | + amount: z.string().describe("The amount of SPL token to send"), |
| 49 | +}); |
| 50 | + |
| 51 | +const transferSplTokenMethod = |
| 52 | + (connection: Connection) => |
| 53 | + async ( |
| 54 | + walletClient: SolanaWalletClient, |
| 55 | + { recipientAddress, tokenMintAddress, amount }: z.infer<typeof transferSplTokenParametersSchema>, |
| 56 | + ): Promise<string> => { |
| 57 | + const tokenMint = new PublicKey(tokenMintAddress); |
| 58 | + const recipient = new PublicKey(recipientAddress); |
| 59 | + await getOrCreateAssociatedTokenAccountWalletClient(connection, walletClient, tokenMint, recipient); |
| 60 | + const senderTokenAccount = await getOrCreateAssociatedTokenAccountWalletClient( |
| 61 | + connection, |
| 62 | + walletClient, |
| 63 | + tokenMint, |
| 64 | + new PublicKey(walletClient.getAddress()), |
| 65 | + ); |
| 66 | + console.log(`Resolved sender token account: ${senderTokenAccount.address.toBase58()}`); |
| 67 | + const receiverTokenAccount = await getOrCreateAssociatedTokenAccountWalletClient( |
| 68 | + connection, |
| 69 | + walletClient, |
| 70 | + tokenMint, |
| 71 | + recipient, |
| 72 | + ); |
| 73 | + console.log(`Resolved receiver token account: ${receiverTokenAccount.address.toBase58()}`); |
| 74 | + const result = await walletClient.sendTransaction({ |
| 75 | + instructions: [ |
| 76 | + createTransferInstruction( |
| 77 | + senderTokenAccount.address, |
| 78 | + receiverTokenAccount.address, |
| 79 | + new PublicKey(walletClient.getAddress()), |
| 80 | + BigInt(amount), |
| 81 | + ), |
| 82 | + ], |
| 83 | + }); |
| 84 | + return result.hash; |
| 85 | + }; |
| 86 | + |
| 87 | +// Copied from @solana/spl-token with modifications to use WalletClient instead of Signer |
| 88 | +type Account = Awaited<ReturnType<typeof getAccount>>; |
| 89 | +export async function getOrCreateAssociatedTokenAccountWalletClient( |
| 90 | + connection: Connection, |
| 91 | + walletClient: SolanaWalletClient, |
| 92 | + mint: PublicKey, |
| 93 | + owner: PublicKey, |
| 94 | + allowOwnerOffCurve = false, |
| 95 | + commitment?: Commitment, |
| 96 | + programId = TOKEN_PROGRAM_ID, |
| 97 | + associatedTokenProgramId = ASSOCIATED_TOKEN_PROGRAM_ID, |
| 98 | +): Promise<ReturnType<typeof getAccount>> { |
| 99 | + const associatedToken = getAssociatedTokenAddressSync( |
| 100 | + mint, |
| 101 | + owner, |
| 102 | + allowOwnerOffCurve, |
| 103 | + programId, |
| 104 | + associatedTokenProgramId, |
| 105 | + ); |
| 106 | + |
| 107 | + // This is the optimal logic, considering TX fee, client-side computation, RPC roundtrips and guaranteed idempotent. |
| 108 | + // Sadly we can't do this atomically. |
| 109 | + let account: Account; |
| 110 | + try { |
| 111 | + account = await getAccount(connection, associatedToken, commitment, programId); |
| 112 | + } catch (error: unknown) { |
| 113 | + // TokenAccountNotFoundError can be possible if the associated address has already received some lamports, |
| 114 | + // becoming a system account. Assuming program derived addressing is safe, this is the only case for the |
| 115 | + // TokenInvalidAccountOwnerError in this code path. |
| 116 | + if (error instanceof TokenAccountNotFoundError || error instanceof TokenInvalidAccountOwnerError) { |
| 117 | + // As this isn't atomic, it's possible others can create associated accounts meanwhile. |
| 118 | + try { |
| 119 | + const ix = createAssociatedTokenAccountInstruction( |
| 120 | + new PublicKey(walletClient.getAddress()), |
| 121 | + associatedToken, |
| 122 | + owner, |
| 123 | + mint, |
| 124 | + programId, |
| 125 | + associatedTokenProgramId, |
| 126 | + ); |
| 127 | + |
| 128 | + await walletClient.sendTransaction({ instructions: [ix] }); |
| 129 | + } catch (error: unknown) { |
| 130 | + // Ignore all errors; for now there is no API-compatible way to selectively ignore the expected |
| 131 | + // instruction error if the associated account exists already. |
| 132 | + } |
| 133 | + |
| 134 | + // Now this should always succeed |
| 135 | + account = await getAccount(connection, associatedToken, commitment, programId); |
| 136 | + } else { |
| 137 | + throw error; |
| 138 | + } |
| 139 | + } |
| 140 | + |
| 141 | + if (!account.mint.equals(mint)) throw new TokenInvalidMintError(); |
| 142 | + if (!account.owner.equals(owner)) throw new TokenInvalidOwnerError(); |
| 143 | + |
| 144 | + return account; |
| 145 | +} |
0 commit comments