Skip to content

Commit e7a667d

Browse files
authored
update: add chain context package links to core readme (#7)
1 parent d6592b5 commit e7a667d

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

packages/sdk-core/README.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
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.
44

5-
## Usage
5+
## Getting started
66

7-
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.
7+
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.
88

99
Getting started is simple, just import and pass in the contexts to the Wormhole class.
1010

@@ -32,13 +32,20 @@ const receipt = wormholeSDK.startTransfer(
3232
)
3333
```
3434

35+
## Chain Context Packages
36+
37+
- [EVM](https://www.npmjs.com/package/@wormhole-foundation/connect-sdk-evm) (Ethereum, Polygon, Fantom, Moonbeam, Celo, Avalanche, BSC)
38+
- [Aptos](https://www.npmjs.com/package/@wormhole-foundation/connect-sdk-aptos)
39+
- [Solana](https://www.npmjs.com/package/@wormhole-foundation/connect-sdk-solana)
40+
- [SUI](https://www.npmjs.com/package/@wormhole-foundation/connect-sdk-sui)
41+
3542
### Note WIP
3643

44+
Overall structure is subject to change.
45+
3746
Several components will be replaced over time. Portions that will be changed:
3847

3948
1. `@certusone/wormhole-sdk` will be removed as a dependency from all packages
4049
2. Contract interfaces will be imported from another package
4150
3. Chain Config will be rewritten and imported from [1-base-layer](https://github.com/nonergodic/sdkv2/tree/main/1-base-layer)
4251
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)
43-
44-
Overall structure is subject to change

0 commit comments

Comments
 (0)