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

Add ffi module #71

Merged
merged 9 commits into from
Dec 6, 2023
Merged

Conversation

tcharding
Copy link
Member

This is #67 without the final version bump patch.

Do a bunch of cleanups then add an ffi module to encapsulate the FFI function declarations.

Improve the docs on `verify` by doing:

- Attempt to make the docs more terse with no loss of meaning.
- Remove link to transactions, no need to bless a specific explorer,
  folk can use the explorer of their choice to look things up.
Move the error code to the bottom of the file because it is boring and
should not be looked at.

Code move only, no other changes.
Wildcards obfuscate imports; import the types explicitly.

Refactor only, no logic changes.
The C function declarations can go at the bottom, based on the principle
of putting the most important stuff at the top.

Refactor only, no logic changes.
We don't need to see C++ build warnings for implicit fallthrough.
We have moved away from using this comment in the rest of the
`rust-bitcoin` org repos, do so here also.
We use github actions for CI now, we no longer need the old travis
config file.
In order to de-clutter the HTML docs add a public submodule `ffi` and
put the C function definitions in it.
Copy link
Member

@apoelstra apoelstra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 01a48d1

@apoelstra apoelstra merged commit 76ada74 into rust-bitcoin:master Dec 6, 2023
@tcharding tcharding deleted the 12-07-add-ffi-module branch December 11, 2023 04:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants