Struct sn_transfers::TransferReplica

pub struct TransferReplica { /* fields omitted */ }

The Replica is the part of an AT2 system that forms validating groups, and signs individual transfers between wallets. Replicas validate requests to debit an wallet, and apply operations that has a valid "debit agreement proof" from the group, i.e. signatures from a quorum of its peers. Replicas don't initiate transfers or drive the algo - only Actors do.

Implementations

impl Replica

pub fn from_history(
    secret_key: SecretKeyShare,
    key_index: usize,
    peer_replicas: PublicKeySet,
    events: Vec<ReplicaEvent>
) -> Result<Replica>

A new Replica instance from a history of events.

pub fn from_snapshot(
    secret_key: SecretKeyShare,
    key_index: usize,
    peer_replicas: PublicKeySet,
    other_groups: HashSet<PublicKeySet>,
    wallets: HashMap<PublicKey, Wallet>,
    pending_debits: HashMap<PublicKey, u64>
) -> Replica

A new Replica instance from current state.

pub fn credits_since(
    &self,
    wallet_id: &PublicKey,
    index: usize
) -> Option<Vec<Transfer>>

---

---------------------- Queries ----------------------------------

Query for new credits since specified index. NB: This is not guaranteed to give you all unknown to you, since there is no absolute order on the credits! Includes the credit at specified index (which may, or may not, be the same as the one that the Actor has at the same index).

pub fn debits_since(
    &self,
    wallet_id: &PublicKey,
    index: usize
) -> Option<Vec<Transfer>>

Query for new debits transfers since specified index. Includes the debit at specified index.

pub fn balance(&self, wallet_id: &PublicKey) -> Option<Money>

pub fn replicas_pk_set(&self) -> Option<PublicKeySet>

Get the replica's PK set

pub fn genesis<F: FnOnce() -> Option<PublicKey>>(
    &self,
    debit_proof: &DebitAgreementProof,
    f: F
) -> Result<Option<TransferPropagated>>

---

---------------------- Cmds -------------------------------------

This is the one and only infusion of money to the system. Ever. It is carried out by the first node in the network.

pub fn add_known_group(
    &self,
    group: PublicKeySet
) -> Result<Option<KnownGroupAdded>>

Adds a PK set for a a new group that we learn of.

pub fn test_validate_transfer(
    &self,
    signed_transfer: SignedTransfer
) -> Result<Option<TransferValidated>>

For now, with test money there is no from wallet.., money is created from thin air.

pub fn validate(
    &self,
    signed_transfer: SignedTransfer
) -> Result<Option<TransferValidated>>

Step 1. Main business logic validation of a debit.

pub fn register<F: FnOnce() -> bool>(
    &self,
    debit_proof: &DebitAgreementProof,
    f: F
) -> Result<Option<TransferRegistered>>

Step 2. Validation of agreement, and order at debit source.

pub fn receive_propagated<F: FnOnce() -> Option<PublicKey>>(
    &self,
    debit_proof: &DebitAgreementProof,
    f: F
) -> Result<Option<TransferPropagated>>

Step 3. Validation of DebitAgreementProof, and credit idempotency at credit destination. (Since this leads to a credit, there is no requirement on order.)

pub fn apply(&mut self, event: ReplicaEvent) -> Result<()>

---

---------------------- Mutation ---------------------------------

Mutation of state. There is no validation of an event, it (the cmd) is assumed to have been properly validated before the fact is established (event raised), and thus anything that breaks here, is a bug in the validation..

Trait Implementations

impl Clone for Replica

fn clone(&self) -> Replica

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Replica

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

Formats the value using the given formatter.

impl Eq for Replica

impl PartialEq<Replica> for Replica

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

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

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

This method tests for !=.

impl StructuralEq for Replica

impl StructuralPartialEq for Replica