secp256kfun 0.12.1

A mid-level secp256k1 library optimized for fun!
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

//!
#![no_std]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![allow(non_snake_case)]
#![deny(missing_docs)]
#![doc = include_str!("../README.md")]

#[cfg(feature = "alloc")]
#[allow(unused_imports)]
#[macro_use]
extern crate alloc;

#[cfg(feature = "std")]
#[macro_use]
extern crate std;

pub mod hash;
pub mod hex;
pub mod nonce;

#[cfg(feature = "alloc")]
pub mod poly;

pub use digest;
pub use rand_core;
pub use subtle;

mod keypair;
mod point;
mod scalar;

mod vendor;

#[macro_use]
mod macros;
mod backend;
pub mod marker;
pub mod op;

pub use keypair::*;
pub use point::Point;
pub use scalar::Scalar;

/// Re-export `serde`
#[cfg_attr(docsrs, doc(cfg(feature = "serde")))]
#[cfg(feature = "serde")]
pub use serde;

/// Re-export `bincode`
#[cfg_attr(docsrs, doc(cfg(feature = "bincode")))]
#[cfg(feature = "bincode")]
pub use bincode;

#[doc(hidden)]
/// these are helpers so we hide them. Actual g! macro is defined in macros.rs
pub use secp256kfun_arithmetic_macros as arithmetic_macros;

mod libsecp_compat;
#[cfg(any(feature = "proptest", test))]
mod proptest_impls;
#[cfg(feature = "proptest")]
#[cfg_attr(docsrs, doc(cfg(feature = "proptest")))]
/// Re-export `proptest`
pub extern crate proptest;
/// The main basepoint for secp256k1 as specified in [_SEC 2: Recommended Elliptic Curve Domain Parameters_] and used in Bitcoin.
///
/// At the moment, [`G`] is the only [`BasePoint`] in the library.
/// ```
/// use secp256kfun::G;
/// assert_eq!(
///     format!("{:?}", G),
///     "Point<BasePoint,Public,NonZero>(0279be667ef9dcbbac55a06295ce870b07029bfcdb2dce28d959f2815b16f81798)"
/// );
/// ```
///
///[_SEC 2: Recommended Elliptic Curve Domain Parameters_]: https://www.secg.org/sec2-v2.pdf
///[`BasePoint`]: crate::marker::BasePoint
pub static G: &Point<marker::BasePoint, marker::Public, marker::NonZero> =
    &Point::from_inner(backend::G_POINT, marker::BasePoint);

// it is applied to nonce generators too so export at root
pub use hash::Tag;

#[cfg(feature = "libsecp_compat_0_27")]
/// Re-export `secp256k1`
pub extern crate secp256k1_0_27;

#[cfg(feature = "libsecp_compat_0_28")]
/// Re-export `secp256k1`
pub extern crate secp256k1_0_28;

#[cfg(feature = "libsecp_compat_0_29")]
/// Re-export `secp256k1`
pub extern crate secp256k1_0_29;

#[cfg(feature = "libsecp_compat_0_30")]
/// Re-export `secp256k1`
pub extern crate secp256k1_0_30;

#[cfg(feature = "libsecp_compat")]
pub use secp256k1_0_30 as secp256k1;

/// Convenience module to import the most frequently used tools
pub mod prelude {
    pub use crate::{G, Point, Scalar, g, marker::*, s};
}