Struct grin_wallet_libwallet::slate::Slate

pub struct Slate {
    pub version_info: VersionCompatInfo,
    pub num_participants: usize,
    pub id: Uuid,
    pub tx: Transaction,
    pub amount: u64,
    pub fee: u64,
    pub height: u64,
    pub lock_height: u64,
    pub participant_data: Vec<ParticipantData>,
}

A 'Slate' is passed around to all parties to build up all of the public transaction data needed to create a finalized transaction. Callers can pass the slate around by whatever means they choose, (but we can provide some binary or JSON serialization helpers here).

Fields

version_info: VersionCompatInfo

Versioning info

num_participants: usize

The number of participants intended to take part in this transaction

id: Uuid

Unique transaction ID, selected by sender

tx: Transaction

The core transaction data: inputs, outputs, kernels, kernel offset

amount: u64

base amount (excluding fee)

fee: u64

fee amount

height: u64

Block height for the transaction

lock_height: u64

Lock height

participant_data: Vec<ParticipantData>

Participant data, each participant in the transaction will insert their public data here. For now, 0 is sender and 1 is receiver, though this will change for multi-party

Methods

impl Slate

pub fn parse_slate_version(slate_json: &str) -> Result<u16, Error>

TODO: Reduce the number of changes that need to occur below for each new slate version

pub fn deserialize_upgrade(slate_json: &str) -> Result<Slate, Error>

Recieve a slate, upgrade it to the latest version internally

pub fn serialize_to_version(
    &self,
    version: Option<u16>
) -> Result<String, Error>

Downgrate slate to desired version

pub fn blank(num_participants: usize) -> Slate

Create a new slate

pub fn add_transaction_elements<K>(
    &mut self,
    keychain: &K,
    elems: Vec<Box<Append<K>>>
) -> Result<BlindingFactor, Error> where
    K: Keychain, 

Adds selected inputs and outputs to the slate's transaction Returns blinding factor

pub fn fill_round_1<K>(
    &mut self,
    keychain: &K,
    sec_key: &mut SecretKey,
    sec_nonce: &SecretKey,
    participant_id: usize,
    message: Option<String>,
    use_test_rng: bool
) -> Result<(), Error> where
    K: Keychain, 

Completes callers part of round 1, adding public key info to the slate

pub fn fill_round_2<K>(
    &mut self,
    keychain: &K,
    sec_key: &SecretKey,
    sec_nonce: &SecretKey,
    participant_id: usize
) -> Result<(), Error> where
    K: Keychain, 

Completes caller's part of round 2, completing signatures

pub fn finalize<K>(&mut self, keychain: &K) -> Result<(), Error> where
    K: Keychain, 

Creates the final signature, callable by either the sender or recipient (after phase 3: sender confirmation) TODO: Only callable by receiver at the moment

pub fn participant_messages(&self) -> ParticipantMessages

helper to return all participant messages

pub fn verify_messages(&self) -> Result<(), Error>

Verifies any messages in the slate's participant data match their signatures

Trait Implementations

impl Clone for Slate

fn clone(&self) -> Slate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Slate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Slate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Slate

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

Serialize this value into the given Serde serializer.