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.

shared-libraries.md 3.1KB

Shared Libraries

starwelsconsensus

The purpose of this library is to make the verification functionality that is critical to Starwels’s consensus available to other applications, e.g. to language bindings.

API

The interface is defined in the C header starwelsconsensus.h located in src/script/starwelsconsensus.h.

Version

starwelsconsensus_version returns an unsigned int with the API version (currently at an experimental 0).

Script Validation

starwelsconsensus_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).
  • starwelsconsensus_error* err - Will have the error/success code for the operation (see below).
Script Flags
  • starwelsconsensus_SCRIPT_FLAGS_VERIFY_NONE
  • starwelsconsensus_SCRIPT_FLAGS_VERIFY_P2SH - Evaluate P2SH (BIP16) subscripts
  • starwelsconsensus_SCRIPT_FLAGS_VERIFY_DERSIG - Enforce strict DER (BIP66) compliance
  • starwelsconsensus_SCRIPT_FLAGS_VERIFY_NULLDUMMY - Enforce NULLDUMMY (BIP147)
  • starwelsconsensus_SCRIPT_FLAGS_VERIFY_CHECKLOCKTIMEVERIFY - Enable CHECKLOCKTIMEVERIFY (BIP65)
  • starwelsconsensus_SCRIPT_FLAGS_VERIFY_CHECKSEQUENCEVERIFY - Enable CHECKSEQUENCEVERIFY (BIP112)
  • starwelsconsensus_SCRIPT_FLAGS_VERIFY_WITNESS - Enable WITNESS (BIP141)
Errors
  • starwelsconsensus_ERR_OK - No errors with input parameters (see the return value of starwelsconsensus_verify_script for the verification status)
  • starwelsconsensus_ERR_TX_INDEX - An invalid index for txTo
  • starwelsconsensus_ERR_TX_SIZE_MISMATCH - txToLen did not match with the size of txTo
  • starwelsconsensus_ERR_DESERIALIZE - An error deserializing txTo
  • starwelsconsensus_ERR_AMOUNT_REQUIRED - Input amount is required if WITNESS is used

Example Implementations