Struct grin_wallet_libwallet::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 ttl_cutoff_height: Option<u64>,
    pub participant_data: Vec<ParticipantData>,
    pub payment_proof: Option<PaymentInfo>,
}

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

ttl_cutoff_height: Option<u64>

TTL, the block height at which wallets should refuse to process the transaction and unlock all associated outputs

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

payment_proof: Option<PaymentInfo>

Payment Proof

Methods

impl Slate

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

Attempt to find slate version

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

Recieve a slate, upgrade it to the latest version internally

pub fn blank(num_participants: usize) -> Slate

Create a new slate

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

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

pub fn update_kernel(&mut self)

Update the tx kernel based on kernel features derived from the current slate. The fee may change as we build a transaction and we need to update the tx kernel to reflect this during the tx building process.

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)

pub fn participant_with_id(&self, id: usize) -> Option<ParticipantData>

Return the participant with the given id

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

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

return the final excess

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<'_> From<&'_ Slate> for SlateV3

fn from(slate: &Slate) -> SlateV3

Performs the conversion.

impl From<Slate> for SlateV3

fn from(slate: Slate) -> SlateV3

Performs the conversion.

impl From<SlateV3> for Slate

fn from(slate: SlateV3) -> Slate

Performs the conversion.

impl From<VersionedSlate> for Slate

fn from(slate: VersionedSlate) -> Slate

Performs the conversion.

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.