Packaging: Provide true ESM modules and fallback CJS (#408)

Author: barnjamin

README.md

@@ -40,11 +40,11 @@ Getting started is simple, just import Wormhole and the [Platform](#platforms) m
 <!--EXAMPLE_IMPORTS-->
 ```ts
 import { wormhole } from "@wormhole-foundation/sdk";
-import { algorand } from "@wormhole-foundation/sdk/algorand";
-import { cosmwasm } from "@wormhole-foundation/sdk/cosmwasm";
-import { evm } from "@wormhole-foundation/sdk/evm";
-import { solana } from "@wormhole-foundation/sdk/solana";
-import { sui } from "@wormhole-foundation/sdk/sui";
+import algorand from "@wormhole-foundation/sdk/algorand";
+import cosmwasm from "@wormhole-foundation/sdk/cosmwasm";
+import evm from "@wormhole-foundation/sdk/evm";
+import solana from "@wormhole-foundation/sdk/solana";
+import sui from "@wormhole-foundation/sdk/sui";
 ```
 See example [here](https://github.com/wormhole-foundation/connect-sdk/blob/main/examples/src/index.ts#L2)
 <!--EXAMPLE_IMPORTS-->

VERSION

@@ -1 +1 @@
-0.5.0-beta.10
+0.5.0-alpha.8

connect/__tests__/index.test.ts

@@ -1,11 +1,11 @@
-import * as publicRpcMock from "./mocks/publicrpc"; // Should be first
+import * as publicRpcMock from "./mocks/publicrpc.js"; // Should be first
 
 import { describe, expect, test } from "@jest/globals";
 import { Platform, platform } from "@wormhole-foundation/sdk-base";
 import { ChainContext, PlatformContext, RpcConnection } from "@wormhole-foundation/sdk-definitions";
-
 import { mocks, utils } from "@wormhole-foundation/sdk-definitions/testing";
-import { Wormhole, networkPlatformConfigs } from "../src";
+
+import { Wormhole, networkPlatformConfigs } from "./../src/index.js";
 
 const network: "Testnet" = "Testnet";
 type TNet = typeof network;
@@ -40,7 +40,6 @@ describe("Wormhole Tests", () => {
       });
       expect(vaa).toBeDefined();
     });
-
     test("returns undefined when vaa bytes not found", async function () {
       publicRpcMock.givenSignedVaaNotFound();
       const vaa = await wh.getVaaBytes(
@@ -49,7 +48,6 @@ describe("Wormhole Tests", () => {
       );
       expect(vaa).toBeNull();
     });
-
     test("returns after first try fails", async function () {
       publicRpcMock.givenSignedVaaRequestWorksAfterRetry();
       const vaa = await wh.getVaaBytes({
@@ -70,8 +68,8 @@ describe("Platform Tests", () => {
   });
 
   let rpc: RpcConnection<Platform>;
-  test("Gets RPC", () => {
-    rpc = p.getRpc("Ethereum");
+  test("Gets RPC", async () => {
+    rpc = await p.getRpc("Ethereum");
     expect(rpc).toBeTruthy();
   });
 });
@@ -84,8 +82,8 @@ describe("Chain Tests", () => {
   });
 
   let rpc: RpcConnection<Platform>;
-  test("Gets RPC", () => {
-    rpc = c.getRpc();
+  test("Gets RPC", async () => {
+    rpc = await c.getRpc();
     expect(rpc).toBeTruthy();
   });
 });

connect/__tests__/route.test.ts

@@ -1,35 +1,22 @@
 import { describe } from "@jest/globals";
 import { platform } from "@wormhole-foundation/sdk-base";
-import { utils, mocks } from "@wormhole-foundation/sdk-definitions/testing";
-import { Wormhole, networkPlatformConfigs } from "../src";
-import { RouteTransferRequest } from "../src/routes";
+import { mocks } from "@wormhole-foundation/sdk-definitions/testing";
+import { Wormhole, networkPlatformConfigs } from "./../src/index.js";
 
 const network: "Testnet" = "Testnet";
 type TNet = typeof network;
 const allPlatformCtrs = platform.platforms.map((p) =>
   mocks.mockPlatformFactory(p, networkPlatformConfigs(network, p)),
 );
 
-async function createRequest(wh: Wormhole<TNet>): Promise<RouteTransferRequest<TNet>> {
-  const fromChain = wh.getChain("Solana");
-  const toChain = wh.getChain("Ethereum");
-
-  const req = {
-    from: utils.makeUniversalChainAddress("Solana"),
-    to: utils.makeUniversalChainAddress("Ethereum"),
-    source: utils.makeUniversalChainAddress("Solana"),
-    destination: utils.makeUniversalChainAddress("Ethereum"),
-  };
-  return RouteTransferRequest.create(wh, req, fromChain, toChain);
-}
-
 describe("Wormhole Tests", () => {
   let wh: Wormhole<TNet>;
-  beforeEach(() => {
+  beforeEach(function () {
     wh = new Wormhole(network, allPlatformCtrs);
   });
 
-  test("nothing", () => {
+  test("nothing", function () {
+    console.log(wh.network);
     expect(1).toBe(1);
   });
   // test("Creates route resolver", async () => {

connect/jest.config.ts

@@ -1,16 +1,13 @@
 import type { JestConfigWithTsJest } from "ts-jest";
 
 const jestConfig: JestConfigWithTsJest = {
-  preset: "ts-jest",
   verbose: true,
-  modulePathIgnorePatterns: ["mocks"],
+  preset: "ts-jest",
+  moduleNameMapper: {
+    "^(\\.{1,2}/.*)\\.js$": "$1",
+  },
   transform: {
-    "^.+\\.tsx?$": [
-      "ts-jest",
-      {
-        isolatedModules: true,
-      },
-    ],
+    "^.+\\.tsx?$": ["ts-jest", { tsconfig: "tsconfig.esm.json" }],
   },
 };
 

connect/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wormhole-foundation/sdk-connect",
-  "version": "0.5.0-beta.10",
+  "version": "0.5.0-alpha.8",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/wormhole-foundation/connect-sdk.git"
@@ -18,9 +18,21 @@
   "module": "./dist/esm/index.js",
   "author": "",
   "description": "The core package for the Connect SDK, used in conjunction with 1 or more of the chain packages",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "default": "./dist/cjs/index.js",
+        "types": "./dist/cjs/index.d.ts"
+      }
+    }
+  },
   "files": [
-    "dist/cjs",
-    "dist/esm"
+    "dist/esm",
+    "dist/cjs"
   ],
   "keywords": [
     "wormhole",
@@ -33,9 +45,9 @@
   },
   "sideEffects": false,
   "scripts": {
-    "build:cjs": "tsc -p ./tsconfig.cjs.json",
+    "build:cjs": "tsc -p ./tsconfig.cjs.json && echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
     "build:esm": "tsc -p ./tsconfig.esm.json",
-    "build": "npm run build:cjs && npm run build:esm",
+    "build": "npm run build:esm && npm run build:cjs",
     "rebuild": "npm run clean && npm run build",
     "clean": "rm -rf ./dist && rm -rf ./.turbo",
     "lint": "npm run prettier && eslint --fix ./src --ext .ts",
@@ -46,7 +58,8 @@
   },
   "dependencies": {
     "axios": "^1.4.0",
-    "@wormhole-foundation/sdk-base": "0.5.0-beta.10",
-    "@wormhole-foundation/sdk-definitions": "0.5.0-beta.10"
-  }
+    "@wormhole-foundation/sdk-base": "0.5.0-alpha.8",
+    "@wormhole-foundation/sdk-definitions": "0.5.0-alpha.8"
+  },
+  "type": "module"
 }

connect/src/circle-api.ts

@@ -1,5 +1,5 @@
 import axios from "axios";
-import { retry } from "./tasks";
+import { retry } from "./tasks.js";
 
 // Note: mostly ripped off from https://github.com/circlefin/cctp-sample-app/blob/master/src/services/attestationService.ts
 export const CIRCLE_RETRY_INTERVAL = 2000;

connect/src/index.ts

@@ -1,19 +1,20 @@
-export * from "./wormhole";
-export * from "./config";
-export * from "./common";
-export * from "./types";
+export * from "./wormhole.js";
+export * from "./config.js";
+export * from "./common.js";
+export * from "./types.js";
 
-export * from "./protocols/wormholeTransfer";
-export * from "./protocols/tokenTransfer";
-export * from "./protocols/cctpTransfer";
-export * from "./protocols/gatewayTransfer";
+export * from "./protocols/wormholeTransfer.js";
+export * from "./protocols/tokenTransfer.js";
+export * from "./protocols/cctpTransfer.js";
+export * from "./protocols/gatewayTransfer.js";
 
-export * as tasks from "./tasks";
-export * as circleApi from "./circle-api";
-export * as api from "./whscan-api";
+export * as tasks from "./tasks.js";
+export * as circleApi from "./circle-api.js";
+export * as api from "./whscan-api.js";
 
-export * as routes from "./routes";
+export * as routes from "./routes/index.js";
 
 // Re-export from core packages
 export * from "@wormhole-foundation/sdk-base";
 export * from "@wormhole-foundation/sdk-definitions";
+export * as testing from "@wormhole-foundation/sdk-definitions/testing";

connect/src/protocols/cctpTransfer.ts

@@ -22,8 +22,8 @@ import {
   isWormholeMessageId,
 } from "@wormhole-foundation/sdk-definitions";
 
-import { signSendWait } from "../common";
-import { DEFAULT_TASK_TIMEOUT } from "../config";
+import { signSendWait } from "../common.js";
+import { DEFAULT_TASK_TIMEOUT } from "../config.js";
 import type {
   AttestationReceipt,
   AttestedTransferReceipt,
@@ -32,10 +32,10 @@ import type {
   SourceInitiatedTransferReceipt,
   TransferQuote,
   TransferReceipt,
-} from "../types";
-import { TransferState, isAttested, isSourceFinalized, isSourceInitiated } from "../types";
-import { Wormhole } from "../wormhole";
-import type { WormholeTransfer } from "./wormholeTransfer";
+} from "../types.js";
+import { TransferState, isAttested, isSourceFinalized, isSourceInitiated } from "../types.js";
+import { Wormhole } from "../wormhole.js";
+import type { WormholeTransfer } from "./wormholeTransfer.js";
 
 type CircleTransferProtocol = "CircleBridge" | "AutomaticCircleBridge";
 

connect/src/protocols/gatewayTransfer.ts

@@ -27,11 +27,11 @@ import {
   toGatewayMsg,
   toNative,
 } from "@wormhole-foundation/sdk-definitions";
-import { signSendWait } from "../common";
-import { fetchIbcXfer, isTokenBridgeVaaRedeemed, retry } from "../tasks";
-import { TransferState } from "../types";
-import { Wormhole } from "../wormhole";
-import type { WormholeTransfer } from "./wormholeTransfer";
+import { signSendWait } from "../common.js";
+import { fetchIbcXfer, isTokenBridgeVaaRedeemed, retry } from "../tasks.js";
+import { TransferState } from "../types.js";
+import { Wormhole } from "../wormhole.js";
+import type { WormholeTransfer } from "./wormholeTransfer.js";
 
 type GatewayContext<N extends Network> = ChainContext<N, typeof GatewayTransfer.chain>;
 

connect/src/protocols/tokenTransfer.ts

@@ -25,8 +25,8 @@ import {
   toUniversal,
   universalAddress,
 } from "@wormhole-foundation/sdk-definitions";
-import { signSendWait } from "../common";
-import { DEFAULT_TASK_TIMEOUT } from "../config";
+import { signSendWait } from "../common.js";
+import { DEFAULT_TASK_TIMEOUT } from "../config.js";
 import type {
   AttestationReceipt,
   AttestedTransferReceipt,
@@ -35,11 +35,11 @@ import type {
   SourceInitiatedTransferReceipt,
   TransferQuote,
   TransferReceipt,
-} from "../types";
-import { TransferState, isAttested, isSourceFinalized, isSourceInitiated } from "../types";
-import { getGovernedTokens, getGovernorLimits } from "../whscan-api";
-import { Wormhole } from "../wormhole";
-import type { WormholeTransfer } from "./wormholeTransfer";
+} from "../types.js";
+import { TransferState, isAttested, isSourceFinalized, isSourceInitiated } from "../types.js";
+import { getGovernedTokens, getGovernorLimits } from "../whscan-api.js";
+import { Wormhole } from "../wormhole.js";
+import type { WormholeTransfer } from "./wormholeTransfer.js";
 
 export type TokenTransferProtocol = "TokenBridge" | "AutomaticTokenBridge";
 export type TokenTransferVAA = TokenBridge.TransferVAA | AutomaticTokenBridge.VAA;

connect/src/protocols/wormholeTransfer.ts

@@ -9,8 +9,13 @@ import type {
   TokenTransferDetails,
   TxHash,
 } from "@wormhole-foundation/sdk-definitions";
-import type { AttestationReceipt, TransferQuote, TransferReceipt, TransferState } from "../types";
-import type { Wormhole } from "../wormhole";
+import type {
+  AttestationReceipt,
+  TransferQuote,
+  TransferReceipt,
+  TransferState,
+} from "../types.js";
+import type { Wormhole } from "../wormhole.js";
 
 export type TransferRequest<PN extends ProtocolName = ProtocolName> = PN extends
   | "TokenBridge"

connect/src/routes/cctp/automatic.ts

@@ -7,20 +7,20 @@ import type {
   TokenId,
 } from "@wormhole-foundation/sdk-definitions";
 import { nativeTokenId } from "@wormhole-foundation/sdk-definitions";
-import type { CircleAttestationReceipt } from "../../protocols/cctpTransfer";
-import { CircleTransfer } from "../../protocols/cctpTransfer";
-import { TransferState } from "../../types";
-import type { StaticRouteMethods } from "../route";
-import { AutomaticRoute } from "../route";
+import type { CircleAttestationReceipt } from "../../protocols/cctpTransfer.js";
+import { CircleTransfer } from "../../protocols/cctpTransfer.js";
+import { TransferState } from "../../types.js";
+import type { StaticRouteMethods } from "../route.js";
+import { AutomaticRoute } from "../route.js";
 import type {
   Quote,
   QuoteResult,
   Receipt,
   TransferParams,
   ValidatedTransferParams,
   ValidationResult,
-} from "../types";
-import { Wormhole } from "../../wormhole";
+} from "../types.js";
+import { Wormhole } from "../../wormhole.js";
 
 export namespace AutomaticCCTPRoute {
   export type Options = {

connect/src/routes/cctp/index.ts

@@ -1,2 +1,2 @@
-export * from "./manual";
-export * from "./automatic";
+export * from "./manual.js";
+export * from "./automatic.js";

connect/src/routes/cctp/manual.ts

@@ -8,21 +8,21 @@ import type {
   TransactionId,
 } from "@wormhole-foundation/sdk-definitions";
 import { CircleBridge } from "@wormhole-foundation/sdk-definitions";
-import { signSendWait } from "../../common";
-import type { CircleAttestationReceipt } from "../../protocols/cctpTransfer";
-import { CircleTransfer } from "../../protocols/cctpTransfer";
-import type { TransferReceipt } from "../../types";
-import { TransferState, isAttested } from "../../types";
-import type { StaticRouteMethods } from "../route";
-import { ManualRoute } from "../route";
+import { signSendWait } from "../../common.js";
+import type { CircleAttestationReceipt } from "../../protocols/cctpTransfer.js";
+import { CircleTransfer } from "../../protocols/cctpTransfer.js";
+import type { TransferReceipt } from "../../types.js";
+import { TransferState, isAttested } from "../../types.js";
+import type { StaticRouteMethods } from "../route.js";
+import { ManualRoute } from "../route.js";
 import type {
   Quote,
   QuoteResult,
   TransferParams,
   ValidatedTransferParams,
   ValidationResult,
-} from "../types";
-import { Wormhole } from "../../wormhole";
+} from "../types.js";
+import { Wormhole } from "../../wormhole.js";
 
 export namespace CCTPRoute {
   export type Options = {

connect/src/routes/common.ts

@@ -1,9 +1,9 @@
 import type { Network } from "@wormhole-foundation/sdk-base";
 import type { Signer } from "@wormhole-foundation/sdk-definitions";
-import type { Receipt } from "./types";
-import type { Route } from "./route";
-import { isManual } from "./route";
-import { TransferState, isAttested, isCompleted } from "../types";
+import type { Receipt } from "./types.js";
+import type { Route } from "./route.js";
+import { isManual } from "./route.js";
+import { TransferState, isAttested, isCompleted } from "../types.js";
 
 /**
  * track the transfer until the destination is initiated