Changeset View
Changeset View
Standalone View
Standalone View
doc/shared-libraries.md
| Shared Libraries | Shared Libraries | ||||
| ================ | ================ | ||||
| ## bitcoinconsensus | ## 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. | 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 | ### API | ||||
| The interface is defined in the C header `bitcoinconsensus.h` located in `src/script/bitcoinconsensus.h`. | The interface is defined in the C header `bitcoinconsensus.h` located in `src/script/bitcoinconsensus.h`. | ||||
| #### Version | #### Version | ||||
| `bitcoinconsensus_version` returns an `unsigned int` with the API version *(currently at an experimental `0`)*. | `bitcoinconsensus_version` returns an `unsigned int` with the API version *(currently `1`)*. | ||||
| #### Script Validation | #### 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`. | `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 | ##### Parameters | ||||
| - `const unsigned char *scriptPubKey` - The previous output script that encumbers spending. | - `const unsigned char *scriptPubKey` - The previous output script that encumbers spending. | ||||
| - `unsigned int scriptPubKeyLen` - The number of bytes for the `scriptPubKey`. | - `unsigned int scriptPubKeyLen` - The number of bytes for the `scriptPubKey`. | ||||
| Show All 26 Lines | |||||