Skip to content

Commit 73bfb4d

Browse files
committed
add connect
1 parent ca0df6a commit 73bfb4d

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

DESIGN.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ To address this goal, the SDK is structured into layers
1010
```
1111
core/ -- Low level packages
1212
base/ -- Constants and utilities
13-
definitions/ -- Definitions of interfaces required for Platforms, Protocol interfaces and Payload layout structures
13+
definitions/ -- Definitions of interfaces for Platforms/Protocols and Payload Layouts
1414
icons/ -- Logos for chains
1515
1616
connect/ -- Makes use of the interfaces in `definitions` to expose protocols in a platform independent way.
@@ -26,7 +26,7 @@ platforms/ -- Contains `Platform` and `Protocol` implementations
2626
solana/ -- Contains Solana `Platform` and `Protocol` implementations
2727
etc...
2828
29-
sdk/ -- Metapackage that depeneds on the rest of the packages, meant to be a simpler way to install/use. Exports packages in a way that allows for tree shaking unused packages and splitting chunks.
29+
sdk/ -- Metapackage that depeneds on the rest of the packages, meant to be a simpler way to install/use.
3030
3131
examples/ -- Examples, also used for README string replace
3232
```
@@ -48,6 +48,14 @@ A Protocol (fka `Module`) is a specific application, it provides a set of method
4848

4949
To allow platform agnostic access to Protocols, each Platform that provides the protocol should have its own implementation.
5050

51+
# Connect package
52+
53+
The `connect` package provides access to all the `Platform` and `Protocol` implementations through their interfaces.
54+
55+
The `Wormhole` class represents a context to register specific Platforms and set some initial configuration overrides. It provides utility methods to do things like create a `ChainContext` or parse an address.
56+
57+
The `routes` directory contains the logic to make use of the Protocol implementations by composing a route through the use of one or more Protocol interfaces.
58+
5159
# SDK package
5260

5361
The `@wormhole-foundation/sdk` package was created to reduce the confusion reported by devs around what they needed to install and use.

0 commit comments

Comments
 (0)