Skip to content

Commit de54882

Browse files
jrawsthornebrunoerg
andcommitted
docs: add docs for additional libconsensus functions
Co-authored-by: Bruno Garcia <[email protected]>
1 parent 70106e0 commit de54882

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

doc/shared-libraries.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,14 @@ The interface is defined in the C header `bitcoinconsensus.h` located in `src/sc
1111

1212
#### Version
1313

14-
`bitcoinconsensus_version` returns an `unsigned int` with the API version *(currently `1`)*.
14+
`bitcoinconsensus_version` returns an `unsigned int` with the API version *(currently `2`)*.
1515

1616
#### Script Validation
1717

18-
`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`.
18+
`bitcoinconsensus_verify_script`, `bitcoinconsensus_verify_script_with_amount` and `bitcoinconsensus_verify_script_with_spent_outputs` return an `int` with the status of the verification. It will be `1` if the input script correctly spends the previous output `scriptPubKey`.
1919

2020
##### Parameters
21+
###### bitcoinconsensus_verify_script
2122
- `const unsigned char *scriptPubKey` - The previous output script that encumbers spending.
2223
- `unsigned int scriptPubKeyLen` - The number of bytes for the `scriptPubKey`.
2324
- `const unsigned char *txTo` - The transaction with the input that is spending the previous output.
@@ -26,6 +27,28 @@ The interface is defined in the C header `bitcoinconsensus.h` located in `src/sc
2627
- `unsigned int flags` - The script validation flags *(see below)*.
2728
- `bitcoinconsensus_error* err` - Will have the error/success code for the operation *(see below)*.
2829

30+
###### bitcoinconsensus_verify_script_with_amount
31+
- `const unsigned char *scriptPubKey` - The previous output script that encumbers spending.
32+
- `unsigned int scriptPubKeyLen` - The number of bytes for the `scriptPubKey`.
33+
- `int64_t amount` - The amount spent in the input
34+
- `const unsigned char *txTo` - The transaction with the input that is spending the previous output.
35+
- `unsigned int txToLen` - The number of bytes for the `txTo`.
36+
- `unsigned int nIn` - The index of the input in `txTo` that spends the `scriptPubKey`.
37+
- `unsigned int flags` - The script validation flags *(see below)*.
38+
- `bitcoinconsensus_error* err` - Will have the error/success code for the operation *(see below)*.
39+
40+
###### bitcoinconsensus_verify_script_with_spent_outputs
41+
- `const unsigned char *scriptPubKey` - The previous output script that encumbers spending.
42+
- `unsigned int scriptPubKeyLen` - The number of bytes for the `scriptPubKey`.
43+
- `int64_t amount` - The amount spent in the input
44+
- `const unsigned char *txTo` - The transaction with the input that is spending the previous output.
45+
- `unsigned int txToLen` - The number of bytes for the `txTo`.
46+
- `UTXO *spentOutputs` - Previous outputs spent in the transaction. `UTXO` is a struct composed by `const unsigned char *scriptPubKey`, `unsigned int scriptPubKeySize` (the number of bytes for the `scriptPubKey`) and `unsigned int value`.
47+
- `unsigned int spentOutputsLen` - The number of bytes for the `spentOutputs`.
48+
- `unsigned int nIn` - The index of the input in `txTo` that spends the `scriptPubKey`.
49+
- `unsigned int flags` - The script validation flags *(see below)*.
50+
- `bitcoinconsensus_error* err` - Will have the error/success code for the operation *(see below)*.
51+
2952
##### Script Flags
3053
- `bitcoinconsensus_SCRIPT_FLAGS_VERIFY_NONE`
3154
- `bitcoinconsensus_SCRIPT_FLAGS_VERIFY_P2SH` - Evaluate P2SH ([BIP16](https://github.com/bitcoin/bips/blob/master/bip-0016.mediawiki)) subscripts
@@ -34,6 +57,7 @@ The interface is defined in the C header `bitcoinconsensus.h` located in `src/sc
3457
- `bitcoinconsensus_SCRIPT_FLAGS_VERIFY_CHECKLOCKTIMEVERIFY` - Enable CHECKLOCKTIMEVERIFY ([BIP65](https://github.com/bitcoin/bips/blob/master/bip-0065.mediawiki))
3558
- `bitcoinconsensus_SCRIPT_FLAGS_VERIFY_CHECKSEQUENCEVERIFY` - Enable CHECKSEQUENCEVERIFY ([BIP112](https://github.com/bitcoin/bips/blob/master/bip-0112.mediawiki))
3659
- `bitcoinconsensus_SCRIPT_FLAGS_VERIFY_WITNESS` - Enable WITNESS ([BIP141](https://github.com/bitcoin/bips/blob/master/bip-0141.mediawiki))
60+
- `bitcoinconsensus_SCRIPT_FLAGS_VERIFY_TAPROOT` - Enable TAPROOT ([BIP340](https://github.com/bitcoin/bips/blob/master/bip-0340.mediawiki), [BIP341](https://github.com/bitcoin/bips/blob/master/bip-0341.mediawiki), [BIP342](https://github.com/bitcoin/bips/blob/master/bip-0342.mediawiki))
3761

3862
##### Errors
3963
- `bitcoinconsensus_ERR_OK` - No errors with input parameters *(see the return value of `bitcoinconsensus_verify_script` for the verification status)*
@@ -42,6 +66,8 @@ The interface is defined in the C header `bitcoinconsensus.h` located in `src/sc
4266
- `bitcoinconsensus_ERR_DESERIALIZE` - An error deserializing `txTo`
4367
- `bitcoinconsensus_ERR_AMOUNT_REQUIRED` - Input amount is required if WITNESS is used
4468
- `bitcoinconsensus_ERR_INVALID_FLAGS` - Script verification `flags` are invalid (i.e. not part of the libconsensus interface)
69+
- `bitcoinconsensus_ERR_SPENT_OUTPUTS_REQUIRED` - Spent outputs are required if TAPROOT is used
70+
- `bitcoinconsensus_ERR_SPENT_OUTPUTS_MISMATCH` - Spent outputs size doesn't match tx inputs size
4571

4672
### Example Implementations
4773
- [NBitcoin](https://github.com/MetacoSA/NBitcoin/blob/5e1055cd7c4186dee4227c344af8892aea54faec/NBitcoin/Script.cs#L979-#L1031) (.NET Bindings)

0 commit comments

Comments
 (0)