Added additional SDK tests to CI job (#479)

Author: kev1n-peters

.github/workflows/sdk.yml

@@ -0,0 +1,22 @@
+name: TS SDK CI
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  ts-sdk-ci:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: "npm"
+          registry-url: "https://registry.npmjs.org"
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm test

evm/ts/src/ntt.ts

@@ -145,7 +145,7 @@ export class EvmNtt<N extends Network, C extends EvmChains>
     const payload =
       attestation.payloadName === "WormholeTransfer"
         ? attestation.payload
-        : attestation.payload.payload;
+        : attestation.payload["payload"];
     const isExecuted = await this.manager.isMessageExecuted(
       Ntt.messageDigest(attestation.emitterChain, payload["nttManagerPayload"])
     );
@@ -160,7 +160,7 @@ export class EvmNtt<N extends Network, C extends EvmChains>
     const payload =
       attestation.payloadName === "WormholeTransfer"
         ? attestation.payload
-        : attestation.payload.payload;
+        : attestation.payload["payload"];
     return (
       (await this.getInboundQueuedTransfer(
         attestation.emitterChain,
@@ -173,7 +173,7 @@ export class EvmNtt<N extends Network, C extends EvmChains>
     const payload =
       attestation.payloadName === "WormholeTransfer"
         ? attestation.payload
-        : attestation.payload.payload;
+        : attestation.payload["payload"];
     return this.manager.isMessageApproved(
       Ntt.messageDigest(attestation.emitterChain, payload["nttManagerPayload"])
     );

sdk/route/__tests__/route.test.ts

@@ -49,6 +49,14 @@ const conf: NttRoute.Config = {
 };
 const network: Network = "Testnet";
 
+const dummyGetProtocol = async function (name: string, params: any) {
+  if (name !== "Ntt") throw new Error("Unexpected protocol");
+  return {
+    getRateLimitDuration: async () => 0n,
+    getCurrentInboundCapacity: async () => 0n,
+  };
+};
+
 describe("Manual Route Tests", function () {
   const wh = new Wormhole("Testnet", [SolanaPlatform, EvmPlatform]);
   const fromChain = wh.getChain("Solana");
@@ -88,14 +96,15 @@ describe("Manual Route Tests", function () {
   });
 
   let found: routes.ManualRoute<Network>;
+  let request: routes.RouteTransferRequest<Network>;
   it("Should resolve a given route request", async function () {
-    const request = await routes.RouteTransferRequest.create(wh, {
+    request = await routes.RouteTransferRequest.create(wh, {
       source: Wormhole.tokenId("Solana", SOL_TOKEN),
       destination: Wormhole.tokenId("Sepolia", SEPOLIA_TOKEN),
     });
     const foundRoutes = await resolver.findRoutes(request);
     expect(foundRoutes).toHaveLength(1);
-    expect(foundRoutes[0]!.request.fromChain.chain).toEqual("Solana");
+    expect(request.fromChain.chain).toEqual("Solana");
 
     const rt = foundRoutes[0]!;
     if (!routes.isManual(rt)) throw new Error("Expected manual route");
@@ -111,15 +120,20 @@ describe("Manual Route Tests", function () {
 
   let vp: routes.ValidationResult<typeof op>;
   it("Should validate a transfer request", async function () {
-    vp = await found.validate({ amount: "1.0", options: op });
+    vp = await found.validate(request, { amount: "1.0", options: op });
     expect(vp.valid).toBeTruthy();
     expect(vp.params.amount).toEqual("1.0");
   });
 
   let qr: Awaited<ReturnType<typeof found.quote>>;
   it("Should fetch a quote given the validated parameters", async function () {
     if (!vp.valid) throw new Error("Invalid transfer params used");
-    qr = await found.quote(vp.params);
+    const getProtocol = request.toChain.getProtocol;
+    // @ts-ignore
+    // TODO: mock instead of monkey patch
+    request.toChain.getProtocol = dummyGetProtocol;
+    qr = await found.quote(request, vp.params);
+    request.toChain.getProtocol = getProtocol;
     if (!qr.success) throw new Error("Failed to fetch quote");
 
     expect(qr.params.amount).toEqual("1.0");
@@ -179,14 +193,15 @@ describe("Automatic Route Tests", function () {
   });
 
   let found: routes.AutomaticRoute<Network>;
+  let request: routes.RouteTransferRequest<Network>;
   it("Should resolve a given route request", async function () {
-    const request = await routes.RouteTransferRequest.create(wh, {
+    request = await routes.RouteTransferRequest.create(wh, {
       source: Wormhole.tokenId("Solana", SOL_TOKEN),
       destination: Wormhole.tokenId("Sepolia", SEPOLIA_TOKEN),
     });
     const foundRoutes = await resolver.findRoutes(request);
     expect(foundRoutes).toHaveLength(1);
-    expect(foundRoutes[0]!.request.fromChain.chain).toEqual("Solana");
+    expect(request.fromChain.chain).toEqual("Solana");
 
     const rt = foundRoutes[0]!;
     if (!routes.isAutomatic(rt)) throw new Error("Expected automatic route");
@@ -202,15 +217,20 @@ describe("Automatic Route Tests", function () {
 
   let vp: routes.ValidationResult<typeof op>;
   it("Should validate a transfer request", async function () {
-    vp = await found.validate({ amount: "1.0", options: op });
+    vp = await found.validate(request, { amount: "1.0", options: op });
     expect(vp.valid).toBeTruthy();
     expect(vp.params.amount).toEqual("1.0");
   });
 
   let qr: Awaited<ReturnType<typeof found.quote>>;
   it("Should fetch a quote given the validated parameters", async function () {
     if (!vp.valid) throw new Error("Invalid transfer params used");
-    qr = await found.quote(vp.params);
+    const getProtocol = request.toChain.getProtocol;
+    // @ts-ignore
+    // TODO: mock instead of monkey patch
+    request.toChain.getProtocol = dummyGetProtocol;
+    qr = await found.quote(request, vp.params);
+    request.toChain.getProtocol = getProtocol;
     if (!qr.success) throw new Error("Failed to fetch quote");
 
     expect(qr.params.amount).toEqual("1.0");

sdk/route/src/automatic.ts

@@ -256,7 +256,7 @@ export class NttAutomaticRoute<N extends Network>
     const payload =
       vaa.payloadName === "WormholeTransfer"
         ? vaa.payload
-        : vaa.payload.payload;
+        : vaa.payload["payload"];
     const completeTransfer = ntt.completeInboundQueuedTransfer(
       receipt.from,
       payload["nttManagerPayload"],
@@ -331,7 +331,7 @@ export class NttAutomaticRoute<N extends Network>
       const payload =
         vaa.payloadName === "WormholeTransfer"
           ? vaa.payload
-          : vaa.payload.payload;
+          : vaa.payload["payload"];
       const queuedTransfer = await ntt.getInboundQueuedTransfer(
         vaa.emitterChain,
         payload["nttManagerPayload"]