xdapp-book/src/technical/typescript/overview.md

16 lines
796 B
Markdown
Raw Normal View History

2022-09-22 13:20:32 -07:00
# Wormhole Typescript SDK
2022-09-23 11:14:40 -07:00
A Wormhole Typescript SDK provided for applications that only need to interact with the Core and Token Bridge contracts off-chain.
2022-09-22 13:20:32 -07:00
It can be installed using npm:
```sh
2022-10-11 12:15:49 -07:00
npm i @certusone/wormhole-sdk
2022-09-22 13:20:32 -07:00
```
2022-09-23 11:14:40 -07:00
The following sections will explain and provide examples of how to perform key functions with Wormhole using the Typescript SDK.
For more examples with a more exhaustive coverage of all the supported blockchains in Wormhole, be sure to check the [official codebase](https://github.com/wormhole-foundation/wormhole/tree/main/sdk/js) for the Typescript SDK.
2022-09-22 13:20:32 -07:00
Virtually all functions of the SDK are demonstrated in the [reference bridge UI](https://github.com/wormhole-foundation/example-token-bridge-ui), which makes it an excellent source of example code as well.