Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add documentation for shared library libbitcoinconsensus #6430

Merged
merged 3 commits into from Jul 17, 2015

Conversation

braydonf
Copy link

@braydonf braydonf commented Jul 13, 2015

Related Issue: #5311

@laanwj laanwj added the Docs label Jul 14, 2015
@laanwj
Copy link
Member

laanwj commented Jul 14, 2015

Looks good to me, thanks!

@jonasschnelli
Copy link
Contributor

jonasschnelli commented Jul 14, 2015

Nice. Thanks.
ACK.
I also like name shared-libraries.md which implies that more things should be available as library.

@theuni
Copy link
Member

theuni commented Jul 14, 2015

Looks great, thanks. One nit though: Please specify that bitcoinconsensus_ERR_OK only means that the inputs were sane and that verification was attempted, it does not mean that verification succeeded.

@fanquake
Copy link
Member

fanquake commented Jul 15, 2015

ACK

@lontivero
Copy link
Contributor

lontivero commented Jul 15, 2015

Could you add another Example Implementations for NBitcoin? It is a library for .NET that implements the consensus library too.

https://github.com/NicolasDorier/NBitcoin/blob/master/NBitcoin/Script.cs#L814

@paveljanik
Copy link
Contributor

paveljanik commented Jul 15, 2015

ACK

@laanwj laanwj merged commit 3361edd into bitcoin:master Jul 17, 2015
1 check passed
laanwj added a commit that referenced this issue Jul 17, 2015
3361edd doc: Add NBitcoin to bitcoinconsensus examples (Braydon Fuller)
b1bac4e Add description for bitcoinconsensus_ERR_OK (Braydon Fuller)
c156ada doc: add documentation for shared library libbitcoinconsensus (Braydon Fuller)
fanquake added a commit that referenced this issue Dec 7, 2020
…fix NBitcoin link

cb0b712 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 5ca8ef2, PR #8976)
  * updates and fixes the link to the NBitcoin implementation (introduced by commit 3361edd, 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 cb0b712
  harding:
    Code (documentation) review ACK cb0b712.  Text is clear and seems accurate, and the link checks out.

Tree-SHA512: 9840458db6fb40e71c9852104aefcec5abbaf5054c6123701181dd477cea8c81d3647f376b67692159adf577c9b6305b05b784728bf9f14a753fab5898075a4e
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Aug 18, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants