59 lines
3.9 KiB
Markdown
59 lines
3.9 KiB
Markdown
# 2.0.0
|
|
|
|
In this release we have strived to simplify the API, [using native types](https://github.com/bitcoinjs/bitcoinjs-lib/issues/407) wherevever possible to encourage cross-compatibility with other open source community modules.
|
|
|
|
The `ecdsa` module has been removed in lieu of using a new ECDSA module (for performance and safety reasons) during the `2.x.y` major release.
|
|
Several other cumbersome modules have been removed, with their new independent modules recommended for usage instead for greater modularity in your projects.
|
|
|
|
-----------------------------
|
|
|
|
Backward incompatible changes:
|
|
|
|
__added__
|
|
- export `address`, for `address` based [utility functions](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/src/address.js), most compatible, just without `Address` instantiation, see #401, #444
|
|
- export `script`, for `script` based [utility functions](https://github.com/bitcoinjs/bitcoinjs-lib/blob/master/src/script.js), mostly compatible, just without `Script` instantiation, see #438, #444
|
|
- export `ECPair`, a merged replacement for `ECKey`/`ECPubKey`, invalid types will throw via `typeforce`
|
|
|
|
__changed__
|
|
- `address.toOutputScript`, `ECPair.prototype.fromWIF` and `HDNode.prototype.fromBase58` no longer automatically detect the network, `networks.bitcoin` is always assumed unless given.
|
|
- `assert` was used for type checking, now replaced by `typeforce`
|
|
- `BIP66` compliant strict DER signature validation was added to `ECSignature.fromDER`, changing the exact exception messages slightly, see #448.
|
|
|
|
- `new HDNode(d/Q, chainCode, network)` -> `new HDNode(keyPair, chainCode)`, now uses `ECPair`
|
|
- `HDNode.prototype.toBase58(false)` -> `HDNode.prototype.neutered().toBase58()` for exporting an extended public key
|
|
- `HDNode.prototype.toBase58(true)` -> `HDNode.prototype.toBase58()` for exporting an extended private key
|
|
|
|
- `Transaction.prototype.hashForSignature(prevOutScript, inIndex, hashType)` -> `Transaction.prototype.hashForSignature(inIndex, prevOutScript, hashType)`
|
|
- `Transaction.prototype.addInput(hash, ...)`: `hash` could be a string, Transaction or Buffer -> `hash` can now **only** be a `Buffer`.
|
|
- `Transaction.prototype.addOutput(scriptPubKey, ...)`: `scriptPubKey ` could be a string, `Address` or a `Buffer` -> `scriptPubKey` can now **only** be a `Buffer`.
|
|
- `TransactionBuilder` API unchanged.
|
|
|
|
__removed__
|
|
- export `Address`, `strings` are now used, benchwith no performance loss for most use cases
|
|
- export `base58check`, use [`bs58check`](https://github.com/bitcoinjs/bs58check) instead
|
|
- export `ecdsa`, use [`ecurve`](https://github.com/cryptocoinjs/ecurve) instead
|
|
- export `ECKey`, use new export `ECPair` instead
|
|
- export `ECPubKey`, use new export `ECPair` instead
|
|
- export `Wallet`, see README.md#complementing-libraries instead
|
|
- export `Script`, use new utility export `script` instead (#438 for more information)
|
|
|
|
- `crypto.HmacSHA256 `, use [node crypto](https://nodejs.org/api/crypto.html) instead
|
|
- `crypto.HmacSHA512 `, use [node crypto](https://nodejs.org/api/crypto.html) instead
|
|
|
|
- `Transaction.prototype.sign`, use `TransactionBuilder.prototype.sign`
|
|
- `Transaction.prototype.signInput`, use `TransactionBuilder.prototype.sign`
|
|
- `Transaction.prototype.validateInput`, use `Transaction.prototype.hashForSignature` and `ECPair.verify`
|
|
|
|
- `HDNode.fromBuffer`, use `HDNode.fromBase58` instead
|
|
- `HDNode.fromHex`, use `HDNode.fromBase58` instead
|
|
- `HDNode.toBuffer`, use `HDNode.prototype.toBase58` instead
|
|
- `HDNode.toHex`, use `HDNode.prototype.toBase58` instead
|
|
|
|
- `networks.*.magic`, see the comment [here](https://github.com/bitcoinjs/bitcoinjs-lib/pull/432/files#r36715792)
|
|
- `networks.[viacoin|viacointestnet|gamerscoin|jumbucks|zetacoin]`, import these yourself (see #383/a0e6ee7)
|
|
- `networks.*.estimateFee`, out-dated
|
|
|
|
__renamed__
|
|
- `Message` -> `message`
|
|
- `scripts` -> `script`
|
|
- `scripts.dataOutput ` -> `script.nullDataOutput` (per [convention](https://org/en/glossary/null-data-transaction))
|