Struct sm9::Fn

#[repr(C)]
pub struct Fn(/* private fields */);

Fn is a prime field with n elements where n is the order of the cyclic groups 𝔾1, 𝔾2 and 𝔾t Represents an element of the finite field F_r

Examples

use sm9_core::*;
use hex_literal::hex;

let ks = Fr::from_slice(&hex!("000130E78459D78545CB54C587E02CF480CE0B66340F319F348A1D5B1F2DC5F4")).unwrap();
let r = Fr::from_slice(&hex!("00033C86 16B06704 813203DF D0096502 2ED15975 C662337A ED648835 DC4B1CBE")).unwrap();
let pub_s = G2::one() * ks;
let g = pairing(G1::one(), pub_s).pow(r);
let r1 = g.to_slice();
println!("{:#?}", g);
let r0 = hex!(
"81377B8F DBC2839B 4FA2D0E0 F8AA6853 BBBE9E9C 4099608F 8612C607 8ACD7563"
"815AEBA2 17AD502D A0F48704 CC73CABB 3C06209B D87142E1 4CBD99E8 BCA1680F"
"30DADC5C D9E207AE E32209F6 C3CA3EC0 D800A1A4 2D33C731 53DED47C 70A39D2E"
"8EAF5D17 9A1836B3 59A9D1D9 BFC19F2E FCDB8293 28620962 BD3FDF15 F2567F58"
"A543D256 09AE9439 20679194 ED30328B B33FD156 60BDE485 C6B79A7B 32B01398"
"3F012DB0 4BA59FE8 8DB88932 1CC2373D 4C0C35E8 4F7AB1FF 33679BCA 575D6765"
"4F8624EB 435B838C CA77B2D0 347E65D5 E4696441 2A096F41 50D8C5ED E5440DDF"
"0656FCB6 63D24731 E8029218 8A2471B8 B68AA993 89926849 9D23C897 55A1A897"
"44643CEA D40F0965 F28E1CD2 895C3D11 8E4F65C9 A0E3E741 B6DD52C0 EE2D25F5"
"898D6084 8026B7EF B8FCC1B2 442ECF07 95F8A81C EE99A624 8F294C82 C90D26BD"
"6A814AAF 475F128A EF43A128 E37F8015 4AE6CB92 CAD7D150 1BAE30F7 50B3A9BD"
"1F96B08E 97997363 91131470 5BFB9A9D BB97F755 53EC90FB B2DDAE53 C8F68E42"
);
assert_eq!(r0, r1);
// test  fast_pairing
let g1 = fast_pairing(G1::one(), pub_s).pow(r);
let r1 = g1.to_slice();
assert_eq!(r0, r1);

Implementations

impl Fr

pub fn from_slice(hex: &[u8]) -> Option<Fr>

Attempts to convert a big-endian byte slice into an element of Fr, slice’s length must be in [1, 64]

pub fn from_hash(hex: &[u8]) -> Option<Fr>

for H1() and H2(), Attempts to convert a HASH result (40 bytes) to a Fr element

pub fn zero() -> Fr

Returns zero, the additive identity.

pub fn one() -> Fr

Returns one, the multiplicative identity.

pub fn pow(&self, exp: Fr) -> Fr

Exponentiates self by exp, where exp is a Fr element exponent.

pub fn inverse(&self) -> Option<Fr>

Computes the multiplicative inverse of this element, failing if the element is zero.

pub fn random<R>(rng: &mut R) -> Fr

where R: Rng,

Get a random element

pub fn is_zero(&self) -> bool

Returns true if element is the additive identity.

pub fn interpret(buf: &[u8; 64]) -> Fr

Attempts to convert a big-endian byte representation of a field element into an element of Fr, slice length must be 64

pub fn to_slice(self) -> [u8; 32]

Converts an element of Fr into a byte representation in big-endian byte order.

pub fn set_bit(&mut self, bit: usize, to: bool)

Set the specified bit to 0 or 1

Trait Implementations

impl<'a, 'b> Add<&'b Fr> for &'a Fr

type Output = Fr

The resulting type after applying the + operator.

fn add(self, rhs: &'b Fr) -> Fr

Performs the + operation.

impl<'b> Add<&'b Fr> for Fr

type Output = Fr

The resulting type after applying the + operator.

fn add(self, rhs: &'b Fr) -> Fr

Performs the + operation.

impl<'a> Add<Fr> for &'a Fr

type Output = Fr

The resulting type after applying the + operator.

fn add(self, rhs: Fr) -> Fr

Performs the + operation.

impl Add for Fr

type Output = Fr

The resulting type after applying the + operator.

fn add(self, rhs: Fr) -> Fr

Performs the + operation.

impl<'b> AddAssign<&'b Fr> for Fr

fn add_assign(&mut self, rhs: &'b Fr)

Performs the += operation.

impl AddAssign for Fr

fn add_assign(&mut self, rhs: Fr)

Performs the += operation.

impl Clone for Fr

fn clone(&self) -> Fr

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Fr

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl FromStr for Fr

fn from_str(s: &str) -> Result<Fr, <Fr as FromStr>::Err>

Attempts to convert a decimal base string to a element of Fr

type Err = FieldError

The associated error which can be returned from parsing.

impl<'a, 'b> Mul<&'b Fr> for &'a Fr

type Output = Fr

The resulting type after applying the * operator.

fn mul(self, rhs: &'b Fr) -> Fr

Performs the * operation.

impl<'b> Mul<&'b Fr> for Fr

type Output = Fr

The resulting type after applying the * operator.

fn mul(self, rhs: &'b Fr) -> Fr

Performs the * operation.

impl<'a> Mul<Fr> for &'a Fr

type Output = Fr

The resulting type after applying the * operator.

fn mul(self, rhs: Fr) -> Fr

Performs the * operation.

impl Mul<G1> for Fr

type Output = G1

The resulting type after applying the * operator.

fn mul(self, other: G1) -> G1

Performs the * operation.

impl Mul<G2> for Fr

type Output = G2

The resulting type after applying the * operator.

fn mul(self, other: G2) -> G2

Performs the * operation.

impl Mul for Fr

type Output = Fr

The resulting type after applying the * operator.

fn mul(self, rhs: Fr) -> Fr

Performs the * operation.

impl<'b> MulAssign<&'b Fr> for Fr

fn mul_assign(&mut self, rhs: &'b Fr)

Performs the *= operation.

impl MulAssign for Fr

fn mul_assign(&mut self, rhs: Fr)

Performs the *= operation.

impl<'a> Neg for &'a Fr

type Output = Fr

The resulting type after applying the - operator.

fn neg(self) -> Fr

Performs the unary - operation.

impl Neg for Fr

type Output = Fr

The resulting type after applying the - operator.

fn neg(self) -> Fr

Performs the unary - operation.

impl PartialEq for Fr

fn eq(&self, other: &Fr) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, 'b> Sub<&'b Fr> for &'a Fr

type Output = Fr

The resulting type after applying the - operator.

fn sub(self, rhs: &'b Fr) -> Fr

Performs the - operation.

impl<'b> Sub<&'b Fr> for Fr

type Output = Fr

The resulting type after applying the - operator.

fn sub(self, rhs: &'b Fr) -> Fr

Performs the - operation.

impl<'a> Sub<Fr> for &'a Fr

type Output = Fr

The resulting type after applying the - operator.

fn sub(self, rhs: Fr) -> Fr

Performs the - operation.

impl Sub for Fr

type Output = Fr

The resulting type after applying the - operator.

fn sub(self, rhs: Fr) -> Fr

Performs the - operation.

impl<'b> SubAssign<&'b Fr> for Fr

fn sub_assign(&mut self, rhs: &'b Fr)

Performs the -= operation.

impl SubAssign for Fr

fn sub_assign(&mut self, rhs: Fr)

Performs the -= operation.

impl TryFrom<&[u8]> for Fr

type Error = FieldError

The type returned in the event of a conversion error.

fn try_from(hex: &[u8]) -> Result<Fr, <Fr as TryFrom<&[u8]>>::Error>

Performs the conversion.

impl Copy for Fr

impl Eq for Fr

impl StructuralEq for Fr

impl StructuralPartialEq for Fr