aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBraydon Fuller <braydon@bitpay.com>2015-07-13 12:22:55 -0400
committerBraydon Fuller <braydon@bitpay.com>2015-07-13 12:22:55 -0400
commitc156adac53b448780c7c9ef366c12237a7cea8e1 (patch)
treef1d559504fb6bb3b6394b66e221a99874576d518
parent7cdefb927e928780cdbbb3a9b2ffe37716eebae1 (diff)
doc: add documentation for shared library libbitcoinconsensus
-rw-r--r--doc/README.md1
-rw-r--r--doc/shared-libraries.md41
2 files changed, 42 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md
index ecddf50d4b..7b0c39d383 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -58,6 +58,7 @@ The Bitcoin repo's [root README](https://github.com/bitcoin/bitcoin/blob/master/
- [Translation Strings Policy](translation_strings_policy.md)
- [Unit Tests](unit-tests.md)
- [Unauthenticated REST Interface](REST-interface.md)
+- [Shared Libraries](shared-libraries.md)
- [BIPS](bips.md)
- [Dnsseed Policy](dnsseed-policy.md)
diff --git a/doc/shared-libraries.md b/doc/shared-libraries.md
new file mode 100644
index 0000000000..c8f4939e7e
--- /dev/null
+++ b/doc/shared-libraries.md
@@ -0,0 +1,41 @@
+Shared Libraries
+================
+
+## bitcoinconsensus
+
+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.
+
+### API
+
+The interface is defined in the C header `bitcoinconsensus.h` located in `src/script/bitcoinconsensus.h`.
+
+#### Version
+
+`bitcoinconsensus_version` returns an `unsigned int` with the the API version *(currently at an experimental `0`)*.
+
+#### Script Validation
+
+`bitcoinconsensus_verify_script` returns an `int` with the status of the verification. It will be `1` if the input script correctly spends the previous output `scriptPubKey`.
+
+##### Parameters
+- `const unsigned char *scriptPubKey` - The previous output script that encumbers spending.
+- `unsigned int scriptPubKeyLen` - The number of bytes for the `scriptPubKey`.
+- `const unsigned char *txTo` - The transaction with the input that is spending the previous output.
+- `unsigned int txToLen` - The number of bytes for the `txTo`.
+- `unsigned int nIn` - The index of the input in `txTo` that spends the `scriptPubKey`.
+- `unsigned int flags` - The script validation flags *(see below)*.
+- `bitcoinconsensus_error* err` - Will have the error/success code for the operation *(see below)*.
+
+##### Script Flags
+- `bitcoinconsensus_SCRIPT_FLAGS_VERIFY_NONE`
+- `bitcoinconsensus_SCRIPT_FLAGS_VERIFY_P2SH` - Evaluate P2SH ([BIP16](https://github.com/bitcoin/bips/blob/master/bip-0016.mediawiki)) subscripts
+- `bitcoinconsensus_SCRIPT_FLAGS_VERIFY_DERSIG` - Enforce strict DER ([BIP66](https://github.com/bitcoin/bips/blob/master/bip-0066.mediawiki)) compliance
+
+##### Errors
+- `bitcoinconsensus_ERR_OK`
+- `bitcoinconsensus_ERR_TX_INDEX` - An invalid index for `txTo`
+- `bitcoinconsensus_ERR_TX_SIZE_MISMATCH` - `txToLen` did not match with the size of `txTo`
+- `bitcoinconsensus_ERR_DESERIALIZE` - An error deserializing `txTo`
+
+### Example Implementations
+- [node-libbitcoinconsensus](https://github.com/bitpay/node-libbitcoinconsensus) (Node.js Bindings)