rust-secp256k1-unsafe-fast/secp256k1-sys
Andrew Poelstra 9bdab89562
change --cfg=fuzzing to --cfg=secp256k1_fuzz
2023-05-01 16:11:44 +00:00
..
depend secp-sys: update README for new vendoring script 2023-03-30 12:40:18 +00:00
src change --cfg=fuzzing to --cfg=secp256k1_fuzz 2023-05-01 16:11:44 +00:00
wasm Move WASM const definitions to a source file 2022-03-30 10:22:37 +11:00
CHANGELOG.md Bump MSRV to 1.48 2023-03-31 09:43:50 +11:00
Cargo.toml Bump secp256k1-sys version to 0.8.1 2023-03-17 16:22:01 +11:00
LICENSE Add secp256k1-sys README and LICENSE files 2019-11-27 21:02:44 +00:00
README.md Merge rust-bitcoin/rust-secp256k1#594: Rewrite revendoring script 2023-03-31 21:26:24 +00:00
build.rs secp256k1-sys: Remove unused flags in build.rs 2022-11-24 13:38:40 +02:00
vendor-libsecp.sh secp-sys: update README for new vendoring script 2023-03-30 12:40:18 +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 <rev>

Where <rev> is the git revision of libsecp256k1 to checkout. If you do not specify a revision, the script will simply clone the repo and use whatever revision the default branch is pointing to.

Linking to external symbols

If you want to compile this library without using the bundled symbols (which may be required for integration into other build systems), you can do so by adding --cfg=rust_secp_no_symbol_renaming' to your RUSTFLAGS variable.

Minimum Supported Rust Version

This library should always compile with any combination of features on Rust 1.48.0.