Struct sn_transfers::MainSecretKey

pub struct MainSecretKey(/* private fields */);

Types used in the public API A CashNote MainSecretKey is held by anyone who wants to send or receive tokens using CashNotes. It is held privately and not shared with anyone.

The secret MainSecretKey has a static MainPubkey, which is shared with others in order to receive payments. With this MainSecretKey, new DerivedSecretKey:UniquePubkey pairs can be generated.

Implementations

impl MainSecretKey

pub fn new(secret_key: SecretKey) -> Self

Create a new MainSecretKey from a bls SecretKey.

pub fn secret_key(&self) -> &SecretKey

Get the secret key.

pub fn main_pubkey(&self) -> MainPubkey

This is the static public address which is shared with others, and to which payments can be made by getting a new unique identifier for a CashNote to be created.

pub fn sign(&self, msg: &[u8]) -> Signature

Sign a message with the main key.

pub fn derive_key(&self, index: &DerivationIndex) -> DerivedSecretKey

Derive the key - the DerivedSecretKey - corresponding to a UniquePubkey which was also derived using the same DerivationIndex.

When someone wants to send tokens to the MainPubkey of this MainSecretKey, they generate the id of the CashNote - the UniquePubkey - that shall hold the tokens. The recipient of the tokens, is the person/entity that holds this MainSecretKey.

The created CashNote contains the derivation index that was used to generate that very UniquePubkey.

When passing the derivation index to this function (fn derive_key), a DerivedSecretKey is generated corresponding to the UniquePubkey. This DerivedSecretKey can unlock the CashNote of that UniquePubkey, thus giving access to the tokens it holds. By that, the recipient has received the tokens from the sender.

pub fn to_bytes(&self) -> Vec<u8>

Represent as bytes.

pub fn random() -> Self

pub fn random_from_rng(rng: &mut impl RngCore) -> Self

Create a randomly generated MainSecretKey.

pub fn random_derived_key(&self, rng: &mut impl RngCore) -> DerivedSecretKey