package memwallet

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: Accounts

• uint32 account_id = 1

  the index of this account

• AccountKind kind = 2

  derived or imported

• optional bytes seed_fingerprint = 3

• optional uint32 account_index = 4

  HD index to derive account from seed

• optional AccountPurpose purpose = 5

  spending or view-only

• string viewing_key = 6

  the viewing key for this account

• optional AccountBirthday birthday = 7

  the block height at which this account was created

• repeated Address addresses = 8

  account addresses

• repeated EphemeralAddressRecord ephemeral_addresses = 9

  map from index to encoded unified address

• string account_name = 10

  human readable name for the account

• optional string key_source = 11

  key source metadata

Used in: Account

• optional ChainState prior_chain_state = 1

  the chain state at the block height before the account was created

• optional uint32 recover_until = 2

  the block height until which the account should stop being in recovery mode

Used in: Account

• Derived = 0

• Imported = 1

Used in: Account

• Spending = 0

• ViewOnly = 1

Used in: MemoryWallet

• repeated Account accounts = 1

  map from account index to account data

• uint32 account_nonce = 2

  the nonce for the next account

Used in: Account

• bytes diversifier_index = 1

• string address = 2

Used in: AccountBirthday

• uint32 block_height = 1

  the height of this block

• bytes block_hash = 2

• bytes final_sapling_tree = 3

• bytes final_orchard_tree = 4

Used in: EphemeralAddressRecord

• string address = 1

• optional bytes used_in_tx = 2

• optional bytes seen_in_tx = 3

Used in: Account

• uint32 index = 1

• optional EphemeralAddress ephemeral_address = 2

Used in: WalletBlock

• optional NoteId note_id = 1

• bytes memo = 2

A serialized zcash wallet state

• uint32 version = 1

  the version of the wallet serialization format

• optional Accounts accounts = 2

  the accounts in this wallet

• repeated WalletBlock blocks = 3

  map from block height to block data

• repeated TransactionTableRecord tx_table = 4

  map from transaction id to transaction data

• repeated ReceivedNote received_note_table = 5

  the notes received by this wallet

• repeated ReceivedNoteSpendRecord received_note_spends = 6

  the notes spent by this wallet

• repeated NullifierRecord nullifiers = 7

  the nullifiers for notes spent by this wallet

• repeated SentNoteRecord sent_notes = 8

  the notes sent by this wallet

• repeated TxLocatorRecord tx_locator = 9

  map between txIds and their inclusion in blocks

• repeated ScanQueueRecord scan_queue = 10

  the scan queue (which blocks the wallet should scan next and with what priority)

• optional ShardTree sapling_tree = 11

  Sapling shielded pool shard tree

• repeated TreeEndHeightsRecord sapling_tree_shard_end_heights = 12

  the block heights corresponding to the last note commitment for each shard in the sapling tree

• optional ShardTree orchard_tree = 13

  Orchard shielded pool shard tree

• repeated TreeEndHeightsRecord orchard_tree_shard_end_heights = 14

  the block heights corresponding to the last note commitment for each shard in the orchard tree

• repeated TransparentReceivedOutputRecord transparent_received_outputs = 15

  UTXOs known to this wallet

• repeated TransparentReceivedOutputSpendRecord transparent_received_output_spends = 16

  UTXOs spent by this wallet

• repeated TransparentSpendCacheRecord transparent_spend_map = 17

  Map from spends to their location in the blockchain

• repeated TransactionDataRequest transaction_data_requests = 18

  Queue of transaction data requests the wallet should make to the lightwalletd provided to obtain more complete information

Used in: ReceivedNote, Recipient

• ShieldedProtocol protocol = 1

• bytes recipient = 2

• uint64 value = 3

• optional bytes rho = 4

• optional RSeed rseed = 5

Used in: Memo, ReceivedNote, ReceivedNoteSpendRecord, SentNoteRecord

• optional TxId tx_id = 1

• PoolType pool = 2

• uint32 output_index = 3

Used in: NullifierRecord, ReceivedNote

• ShieldedProtocol protocol = 1

• bytes nullifier = 2

records where a nullifier was spent by block height and tx index in that block

Used in: MemoryWallet

• optional Nullifier nullifier = 1

• uint32 block_height = 2

• uint32 tx_index = 3

Used in: Recipient, TransparentReceivedOutputRecord, TransparentReceivedOutputSpendRecord, TransparentSpendCacheRecord

• bytes hash = 1

• uint32 n = 2

Used in: NoteId, Recipient

• Transparent = 0

• ShieldedSapling = 1

• ShieldedOrchard = 2

Used in: Note

• optional RSeedType rseed_type = 1

• bytes payload = 2

Used in: RSeed

• BeforeZip212 = 0

• AfterZip212 = 1

Used in: MemoryWallet

• optional NoteId note_id = 1

• optional TxId tx_id = 2

• uint32 output_index = 3

• uint32 account_id = 4

• optional Note note = 5

• optional Nullifier nullifier = 6

• bool is_change = 7

• bytes memo = 8

• optional uint64 commitment_tree_position = 9

• optional Scope recipient_key_scope = 10

associates a note and a transaction where it was spent

Used in: MemoryWallet

• optional NoteId note_id = 1

• optional TxId tx_id = 2

Used in: TransparentReceivedOutputRecord

• bytes transaction_id = 1

• uint32 account_id = 2

• string address = 3

• optional TxOut txout = 4

• optional uint32 max_observed_unspent_height = 5

Used in: SentNote

• RecipientType recipient_type = 1

• optional string address = 2

  either the zcash address if external or transparent address if EphemeralTransparent

• optional PoolType pool_type = 3

  the shielded protocol if External

• optional uint32 account_id = 4

  the account id if EphemeralTransparent or InternalAccount

• optional OutPoint outpoint = 5

  the outpoint metadata if InternalAccount

• optional Note note = 6

  the note if InternalAccount

Used in: Recipient

• ExternalRecipient = 0

• EphemeralTransparent = 1

• InternalAccount = 2

Used in: ScanQueueRecord

• Ignored = 0

  / Block ranges that are ignored have lowest priority.

• Scanned = 1

  / Block ranges that have already been scanned will not be re-scanned.

• Historic = 2

  / Block ranges to be scanned to advance the fully-scanned height.

• OpenAdjacent = 3

  / Block ranges adjacent to heights at which the user opened the wallet.

• FoundNote = 4

  / Blocks that must be scanned to complete note commitment tree shards adjacent to found notes.

• ChainTip = 5

  / Blocks that must be scanned to complete the latest note commitment tree shard.

• Verify = 6

  / A previously scanned range that must be verified to check it is still in the / main chain, has highest priority.

Used in: MemoryWallet

• uint32 start_height = 1

• uint32 end_height = 2

• ScanPriority priority = 3

Used in: ReceivedNote

• Internal = 0

• External = 1

Used in: SentNoteRecord

• uint32 from_account_id = 1

• optional Recipient to = 2

• uint64 value = 3

• bytes memo = 4

Record storing the sent information for a given note

Used in: MemoryWallet

• optional NoteId sent_note_id = 1

• optional SentNote sent_note = 2

A shard tree defined by a cap subtree and shard subtrees

Used in: MemoryWallet

• bytes cap = 1

• repeated TreeShard shards = 2

• repeated TreeCheckpoint checkpoints = 3

Used in: Note, Nullifier

• sapling = 0

• orchard = 1

Used in: MemoryWallet

• TransactionDataRequestType request_type = 1

• optional TxId tx_id = 2

  for the GetStatus and Enhancement variants

• optional bytes address = 3

  for the SpendsFromAddress variant

• optional uint32 block_range_start = 4

• optional uint32 block_range_end = 5

Used in: TransactionDataRequest

• GetStatus = 0

• Enhancement = 1

• SpendsFromAddress = 2

Used in: TransactionTableRecord

• TransactionStatus tx_status = 1

• optional uint32 block = 2

• optional uint32 tx_index = 3

• optional uint32 expiry_height = 4

• optional bytes raw_tx = 5

• optional uint64 fee = 6

• optional uint32 target_height = 7

• optional uint32 mined_height = 8

Used in: TransactionEntry

• TxidNotRecognized = 0

• NotInMainChain = 1

• Mined = 2

A record storing transaction data in the transaction table

Used in: MemoryWallet

• optional TxId tx_id = 1

• optional TransactionEntry tx_entry = 2

Used in: MemoryWallet

• optional OutPoint outpoint = 1

• optional ReceivedTransparentOutput output = 2

Used in: MemoryWallet

• optional OutPoint outpoint = 1

• optional TxId tx_id = 2

Used in: MemoryWallet

• optional TxId tx_id = 1

• optional OutPoint outpoint = 2

A checkpoint in a shard tree

Used in: ShardTree

• uint32 checkpoint_id = 1

• uint64 position = 2

Stores the block height corresponding to the last note commitment in a shard as defined by its level and index in the tree

Used in: MemoryWallet

• uint32 level = 1

• uint64 index = 2

• uint32 block_height = 3

A shard in a shard tree

Used in: ShardTree

• uint64 shard_index = 1

• bytes shard_data = 3

Unique identifier for a zcash transaction

Used in: NoteId, ReceivedNote, ReceivedNoteSpendRecord, TransactionDataRequest, TransactionTableRecord, TransparentReceivedOutputSpendRecord, TransparentSpendCacheRecord, TxLocatorRecord

• bytes hash = 1

Maps a block height and transaction index to a transaction ID.

Used in: MemoryWallet

• uint32 block_height = 1

• uint32 tx_index = 2

• optional TxId tx_id = 3

Used in: ReceivedTransparentOutput

• uint64 value = 1

• bytes script = 2

Used in: MemoryWallet

• uint32 height = 1

  the height of this block

• bytes hash = 2

  the ID (hash) of this block, same as in block explorers

• uint32 block_time = 3

  Unix epoch time when the block was mined

• repeated bytes transactions = 4

  the txids of transactions in this block

• repeated Memo memos = 5

  map from note id to memo

• optional uint32 sapling_commitment_tree_size = 6

  the size of the Sapling note commitment tree as of the end of this block

• optional uint32 sapling_output_count = 7

  the number of Sapling outputs in this block

• optional uint32 orchard_commitment_tree_size = 8

  the size of the Orchard note commitment tree as of the end of this block

• optional uint32 orchard_action_count = 9

  the number of Orchard actions in this block