milksad

History

Steven Roose bf3fba71cb Add external-symbols feature to support external libsecp This feature disables using the bundles sources and will link into existing libsecp256k1 symbols.		2019-11-27 21:04:32 +00:00
..
depend	Add vendor script to prefix secp256k1 sources	2019-11-27 21:03:48 +00:00
src	Add external-symbols feature to support external libsecp	2019-11-27 21:04:32 +00:00
Cargo.toml	Add external-symbols feature to support external libsecp	2019-11-27 21:04:32 +00:00
LICENSE	Add secp256k1-sys README and LICENSE files	2019-11-27 21:02:44 +00:00
README.md	Add secp256k1-sys README and LICENSE files	2019-11-27 21:02:44 +00:00
build.rs	Add external-symbols feature to support external libsecp	2019-11-27 21:04:32 +00:00
vendor-libsecp.sh	Add vendor script to prefix secp256k1 sources	2019-11-27 21:03:48 +00:00

README.md

secp256k1-sys

This crate provides Rust definitions for the FFI structures and methods.

Vendoring

The default build process is to build using the vendored libsecp256k1 sources in the depend folder. These sources are prefixed with a special rust-secp256k1-sys-specific prefix rustsecp256k1_v1_2_3_.

This prefix ensures that no symbol collision can happen:

when a Rust project has two different versions of rust-secp256k1 in its depepdency tree, or
when rust-secp256k1 is used for building a static library in a context where existing libsecp256k1 symbols are already linked.

To update the vendored sources, use the vendor-libsecp.sh script:

$ ./vendor-libsecp.sh depend <version-code> <rev>

Where <version-code> is the secp256k1-sys version number underscored: 0_1_2.
Where <rev> is the git revision of libsecp256k1 to checkout.

Linking to external symbols

For the more exotic use cases, this crate can be used with existing libsecp256k1 symbols by using the external-symbols feature. How to setup rustc to link against those existing symbols is left as an exercise to the reader.