@coinbase/agentkit 0.4.0 → 0.6.0

package/dist/action-providers/onramp/onrampActionProvider.test.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const onrampActionProvider_1 = require("./onrampActionProvider");
+const schemas_1 = require("./schemas");
+describe("OnrampActionProvider", () => {
+    const provider = new onrampActionProvider_1.OnrampActionProvider({
+        projectId: "test-project-id",
+    });
+    let mockWalletProvider;
+    beforeEach(() => {
+        mockWalletProvider = {
+            getAddress: jest.fn().mockReturnValue("0x123"),
+            getBalance: jest.fn(),
+            getName: jest.fn(),
+            getNetwork: jest.fn().mockReturnValue({
+                protocolFamily: "evm",
+                networkId: "base-mainnet",
+            }),
+            nativeTransfer: jest.fn(),
+        };
+    });
+    describe("network support", () => {
+        it("should support valid EVM networks", () => {
+            expect(provider.supportsNetwork({
+                networkId: "base-mainnet",
+                protocolFamily: "evm",
+            })).toBe(true);
+        });
+        it("should not support invalid EVM networks, such as testnets", () => {
+            expect(provider.supportsNetwork({
+                networkId: "base-sepolia",
+                protocolFamily: "evm",
+            })).toBe(false);
+        });
+        it("should not support other protocol families", () => {
+            expect(provider.supportsNetwork({
+                protocolFamily: "other-protocol-family",
+            })).toBe(false);
+        });
+        it("should handle invalid network objects", () => {
+            expect(provider.supportsNetwork({})).toBe(false);
+        });
+    });
+    describe("action validation", () => {
+        it("should validate getOnrampBuyUrl schema", () => {
+            const validInput = {};
+            const parseResult = schemas_1.GetOnrampBuyUrlActionSchema.safeParse(validInput);
+            expect(parseResult.success).toBe(true);
+        });
+    });
+    describe("getOnrampBuyUrl", () => {
+        beforeEach(() => {
+            mockWalletProvider.getAddress.mockReturnValue("0x123");
+        });
+        /**
+         * Parses URL search parameters from a URL string.
+         *
+         * @param url - The URL string to parse parameters from
+         * @returns The parsed URL search parameters
+         */
+        function parseUrlParams(url) {
+            const urlObj = new URL(url);
+            return urlObj.searchParams;
+        }
+        it("should execute getOnrampBuyUrl with wallet provider", async () => {
+            const result = await provider.getOnrampBuyUrl(mockWalletProvider, {});
+            const url = new URL(result);
+            const params = parseUrlParams(result);
+            // Verify base URL
+            expect(url.origin + url.pathname).toBe("https://pay.coinbase.com/buy");
+            // Verify all expected parameters are present with correct values
+            expect(params.get("appId")).toBe("test-project-id");
+            expect(params.get("defaultNetwork")).toBe("base");
+            // Verify address configuration
+            const addressConfig = JSON.parse(params.get("addresses") || "{}");
+            expect(addressConfig).toEqual({
+                "0x123": ["base"],
+            });
+            expect(mockWalletProvider.getNetwork).toHaveBeenCalled();
+            expect(mockWalletProvider.getAddress).toHaveBeenCalled();
+        });
+        it("should throw error for unsupported network", async () => {
+            mockWalletProvider.getNetwork.mockReturnValue({
+                protocolFamily: "evm",
+                networkId: "unsupported-network",
+            });
+            await expect(provider.getOnrampBuyUrl(mockWalletProvider, {})).rejects.toThrow("Network ID is not supported. Make sure you are using a supported mainnet network.");
+        });
+        it("should throw error when network ID is not set", async () => {
+            mockWalletProvider.getNetwork.mockReturnValue({
+                protocolFamily: "evm",
+                networkId: undefined,
+            });
+            await expect(provider.getOnrampBuyUrl(mockWalletProvider, {})).rejects.toThrow("Network ID is not set");
+        });
+    });
+});

package/dist/action-providers/onramp/schemas.d.ts

@@ -0,0 +1,12 @@
+import { z } from "zod";
+/**
+ * Action schemas for the onramp action provider.
+ *
+ * This file contains the Zod schemas that define the shape and validation
+ * rules for action parameters in the onramp action provider.
+ */
+/**
+ * Example action schema demonstrating various field types and validations.
+ * Replace or modify this with your actual action schemas.
+ */
+export declare const GetOnrampBuyUrlActionSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;

package/dist/action-providers/onramp/schemas.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetOnrampBuyUrlActionSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * Action schemas for the onramp action provider.
+ *
+ * This file contains the Zod schemas that define the shape and validation
+ * rules for action parameters in the onramp action provider.
+ */
+/**
+ * Example action schema demonstrating various field types and validations.
+ * Replace or modify this with your actual action schemas.
+ */
+exports.GetOnrampBuyUrlActionSchema = zod_1.z.object({});

package/dist/action-providers/onramp/types.d.ts

@@ -0,0 +1,107 @@
+/**
+ * Props used to get an Onramp buy URL by directly providing a CDP project ID.
+ * See https://docs.cdp.coinbase.com/onramp/docs/api-initializing#generating-the-coinbase-onramp-buysell-url
+ *
+ * Note: exported as public Type
+ */
+export type GetOnrampUrlWithProjectIdParams = {
+    /**
+     * The Project ID of your CDP project created at https://portal.cdp.coinbase.com/
+     * This must be provided if you don't provide a sessionToken.
+     */
+    projectId: string;
+    sessionToken?: never;
+    /**
+     * The addresses that the customer's funds should be delivered to.
+     *
+     * Each entry in the record represents a wallet address and the networks it is valid for. There should only be a
+     * single address for each network your app supports. Users will be able to buy/send any asset supported by any of
+     * the networks you specify. See the assets param if you want to restrict the available assets.
+     *
+     * Some common examples:
+     *
+     * Support all assets that are available for sending on the base network, only on the base network:
+     *
+     * `{ "0x1": ["base"] }`
+     */
+    addresses: Record<string, string[]>;
+    /**
+     * This optional parameter will restrict the assets available for the user to buy/send. It acts as a filter on the
+     * networks specified in the {addresses} param.
+     *
+     * Some common examples:
+     *
+     * Support only USDC on either the base network or the ethereum network:
+     *
+     * `addresses: { "0x1": ["base", "ethereum"] }, assets: ["USDC"]`
+     *
+     * The values in this list can either be asset symbols like BTC, ETH, or asset UUIDs that you can get from the Buy
+     * Options API {@link https://docs.cdp.coinbase.com/onramp/docs/api-configurations/#buy-options}.
+     */
+    assets?: string[];
+} & GetOnrampBuyUrlOptionalProps;
+/**
+ * Props used to get an Onramp buy URL using a session token created using the Onramp session token API.
+ * See https://docs.cdp.coinbase.com/onramp/docs/api-initializing#getting-an-coinbase-onramp-buysell-session-token
+ *
+ * Note: exported as public Type
+ */
+export type GetOnrampUrlWithSessionTokenParams = {
+    /**
+     * A session token create using the Onramp session token API. The token will be linked to the project ID, addresses,
+     * and assets params provided in the create session token API request.
+     */
+    sessionToken: string;
+    projectId?: never;
+    addresses?: never;
+    assets?: never;
+} & GetOnrampBuyUrlOptionalProps;
+/**
+ * The optional properties that can be used to create an Onramp buy URL.
+ */
+type GetOnrampBuyUrlOptionalProps = {
+    /**
+     * If specified, this asset will be automatically selected for the user in the Onramp UI. Should be a valid asset
+     * symbol e.g. BTC, ETH, USDC.
+     */
+    defaultAsset?: string;
+    /**
+     * If specified, this network will be automatically selected for the user in the Onramp UI. Should be a valid network
+     * name in lower case e.g. ethereum, base.
+     */
+    defaultNetwork?: string;
+    /**
+     * A unique identifier that will be associated with any transactions created by the user during their Onramp session.
+     * You can use this with the Transaction Status API to check the status of the user's transaction.
+     * See https://docs.cdp.coinbase.com/onramp/docs/api-reporting#buy-transaction-status
+     */
+    partnerUserId?: string;
+    /**
+     * This amount will be used to pre-fill the amount of crypto the user is buying or sending. The user can choose to
+     * change this amount in the UI. Only one of presetCryptoAmount or presetFiatAmount should be provided.
+     */
+    presetCryptoAmount?: number;
+    /**
+     * This amount will be used to pre-fill the fiat value of the crypto the user is buying or sending. The user can
+     * choose to change this amount in the UI. Only one of presetCryptoAmount or presetFiatAmount should be provided.
+     */
+    presetFiatAmount?: number;
+    /**
+     * The default payment method that will be selected for the user in the Onramp UI. Should be one of the payment methods
+     */
+    defaultPaymentMethod?: string;
+    /**
+     * The currency code of the fiat amount provided in the presetFiatAmount param e.g. USD, CAD, EUR.
+     */
+    fiatCurrency?: string;
+    /**
+     * A URL that the user will be automatically redirected to after a successful buy/send. The domain must match a domain
+     * on the domain allowlist in Coinbase Developer Platform (https://portal.cdp.coinbase.com/products/onramp).
+     */
+    redirectUrl?: string;
+    /**
+     * The name of the component that is calling the Onramp buy URL. This will be used for analytics.
+     */
+    originComponentName?: string;
+};
+export {};

package/dist/action-providers/onramp/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/action-providers/onramp/utils.d.ts

@@ -0,0 +1,16 @@
+import type { GetOnrampUrlWithProjectIdParams, GetOnrampUrlWithSessionTokenParams } from "./types";
+/**
+ * Builds a Coinbase Onramp buy URL using the provided parameters.
+ *
+ * @param props - Configuration options for the Onramp buy URL
+ * @param props.projectId - A projectId generated in the Coinbase Developer Portal
+ * @returns The generated Onramp buy URL
+ */
+export declare function getOnrampBuyUrl({ projectId, ...props }: GetOnrampUrlWithProjectIdParams | GetOnrampUrlWithSessionTokenParams): string;
+/**
+ * Converts a network ID to an Onramp network ID.
+ *
+ * @param networkId - The network ID to convert
+ * @returns The Onramp network ID or null if the network ID is not supported
+ */
+export declare const convertNetworkIdToOnrampNetworkId: (networkId: string) => string | null;

package/dist/action-providers/onramp/utils.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertNetworkIdToOnrampNetworkId = void 0;
+exports.getOnrampBuyUrl = getOnrampBuyUrl;
+const version_1 = require("./version");
+/**
+ * Builds a Coinbase Onramp buy URL using the provided parameters.
+ *
+ * @param props - Configuration options for the Onramp buy URL
+ * @param props.projectId - A projectId generated in the Coinbase Developer Portal
+ * @returns The generated Onramp buy URL
+ */
+function getOnrampBuyUrl({ projectId, ...props }) {
+    const url = new URL(version_1.ONRAMP_BUY_URL);
+    if (projectId !== undefined) {
+        // Coinbase Onramp requires projectId to be passed as appId
+        url.searchParams.append("appId", projectId);
+    }
+    for (const key of Object.keys(props)) {
+        const value = props[key];
+        if (value !== undefined) {
+            if (["string", "number", "boolean"].includes(typeof value)) {
+                url.searchParams.append(key, value.toString());
+            }
+            else {
+                url.searchParams.append(key, JSON.stringify(value));
+            }
+        }
+    }
+    url.searchParams.append("sdkVersion", `onchainkit@${version_1.VERSION}`);
+    url.searchParams.sort();
+    return url.toString();
+}
+/**
+ * Converts a network ID to an Onramp network ID.
+ *
+ * @param networkId - The network ID to convert
+ * @returns The Onramp network ID or null if the network ID is not supported
+ */
+const convertNetworkIdToOnrampNetworkId = (networkId) => {
+    switch (networkId) {
+        case "base-mainnet":
+            return "base";
+        case "ethereum-mainnet":
+            return "ethereum";
+        case "polygon-mainnet":
+            return "polygon";
+        case "optimism-mainnet":
+            return "optimism";
+        case "arbitrum-mainnet":
+            return "arbitrum";
+        default:
+            return null;
+    }
+};
+exports.convertNetworkIdToOnrampNetworkId = convertNetworkIdToOnrampNetworkId;

package/dist/action-providers/onramp/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.38.2";
+export declare const ONRAMP_BUY_URL = "https://pay.coinbase.com/buy";

package/dist/action-providers/onramp/version.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ONRAMP_BUY_URL = exports.VERSION = void 0;
+exports.VERSION = "0.38.2";
+exports.ONRAMP_BUY_URL = "https://pay.coinbase.com/buy";

package/dist/wallet-providers/cdpWalletProvider.d.ts

@@ -1,7 +1,7 @@
-import { ReadContractParameters, ReadContractReturnType, TransactionRequest, TransactionSerializable, Abi, ContractFunctionName, ContractFunctionArgs } from "viem";
+import { ReadContractParameters, ReadContractReturnType, TransactionRequest, TransactionSerializable, Abi, ContractFunctionName, ContractFunctionArgs, Address, Hex } from "viem";
 import { EvmWalletProvider } from "./evmWalletProvider";
 import { Network } from "../network";
-import { CreateERC20Options, CreateTradeOptions, SmartContract, Trade, Wallet, WalletData } from "@coinbase/coinbase-sdk";
+import { Coinbase, CreateERC20Options, CreateTradeOptions, SmartContract, Trade, Wallet, WalletData } from "@coinbase/coinbase-sdk";
 /**
  * Configuration options for the CDP Providers.
  */
@@ -233,5 +233,14 @@ export declare class CdpWalletProvider extends EvmWalletProvider {
      * @returns The wallet.
      */
     getWallet(): Wallet;
+    /**
+     * ERC20 transfer method
+     *
+     * @param assetId - The asset ID to transfer. Either USDC, CBBTC or EURC
+     * @param destination - The destination address
+     * @param amount - The amount to transfer
+     * @returns The transaction hash
+     */
+    gaslessERC20Transfer(assetId: typeof Coinbase.assets.Usdc | typeof Coinbase.assets.Cbbtc | typeof Coinbase.assets.Eurc, destination: Address, amount: bigint): Promise<Hex>;
 }
 export {};

package/dist/wallet-providers/cdpWalletProvider.js

@@ -10,7 +10,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _CdpWalletProvider_cdpWallet, _CdpWalletProvider_address, _CdpWalletProvider_network, _CdpWalletProvider_publicClient, _CdpWalletProvider_gasLimitMultiplier, _CdpWalletProvider_feePerGasMultiplier;
+var _CdpWalletProvider_cdpWallet, _CdpWalletProvider_address, _CdpWalletProvider_network, _CdpWalletProvider_publicClient, _CdpWalletProvider_gasLimitMultiplier, _CdpWalletProvider_feePerGasMultiplier, _CdpWalletProvider_transactionQueue;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CdpWalletProvider = void 0;
 const package_json_1 = require("../../package.json");
@@ -37,6 +37,7 @@ class CdpWalletProvider extends evmWalletProvider_1.EvmWalletProvider {
         _CdpWalletProvider_publicClient.set(this, void 0);
         _CdpWalletProvider_gasLimitMultiplier.set(this, void 0);
         _CdpWalletProvider_feePerGasMultiplier.set(this, void 0);
+        _CdpWalletProvider_transactionQueue.set(this, void 0);
         __classPrivateFieldSet(this, _CdpWalletProvider_cdpWallet, config.wallet, "f");
         __classPrivateFieldSet(this, _CdpWalletProvider_address, config.address, "f");
         __classPrivateFieldSet(this, _CdpWalletProvider_network, config.network, "f");
@@ -165,14 +166,22 @@ class CdpWalletProvider extends evmWalletProvider_1.EvmWalletProvider {
         if (!__classPrivateFieldGet(this, _CdpWalletProvider_cdpWallet, "f")) {
             throw new Error("Wallet not initialized");
         }
-        const preparedTransaction = await this.prepareTransaction(transaction.to, transaction.value, transaction.data);
-        const signature = await this.signTransaction({
-            ...preparedTransaction,
-        });
-        const signedPayload = await this.addSignatureAndSerialize(preparedTransaction, signature);
-        const externalAddress = new coinbase_sdk_1.ExternalAddress(__classPrivateFieldGet(this, _CdpWalletProvider_cdpWallet, "f").getNetworkId(), __classPrivateFieldGet(this, _CdpWalletProvider_address, "f"));
-        const tx = await externalAddress.broadcastExternalTransaction(signedPayload.slice(2));
-        return tx.transactionHash;
+        const sendPromise = (async () => {
+            if (__classPrivateFieldGet(this, _CdpWalletProvider_transactionQueue, "f"))
+                await __classPrivateFieldGet(this, _CdpWalletProvider_transactionQueue, "f");
+            const preparedTransaction = await this.prepareTransaction(transaction.to, transaction.value, transaction.data);
+            const signature = await this.signTransaction({
+                ...preparedTransaction,
+            });
+            const signedPayload = await this.addSignatureAndSerialize(preparedTransaction, signature);
+            const externalAddress = new coinbase_sdk_1.ExternalAddress(__classPrivateFieldGet(this, _CdpWalletProvider_cdpWallet, "f").getNetworkId(), __classPrivateFieldGet(this, _CdpWalletProvider_address, "f"));
+            const tx = await externalAddress.broadcastExternalTransaction(signedPayload.slice(2));
+            return tx.transactionHash;
+        })();
+        __classPrivateFieldSet(this, _CdpWalletProvider_transactionQueue, sendPromise
+            .then(txHash => this.waitForTransactionReceipt(txHash))
+            .catch(() => { }), "f");
+        return await sendPromise;
     }
     /**
      * Prepares a transaction.
@@ -188,6 +197,7 @@ class CdpWalletProvider extends evmWalletProvider_1.EvmWalletProvider {
         }
         const nonce = await __classPrivateFieldGet(this, _CdpWalletProvider_publicClient, "f").getTransactionCount({
             address: __classPrivateFieldGet(this, _CdpWalletProvider_address, "f"),
+            blockTag: "pending",
         });
         const feeData = await __classPrivateFieldGet(this, _CdpWalletProvider_publicClient, "f").estimateFeesPerGas();
         const maxFeePerGas = (0, utils_1.applyGasMultiplier)(feeData.maxFeePerGas, __classPrivateFieldGet(this, _CdpWalletProvider_feePerGasMultiplier, "f"));
@@ -392,6 +402,30 @@ class CdpWalletProvider extends evmWalletProvider_1.EvmWalletProvider {
         }
         return __classPrivateFieldGet(this, _CdpWalletProvider_cdpWallet, "f");
     }
+    /**
+     * ERC20 transfer method
+     *
+     * @param assetId - The asset ID to transfer. Either USDC, CBBTC or EURC
+     * @param destination - The destination address
+     * @param amount - The amount to transfer
+     * @returns The transaction hash
+     */
+    async gaslessERC20Transfer(assetId, destination, amount) {
+        if (!__classPrivateFieldGet(this, _CdpWalletProvider_cdpWallet, "f")) {
+            throw new Error("Wallet not initialized");
+        }
+        const transferResult = await __classPrivateFieldGet(this, _CdpWalletProvider_cdpWallet, "f").createTransfer({
+            amount,
+            assetId,
+            destination,
+            gasless: true,
+        });
+        const result = await transferResult.wait();
+        if (!result.getTransactionHash()) {
+            throw new Error("Transaction hash not found");
+        }
+        return result.getTransactionHash();
+    }
 }
 exports.CdpWalletProvider = CdpWalletProvider;
-_CdpWalletProvider_cdpWallet = new WeakMap(), _CdpWalletProvider_address = new WeakMap(), _CdpWalletProvider_network = new WeakMap(), _CdpWalletProvider_publicClient = new WeakMap(), _CdpWalletProvider_gasLimitMultiplier = new WeakMap(), _CdpWalletProvider_feePerGasMultiplier = new WeakMap();
+_CdpWalletProvider_cdpWallet = new WeakMap(), _CdpWalletProvider_address = new WeakMap(), _CdpWalletProvider_network = new WeakMap(), _CdpWalletProvider_publicClient = new WeakMap(), _CdpWalletProvider_gasLimitMultiplier = new WeakMap(), _CdpWalletProvider_feePerGasMultiplier = new WeakMap(), _CdpWalletProvider_transactionQueue = new WeakMap();

package/dist/wallet-providers/cdpWalletProvider.test.d.ts

@@ -0,0 +1 @@
+export {};