wormhole/sdk/README.md

16 lines
671 B
Markdown
Raw Normal View History

# Wormhole Software Development Kit
This directory contains libraries in various languages for developing software that interacts with
wormhole.
# Directory Structure
* [sdk/](./): Go SDK. This package must live in this directory so that clients can use the
docs: quit the spelling spam typo fix PRs with cspell magic (#3845) * Add cspell configuration and custom dictionary The goal is to cut down on both incoming tyops, and well meaning but spammy tyop fix PRs. To run cspell locally install it and run: cspell '**/*.md' \ --config cspell.config.yaml \ --words-only \ --unique \ --quiet | sort --ignore-case * docs: cspell updates * wormchain: cspell updates * aptos: cspell updates * node: cspell updates * algorand: cspell updates * whitepapers: cspell updates * near: cspell updates * solana: cspell updates * terra: cspell updates * cosmwasm: cspell updates * ethereum: cspell updates * clients: cspell updates * cspell updates for DEVELOP document * github: run cspell github action * sdk: cspell updates * github: only run cspell on markdown files * algorand: EMMITTER --> EMITTER Suggested-by: @evan-gray * cspell: removed from dictionary Suggested-by: @evan-gray * aptos and node: cspell updates Suggested-by: @evan-gray * cosmowasm: doc updates for terra2 Suggested-by: @evan-gray * algorand: cspell updates Suggested-by: @evan-gray * algorand: cspell updates Suggested-by: @evan-gray * cspell: updated custom word dictionary This resorts the dictionary and adds a few new words from the algorand/MEMORY.md document around varints and integers. * cspell: sort the dictionary how vscode does it On macOS the sorting is locale dependent. To do this on macOS, you have to invert the case, do a character insensitive sort, and then invert the case again: LC_COLLATE="en_US.UTF-8" cspell '**/*.md' --config cspell.config.yaml \ --words-only \ --unique \ --no-progress \ --quiet \ | tr 'a-zA-Z' 'A-Za-z' \ | sort --ignore-case \ | tr 'a-zA-Z' 'A-Za-z' This requires the `LC_COLLATE` variable to be set to `en_US.UTF-8`, or it will not do the right thing. * docs: grammar clean up --------- Co-authored-by: Evan Gray <battledingo@gmail.com>
2024-03-20 12:40:02 -07:00
`github.com/wormhole-foundation/wormhole/sdk` import path.
* [vaa/](./vaa/): Go package for using VAAs (Verifiable Action Approval).
* [js/](./js/README.md): Javascript SDK.
* [js-proto-node/](./js-proto-node/README.md): NodeJS client protobuf.
* [js-proto-web/](./js-proto-web/README.md): Web client protobuf.
* [js-wasm/](./js-wasm/README.md): WebAssembly libraries.
* [rust/](./rust/): Rust SDK.