diff options
| author | Tomo Ueda <[email protected]> | 2021-09-02 12:54:43 -0700 |
|---|---|---|
| committer | Tomo Ueda <[email protected]> | 2021-09-02 12:54:43 -0700 |
| commit | f5c716526aaafb318a98e974c8b2fbe02870646b (patch) | |
| tree | e14145656fcff86ec2c7a1ecf4ad28e0b40f36aa /doc/shared-libraries.md | |
| parent | s/DOGE/DIS/g (diff) | |
| download | discoin-f5c716526aaafb318a98e974c8b2fbe02870646b.tar.xz discoin-f5c716526aaafb318a98e974c8b2fbe02870646b.zip | |
really s/doge/dis/g this time
Diffstat (limited to 'doc/shared-libraries.md')
| -rw-r--r-- | doc/shared-libraries.md | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/doc/shared-libraries.md b/doc/shared-libraries.md index 2a147c0fa..596c6a221 100644 --- a/doc/shared-libraries.md +++ b/doc/shared-libraries.md @@ -1,21 +1,21 @@ Shared Libraries ================ -## dogecoinconsensus +## discoinconsensus The purpose of this library is to make the verification functionality that is critical to Dogecoin's consensus available to other applications, e.g. to language bindings. ### API -The interface is defined in the C header `dogecoinconsensus.h` located in `src/script/dogecoinconsensus.h`. +The interface is defined in the C header `discoinconsensus.h` located in `src/script/discoinconsensus.h`. #### Version -`dogecoinconsensus_version` returns an `unsigned int` with the API version *(currently at an experimental `0`)*. +`discoinconsensus_version` returns an `unsigned int` with the API version *(currently at an experimental `0`)*. #### Script Validation -`dogecoinconsensus_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`. +`discoinconsensus_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. @@ -24,26 +24,26 @@ The interface is defined in the C header `dogecoinconsensus.h` located in `src/ - `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)*. -- `dogecoinconsensus_error* err` - Will have the error/success code for the operation *(see below)*. +- `discoinconsensus_error* err` - Will have the error/success code for the operation *(see below)*. ##### Script Flags -- `dogecoinconsensus_SCRIPT_FLAGS_VERIFY_NONE` -- `dogecoinconsensus_SCRIPT_FLAGS_VERIFY_P2SH` - Evaluate P2SH ([BIP16](https://github.com/bitcoin/bips/blob/master/bip-0016.mediawiki)) subscripts -- `dogecoinconsensus_SCRIPT_FLAGS_VERIFY_DERSIG` - Enforce strict DER ([BIP66](https://github.com/bitcoin/bips/blob/master/bip-0066.mediawiki)) compliance -- `dogecoinconsensus_SCRIPT_FLAGS_VERIFY_NULLDUMMY` - Enforce NULLDUMMY ([BIP147](https://github.com/bitcoin/bips/blob/master/bip-0147.mediawiki)) -- `dogecoinconsensus_SCRIPT_FLAGS_VERIFY_CHECKLOCKTIMEVERIFY` - Enable CHECKLOCKTIMEVERIFY ([BIP65](https://github.com/bitcoin/bips/blob/master/bip-0065.mediawiki)) -- `dogecoinconsensus_SCRIPT_FLAGS_VERIFY_CHECKSEQUENCEVERIFY` - Enable CHECKSEQUENCEVERIFY ([BIP112](https://github.com/bitcoin/bips/blob/master/bip-0112.mediawiki)) -- `dogecoinconsensus_SCRIPT_FLAGS_VERIFY_WITNESS` - Enable WITNESS ([BIP141](https://github.com/bitcoin/bips/blob/master/bip-0141.mediawiki)) +- `discoinconsensus_SCRIPT_FLAGS_VERIFY_NONE` +- `discoinconsensus_SCRIPT_FLAGS_VERIFY_P2SH` - Evaluate P2SH ([BIP16](https://github.com/bitcoin/bips/blob/master/bip-0016.mediawiki)) subscripts +- `discoinconsensus_SCRIPT_FLAGS_VERIFY_DERSIG` - Enforce strict DER ([BIP66](https://github.com/bitcoin/bips/blob/master/bip-0066.mediawiki)) compliance +- `discoinconsensus_SCRIPT_FLAGS_VERIFY_NULLDUMMY` - Enforce NULLDUMMY ([BIP147](https://github.com/bitcoin/bips/blob/master/bip-0147.mediawiki)) +- `discoinconsensus_SCRIPT_FLAGS_VERIFY_CHECKLOCKTIMEVERIFY` - Enable CHECKLOCKTIMEVERIFY ([BIP65](https://github.com/bitcoin/bips/blob/master/bip-0065.mediawiki)) +- `discoinconsensus_SCRIPT_FLAGS_VERIFY_CHECKSEQUENCEVERIFY` - Enable CHECKSEQUENCEVERIFY ([BIP112](https://github.com/bitcoin/bips/blob/master/bip-0112.mediawiki)) +- `discoinconsensus_SCRIPT_FLAGS_VERIFY_WITNESS` - Enable WITNESS ([BIP141](https://github.com/bitcoin/bips/blob/master/bip-0141.mediawiki)) ##### Errors -- `dogecoinconsensus_ERR_OK` - No errors with input parameters *(see the return value of `dogecoinconsensus_verify_script` for the verification status)* -- `dogecoinconsensus_ERR_TX_INDEX` - An invalid index for `txTo` -- `dogecoinconsensus_ERR_TX_SIZE_MISMATCH` - `txToLen` did not match with the size of `txTo` -- `dogecoinconsensus_ERR_DESERIALIZE` - An error deserializing `txTo` -- `dogecoinconsensus_ERR_AMOUNT_REQUIRED` - Input amount is required if WITNESS is used +- `discoinconsensus_ERR_OK` - No errors with input parameters *(see the return value of `discoinconsensus_verify_script` for the verification status)* +- `discoinconsensus_ERR_TX_INDEX` - An invalid index for `txTo` +- `discoinconsensus_ERR_TX_SIZE_MISMATCH` - `txToLen` did not match with the size of `txTo` +- `discoinconsensus_ERR_DESERIALIZE` - An error deserializing `txTo` +- `discoinconsensus_ERR_AMOUNT_REQUIRED` - Input amount is required if WITNESS is used ### Example Implementations - [NBitcoin](https://github.com/NicolasDorier/NBitcoin/blob/master/NBitcoin/Script.cs#L814) (.NET Bindings) -- [node-libdogecoinconsensus](https://github.com/bitpay/node-libdogecoinconsensus) (Node.js Bindings) -- [java-libdogecoinconsensus](https://github.com/dexX7/java-libdogecoinconsensus) (Java Bindings) -- [dogecoinconsensus-php](https://github.com/Bit-Wasp/dogecoinconsensus-php) (PHP Bindings) +- [node-libdiscoinconsensus](https://github.com/bitpay/node-libdiscoinconsensus) (Node.js Bindings) +- [java-libdiscoinconsensus](https://github.com/dexX7/java-libdiscoinconsensus) (Java Bindings) +- [discoinconsensus-php](https://github.com/Bit-Wasp/discoinconsensus-php) (PHP Bindings) |