rust-secp256k1-unsafe-fast/secp256k1-sys
Tobin Harding 02dec3eb9b
Implement AsRef instead of custom method
Clippy emits a warning since we define a method that has the same name
as a standard trait. Implement the trait `AsRef` instead of using a
custom method.
2020-12-22 12:56:11 +11:00
..
depend Update depend folder to latest master 2020-10-12 21:35:28 +09:00
src Implement AsRef instead of custom method 2020-12-22 12:56:11 +11:00
wasm-sysroot Add sanity checks for wasm32 for size and alignment of types 2020-04-29 15:32:57 -04:00
CHANGELOG.md Update MSRV to 1.29; increase version to 0.19 and -sys version to 0.3 2020-08-27 14:18:06 +00:00
Cargo.toml Add AligneType and redo secp256k1_context_create with alloc 2020-12-18 12:48:16 +02:00
LICENSE Add secp256k1-sys README and LICENSE files 2019-11-27 21:02:44 +00:00
README.md readme: add an example for travis 2020-03-17 22:33:29 +01:00
build.rs Update secp256k1-sys to add schnorr/extra-keys 2020-11-09 16:00:28 +09:00
vendor-libsecp.sh Update Cargo.toml link in vendor script 2019-12-11 15:54:30 +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.