Module tuxedo_template_wallet::sync

This module is responsible for maintaining the wallet’s local database of blocks and owned UTXOs to the canonical database reported by the node.

It is backed by a sled database

Schema

There are 4 tables in the database BlockHashes block_number:u32 => block_hash:H256 Blocks block_hash:H256 => block:Block UnspentOutputs output_ref => (owner_pubkey, amount) SpentOutputs output_ref => (owner_pubkey, amount)

Constants

• BLOCKS 🔒
  The identifier for the blocks tree in the db.
• BLOCK_HASHES 🔒
  The identifier for the block_hashes tree in the db.
• SPENT 🔒
  The identifier for the spent tree in the db.
• UNSPENT 🔒
  The identifier for the unspent tree in the db.

Functions

• add_unspent_output 🔒
  Add a new output to the database updating all tables.
• apply_block 🔒
  Apply a block to the local database
• apply_transaction 🔒
  Apply a single transaction to the local database The owner-specific tables are mappings from output_refs to coin amounts
• get_arbitrary_unspent_set 🔒
  Picks an arbitrary set of unspent outputs from the database for spending. The set’s token values must add up to at least the specified target value.
• get_balances 🔒
  Iterate the entire unspent set summing the values of the coins on a per-address basis.
• get_block 🔒
  Gets the block from the local database given a block hash. Similar to the Node’s RPC.
• get_block_hash 🔒
  Gets the block hash from the local database given a block height. Similar the Node’s RPC.
• get_unspent 🔒
  Gets the owner and amount associated with an output ref from the unspent table
• height 🔒
  Get the block height that the wallet is currently synced to
• open_db 🔒
  Open a database at the given location intended for the given genesis block.
• print_block_hashes_tree 🔒
  Debugging use. Print out the entire block_hashes tree.
• print_unspent_tree 🔒
  Debugging use. Print the entire unspent outputs tree.
• remove_unspent_output 🔒
  Remove an output from the database updating all tables.
• spend_output 🔒
  Mark an existing output as spent. This does not purge all record of the output from the db. It just moves the record from the unspent table to the spent table
• synchronize 🔒
• synchronize_helper 🔒
  Synchronize the local database to the database of the running node. The wallet entirely trusts the data the node feeds it. In the bigger picture, that means run your own (light) node.
• unapply_highest_block 🔒
  Unapply the best block that the wallet currently knows about
• unapply_transaction 🔒
  Run a transaction backwards against a database. Mark all of the Inputs as unspent, and drop all of the outputs.
• unspend_output 🔒
  Mark an output that was previously spent back as unspent.