Skip to content
Merged
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
32 changes: 4 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,7 @@
# wasm-miniscript
# Deprecated

This is a wrapper around the [rust-miniscript](https://github.com/rust-bitcoin/rust-miniscript) crate that is compiled
to WebAssembly. It allows you to use Miniscript in NodeJS and in the browser.
This repository has migrated to [`BitGoWASM`](https://github.com/BitGo/BitGoWASM).

# WebUI playground
The `wasm-miniscript` package has been superseded by the [`wasm-utxo`](https://github.com/BitGo/BitGoWASM/tree/master/packages/wasm-utxo) package.

Go to https://bitgo.github.io/wasm-miniscript to see a live demo of the wasm-miniscript library in action.

# Dependencies

- [Rust](https://www.rust-lang.org/) nightly
- [wasm-pack](https://rustwasm.github.io/wasm-pack/) (install with `cargo install wasm-pack`)
- [NodeJS](https://nodejs.org/en/)

# Packages

## packages/wasm-miniscript

This contains the core library that is compiled to WebAssembly.
It is a wrapper around the `rust-miniscript` crate.

### Building

If your system has problems with `wasm-pack` (Mac M1), you can use the `Container.mk` Makefile to build the wasm files:

```bash
cd packages/wasm-miniscript
make -f Container.mk build-image
make -f Container.mk build-wasm
```
The old README is accessible at [README_OLD.md](./README_OLD.md)
31 changes: 31 additions & 0 deletions README_OLD.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# wasm-miniscript

This is a wrapper around the [rust-miniscript](https://github.com/rust-bitcoin/rust-miniscript) crate that is compiled
to WebAssembly. It allows you to use Miniscript in NodeJS and in the browser.

# WebUI playground

Go to https://bitgo.github.io/wasm-miniscript to see a live demo of the wasm-miniscript library in action.

# Dependencies

- [Rust](https://www.rust-lang.org/) nightly
- [wasm-pack](https://rustwasm.github.io/wasm-pack/) (install with `cargo install wasm-pack`)
- [NodeJS](https://nodejs.org/en/)

# Packages

## packages/wasm-miniscript

This contains the core library that is compiled to WebAssembly.
It is a wrapper around the `rust-miniscript` crate.

### Building

If your system has problems with `wasm-pack` (Mac M1), you can use the `Container.mk` Makefile to build the wasm files:

```bash
cd packages/wasm-miniscript
make -f Container.mk build-image
make -f Container.mk build-wasm
```