diff --git a/CHANGELOG.md b/CHANGELOG.md index f31645b..25c9b3c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,15 @@ +# 5.0.0 +__added__ +- TypeScript support (#1319) +- `Block.prototype.checkTxRoots` will check the merkleRoot and witnessCommit if it exists against the transactions array. (e52abec) (0426c66) + +__changed__ +- `Transaction.prototype.getHash` now has `forWitness?: boolean` which when true returns the hash for wtxid (a652d04) +- `Block.calculateMerkleRoot` now has `forWitness?: boolean` which when true returns the witness commit (a652d04) + +__removed__ +- `Block.prototype.checkMerkleRoot` was removed, please use `checkTxRoots` (0426c66) + # 4.0.3 __fixed__ - Fixed `TransactionBuilder` to require that the Transaction has outputs before signing (#1151) diff --git a/README.md b/README.md index 458693f..27b336c 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ [![Build Status](https://travis-ci.org/bitcoinjs/bitcoinjs-lib.png?branch=master)](https://travis-ci.org/bitcoinjs/bitcoinjs-lib) [![NPM](https://img.shields.io/npm/v/bitcoinjs-lib.svg)](https://www.npmjs.org/package/bitcoinjs-lib) -[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard) +[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) -A javascript Bitcoin library for node.js and browsers. +A javascript Bitcoin library for node.js and browsers. Written in TypeScript, but committing the JS files to verify. Released under the terms of the [MIT LICENSE](LICENSE). @@ -23,7 +23,7 @@ Mistakes and bugs happen, but with your help in resolving and reporting [issues] - Easy to audit and verify, - Tested, with test coverage >95%, - Advanced and feature rich, -- Standardized, using [standard](https://github.com/standard/standard) and Node `Buffer`'s throughout, and +- Standardized, using [prettier](https://github.com/prettier/prettier) and Node `Buffer`'s throughout, and - Friendly, with a strong and helpful community, ready to answer questions. @@ -80,20 +80,6 @@ If you're familiar with how to use browserify, ignore this and carry on, otherwi ### Typescript or VSCode users Type declarations for Typescript are included in this library. Normal installation should include all the needed type information. - -### Flow -[Flow-type](https://flowtype.org/) definitions for are available in the [flow-*typed* repository](https://github.com/flowtype/flow-typed/tree/master/definitions/npm/bitcoinjs-lib_v2.x.x) for version `^2.0.0` of the library. - -You can [download them directly](https://github.com/flowtype/flow-typed/blob/master/definitions/npm/bitcoinjs-lib_v2.x.x/flow_v0.17.x-/bitcoinjs-lib_v2.x.x.js), or using the flow-typed CLI: - -``` bash -npm install -g flow-typed -flow-typed install -f 0.27 bitcoinjs-lib@2.2.0 -``` - -**WARNING**: These flow-typed definitions are not maintained by the maintainers of this repository. - - ## Examples The below examples are implemented as integration tests, they should be very easy to understand. Otherwise, pull requests are appreciated.