https://github.com/metamask/bdk-wasm
The Bitcoin Dev Kit for Browsers and Node
https://github.com/metamask/bdk-wasm
bdk bitcoin descriptors js node wasm webassembly
Last synced: about 2 months ago
JSON representation
The Bitcoin Dev Kit for Browsers and Node
- Host: GitHub
- URL: https://github.com/metamask/bdk-wasm
- Owner: MetaMask
- License: other
- Created: 2024-11-05T12:16:00.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-04-07T15:28:51.000Z (2 months ago)
- Last Synced: 2025-04-07T16:40:45.213Z (2 months ago)
- Topics: bdk, bitcoin, descriptors, js, node, wasm, webassembly
- Language: Rust
- Homepage: https://bitcoindevkit.org/
- Size: 202 KB
- Stars: 23
- Watchers: 43
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
The Bitcoin Dev Kit: WebAssembly
The Bitcoin Dev Kit for Browsers, Node, and React Native
## About
The `bdk-wasm` library aims at providing access to the excellent [BitcoinDevKit](https://github.com/bitcoindevkit/bdk) to JS and Node environments (and eventually any device supporting WebAssembly).
It specializes in compiling BDK on the `wasm32-unknown-unknown` target and use [`wasm-bindgen`](https://github.com/rustwasm/wasm-bindgen) to create TypeScript bindings.
This repo handles the packaging and publishing of the `bitcoindevkit` NPM package, using `wasm-pack`.
This library offers all the desired functionality to build a Bitcoin wallet out of the box:
- UTXO management
- Coin selection
- Wallet upates by syncing and scanning the chain data
- Bitcoin descriptors for flexibility in the definition of spending conditions. Supports all address types from legacy to Taproot.
- State update and persistence
- Transaction creation, signing and broadcasting
- Dynamic addresses
- and much more
For a lightweight library providing stateless utility functions, see [`bitcoinjs`](https://github.com/bitcoinjs/bitcoinjs-lib).
## Browser Usage
```sh
yarn add bitcoindevkit
```
## Notes on WASM Specific Considerations
> [!WARNING]
> There are several limitations to using BDK in WASM. Basically any functionality that requires the OS standard library is not directly available in WASM. However, there are viable workarounds documented below. Some key limitations include:
>
> - No access to the file system
> - Network access is limited to http(s)
### WASM Considerations Overview
#### No access to the file system
With no direct access to the file system, persistence cannot be handled by BDK directly. Instead, an in memory wallet must be used in the WASM environment, and the data must be exported using `wallet.take_staged()`. This will export the changeset for the updates to the wallet state, which must then be merged with current wallet state in JS (will depend on your persistence strategy). The persisted `ChangeSet` can be passed to `wallet.load()` to recover the wallet.
#### Network access is limited to http(s)
This essentially means the library only supports [Esplora](https://github.com/blockstream/esplora/blob/master/API.md) as blockchain client. Both RPC and Electrum clients require sockets and will not work for BDK in a WASM environment out of the box.
## Development Environment
### Requirements
- Install [Rust](https://www.rust-lang.org/tools/install)
- Install [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/)
#### MacOS special requirement
Refers to [this section](./DEVELOPMENT.md#build-on-macos).
### Build with `wasm-pack build`
> [!IMPORTANT]
> You need the `wasm32-unknown-unknown` toolchain to be installed:
>
> ```sh
> rustup target add wasm32-unknown-unknown
> ```
```sh
wasm-pack build
```
> Choose your desired features when building: `--features "esplora"`
### Test in Headless Browsers with `wasm-pack test`
```sh
wasm-pack test --headless --firefox
```
> Works with `--firefox`, `--chrome` or `--safari`.
## License
Licensed under either of
- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or )
- MIT license ([LICENSE-MIT](LICENSE-MIT) or )
at your option.
### Contribution
Unless you explicitly state otherwise, any contribution intentionally
submitted for inclusion in the work by you, as defined in the Apache-2.0
license, shall be dual licensed as above, without any additional terms or
conditions.