Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add info to wasm page #103

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/cookbook/wasm.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# WASM Example
# WASM Example (JavaScript)

WASM bindings can be used to access rust code from virtually any JavaScript environment: browsers, Node.js, ReactNative, etc.

!!! info
This page details how to build a custom WASM package that uses BDK rust crate under the hood. If you want an out of the box solution for JS(WASM) bindings for BDK which don't require writing any rust code, see the WASM section on the [3rd Party Bindings](https://bitcoindevkit.github.io/book-of-bdk/getting-started/3rd-party-bindings/) page for a pre-packaged npm module.

Because rust can compile to WASM, it is possible to use BDK in the browser. However, there are a few limitations to keep in mind which will be highlighted in this example. That being said, there are perfectly viable work-arounds for these limitations that should suffice for most use cases.

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ nav:
- Seed Phrase to Descriptors: cookbook/keys-descriptors/seed-phrase.md
- Transactions:
- Transaction Builder: cookbook/transactions/transaction-builder.md
- WASM: cookbook/wasm.md
- WASM (JS): cookbook/wasm.md
- Architecture:
- Overview:
- Design: architecture/design.md
Loading