dash/doc/shared-libraries.md

Shared Libraries
================

## dashconsensus

The purpose of this library is to make the verification functionality that is critical to Dash'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

`dashconsensus_version` returns an `unsigned int` with the API version *(currently at an experimental `0`)*.

#### Script Validation

`dashconsensus_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)*.
- `dashconsensus_error* err` - Will have the error/success code for the operation *(see below)*.

##### Script Flags
- `dashconsensus_SCRIPT_FLAGS_VERIFY_NONE`
- `dashconsensus_SCRIPT_FLAGS_VERIFY_P2SH` - Evaluate P2SH ([BIP16](https://github.com/bitcoin/bips/blob/master/bip-0016.mediawiki)) subscripts
- `dashconsensus_SCRIPT_FLAGS_VERIFY_DERSIG` - Enforce strict DER ([BIP66](https://github.com/bitcoin/bips/blob/master/bip-0066.mediawiki)) compliance
- `dashconsensus_SCRIPT_FLAGS_VERIFY_NULLDUMMY` - Enforce NULLDUMMY ([BIP147](https://github.com/bitcoin/bips/blob/master/bip-0147.mediawiki))
- `dashconsensus_SCRIPT_FLAGS_VERIFY_CHECKLOCKTIMEVERIFY` - Enable CHECKLOCKTIMEVERIFY ([BIP65](https://github.com/bitcoin/bips/blob/master/bip-0065.mediawiki))
- `dashconsensus_SCRIPT_FLAGS_VERIFY_CHECKSEQUENCEVERIFY` - Enable CHECKSEQUENCEVERIFY ([BIP112](https://github.com/bitcoin/bips/blob/master/bip-0112.mediawiki))

##### Errors
- `dashconsensus_ERR_OK` - No errors with input parameters *(see the return value of `dashconsensus_verify_script` for the verification status)*
- `dashconsensus_ERR_TX_INDEX` - An invalid index for `txTo`
- `dashconsensus_ERR_TX_SIZE_MISMATCH` - `txToLen` did not match with the size of `txTo`
- `dashconsensus_ERR_DESERIALIZE` - An error deserializing `txTo`
- `dashconsensus_ERR_INVALID_FLAGS` - Script verification `flags` are invalid (i.e. not part of the libconsensus interface)
doc: add documentation for shared library libbitcoinconsensus 2015-07-13 18:22:55 +02:00			`Shared Libraries`
			`================`

Rename bitcoinconsensus library to dashconsensus. (#1432) All names containing bitcoinconsensus remaned to contain dashconsensus. This is needed to avoid conflicts with real bitcoinconsensus library shipped with Bitcoin Core. Signed-off-by: Oleg Girko <ol@infoserver.lv> 2017-04-15 09:29:09 +02:00			`## dashconsensus`
doc: add documentation for shared library libbitcoinconsensus 2015-07-13 18:22:55 +02:00
Rename bitcoinconsensus library to dashconsensus. (#1432) All names containing bitcoinconsensus remaned to contain dashconsensus. This is needed to avoid conflicts with real bitcoinconsensus library shipped with Bitcoin Core. Signed-off-by: Oleg Girko <ol@infoserver.lv> 2017-04-15 09:29:09 +02:00			`The purpose of this library is to make the verification functionality that is critical to Dash's consensus available to other applications, e.g. to language bindings.`
doc: add documentation for shared library libbitcoinconsensus 2015-07-13 18:22:55 +02:00
			`### API`

revert dash#1432: Rename consensus source library and API It's a shared library, so we should keep its name and API distinguishable from Bitcoin's and avoid pkgconfig confusion Co-authored-by: UdjinM6 <UdjinM6@users.noreply.github.com> 2022-08-02 18:35:18 +02:00			The interface is defined in the C header `bitcoinconsensus.h` located in `src/script/bitcoinconsensus.h`.
doc: add documentation for shared library libbitcoinconsensus 2015-07-13 18:22:55 +02:00
			`#### Version`

Merge #7300: [trivial] Add missing copyright headers fabcee1 Remove copyright header from autogenerated chainparamsseeds.h (MarcoFalke) fa60d05 Add missing copyright headers (MarcoFalke) fa7e4c0 Bump copyright headers to 2014 (MarcoFalke) 2016-01-27 12:05:25 +01:00			`dashconsensus_version` returns an `unsigned int` with the API version (currently at an experimental `0`).
doc: add documentation for shared library libbitcoinconsensus 2015-07-13 18:22:55 +02:00
			`#### Script Validation`

Rename bitcoinconsensus library to dashconsensus. (#1432) All names containing bitcoinconsensus remaned to contain dashconsensus. This is needed to avoid conflicts with real bitcoinconsensus library shipped with Bitcoin Core. Signed-off-by: Oleg Girko <ol@infoserver.lv> 2017-04-15 09:29:09 +02:00			`dashconsensus_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`.
doc: add documentation for shared library libbitcoinconsensus 2015-07-13 18:22:55 +02:00
			`##### 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).
Rename bitcoinconsensus library to dashconsensus. (#1432) All names containing bitcoinconsensus remaned to contain dashconsensus. This is needed to avoid conflicts with real bitcoinconsensus library shipped with Bitcoin Core. Signed-off-by: Oleg Girko <ol@infoserver.lv> 2017-04-15 09:29:09 +02:00			- `dashconsensus_error* err` - Will have the error/success code for the operation (see below).
doc: add documentation for shared library libbitcoinconsensus 2015-07-13 18:22:55 +02:00
			`##### Script Flags`
Rename bitcoinconsensus library to dashconsensus. (#1432) All names containing bitcoinconsensus remaned to contain dashconsensus. This is needed to avoid conflicts with real bitcoinconsensus library shipped with Bitcoin Core. Signed-off-by: Oleg Girko <ol@infoserver.lv> 2017-04-15 09:29:09 +02:00			- `dashconsensus_SCRIPT_FLAGS_VERIFY_NONE`
			- `dashconsensus_SCRIPT_FLAGS_VERIFY_P2SH` - Evaluate P2SH ([BIP16](https://github.com/bitcoin/bips/blob/master/bip-0016.mediawiki)) subscripts
			- `dashconsensus_SCRIPT_FLAGS_VERIFY_DERSIG` - Enforce strict DER ([BIP66](https://github.com/bitcoin/bips/blob/master/bip-0066.mediawiki)) compliance
Merge #8848: Add NULLDUMMY verify flag in bitcoinconsensus.h 2fa0063 Add NULLDUMMY verify flag in bitcoinconsensus.h (Johnson Lau) 2016-10-04 12:14:43 +02:00			- `dashconsensus_SCRIPT_FLAGS_VERIFY_NULLDUMMY` - Enforce NULLDUMMY ([BIP147](https://github.com/bitcoin/bips/blob/master/bip-0147.mediawiki))
			- `dashconsensus_SCRIPT_FLAGS_VERIFY_CHECKLOCKTIMEVERIFY` - Enable CHECKLOCKTIMEVERIFY ([BIP65](https://github.com/bitcoin/bips/blob/master/bip-0065.mediawiki))
			- `dashconsensus_SCRIPT_FLAGS_VERIFY_CHECKSEQUENCEVERIFY` - Enable CHECKSEQUENCEVERIFY ([BIP112](https://github.com/bitcoin/bips/blob/master/bip-0112.mediawiki))
doc: add documentation for shared library libbitcoinconsensus 2015-07-13 18:22:55 +02:00
			`##### Errors`
Rename bitcoinconsensus library to dashconsensus. (#1432) All names containing bitcoinconsensus remaned to contain dashconsensus. This is needed to avoid conflicts with real bitcoinconsensus library shipped with Bitcoin Core. Signed-off-by: Oleg Girko <ol@infoserver.lv> 2017-04-15 09:29:09 +02:00			- `dashconsensus_ERR_OK` - No errors with input parameters (see the return value of `dashconsensus_verify_script` for the verification status)
			- `dashconsensus_ERR_TX_INDEX` - An invalid index for `txTo`
			- `dashconsensus_ERR_TX_SIZE_MISMATCH` - `txToLen` did not match with the size of `txTo`
			- `dashconsensus_ERR_DESERIALIZE` - An error deserializing `txTo`
Merge #20577: doc: libconsensus: add missing error code description, fix NBitcoin link cb0b7125c14bf97394bd8b43bf2abfb943bb1cf9 doc: libbitcoinconsensus: add missing error code description, fix NBitcoin link (Sebastian Falbesoner) Pull request description: This PR improves the libbitcoinconsensus description in `shared-libraries.md` in two ways: * adds the missing error code description for `bitcoinconsensus_ERR_INVALID_FLAGS` (introduced by commit 5ca8ef299a08aae91d5061750533694b58d810b2, PR #8976) * updates and fixes the link to the NBitcoin implementation (introduced by commit 3361edd01046aab137928d1e6e2468dbfc4b946e, PR #6430) * the owner of the `NBitcoin` github repository changed from `NicolasDorier` to `MetacoSA` (redirection still worked though) * instead of dynamically referring to a file in master with a fixed line number (which is obviously always quickly outdated), use a permalink with a file numbers area ACKs for top commit: MarcoFalke: cr ACK cb0b7125c14bf97394bd8b43bf2abfb943bb1cf9 harding: Code (documentation) review ACK cb0b7125c14bf97394bd8b43bf2abfb943bb1cf9. Text is clear and seems accurate, and the link checks out. Tree-SHA512: 9840458db6fb40e71c9852104aefcec5abbaf5054c6123701181dd477cea8c81d3647f376b67692159adf577c9b6305b05b784728bf9f14a753fab5898075a4e 2020-12-07 03:02:45 +01:00			- `dashconsensus_ERR_INVALID_FLAGS` - Script verification `flags` are invalid (i.e. not part of the libconsensus interface)