add changelog

Author: phdargen

.github/workflows/unit_tests.yml

@@ -42,7 +42,6 @@ jobs:
 
   test-agentkit-typescript:
     runs-on: ubuntu-latest
-    timeout-minutes: 15
     strategy:
       matrix:
         node-version: ["18", "20"]
@@ -57,4 +56,4 @@ jobs:
         working-directory: ./typescript
         run: |
           npm ci
-          npm run test -- -- --testTimeout=300000
+          npm run test

typescript/.changeset/tidy-cities-scream.md

@@ -0,0 +1,5 @@
+---
+"@coinbase/agentkit": minor
+---
+
+Added a new wallet provider and action providers to interact with the Safe Protocol

typescript/agentkit/src/action-providers/safe/README.md

@@ -1 +1,60 @@
-# Safe Action Provider
+# Safe Action Provider
+
+This directory contains the **SafeActionProvider** implementation, which provides actions to interact with [Safe](https://safe.global/) multi-signature wallets on EVM-compatible blockchains.
+
+## Directory Structure
+
+```
+safe/
+├── safeApiActionProvider.ts         # Provider for Safe API interactions
+├── safeWalletActionProvider.ts      # Provider for Safe Wallet operations
+├── schemas.ts                       # Action schemas for Safe operations
+├── index.ts                         # Main exports
+└── README.md                        # This file
+```
+
+## Actions
+
+### Safe API Actions
+
+- `safeInfo`: Retrieve detailed information about a Safe wallet
+- `getAllowanceInfo`: Get current allowance configurations
+- `withdrawAllowance`: Withdraw funds from an allowance
+
+### Safe Wallet Actions
+
+- `addSigner`: Add a new signer to a Safe wallet
+- `removeSigner`: Remove an existing signer from a Safe wallet
+- `changeThreshold`: Modify the number of required signatures
+- `approvePending`: Approve a pending transaction
+- `enableAllowanceModule`: Activate the allowance module for a Safe
+- `setAllowance`: Configure spending allowances for specific addresses
+
+## Adding New Actions
+
+To add new Safe actions:
+
+1. Define your action schema in `schemas.ts`
+2. Implement the action in the appropriate provider file:
+   - Safe API actions in `safeApiActionProvider.ts`
+   - Safe Wallet actions in `safeWalletActionProvider.ts`
+3. Add corresponding tests
+
+## Network Support
+
+The Safe providers support all EVM-compatible networks, including:
+
+- Ethereum (Mainnet & Testnets)
+- Base (Mainnet & Testnets)
+- Optimism
+- Arbitrum
+- Optimism
+- And other EVM-compatible networks
+
+## Notes
+
+- safeWalletActionProvider requires a safeWalletProvider
+- safeWalletProvider connects to an existing Safe account or automatically creates a new one with the provided private key as single signer
+- Safe API actions can be used with other evmWalletProvider
+
+For more information on Safe multi-signature wallets visit [Safe Documentation](https://docs.safe.global/).

typescript/agentkit/src/action-providers/safe/safeWalletActionProvider.ts

@@ -33,7 +33,21 @@ export class SafeWalletActionProvider extends ActionProvider<SafeWalletProvider>
    */
   @CreateAction({
     name: "add_signer",
-    description: "Add a new signer to the Safe multi-sig wallet",
+    description: `
+Add a new signer to the Safe multi-sig wallet
+
+Takes the following inputs:
+- newSigner: Address of the new signer to add
+- newThreshold: (Optional) New threshold after adding signer
+
+Important notes:
+- Must be called by an existing signer
+- Requires confirmation from other signers if current threshold > 1
+- New signer must not already be in the Safe
+- New threshold cannot exceed number of signers
+- If newThreshold not provided, keeps existing threshold if valid, otherwise reduces it
+
+    `,
     schema: AddSignerSchema,
   })
   async addSigner(
@@ -151,6 +165,12 @@ Important notes:
     description: `
 Enables the allowance module for a Safe, allowing for token spending allowances.
 
+Takes the following inputs:
+- delegateAddress: Address that will receive the allowance
+- tokenAddress:  Address of the ERC20 token
+- amount: Amount of tokens to allow (e.g. '1.5' for 1.5 tokens)
+- resetTimeInMinutes: Time in minutes after which the allowance resets, e.g 1440 for 24 hours (optional, defaults to 0 for one-time allowance)
+
 Important notes:
 - Must be called by an existing signer
 - Requires confirmation from other signers if threshold > 1

typescript/agentkit/src/wallet-providers/smartWalletProvider.ts

@@ -147,6 +147,18 @@ export class SmartWalletProvider extends EvmWalletProvider {
     return smartWalletProvider;
   }
 
+  /**
+   * Stub for hash signing
+   *
+   * @throws as signing hashes is not implemented for SmartWallets.
+   *
+   * @param _ - The hash to sign.
+   * @returns The signed hash.
+   */
+  async signHash(_: Hex): Promise<Hex> {
+    throw new Error("Not implemented");
+  }
+
   /**
    * Stub for message signing
    *
@@ -359,4 +371,13 @@ export class SmartWalletProvider extends EvmWalletProvider {
       throw new Error(`Transfer failed with status ${result.status}`);
     }
   }
+
+  /**
+   * Gets the public client instance.
+   *
+   * @returns The Viem PublicClient instance.
+   */
+  getPublicClient(): ViemPublicClient {
+    return this.#publicClient;
+  }
 }