@ -1,5 +1,32 @@ |
||||
# Hyperlane Application SDK |
||||
# Hyperlane SDK |
||||
|
||||
The Hyperlane Application SDK help developers manage multichain Hyperlane applications. This requires a higher level API than dApp developers are familiar with which is namespaced by target chain. |
||||
The Hyperlane SDK helps developers create and manage interchain applications. |
||||
|
||||
You can find the docs at https://docs.hyperlane.xyz/hyperlane-docs/developers/application-sdk |
||||
For details on how to use the various abstractions and utilities, [see the documentation](https://docs.hyperlane.xyz/hyperlane-docs-1/developers/building-applications) |
||||
|
||||
## Install |
||||
|
||||
`yarn install @hyperlane-xyz/sdk` |
||||
|
||||
## Contents |
||||
|
||||
### Constants |
||||
|
||||
The names and relevant metadata for all Hyperlane-supported chains are included in this SDK, including public RPC and Explorer urls. It also includes the addresses for all Hyperlane core contracts and middleware. |
||||
|
||||
### Deployment, testing, and development classes |
||||
|
||||
Classes for deploying, testing, and building applications using Hyperlane are included in the SDK. See [the docs](https://docs.hyperlane.xyz/hyperlane-docs-1/developers/building-applications/nodejs-sdk) for details. |
||||
|
||||
### Chain Logos |
||||
|
||||
The SDK contains SVG files for all Hyperlane-supported chains. They can be imported from the `/logos` folder. |
||||
|
||||
```js |
||||
import ArbitrumBlack from '@hyperlane-xyz/sdk/logos/black/arbitrum.svg'; |
||||
import ArbitrumColor from '@hyperlane-xyz/sdk/logos/color/arbitrum.svg'; |
||||
``` |
||||
|
||||
## License |
||||
|
||||
Apache 2.0 |
||||
|
After Width: | Height: | Size: 922 B |
After Width: | Height: | Size: 779 B |
After Width: | Height: | Size: 495 B |
After Width: | Height: | Size: 614 B |
After Width: | Height: | Size: 608 B |
After Width: | Height: | Size: 1.2 KiB |
After Width: | Height: | Size: 427 B |
After Width: | Height: | Size: 506 B |
After Width: | Height: | Size: 948 B |
After Width: | Height: | Size: 700 B |
After Width: | Height: | Size: 1.3 KiB |
After Width: | Height: | Size: 883 B |
After Width: | Height: | Size: 548 B |
After Width: | Height: | Size: 555 B |
After Width: | Height: | Size: 536 B |
After Width: | Height: | Size: 1.2 KiB |
After Width: | Height: | Size: 2.3 KiB |
After Width: | Height: | Size: 1.1 KiB |
After Width: | Height: | Size: 705 B |