Skip to content

Commit

Permalink
Update README and package.json with revised descriptions of Miniscrip…
Browse files Browse the repository at this point in the history
…t Satisfier
  • Loading branch information
landabaso committed Dec 27, 2022
1 parent f2b3bb2 commit 778d47f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This project is a JavaScript implementation of Bitcoin Miniscript, a high-level language for describing Bitcoin spending conditions.

It includes a transpilation of [Peter Wuille's C++ code](https://github.com/sipa/miniscript) for compiling spending policies into Miniscript and Bitcoin scripts, as well as a Miniscript Satisfier for generating explicit witness scripts that are decoupled from the tx signer.
It includes a transpilation of [Peter Wuille's C++ code](https://github.com/sipa/miniscript) for compiling spending policies into Miniscript and Bitcoin scripts, as well as a novel Miniscript Satisfier for generating explicit witness scripts that are decoupled from the tx signer.

## Features

Expand Down Expand Up @@ -53,9 +53,9 @@ const miniscript = 'and_v(v:pk(key),or_b(l:after(100),al:after(200)))';
const { asm, issane } = compileMiniscript(miniscript);
```

### Generating expressive witness scripts
### Generating explicit witness scripts

To generate an expressive witness script from a Miniscript, you can use the `satisfier` function:
To generate an explicit witness script from a Miniscript, you can use the `satisfier` function:

```javascript
const { satisfier } = require('@bitcoinerlab/miniscript');
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
],
"homepage": "https://bitcoinerlab.com/miniscript",
"version": "1.0.2",
"description": "Bitcoin Miniscript, a high-level language for describing Bitcoin spending conditions. It includes a Policy and Miniscript compiler, as well as a Satisfier for generating expressive witness scripts.",
"description": "Bitcoin Miniscript, a high-level language for describing Bitcoin spending conditions. It includes a Policy and Miniscript compiler, as well as a novel Satisfier for generating expressive witness scripts.",
"main": "dist/index.js",
"scripts": {
"build": "rollup -c --bundleConfigAsCjs",
Expand Down

0 comments on commit 778d47f

Please sign in to comment.