sikkienl/dash
1
0
Fork 0
mirror of https://github.com/dashpay/dash.git synced 2024-12-27 04:52:59 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity
4f97133dd6
dash/doc/shared-libraries.md
Kittywhiskers Van Gogh f02085e988 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-09 14:16:28 +05:30

2.4 KiB
Raw Blame History

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) subscripts
  • dashconsensus_SCRIPT_FLAGS_VERIFY_DERSIG - Enforce strict DER (BIP66) compliance
  • dashconsensus_SCRIPT_FLAGS_VERIFY_NULLDUMMY - Enforce NULLDUMMY (BIP147)
  • dashconsensus_SCRIPT_FLAGS_VERIFY_CHECKLOCKTIMEVERIFY - Enable CHECKLOCKTIMEVERIFY (BIP65)
  • dashconsensus_SCRIPT_FLAGS_VERIFY_CHECKSEQUENCEVERIFY - Enable CHECKSEQUENCEVERIFY (BIP112)
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