Struct sn_transfers::OfflineTransfer

pub struct OfflineTransfer {
    pub tx: Transaction,
    pub created_cash_notes: Vec<CashNote>,
    pub change_cash_note: Option<CashNote>,
    pub all_spend_requests: Vec<SignedSpend>,
}

Offline Transfer This struct contains all the necessary information to carry out the transfer. The created cash_notes and change cash_note from a transfer of tokens from one or more cash_notes, into one or more new cash_notes.

Fields

tx: Transaction

This is the transaction where all the below spends were made and cash_notes created.

created_cash_notes: Vec<CashNote>

The cash_notes that were created containing the tokens sent to respective recipient.

change_cash_note: Option<CashNote>

The cash_note holding surplus tokens after spending the necessary input cash_notes.

all_spend_requests: Vec<SignedSpend>

The parameters necessary to send all spend requests to the network.

Implementations

impl OfflineTransfer

pub fn from_transaction( signed_spends: BTreeSet<SignedSpend>, tx: Transaction, change_id: UniquePubkey, output_details: BTreeMap<UniquePubkey, (MainPubkey, DerivationIndex)> ) -> Result<Self>

pub fn new( available_cash_notes: Vec<(CashNote, Option<DerivedSecretKey>)>, recipients: Vec<(NanoTokens, MainPubkey, DerivationIndex)>, change_to: MainPubkey, reason_hash: Hash ) -> Result<Self>

A function for creating an offline transfer of tokens. This is done by creating new cash_notes to the recipients (and a change cash_note if any) by selecting from the available input cash_notes, and creating the necessary spends to do so.

Those signed spends are found in each new cash_note, and must be uploaded to the network for the transaction to take effect. The peers will validate each signed spend they receive, before accepting it. Once enough peers have accepted all the spends of the transaction, and serve them upon request, the transaction will be completed.

Trait Implementations

impl Clone for OfflineTransfer

fn clone(&self) -> OfflineTransfer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OfflineTransfer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OfflineTransfer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OfflineTransfer

fn eq(&self, other: &OfflineTransfer) -> 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 Serialize for OfflineTransfer

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OfflineTransfer