Prepare CHANGELOG for v3.0

peercoin · Feb 24, 2025 · e03ce94 · e03ce94
1 parent 6cb8598
commit e03ce94
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/coinlib/CHANGELOG.md b/coinlib/CHANGELOG.md
@@ -1,3 +1,20 @@
+## 3.0.0
+
+This release adds support for ANYPREVOUT and ANYPREVOUTANYSCRIPT. There have
+been numerous breaking changes.
+
+- Refactored `SigHashType` to use `OutputSigHashOption` and
+    `InputSigHashOption`. Adds ANYPREVOUT and ANYPREVOUTANYSCRIPT.
+- Add `TapLeafChecksig` for single signature checksig tapscripts
+- Add `TaprootSingleScriptSigInput` to sign tapscripts using `TapLeafChecksig`.
+    Can sign using ANYPREVOUT and ANYPREVOUTANYSCRIPT.
+- Replaced `sign()` with `signLegacy()`, `signLegacyWitness()`, `signTaproot()`
+    and `signTaprootSingleScriptSig()`.
+- Added `SignDetails` with numerous subclasses for providing signing details for
+    inputs. `SignatureHasher` subclasses and `Input` sign methods refactored
+    accordingly.
+- Taproot signatures are made using SIGHASH_DEFAULT by default.
+
 ## 2.2.0
 
 Add `ECCompressedPublicKey` class that forces compressed public keys.

diff --git a/coinlib/README.md b/coinlib/README.md
@@ -51,7 +51,7 @@ immutable. New modified objects are returned from methods. For example, signing
 a transaction returns a new signed transaction object:
 
 ```dart
-final signedTx = unsignedTx.sign(inputN: 0, key: privateKey);
+final signedTx = unsignedTx.signLegacy(inputN: 0, key: privateKey);
 ```
 
 An example is found in the `example/` directory.