Struct Zewif

pub struct Zewif { /* private fields */ }

The top-level container for the Zcash Wallet Interchange Format (ZeWIF).

Zewif is the root structure of the ZeWIF hierarchy, serving as a container for multiple wallets and a global transaction history. This structure represents the entirety of the data that would be migrated between different Zcash wallet implementations.

Zcash Concept Relation

In the Zcash wallet ecosystem:

• Interchange Container: Zewif serves as the standardized format for moving wallet data between different implementations
• Multi-Wallet Support: A single interchange file can contain multiple wallets, each with its own accounts and configuration
• Global Transaction History: Transactions are stored at the top level and referenced by accounts in wallets, avoiding duplication
• Migration Target: This structure is the complete package that can be serialized/deserialized during wallet migration

Data Preservation

During wallet migration, the ZeWIF top-level container preserves:

• Complete Wallet Collection: All wallets with their unique identities and configurations
• Full Transaction Graph: The complete transaction history across all wallets
• Relationship Structure: The connections between wallets, accounts, and transactions
• Vendor-Specific Extensions: Custom metadata through the attachments system

Examples

// Create the top-level container
let mut zewif = Zewif::new(BlockHeight::from_u32(2000000));

// Add a wallet
let wallet = ZewifWallet::new(Network::Main);
zewif.add_wallet(wallet);

// Add a transaction to the global history
let txid = TxId::from_bytes([0u8; 32]); // In practice, a real transaction ID
let tx = Transaction::new(txid);
zewif.add_transaction(txid, tx);

// Access transactions
let tx_count = zewif.transactions().len();

Implementations

impl Zewif

pub fn new(export_height: BlockHeight) -> Self

pub fn id(&self) -> ARID

pub fn wallets(&self) -> &Vec<ZewifWallet>

pub fn wallets_len(&self) -> usize

pub fn add_wallet(&mut self, wallet: ZewifWallet)

pub fn transactions(&self) -> &HashMap<TxId, Transaction>

pub fn add_transaction(&mut self, txid: TxId, transaction: Transaction)

pub fn get_transaction(&self, txid: TxId) -> Option<&Transaction>

pub fn set_transactions(&mut self, transactions: HashMap<TxId, Transaction>)

pub fn export_height(&self) -> BlockHeight

Trait Implementations

impl Attachable for Zewif

fn attachments(&self) -> &Attachments

Returns a reference to the attachments container.

fn attachments_mut(&mut self) -> &mut Attachments

Returns a mutable reference to the attachments container.

fn add_attachment( &mut self, payload: impl EnvelopeEncodable, vendor: &str, conforms_to: Option<&str>, )

Adds a new attachment with the specified payload and metadata.

fn get_attachment(&self, digest: &Digest) -> Option<&Envelope>

Retrieves an attachment by its digest.

fn remove_attachment(&mut self, digest: &Digest) -> Option<Envelope>

Removes an attachment by its digest.

fn clear_attachments(&mut self)

Removes all attachments from the object.

fn has_attachments(&self) -> bool

Returns whether the object has any attachments.

impl Clone for Zewif

fn clone(&self) -> Zewif

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Zewif

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

Formats the value using the given formatter.

impl From<Zewif> for Envelope

fn from(value: Zewif) -> Self

Converts to this type from the input type.

impl PartialEq for Zewif

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<Envelope> for Zewif

type Error = Error

The type returned in the event of a conversion error.

fn try_from(envelope: Envelope) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Zewif