Sdkv2 (#347)

Author: barnjamin

README.md

@@ -1,56 +1,53 @@
-# Connect SDK
+# Wormhole TS SDK
 
-The Connect SDK is a TypeScript SDK for interacting with the chains Wormhole supports and the [protocols](#protocols) built on top of Wormhole.
+The Wormhole Typescript SDK is useful for interacting with the chains Wormhole supports and the [protocols](#protocols) built on top of Wormhole.
 
 ## Warning 
 
 :warning: This package is a Work in Progress so the interface may change and there are likely bugs. Please [report](https://github.com/wormhole-foundation/connect-sdk/issues) any issues you find. :warning:
 
 ## Installation
 
-Install the primary package
+### Basic 
+
+Install the (meta) package
 
 ```bash
-npm install @wormhole-foundation/connect-sdk
+npm install @wormhole-foundation/sdk
 ```
 
-As well as any other platforms you wish to use
+This package combines all the individual packages in a way that makes setup easier while still allowing for tree shaking. 
 
-```bash
-npm install @wormhole-foundation/connect-sdk-evm
-npm install @wormhole-foundation/connect-sdk-solana
-npm install @wormhole-foundation/connect-sdk-algorand
-```
+### Advanced
 
-And any protocols you intend to use
+Alternatively, for an advanced user, install a specific set of the packages published.
 
 ```bash
-npm install @wormhole-foundation/connect-sdk-evm-tokenbridge
-npm install @wormhole-foundation/connect-sdk-solana-tokenbridge
-npm install @wormhole-foundation/connect-sdk-algorand-tokenbridge
+# constants
+npm install @wormhole-foundation/sdk-base
+
+# contract interfaces, basic types, vaa payload definitions
+npm install @wormhole-foundation/sdk-definitions
+
+# Evm specific utilities
+npm install @wormhole-foundation/sdk-evm
+
+# Evm TokenBridge protocol client
+npm install @wormhole-foundation/sdk-evm-tokenbridge
 ```
 
 ## Usage
 
-A developer would use the connect-sdk package in conjunction with one or more of the chain context packages. Most developers don't use every single chain and may only use a couple, which allows developers to import only the dependencies they actually need.
-
 Getting started is simple, just import and pass in the [Platform](#platforms) modules you wish to support as an argument to the Wormhole class.
 
 ```ts
-import { Wormhole, Signer } from "@wormhole-foundation/connect-sdk";
-import { EvmPlatform } from "@wormhole-foundation/connect-sdk-evm";
-import { SolanaPlatform } from "@wormhole-foundation/connect-sdk-solana";
-import { AlgorandPlatform } from "@wormhole-foundation/connect-sdk-algorand";
-
-// Include the protocols you wish to use
-// these imports register the protocol to be used by higher level abstractions
-// like WormholeTransfers 
-import "@wormhole-foundation/connect-sdk-evm-tokenbridge";
-import "@wormhole-foundation/connect-sdk-solana-tokenbridge";
-import "@wormhole-foundation/connect-sdk-algorand-tokenbridge";
+import { Wormhole, Signer } from "@wormhole-foundation/sdk";
+import { evm } from "@wormhole-foundation/sdk/evm";
+import { solana } from "@wormhole-foundation/sdk/solana";
+import { algorand } from "@wormhole-foundation/sdk/algorand";
 
 const network = "Mainnet"; // Or "Testnet"
-const wh = new Wormhole(network, [EvmPlatform, SolanaPlatform, AlgorandPlatform]);
+const wh = new Wormhole(network, [evm.Platform, solana.Platform, algorand.Platform]);
 
 // Get a ChainContext object for a specific chain
 // Useful to do things like get the rpc client, make Protocol clients,
@@ -187,11 +184,6 @@ Each Protocol, if available, will have a Platform specific implementation. These
 The protocol that underlies all Wormhole activity is the Core protocol. This protocol is responsible for emitting the message containing the information necessary to perform bridging including [Emitter address](https://docs.wormhole.com/wormhole/reference/glossary#emitter), the [Sequence number](https://docs.wormhole.com/wormhole/reference/glossary#sequence) for the message and the Payload of the message itself.
 
 ```ts
-//  ...
-// register the protocol
-import "@wormhole-foundation/connect-sdk-solana-core";
-
-// ...
 
 // get chain context
 const chain = wh.getChain("Solana");
@@ -215,9 +207,7 @@ Every chain has a `TokenBridge` protocol client that provides a consistent inter
 Using the `WormholeTransfer` abstractions is the recommended way to interact with these protocols but it is possible to use them directly
 
 ```ts
-import { signSendWait } from "@wormhole-foundation/connect-sdk";
-
-import "@wormhole-foundation/connect-sdk-evm-tokenbridge";
+import { signSendWait } from "@wormhole-foundation/sdk";
 
 // ...
 

VERSION

@@ -1 +1 @@
-0.4.6
+0.5.0-beta.5

__tests__/integration/index.test.ts

@@ -3,14 +3,14 @@ import {
   PlatformContext,
   RpcConnection,
   TokenBridge,
-  testing,
   Network,
   Platform,
   Wormhole,
   Chain,
-} from "@wormhole-foundation/connect-sdk";
-import { EvmPlatform } from "@wormhole-foundation/connect-sdk-evm";
-import { SolanaPlatform } from "@wormhole-foundation/connect-sdk-solana";
+} from "@wormhole-foundation/sdk-connect";
+import { utils } from "@wormhole-foundation/sdk-definitions/testing";
+import { EvmPlatform } from "@wormhole-foundation/sdk-evm";
+import { SolanaPlatform } from "@wormhole-foundation/sdk-solana";
 
 const allPlatformCtrs = [SolanaPlatform, EvmPlatform];
 
@@ -26,15 +26,15 @@ describe("Wormhole Tests", () => {
     expect(p).toBeTruthy();
   });
 
-  let c: ChainContext<Network, Platform, Chain>;
+  let c: ChainContext<Network, Chain>;
   test("returns chain", async () => {
     c = wh.getChain("Ethereum");
     expect(c).toBeTruthy();
   });
 
   test("should parse address", () => {
     const chain = "Ethereum";
-    const address = testing.utils.makeNativeAddress(chain);
+    const address = utils.makeNativeAddress(chain);
 
     const result = Wormhole.parseAddress(chain, address.toString());
     expect(result).toBeTruthy();
@@ -60,15 +60,15 @@ describe("Platform Tests", () => {
     expect(rpc).toBeTruthy();
   });
 
-  let tb: TokenBridge<"Devnet", "Evm", "Ethereum">;
+  let tb: TokenBridge<"Devnet", "Ethereum">;
   test("Gets Token Bridge", async () => {
     tb = await p.getProtocol("TokenBridge", rpc);
     expect(tb).toBeTruthy();
   });
 });
 
 describe("Chain Tests", () => {
-  let c: ChainContext<"Devnet", "Evm", "Ethereum">;
+  let c: ChainContext<"Devnet", "Ethereum">;
   beforeEach(() => {
     const wh = new Wormhole<"Devnet">("Devnet", allPlatformCtrs);
     c = wh.getChain("Ethereum");

__tests__/tilt/helpers/helpers.ts

@@ -6,11 +6,11 @@
 //   Signer,
 //   WormholeConfig,
 //   nativeChainAddress,
-// } from "@wormhole-foundation/connect-sdk";
+// } from "@wormhole-foundation/sdk-connect";
 //
-// import { getCosmwasmSigner } from "@wormhole-foundation/connect-sdk-cosmwasm";
-// import { getEvmSigner } from "@wormhole-foundation/connect-sdk-evm";
-// import { getSolanaSigner } from "@wormhole-foundation/connect-sdk-solana";
+// import { getCosmwasmSigner } from "@wormhole-foundation/sdk-cosmwasm";
+// import { getEvmSigner } from "@wormhole-foundation/sdk-evm";
+// import { getSolanaSigner } from "@wormhole-foundation/sdk-solana";
 //
 // import { ETH_PRIVATE_KEY, SOLANA_PRIVATE_KEY, TERRA_PRIVATE_KEY } from "./consts";
 //

__tests__/tilt/tokenbridge.test.ts

@@ -13,10 +13,10 @@
 //     baseUnits,
 //     parseAmount,
 //     signSendWait,
-// } from "@wormhole-foundation/connect-sdk";
-// import { EvmPlatform } from "@wormhole-foundation/connect-sdk-evm";
-// import { SolanaPlatform } from "@wormhole-foundation/connect-sdk-solana";
-// import { CosmwasmPlatform } from "@wormhole-foundation/connect-sdk-cosmwasm";
+// } from "@wormhole-foundation/sdk-connect";
+// import { EvmPlatform } from "@wormhole-foundation/sdk-evm";
+// import { SolanaPlatform } from "@wormhole-foundation/sdk-solana";
+// import { CosmwasmPlatform } from "@wormhole-foundation/sdk-cosmwasm";
 //
 // import { expect, jest, describe, test } from '@jest/globals';
 //

connect/__tests__/index.test.ts

@@ -2,19 +2,16 @@ import * as publicRpcMock from "./mocks/publicrpc"; // Should be first
 
 import { describe, expect, test } from "@jest/globals";
 import { Platform, platform } from "@wormhole-foundation/sdk-base";
-import {
-  ChainContext,
-  PlatformContext,
-  RpcConnection,
-  testing,
-} from "@wormhole-foundation/sdk-definitions";
+import { ChainContext, PlatformContext, RpcConnection } from "@wormhole-foundation/sdk-definitions";
+
+import { mocks, utils } from "@wormhole-foundation/sdk-definitions/testing";
 import { Wormhole, networkPlatformConfigs } from "../src";
 
 const network: "Testnet" = "Testnet";
 type TNet = typeof network;
 const allPlatformCtrs = platform.platforms.map((p) =>
-  testing.mocks.mockPlatformFactory(p, networkPlatformConfigs(network, p)),
-);
+  mocks.mockPlatformFactory(p, networkPlatformConfigs(network, p)),
+) as any;
 
 describe("Wormhole Tests", () => {
   let wh: Wormhole<TNet>;
@@ -38,7 +35,7 @@ describe("Wormhole Tests", () => {
     test("returns vaa bytes", async function () {
       const vaa = await wh.getVaaBytes({
         chain: "Arbitrum",
-        emitter: testing.utils.makeUniversalAddress("Arbitrum"),
+        emitter: utils.makeUniversalAddress("Arbitrum"),
         sequence: 1n,
       });
       expect(vaa).toBeDefined();
@@ -47,7 +44,7 @@ describe("Wormhole Tests", () => {
     test("returns undefined when vaa bytes not found", async function () {
       publicRpcMock.givenSignedVaaNotFound();
       const vaa = await wh.getVaaBytes(
-        { chain: "Aptos", emitter: testing.utils.makeUniversalAddress("Aptos"), sequence: 1n },
+        { chain: "Aptos", emitter: utils.makeUniversalAddress("Aptos"), sequence: 1n },
         1,
       );
       expect(vaa).toBeNull();
@@ -57,7 +54,7 @@ describe("Wormhole Tests", () => {
       publicRpcMock.givenSignedVaaRequestWorksAfterRetry();
       const vaa = await wh.getVaaBytes({
         chain: "Base",
-        emitter: testing.utils.makeUniversalAddress("Base"),
+        emitter: utils.makeUniversalAddress("Base"),
         sequence: 1n,
       });
       expect(vaa).toBeDefined();

connect/__tests__/route.test.ts

@@ -1,24 +1,24 @@
 import { describe } from "@jest/globals";
 import { platform } from "@wormhole-foundation/sdk-base";
-import { testing } from "@wormhole-foundation/sdk-definitions";
+import { utils, mocks } from "@wormhole-foundation/sdk-definitions/testing";
 import { Wormhole, networkPlatformConfigs } from "../src";
 import { RouteTransferRequest } from "../src/routes";
 
 const network: "Testnet" = "Testnet";
 type TNet = typeof network;
 const allPlatformCtrs = platform.platforms.map((p) =>
-  testing.mocks.mockPlatformFactory(p, networkPlatformConfigs(network, 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: testing.utils.makeUniversalChainAddress("Solana"),
-    to: testing.utils.makeUniversalChainAddress("Ethereum"),
-    source: testing.utils.makeUniversalChainAddress("Solana"),
-    destination: testing.utils.makeUniversalChainAddress("Ethereum"),
+    from: utils.makeUniversalChainAddress("Solana"),
+    to: utils.makeUniversalChainAddress("Ethereum"),
+    source: utils.makeUniversalChainAddress("Solana"),
+    destination: utils.makeUniversalChainAddress("Ethereum"),
   };
   return RouteTransferRequest.create(wh, req, fromChain, toChain);
 }

connect/package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@wormhole-foundation/connect-sdk",
-  "version": "0.4.6",
+  "name": "@wormhole-foundation/sdk-connect",
+  "version": "0.5.0-beta.5",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/wormhole-foundation/connect-sdk.git"
@@ -14,8 +14,8 @@
   },
   "license": "Apache-2.0",
   "main": "./dist/cjs/index.js",
+  "types": "./dist/cjs/index.d.ts",
   "module": "./dist/esm/index.js",
-  "types": "./dist/esm/index.d.ts",
   "author": "",
   "description": "The core package for the Connect SDK, used in conjunction with 1 or more of the chain packages",
   "files": [
@@ -45,7 +45,7 @@
   },
   "dependencies": {
     "axios": "^1.4.0",
-    "@wormhole-foundation/sdk-base": "0.4.6",
-    "@wormhole-foundation/sdk-definitions": "0.4.6"
+    "@wormhole-foundation/sdk-base": "0.5.0-beta.5",
+    "@wormhole-foundation/sdk-definitions": "0.5.0-beta.5"
   }
 }

core/base/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wormhole-foundation/sdk-base",
-  "version": "0.4.6",
+  "version": "0.5.0-beta.5",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/wormhole-foundation/connect-sdk.git"
@@ -14,8 +14,8 @@
   },
   "license": "Apache-2.0",
   "main": "./dist/cjs/index.js",
+  "types": "./dist/cjs/index.d.ts",
   "module": "./dist/esm/index.js",
-  "types": "./dist/esm/index.d.ts",
   "files": [
     "dist"
   ],

core/definitions/__tests__/bamVaa.ts

@@ -1,6 +1,6 @@
 import { deserializeLayout, circle, encoding, contracts } from "@wormhole-foundation/sdk-base";
 import { UniversalAddress } from "../src";
-import { circleMessageLayout } from "../src/payloads/circleBridge";
+import { circleMessageLayout } from "../src/protocols/circleBridge";
 
 const ethAddressToUniversal = (address: string) => {
   return new UniversalAddress("00".repeat(12) + address.slice(2));

core/definitions/__tests__/circleMessage.ts

@@ -1,4 +1,4 @@
-import "../src/payloads/automaticCircleBridge";
+import "../src/protocols/circleBridge/automaticCircleBridgeLayout";
 import { encoding } from "@wormhole-foundation/sdk-base";
 import { deserialize, deserializePayload } from "../src/vaa";