milksad
/
rust-secp256k1-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity
rust-secp256k1-unsafe-fast/secp256k1-sys
History
Tobin C. Harding 873ad47343
Allow dead_code on AlignedType 
We use the `AlignedType` and take a pointer to its inner data, never
access the data directly - this confuses clippy causing a "field is
never used" warning.

Shoosh the lint and add a code comment explaining why.
 		2024-03-26 09:33:38 +11:00
..
depend secp256k1-sys: update all symbols from 0.9.1 to 0.9.2 2024-01-02 16:22:20 +00:00
src Allow dead_code on AlignedType 2024-03-26 09:33:38 +11:00
wasm Move WASM const definitions to a source file 2022-03-30 10:22:37 +11:00
CHANGELOG.md fix incorrect FFI binding for pubkey_combine 2023-12-18 21:28:27 +00:00
Cargo.toml secp256k1-sys: update all symbols from 0.9.1 to 0.9.2 2024-01-02 16:22:20 +00:00
LICENSE Add secp256k1-sys README and LICENSE files 2019-11-27 21:02:44 +00:00
README.md Improve the README files 2023-05-16 08:49:03 +10:00
build.rs build.rs: patch out any calls to `printf` 2023-11-01 17:34:21 +00:00
vendor-libsecp.sh secp256k1-sys: patch out checked_malloc 2023-11-06 14:50:13 +00:00

README.md

Rust secp256k1-sys

Crate Info CC0 1.0 Universal Licensed API Docs Rustc Version 1.48.0+

Provides low-level bindings to the C FFI exposed by libsecp256k1.

Vendoring

The default build process is to build using the vendored libsecp256k1 sources in the depend directory. 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

Danger: doing this incorrectly may have catastrophic consequences!

This is mainly intended for applications consisting of various programming languages that intend to link the same library to save space, or bundles of multiple binaries coming from the same source. Do not use this to link to a random secp256k1 library you found in your OS! If you are packaging software that depends on rust-secp256k1, using this flag to link to another package, make sure you stay within the binary compatibility guarantees of that package. For example, in Debian if you need libsecp256k1 1.2.3, make sure your package requires a version strictly>= 1.2.3 << 1.2.4. Note also that unless you're packaging the library for an official repository you should prefix your package and the library with a string specific to you. E.g. if you have a set of packages called my-awesome-packages you should package libsecp256k1 as libmy-awesome-packages-secp256k1 and depend on that library/package name from your application.

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.