feat: add Sui blockchain support

goat.code-workspace

@@ -143,6 +143,10 @@
             "name": "[Wallet] 🌞 solana",
             "path": "./typescript/packages/wallets/solana"
         },
+        {
+            "name": "[Wallet] 💧 sui",
+            "path": "./typescript/packages/wallets/sui"
+        },
         {
             "name": "[Wallet] 🪨 evm",
             "path": "./typescript/packages/wallets/evm"

typescript/.changeset/giant-balloons-confess.md

@@ -0,0 +1,6 @@
+---
+"@goat-sdk/wallet-sui": patch
+"@goat-sdk/core": patch
+---
+
+Add Sui support

typescript/packages/core/src/types/Chain.ts

@@ -2,7 +2,11 @@
  * @param type - "evm" or "solana", extend this union as needed (e.g., "sui")
  * @param id - Chain ID, optional for EVM
  */
-export type Chain = EvmChain | SolanaChain | AptosChain | ChromiaChain | FuelChain;
+export type Chain = EvmChain | SolanaChain | AptosChain | ChromiaChain | FuelChain | SuiChain;
+
+export type SuiChain = {
+    type: "sui";
+};
 
 export type EvmChain = {
     type: "evm";

typescript/packages/wallets/sui/package.json

@@ -0,0 +1,33 @@
+{
+    "name": "@goat-sdk/wallet-sui",
+    "version": "0.2.8",
+    "sideEffects": false,
+    "files": ["dist/**/*", "README.md", "package.json"],
+    "scripts": {
+        "build": "tsup",
+        "clean": "rm -rf dist",
+        "test": "vitest run --passWithNoTests"
+    },
+    "main": "./dist/index.js",
+    "module": "./dist/index.mjs",
+    "types": "./dist/index.d.ts",
+    "dependencies": {
+        "@goat-sdk/core": "workspace:*",
+        "@mysten/sui": "^1.18.0",
+        "zod": "catalog:"
+    },
+    "peerDependencies": {
+        "@goat-sdk/core": "workspace:*",
+        "@mysten/sui": "^1.0.0"
+    },
+    "homepage": "https://ohmygoat.dev",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/goat-sdk/goat.git"
+    },
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/goat-sdk/goat/issues"
+    },
+    "keywords": ["ai", "agents", "web3"]
+}

typescript/packages/wallets/sui/src/SuiKeyPairWalletClient.ts

@@ -0,0 +1,64 @@
+import type { Signature } from "@goat-sdk/core";
+import { SuiClient } from "@mysten/sui/client";
+import { Ed25519Keypair } from "@mysten/sui/keypairs/ed25519";
+import { SuiWalletClient } from "./SuiWalletClient";
+import type { SuiQuery, SuiReadResponse, SuiTransaction, TransactionResponse } from "./types";
+
+export type SuiKeyPairWalletClientParams = {
+    client: SuiClient;
+    keypair: Ed25519Keypair;
+};
+
+export class SuiKeyPairWalletClient extends SuiWalletClient {
+    private keypair: Ed25519Keypair;
+
+    constructor(params: SuiKeyPairWalletClientParams) {
+        super({ client: params.client });
+        this.keypair = params.keypair;
+    }
+
+    /**
+     * Send a transaction to the Sui network.
+     * This method can handle any type of Sui transaction, including:
+     * - Token transfers
+     * - Smart contract interactions
+     * - Object management
+     * - Custom transaction blocks
+     */
+    async sendTransaction(transaction: SuiTransaction): Promise<TransactionResponse> {
+        const result = await this.client.signAndExecuteTransaction({
+            transaction: transaction.transaction,
+            signer: this.keypair,
+        });
+
+        await this.client.waitForTransaction({
+            digest: result.digest,
+        });
+
+        return { hash: result.digest };
+    }
+
+    async read(query: SuiQuery): Promise<SuiReadResponse> {
+        // Use dynamic field or object read based on the query
+        const result = await this.client.getObject({
+            id: query.objectId,
+            options: {
+                showContent: true,
+            },
+        });
+
+        return {
+            value: result.data,
+        };
+    }
+
+    getAddress(): string {
+        return this.keypair.getPublicKey().toSuiAddress();
+    }
+
+    async signMessage(message: string): Promise<Signature> {
+        const signatureArray = await this.keypair.sign(new TextEncoder().encode(message));
+        const signature = Buffer.from(signatureArray).toString("base64");
+        return { signature };
+    }
+}

typescript/packages/wallets/sui/src/SuiWalletClient.ts

@@ -0,0 +1,53 @@
+import { WalletClientBase } from "@goat-sdk/core";
+import type { Chain } from "@goat-sdk/core";
+import type { Balance, Signature } from "@goat-sdk/core";
+import { type SuiClient } from "@mysten/sui/client";
+
+import type {
+    SuiQuery,
+    SuiReadResponse,
+    SuiTransaction,
+    SuiWalletClientCtorParams,
+    TransactionResponse,
+} from "./types";
+
+export abstract class SuiWalletClient extends WalletClientBase {
+    protected client: SuiClient;
+
+    constructor(params: SuiWalletClientCtorParams) {
+        super();
+        this.client = params.client;
+    }
+
+    getChain(): Chain {
+        return {
+            type: "sui",
+        } as const;
+    }
+
+    getClient() {
+        return this.client;
+    }
+
+    abstract getAddress(): string;
+
+    abstract signMessage(message: string): Promise<Signature>;
+
+    abstract sendTransaction(transaction: SuiTransaction): Promise<TransactionResponse>;
+
+    abstract read(query: SuiQuery): Promise<SuiReadResponse>;
+
+    async balanceOf(address: string): Promise<Balance> {
+        const balance = await this.client.getBalance({
+            owner: address,
+        });
+
+        return {
+            decimals: 9,
+            symbol: "SUI",
+            name: "Sui",
+            value: balance.totalBalance,
+            inBaseUnits: balance.totalBalance,
+        };
+    }
+}

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

@@ -0,0 +1,2 @@
+export * from "./SuiWalletClient";
+export * from "./types";

typescript/packages/wallets/sui/src/sendSui.plugin.ts

@@ -0,0 +1,40 @@
+import { Chain, PluginBase, createTool } from "@goat-sdk/core";
+import { Transaction } from "@mysten/sui/transactions";
+import { z } from "zod";
+import { SuiWalletClient } from "./SuiWalletClient";
+
+const sendSUIParametersSchema = z.object({
+    to: z.string().describe("The recipient's address"),
+    amount: z.number().describe("The amount of SUI to send"),
+});
+
+const sendSUIMethod = async (walletClient: SuiWalletClient, parameters: z.infer<typeof sendSUIParametersSchema>) => {
+    const { to, amount } = parameters;
+    const tx = new Transaction();
+    const [coin] = tx.splitCoins(tx.gas, [amount]);
+    tx.transferObjects([coin], to);
+    return walletClient.sendTransaction({
+        transaction: tx,
+    });
+};
+
+export class SendSUIPlugin extends PluginBase<SuiWalletClient> {
+    constructor() {
+        super("sendSUI", []);
+    }
+
+    supportsChain = (chain: Chain) => chain.type === "sui";
+
+    getTools(walletClient: SuiWalletClient) {
+        const sendTool = createTool(
+            {
+                name: "send_sui",
+                description: "Send SUI to an address.",
+                parameters: sendSUIParametersSchema,
+            },
+            // Implement the method
+            (parameters: z.infer<typeof sendSUIParametersSchema>) => sendSUIMethod(walletClient, parameters),
+        );
+        return [sendTool];
+    }
+}

typescript/packages/wallets/sui/src/types.ts

@@ -0,0 +1,22 @@
+import { SuiClient } from "@mysten/sui/client";
+import { type Transaction } from "@mysten/sui/transactions";
+
+export type SuiReadResponse = {
+    value: unknown;
+};
+
+export type SuiTransaction = {
+    transaction: Transaction;
+};
+
+export type TransactionResponse = {
+    hash: string;
+};
+
+export type SuiQuery = {
+    objectId: string;
+};
+
+export type SuiWalletClientCtorParams = {
+    client: SuiClient;
+};

typescript/packages/wallets/sui/tsconfig.json

@@ -0,0 +1,6 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "extends": "../../../tsconfig.base.json",
+    "include": ["src/**/*"],
+    "exclude": ["node_modules", "dist"]
+}

typescript/packages/wallets/sui/tsup.config.ts

@@ -0,0 +1,6 @@
+import { defineConfig } from "tsup";
+import { treeShakableConfig } from "../../../tsup.config.base";
+
+export default defineConfig({
+    ...treeShakableConfig,
+});