Struct private_currency::SecretState

pub struct SecretState { /* fields omitted */ }

Secret state of an account owner.

Usage

SecretState can be used to create transactions originating from the wallet. The state also should be updated based on the wallet history, which can be retrieved with HTTP API. Each transaction in the history should be applied to the state exactly once.

Methods

impl SecretState

pub fn with_random_keypair() -> Self

Creates an uninitialized state. The keypair for cryptographic operations is generated randomly.

pub fn from_keypair(verifying_key: PublicKey, signing_key: SecretKey) -> Self

Creates an uninitialized state from the specified Ed25519 keypair.

pub fn public_key(&self) -> &PublicKey

Gets the public key of the wallet (aka verifying Ed25519 key for digital signatures).

pub fn balance(&self) -> u64

Gets the current wallet balance.

pub fn create_wallet(&self) -> CreateWallet

Produces a CreateWallet transaction for this wallet.

pub fn create_transfer(     &self,     amount: u64,     receiver: &PublicKey,     rollback_delay: u32 ) -> Transfer

Produces a Transfer transaction from this wallet to the specified receiver.

Panics

This method will panic if the transfer violates constraints imposed by the transaction logic of the service:

• amount is out of bounds specified by service CONFIG
• receiver is same as the sender
• rollback_delay is not within acceptable range

pub fn initialize(&mut self)

Initializes the state.

Safety

This method should be called after CreateWallet transaction is committed. It should only be called once.

pub fn verify_transfer(&self, transfer: &Transfer) -> Option<VerifiedTransfer>

Verifies an incoming transfer.

Return value

Returns the decrypted opening for the transferred amount, or None if it cannot be decrypted from the transfer.

pub fn transfer(&mut self, transfer: &Transfer)

Updates the state according to a Transfer transaction.

Safety

The transfer is assumed to be previously verified or originating from self. It is also assumed to be sourced from the blockchain (i.e., verified according to the blockchain rules).

pub fn rollback(&mut self, transfer: &Transfer)

Rolls back a previously committed transfer.

Safety

The transfer is assumed to be originating from the blockchain and rolled back according to the wallet history.

pub fn corresponds_to(&self, wallet: &WalletInfo) -> bool

Checks if this state corresponds to the supplied public info about a Wallet.

pub fn to_public(&self) -> WalletInfo

Produces a public info about the state.

Trait Implementations

impl Debug for SecretState

fn fmt(&self, formatter: &mut Formatter) -> Result

Formats the value using the given formatter.