sdk: Added resume transfer methods to routes (#487)

* sdk: Added resume transfer methods to routes * bump wormhole sdk to 0.9.0 * add eta to quote * bump wormhole sdk to 0.9.1 * fix test
wormhole-foundation · Aug 7, 2024 · aa72f14 · aa72f14
1 parent a6fcaea
commit aa72f14
Show file tree

Hide file tree

Showing 11 changed files with 449 additions and 554 deletions.
diff --git a/evm/ts/package.json b/evm/ts/package.json
@@ -44,19 +44,19 @@
     "test": "jest --config ./jest.config.ts"
   },
   "dependencies": {
-    "@wormhole-foundation/sdk-base": "^0.8",
-    "@wormhole-foundation/sdk-definitions": "^0.8",
+    "@wormhole-foundation/sdk-base": "^0.9.1",
+    "@wormhole-foundation/sdk-definitions": "^0.9.1",
     "@wormhole-foundation/sdk-definitions-ntt": "0.1.0-beta.0",
-    "@wormhole-foundation/sdk-evm": "^0.8",
-    "@wormhole-foundation/sdk-evm-core": "^0.8",
+    "@wormhole-foundation/sdk-evm": "^0.9.1",
+    "@wormhole-foundation/sdk-evm-core": "^0.9.1",
     "ethers": "^6.5.1"
   },
   "peerDependencies": {
     "@wormhole-foundation/sdk-definitions-ntt": "0.1.0-beta.0",
-    "@wormhole-foundation/sdk-base": "^0.8",
-    "@wormhole-foundation/sdk-definitions": "^0.8",
-    "@wormhole-foundation/sdk-evm": "^0.8",
-    "@wormhole-foundation/sdk-evm-core": "^0.8"
+    "@wormhole-foundation/sdk-base": "^0.9.1",
+    "@wormhole-foundation/sdk-definitions": "^0.9.1",
+    "@wormhole-foundation/sdk-evm": "^0.9.1",
+    "@wormhole-foundation/sdk-evm-core": "^0.9.1"
   },
   "devDependencies": {
     "@typechain/ethers-v6": "^0.5.1",

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -17,7 +17,7 @@
     "version": "tsx setSdkVersion.ts"
   },
   "devDependencies": {
-    "@wormhole-foundation/sdk": "^0.8",
+    "@wormhole-foundation/sdk": "^0.9.1",
     "@solana/spl-token": "0.3.9",
     "@solana/web3.js": "1.91.7",
     "@types/jest": "^29.5.12",

diff --git a/sdk/definitions/package.json b/sdk/definitions/package.json
@@ -49,12 +49,12 @@
     "test": "jest --config ./jest.config.ts"
   },
   "dependencies": {
-    "@wormhole-foundation/sdk-base": "^0.8",
-    "@wormhole-foundation/sdk-definitions": "^0.8"
+    "@wormhole-foundation/sdk-base": "^0.9.1",
+    "@wormhole-foundation/sdk-definitions": "^0.9.1"
   },
   "peerDependencies": {
-    "@wormhole-foundation/sdk-base": "^0.8",
-    "@wormhole-foundation/sdk-definitions": "^0.8"
+    "@wormhole-foundation/sdk-base": "^0.9.1",
+    "@wormhole-foundation/sdk-definitions": "^0.9.1"
   },
   "type": "module"
 }
diff --git a/sdk/examples/package.json b/sdk/examples/package.json
@@ -32,7 +32,7 @@
     "tsx": "^4.7.2"
   },
   "dependencies": {
-    "@wormhole-foundation/sdk": "^0.8",
+    "@wormhole-foundation/sdk": "^0.9.1",
     "@wormhole-foundation/sdk-definitions-ntt": "0.1.0-beta.0",
     "@wormhole-foundation/sdk-evm-ntt": "0.1.0-beta.0",
     "@wormhole-foundation/sdk-solana-ntt": "0.1.0-beta.0",

diff --git a/sdk/route/__tests__/route.test.ts b/sdk/route/__tests__/route.test.ts
@@ -150,6 +150,7 @@ describe("Manual Route Tests", function () {
       "params",
       "sourceToken",
       "destinationToken",
+      "eta",
     ]);
   });
 });
@@ -249,6 +250,7 @@ describe("Automatic Route Tests", function () {
       "destinationToken",
       "relayFee",
       "destinationNativeGas",
+      "eta",
     ]);
   });
 });
diff --git a/sdk/route/package.json b/sdk/route/package.json
@@ -48,10 +48,10 @@
     "@wormhole-foundation/sdk-definitions-ntt": "0.1.0-beta.0",
     "@wormhole-foundation/sdk-solana-ntt": "0.1.0-beta.0",
     "@wormhole-foundation/sdk-evm-ntt": "0.1.0-beta.0",
-    "@wormhole-foundation/sdk-connect": "^0.8"
+    "@wormhole-foundation/sdk-connect": "^0.9.1"
   },
   "peerDependencies": {
-    "@wormhole-foundation/sdk-connect": "^0.8",
+    "@wormhole-foundation/sdk-connect": "^0.9.1",
     "@wormhole-foundation/sdk-definitions-ntt": "0.1.0-beta.0",
     "@wormhole-foundation/sdk-solana-ntt": "0.1.0-beta.0",
     "@wormhole-foundation/sdk-evm-ntt": "0.1.0-beta.0"
@@ -69,4 +69,4 @@
       }
     }
   }
-}
+}
diff --git a/sdk/route/src/automatic.ts b/sdk/route/src/automatic.ts
@@ -9,11 +9,14 @@ import {
   RedeemedTransferReceipt,
   Signer,
   TokenId,
+  TransactionId,
   TransferState,
   Wormhole,
   WormholeMessageId,
   amount,
+  canonicalAddress,
   chainToPlatform,
+  finality,
   isAttested,
   isDestinationQueued,
   isRedeemed,
@@ -179,6 +182,7 @@ export class NttAutomaticRoute<N extends Network>
         params.normalizedParams.options.gasDropoff ?? 0n,
         toChain.config.nativeTokenDecimals
       ),
+      eta: finality.estimateFinalityTime(request.fromChain.chain),
     };
     const dstNtt = await toChain.getProtocol("Ntt", {
       ntt: params.normalizedParams.destinationContracts,
@@ -235,6 +239,87 @@ export class NttAutomaticRoute<N extends Network>
     };
   }
 
+  async resume(tx: TransactionId): Promise<R> {
+    const vaa = await this.wh.getVaa(
+      tx.txid,
+      "Ntt:WormholeTransferStandardRelayer"
+    );
+    if (!vaa) throw new Error("No VAA found for transaction: " + tx.txid);
+
+    const msgId: WormholeMessageId = {
+      chain: vaa.emitterChain,
+      emitter: vaa.emitterAddress,
+      sequence: vaa.sequence,
+    };
+
+    const { payload } = vaa.payload;
+    const { recipientChain, trimmedAmount } =
+      payload["nttManagerPayload"].payload;
+
+    const token = canonicalAddress({
+      chain: vaa.emitterChain,
+      address: payload["nttManagerPayload"].payload.sourceToken,
+    });
+    const manager = canonicalAddress({
+      chain: vaa.emitterChain,
+      address: payload["sourceNttManager"],
+    });
+    const whTransceiver =
+      vaa.emitterChain === "Solana"
+        ? manager
+        : canonicalAddress({
+            chain: vaa.emitterChain,
+            address: vaa.emitterAddress,
+          });
+
+    const dstInfo = NttRoute.resolveDestinationNttContracts(
+      this.staticConfig,
+      {
+        chain: vaa.emitterChain,
+        address: payload["sourceNttManager"],
+      },
+      recipientChain
+    );
+
+    const amt = amount.fromBaseUnits(
+      trimmedAmount.amount,
+      trimmedAmount.decimals
+    );
+
+    return {
+      from: vaa.emitterChain,
+      to: recipientChain,
+      state: TransferState.Attested,
+      originTxs: [tx],
+      attestation: {
+        id: msgId,
+        attestation: vaa,
+      },
+      params: {
+        amount: amount.display(amt),
+        options: { automatic: true },
+        normalizedParams: {
+          amount: amt,
+          options: { queue: false, automatic: true },
+          sourceContracts: {
+            token,
+            manager,
+            transceiver: {
+              wormhole: whTransceiver,
+            },
+          },
+          destinationContracts: {
+            token: dstInfo.token,
+            manager: dstInfo.manager,
+            transceiver: {
+              wormhole: dstInfo.transceiver.wormhole,
+            },
+          },
+        },
+      },
+    };
+  }
+
   // Even though this is an automatic route, the transfer may need to be
   // manually finalized if it was queued
   async finalize(signer: Signer, receipt: R): Promise<R> {

diff --git a/sdk/route/src/manual.ts b/sdk/route/src/manual.ts
@@ -9,17 +9,20 @@ import {
   RedeemedTransferReceipt,
   Signer,
   TokenId,
+  TransactionId,
   TransferState,
   Wormhole,
   WormholeMessageId,
   amount,
+  canonicalAddress,
   isAttested,
   isDestinationQueued,
   isRedeemed,
   isSourceFinalized,
   isSourceInitiated,
   routes,
   signSendWait,
+  finality,
 } from "@wormhole-foundation/sdk-connect";
 import "@wormhole-foundation/sdk-definitions-ntt";
 import { NttRoute } from "./types.js";
@@ -145,6 +148,7 @@ export class NttManualRoute<N extends Network>
         token: request.destination.id,
         amount: amount.parse(params.amount, request.destination.decimals),
       },
+      eta: finality.estimateFinalityTime(request.fromChain.chain),
     };
     const { fromChain, toChain } = request;
     const dstNtt = await toChain.getProtocol("Ntt", {
@@ -224,6 +228,83 @@ export class NttManualRoute<N extends Network>
     };
   }
 
+  async resume(tx: TransactionId): Promise<R> {
+    const vaa = await this.wh.getVaa(tx.txid, "Ntt:WormholeTransfer");
+    if (!vaa) throw new Error("No VAA found for transaction: " + tx.txid);
+
+    const msgId: WormholeMessageId = {
+      chain: vaa.emitterChain,
+      emitter: vaa.emitterAddress,
+      sequence: vaa.sequence,
+    };
+
+    const { recipientChain, trimmedAmount } =
+      vaa.payload["nttManagerPayload"].payload;
+
+    const token = canonicalAddress({
+      chain: vaa.emitterChain,
+      address: vaa.payload["nttManagerPayload"].payload.sourceToken,
+    });
+    const manager = canonicalAddress({
+      chain: vaa.emitterChain,
+      address: vaa.payload["sourceNttManager"],
+    });
+    const whTransceiver =
+      vaa.emitterChain === "Solana"
+        ? manager
+        : canonicalAddress({
+            chain: vaa.emitterChain,
+            address: vaa.emitterAddress,
+          });
+
+    const dstInfo = NttRoute.resolveDestinationNttContracts(
+      this.staticConfig,
+      {
+        chain: vaa.emitterChain,
+        address: vaa.payload["sourceNttManager"],
+      },
+      recipientChain
+    );
+
+    const amt = amount.fromBaseUnits(
+      trimmedAmount.amount,
+      trimmedAmount.decimals
+    );
+
+    return {
+      from: vaa.emitterChain,
+      to: recipientChain,
+      state: TransferState.Attested,
+      originTxs: [tx],
+      attestation: {
+        id: msgId,
+        attestation: vaa,
+      },
+      params: {
+        amount: amount.display(amt),
+        options: { automatic: false },
+        normalizedParams: {
+          amount: amt,
+          options: { queue: false },
+          sourceContracts: {
+            token,
+            manager,
+            transceiver: {
+              wormhole: whTransceiver,
+            },
+          },
+          destinationContracts: {
+            token: dstInfo.token,
+            manager: dstInfo.manager,
+            transceiver: {
+              wormhole: dstInfo.transceiver.wormhole,
+            },
+          },
+        },
+      },
+    };
+  }
+
   async finalize(signer: Signer, receipt: R): Promise<R> {
     if (!isDestinationQueued(receipt)) {
       throw new Error(

diff --git a/sdk/route/src/types.ts b/sdk/route/src/types.ts
@@ -1,5 +1,6 @@
 import {
   Chain,
+  ChainAddress,
   ChainContext,
   Network,
   TokenId,
@@ -168,6 +169,40 @@ export namespace NttRoute {
     throw new Error("Cannot find Ntt contracts in config for: " + address);
   }
 
+  export function resolveDestinationNttContracts<C extends Chain>(
+    config: Config,
+    srcManager: ChainAddress<C>,
+    dstChain: Chain
+  ): Ntt.Contracts {
+    const cfg = Object.values(config.tokens);
+    const address = canonicalAddress(srcManager);
+    for (const tokens of cfg) {
+      const found = tokens.find(
+        (tc) =>
+          tc.manager.toLowerCase() === address.toLowerCase() &&
+          tc.chain === srcManager.chain
+      );
+      if (found) {
+        const remote = tokens.find((tc) => tc.chain === dstChain);
+        if (!remote) {
+          throw new Error(
+            `Cannot find destination Ntt contracts in config for: ${address}`
+          );
+        }
+        return {
+          token: remote.token,
+          manager: remote.manager,
+          transceiver: {
+            wormhole: remote.transceiver.find((v) => v.type === "wormhole")!
+              .address,
+          },
+          quoter: remote.quoter,
+        };
+      }
+    }
+    throw new Error("Cannot find Ntt contracts in config for: " + address);
+  }
+
   // returns true if the amount is greater than 95% of the capacity
   // useful for warning about the possibility of a transfer being queued
   export function isCapacityThresholdExceeded(

diff --git a/solana/package.json b/solana/package.json
@@ -54,16 +54,16 @@
     "@solana/spl-token": "0.4.0",
     "@solana/web3.js": "1.91.7",
     "bn.js": "5.2.1",
-    "@wormhole-foundation/sdk-base": "^0.8",
-    "@wormhole-foundation/sdk-definitions": "^0.8",
-    "@wormhole-foundation/sdk-solana": "^0.8",
-    "@wormhole-foundation/sdk-solana-core": "^0.8"
+    "@wormhole-foundation/sdk-base": "^0.9.1",
+    "@wormhole-foundation/sdk-definitions": "^0.9.1",
+    "@wormhole-foundation/sdk-solana": "^0.9.1",
+    "@wormhole-foundation/sdk-solana-core": "^0.9.1"
   },
   "peerDependencies": {
-    "@wormhole-foundation/sdk-base": "^0.8",
-    "@wormhole-foundation/sdk-definitions": "^0.8",
-    "@wormhole-foundation/sdk-solana": "^0.8",
-    "@wormhole-foundation/sdk-solana-core": "^0.8",
+    "@wormhole-foundation/sdk-base": "^0.9.1",
+    "@wormhole-foundation/sdk-definitions": "^0.9.1",
+    "@wormhole-foundation/sdk-solana": "^0.9.1",
+    "@wormhole-foundation/sdk-solana-core": "^0.9.1",
     "@wormhole-foundation/sdk-definitions-ntt": "0.1.0-beta.0"
   },
   "type": "module",