aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorWladimir J. van der Laan <laanwj@gmail.com>2014-12-23 19:08:06 +0100
committerWladimir J. van der Laan <laanwj@gmail.com>2014-12-23 19:08:19 +0100
commita2300499b76e1a3654241f871ab53d5f6b95308e (patch)
tree90cffb637b866b514fe8ea9e77bfc3b9053bc764 /doc
parent343492795af9b59cc03650bd8d45bb813f6b96ec (diff)
doc: mention consensus library in release notes
Diffstat (limited to 'doc')
-rw-r--r--doc/release-notes.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/release-notes.md b/doc/release-notes.md
index 0a59d27a69..803bb33e6b 100644
--- a/doc/release-notes.md
+++ b/doc/release-notes.md
@@ -173,6 +173,28 @@ Compared to using `getrawtransaction`, this mechanism does not require
with future block chain pruning functionality. It does mean the address needs
to added to the wallet before the payment, though.
+Consensus library
+=================
+
+Starting from 0.10.0, the Bitcoin Core distribution includes a consensus library.
+
+The purpose of this library is to make the verification functionality that is
+critical to Bitcoin's consensus available to other applications, e.g. to language
+bindings such as [python_bitcoinlib](https://pypi.python.org/pypi/python-bitcoinlib) or
+alternative node implementations.
+
+This library is called `libbitcoinconsensus.so` (or, `.dll` for Windows).
+Its interface is defined in the C header [bitcoinconsensus.h](https://github.com/bitcoin/bitcoin/blob/0.10/src/script/bitcoinconsensus.h).
+
+In its initial version the API includes two functions:
+
+- `bitcoinconsensus_verify_script` verifies a script. It returns whether the indicated input of the provided serialized transaction
+correctly spends the passed scriptPubKey under additional constraints indicated by flags
+- `bitcoinconsensus_version` returns the API version, currently at an experimental `0`
+
+The functionality is planned to be extended to e.g. UTXO management in upcoming releases, but the interface
+for existing methods should remain stable.
+
0.10.0 Release notes
=======================