You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2.3 KiB
2.3 KiB
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 thescriptPubKey.const unsigned char *txTo- The transaction with the input that is spending the previous output.unsigned int txToLen- The number of bytes for thetxTo.unsigned int nIn- The index of the input intxTothat spends thescriptPubKey.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_NONEbitcoinconsensus_SCRIPT_FLAGS_VERIFY_P2SH- Evaluate P2SH (BIP16) subscriptsbitcoinconsensus_SCRIPT_FLAGS_VERIFY_DERSIG- Enforce strict DER (BIP66) compliance
Errors
bitcoinconsensus_ERR_OK- No errors with input parameters (see the return value ofbitcoinconsensus_verify_scriptfor the verification status)bitcoinconsensus_ERR_TX_INDEX- An invalid index fortxTobitcoinconsensus_ERR_TX_SIZE_MISMATCH-txToLendid not match with the size oftxTobitcoinconsensus_ERR_DESERIALIZE- An error deserializingtxTo
Example Implementations
- NBitcoin (.NET Bindings)
- node-libbitcoinconsensus (Node.js Bindings)
- java-libbitcoinconsensus (Java Bindings)