[PSDK-348] support trades with server signer (#119)

* [PSDK-348] Trade Verb Support w/ MPC Server-Signer

* jazz review feedback

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Coinbase Node.js SDK Changelog
 
+## Unreleased
+
+### Added
+
+- Support for trade with MPC Server-Signer
+- `CreateTradeOptions` type
+
 ## [0.0.12] - 2024-07-24
 
 ### Changed

README.md

@@ -165,7 +165,7 @@ console.log(`Wallet successfully created: ${mainnetWallet}`);
 // Fund your Wallet's default Address with ETH from an external source.
 
 // Trade 0.00001 ETH to USDC
-let trade = await wallet.createTrade(0.00001, Coinbase.assets.Eth, Coinbase.assets.Usdc);
+let trade = await wallet.createTrade({ amount: 0.00001, fromAssetId: Coinbase.assets.Eth, toAssetId: Coinbase.assets.Usdc });
 
 console.log(`Second trade successfully completed: ${trade}`);
 ```
@@ -222,4 +222,4 @@ await userWallet.loadSeed(seedFilePath);
 [build-size]: https://badgen.net/bundlephobia/minzip/@coinbase/coinbase-sdk
 [build-size-url]: https://bundlephobia.com/result?p=@coinbase/coinbase-sdk
 [npmtrends-url]: https://www.npmtrends.com/@coinbase/coinbase-sdk
-[npm-downloads]: https://img.shields.io/npm/dw/@coinbase/coinbase-sdk
+[npm-downloads]: https://img.shields.io/npm/dw/@coinbase/coinbase-sdk

quickstart-template/trade_assets.js

@@ -1,6 +1,6 @@
 import { Coinbase } from "@coinbase/coinbase-sdk";
 
-let coinbase = Coinbase.configureFromJson({ filePath: '~/Downloads/cdp_api_key.json' });
+let coinbase = Coinbase.configureFromJson({ filePath: "~/Downloads/cdp_api_key.json" });
 let user = await coinbase.getDefaultUser();
 
 // Create a Wallet on base-mainnet to trade assets with.

src/coinbase/address/wallet_address.ts

@@ -7,7 +7,14 @@ import { Coinbase } from "../coinbase";
 import { ArgumentError, InternalError } from "../errors";
 import { Trade } from "../trade";
 import { Transfer } from "../transfer";
-import { Amount, CreateTransferOptions, Destination, TransferStatus } from "../types";
+import {
+  Amount,
+  CreateTransferOptions,
+  CreateTradeOptions,
+  Destination,
+  TransferStatus,
+  TransactionStatus,
+} from "../types";
 import { delay } from "../utils";
 import { Wallet as WalletClass } from "../wallet";
 
@@ -67,9 +74,9 @@ export class WalletAddress extends Address {
   }
 
   /**
-   * Returns all the transfers associated with the address.
+   * Returns all the trades associated with the address.
    *
-   * @returns The list of transfers.
+   * @returns The list of trades.
    */
   public async listTrades(): Promise<Trade[]> {
     const trades: Trade[] = [];
@@ -84,8 +91,8 @@ export class WalletAddress extends Address {
         page?.length ? page : undefined,
       );
 
-      response.data.data.forEach(transferModel => {
-        trades.push(new Trade(transferModel));
+      response.data.data.forEach(tradeModel => {
+        trades.push(new Trade(tradeModel));
       });
 
       if (response.data.has_more) {
@@ -244,25 +251,52 @@ export class WalletAddress extends Address {
   /**
    * Trades the given amount of the given Asset for another Asset. Only same-network Trades are supported.
    *
-   * @param amount - The amount of the Asset to send.
-   * @param fromAssetId - The ID of the Asset to trade from.
-   * @param toAssetId - The ID of the Asset to trade to.
+   * @param options = The options to create the Trade.
+   * @param options.amount - The amount of the From Asset to send.
+   * @param options.fromAssetId - The ID of the Asset to trade from.
+   * @param options.toAssetId - The ID of the Asset to trade to.
+   * @param options.timeoutSeconds - The maximum amount of time to wait for the Trade to complete, in seconds.
+   * @param options.intervalSeconds - The interval at which to poll the Network for Trade status, in seconds.
    * @returns The Trade object.
-   * @throws {Error} If the private key is not loaded, or if the asset IDs are unsupported, or if there are insufficient funds.
+   * @throws {APIError} if the API request to create or broadcast a Trade fails.
+   * @throws {Error} if the Trade times out.
    */
-  public async createTrade(amount: Amount, fromAssetId: string, toAssetId: string): Promise<Trade> {
+  public async createTrade({
+    amount,
+    fromAssetId,
+    toAssetId,
+    timeoutSeconds = 10,
+    intervalSeconds = 0.2,
+  }: CreateTradeOptions): Promise<Trade> {
     const fromAsset = await Asset.fetch(this.getNetworkId(), fromAssetId);
     const toAsset = await Asset.fetch(this.getNetworkId(), toAssetId);
 
     await this.validateCanTrade(amount, fromAssetId);
-    const trade = await this.createTradeRequest(amount, fromAsset, toAsset);
-    // NOTE: Trading does not yet support server signers at this point.
-    const signed_payload = await trade.getTransaction().sign(this.key!);
-    const approveTransactionSignedPayload = trade.getApproveTransaction()
-      ? await trade.getApproveTransaction()!.sign(this.key!)
-      : undefined;
-
-    return this.broadcastTradeRequest(trade, signed_payload, approveTransactionSignedPayload);
+    let trade = await this.createTradeRequest(amount, fromAsset, toAsset);
+
+    if (!Coinbase.useServerSigner) {
+      const signed_payload = await trade.getTransaction().sign(this.key!);
+      const approveTransactionSignedPayload = trade.getApproveTransaction()
+        ? await trade.getApproveTransaction()!.sign(this.key!)
+        : undefined;
+
+      trade = await this.broadcastTradeRequest(
+        trade,
+        signed_payload,
+        approveTransactionSignedPayload,
+      );
+    }
+
+    const startTime = Date.now();
+    while (Date.now() - startTime < timeoutSeconds * 1000) {
+      await trade.reload();
+      const status = trade.getStatus();
+      if (status === TransactionStatus.COMPLETE || status === TransactionStatus.FAILED) {
+        return trade;
+      }
+      await delay(intervalSeconds);
+    }
+    throw new Error("Trade timed out");
   }
 
   /**
@@ -329,7 +363,7 @@ export class WalletAddress extends Address {
    * @throws {Error} If the private key is not loaded, or if the asset IDs are unsupported, or if there are insufficient funds.
    */
   private async validateCanTrade(amount: Amount, fromAssetId: string) {
-    if (!this.canSign()) {
+    if (!Coinbase.useServerSigner && !this.key) {
       throw new Error("Cannot trade from address without private key loaded");
     }
     const currentBalance = await this.getBalance(fromAssetId);

src/coinbase/types.ts

@@ -718,3 +718,14 @@ export type CreateTransferOptions = {
   timeoutSeconds?: number;
   intervalSeconds?: number;
 };
+
+/**
+ * Options for creating a Trade.
+ */
+export type CreateTradeOptions = {
+  amount: Amount;
+  fromAssetId: string;
+  toAssetId: string;
+  timeoutSeconds?: number;
+  intervalSeconds?: number;
+};

src/coinbase/wallet.ts

@@ -16,8 +16,8 @@ import { FaucetTransaction } from "./faucet_transaction";
 import { Trade } from "./trade";
 import { Transfer } from "./transfer";
 import {
-  Amount,
   CreateTransferOptions,
+  CreateTradeOptions,
   SeedData,
   ServerSignerStatus,
   WalletCreateOptions,
@@ -275,18 +275,33 @@ export class Wallet {
   /**
    *  Trades the given amount of the given Asset for another Asset. Currently only the default address is used to source the Trade
    *
-   * @param amount - The amount of the Asset to send.
-   * @param fromAssetId - The ID of the Asset to trade from.
-   * @param toAssetId - The ID of the Asset to trade to.
+   * @param options - The options to create the Trade.
+   * @param options.amount - The amount of the Asset to send.
+   * @param options.fromAssetId - The ID of the Asset to trade from.
+   * @param options.toAssetId - The ID of the Asset to trade to.
+   * @param options.timeoutSeconds - The maximum amount of time to wait for the Trade to complete, in seconds.
+   * @param options.intervalSeconds - The interval at which to poll the Network for Trade status, in seconds.
    * @throws {InternalError} If the default address is not found.
    * @throws {Error} If the private key is not loaded, or if the asset IDs are unsupported, or if there are insufficient funds.
    * @returns The Trade object.
    */
-  public async createTrade(amount: Amount, fromAssetId: string, toAssetId: string): Promise<Trade> {
+  public async createTrade({
+    amount,
+    fromAssetId,
+    toAssetId,
+    timeoutSeconds = 10,
+    intervalSeconds = 0.2,
+  }: CreateTradeOptions): Promise<Trade> {
     if (!this.getDefaultAddress()) {
       throw new InternalError("Default address not found");
     }
-    return await this.getDefaultAddress()!.createTrade(amount, fromAssetId, toAssetId);
+    return await this.getDefaultAddress()!.createTrade({
+      amount: amount,
+      fromAssetId: fromAssetId,
+      toAssetId: toAssetId,
+      timeoutSeconds,
+      intervalSeconds,
+    });
   }
 
   /**

src/examples/trade_assets.js

@@ -8,7 +8,11 @@ async function tradeAssets() {
 
   // Fund the wallet's default address with ETH from an external source.
   // Trade 0.00001 ETH to USDC
-  const trade = await wallet.createTrade(0.00001, Coinbase.assets.Eth, Coinbase.assets.Usdc);
+  const trade = await wallet.createTrade({
+    amount: 0.00001,
+    fromAssetId: Coinbase.assets.Eth,
+    toAssetId: Coinbase.assets.Usdc,
+  });
   console.log(`Trade successfully completed: `, trade.toString());
 }