From e7a667d4f7c5ae59b9dc0e33f26530a0e1105f9b Mon Sep 17 00:00:00 2001 From: anondev2323 <122566365+anondev2323@users.noreply.github.com> Date: Fri, 11 Aug 2023 12:52:11 -0400 Subject: [PATCH] update: add chain context package links to core readme (#7) --- packages/sdk-core/README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/packages/sdk-core/README.md b/packages/sdk-core/README.md index cf8768a1d..1a8eb2c2c 100644 --- a/packages/sdk-core/README.md +++ b/packages/sdk-core/README.md @@ -2,9 +2,9 @@ The primary component here is the Wormhole class, which serves as a wrapper for all the sdk methods. It ensures that each chain implements certain methods with the same function signature and provides an interface for calling those methods easily. -## Usage +## Getting started -A developer would use this package in conjunction with 1 or more of the chain context packages. Why so many packages? Because most developers don't use every single chain and may only use a couple, this allows developers to import only the dependencies they actually need. +Use this package in conjunction with 1 or more of the chain context packages (links provided below). It is divided this way in order to be more modular and light-weight, allowing you to import only the dependencies you actually need. Getting started is simple, just import and pass in the contexts to the Wormhole class. @@ -32,13 +32,20 @@ const receipt = wormholeSDK.startTransfer( ) ``` +## Chain Context Packages + +- [EVM](https://www.npmjs.com/package/@wormhole-foundation/connect-sdk-evm) (Ethereum, Polygon, Fantom, Moonbeam, Celo, Avalanche, BSC) +- [Aptos](https://www.npmjs.com/package/@wormhole-foundation/connect-sdk-aptos) +- [Solana](https://www.npmjs.com/package/@wormhole-foundation/connect-sdk-solana) +- [SUI](https://www.npmjs.com/package/@wormhole-foundation/connect-sdk-sui) + ### Note WIP +Overall structure is subject to change. + Several components will be replaced over time. Portions that will be changed: 1. `@certusone/wormhole-sdk` will be removed as a dependency from all packages 2. Contract interfaces will be imported from another package 3. Chain Config will be rewritten and imported from [1-base-layer](https://github.com/nonergodic/sdkv2/tree/main/1-base-layer) 4. Utils (`vaa`, `array`, `createNonce`, etc) will be rewritten and imported from [2-base-layer](https://github.com/nonergodic/sdkv2/tree/main/2-definition-layer) - -Overall structure is subject to change