Struct SqliteClient 

pub struct SqliteClient { /* private fields */ }

An implementation of the BarkPersister using rusqlite. Changes are persisted using the given PathBuf.

Implementations

impl SqliteClient

pub fn open(db_file: impl AsRef<Path>) -> Result<SqliteClient>

Open a new SqliteClient with the given file path

Trait Implementations

impl BarkPersister for SqliteClient

fn get_vtxos_by_state<'life0, 'life1, 'async_trait>( &'life0 self, state: &'life1 [VtxoStateKind], ) -> Pin<Box<dyn Future<Output = Result<Vec<WalletVtxo>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get all VTXOs that are in one of the provided states

fn init_wallet<'life0, 'life1, 'async_trait>( &'life0 self, properties: &'life1 WalletProperties, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Initialize a wallet in storage with the provided properties.

fn read_properties<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Option<WalletProperties>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Read wallet properties from storage.

fn set_server_pubkey<'life0, 'async_trait>( &'life0 self, server_pubkey: PublicKey, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Set the server public key in wallet properties.

fn set_server_mailbox_pubkey<'life0, 'async_trait>( &'life0 self, server_mailbox_pubkey: PublicKey, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Set the server’s mailbox public key in wallet properties.

fn create_new_movement<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, status: MovementStatus, subsystem: &'life1 MovementSubsystem, time: DateTime<Local>, action_id: Option<&'life2 str>, ) -> Pin<Box<dyn Future<Output = Result<MovementId>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Creates a new movement in the given state, ready to be updated.

fn get_or_create_movement_for_action<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, subsystem: &'life1 MovementSubsystem, time: DateTime<Local>, action_id: &'life2 str, update: MovementUpdate, ) -> Pin<Box<dyn Future<Output = Result<(MovementId, bool)>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Atomically look up the movement owned by action_id, or create it and apply update as its initial state, in a single transaction.

fn update_movement<'life0, 'life1, 'async_trait>( &'life0 self, movement: &'life1 Movement, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Persists the given movement state.

fn get_movement_by_id<'life0, 'async_trait>( &'life0 self, movement_id: MovementId, ) -> Pin<Box<dyn Future<Output = Result<Movement>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Gets the movement with the given MovementId.

fn get_all_movements<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<Movement>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Gets every stored movement.

fn get_movements_by_payment_method<'life0, 'life1, 'async_trait>( &'life0 self, payment_method: &'life1 PaymentMethod, ) -> Pin<Box<dyn Future<Output = Result<Vec<Movement>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get all movements for a given payment method

fn store_round_state<'life0, 'life1, 'async_trait>( &'life0 self, round_state: &'life1 RoundState, ) -> Pin<Box<dyn Future<Output = Result<RoundStateId>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Store a new ongoing round state

fn update_round_state<'life0, 'life1, 'async_trait>( &'life0 self, state: &'life1 StoredRoundState, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Update an existing stored pending round state

fn remove_round_state<'life0, 'life1, 'async_trait>( &'life0 self, round_state: &'life1 StoredRoundState, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Remove a pending round state from the db

fn get_round_state_by_id<'life0, 'async_trait>( &'life0 self, id: RoundStateId, ) -> Pin<Box<dyn Future<Output = Result<Option<StoredRoundState<Unlocked>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Load a single round state by its id

fn get_pending_round_state_ids<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<RoundStateId>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Load all pending round states from the db

fn store_vtxos<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, vtxos: &'life1 [(&'life2 Vtxo<Full>, &'life3 VtxoState)], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Stores VTXOs with their initial state.

fn get_wallet_vtxo<'life0, 'async_trait>( &'life0 self, id: VtxoId, ) -> Pin<Box<dyn Future<Output = Result<Option<WalletVtxo>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetch a wallet Vtxo with its current state by ID.

fn get_wallet_vtxos<'life0, 'life1, 'async_trait>( &'life0 self, ids: &'life1 [VtxoId], ) -> Pin<Box<dyn Future<Output = Result<Vec<WalletVtxo>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetch multiple wallet VTXOs by id, preserving the order of the input slice.

fn get_all_vtxos<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<WalletVtxo>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetch all wallet VTXOs in the database.

fn has_spent_vtxo<'life0, 'async_trait>( &'life0 self, id: VtxoId, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Check whether a Vtxo is already marked spent.

fn get_full_vtxo<'life0, 'async_trait>( &'life0 self, id: VtxoId, ) -> Pin<Box<dyn Future<Output = Result<Option<Vtxo<Full>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetch a single VTXO in full form (including the unilateral exit chain).

fn get_full_vtxos<'life0, 'life1, 'async_trait>( &'life0 self, ids: &'life1 [VtxoId], ) -> Pin<Box<dyn Future<Output = Result<Vec<Vtxo<Full>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Hydrate a batch of VTXOs into their full form, preserving the order of the input slice. Returns an error if any id is missing — callers reach this from a selection step against the wallet’s listings, so a missing row indicates the wallet’s state is inconsistent with the caller’s view.

fn remove_vtxo<'life0, 'async_trait>( &'life0 self, id: VtxoId, ) -> Pin<Box<dyn Future<Output = Result<Option<Vtxo<Full>>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Remove a Vtxo by ID.

fn store_vtxo_key<'life0, 'async_trait>( &'life0 self, index: u32, public_key: PublicKey, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Store a newly derived/assigned Vtxo public key index mapping.

fn get_last_vtxo_key_index<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Option<u32>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get the last revealed/used Vtxo key index.

fn get_public_key_idx<'life0, 'life1, 'async_trait>( &'life0 self, public_key: &'life1 PublicKey, ) -> Pin<Box<dyn Future<Output = Result<Option<u32>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieves the derivation index of the provided PublicKey from the database

fn get_mailbox_checkpoint<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<u64>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieves the mailbox checkpoint from the database

fn store_mailbox_checkpoint<'life0, 'async_trait>( &'life0 self, checkpoint: u64, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Update the mailbox checkpoint to the new checkpoint

fn upsert_wallet_action_checkpoint<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, id: &'life1 WalletActionId, checkpoint: &'life2 WalletActionCheckpoint, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Persist or overwrite a wallet action checkpoint.

fn get_wallet_action_checkpoint<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 WalletActionId, ) -> Pin<Box<dyn Future<Output = Result<Option<WalletActionCheckpoint>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetch a wallet action checkpoint by id.

fn get_all_wallet_action_checkpoints<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<WalletActionCheckpoint>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetch every persisted wallet action checkpoint, oldest first.

fn remove_wallet_action_checkpoint<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 WalletActionId, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Remove a wallet action checkpoint by id. No-op if absent.

fn record_paid_invoice<'life0, 'async_trait>( &'life0 self, payment_hash: PaymentHash, preimage: Preimage, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Record a settled outgoing lightning send.

fn get_paid_invoice<'life0, 'async_trait>( &'life0 self, payment_hash: PaymentHash, ) -> Pin<Box<dyn Future<Output = Result<Option<PaidInvoice>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Look up an existing paid-invoice record by payment hash.

fn record_settled_lightning_receive<'life0, 'life1, 'async_trait>( &'life0 self, payment_hash: PaymentHash, preimage: Preimage, invoice: &'life1 Bolt11Invoice, amount: Amount, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Record a settled incoming lightning receive, ignore if already exists.

fn get_settled_lightning_receive<'life0, 'async_trait>( &'life0 self, payment_hash: PaymentHash, ) -> Pin<Box<dyn Future<Output = Result<Option<SettledLightningReceive>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Look up a settled lightning receive record by payment hash.

fn store_exit_vtxo_entry<'life0, 'life1, 'async_trait>( &'life0 self, exit: &'life1 StoredExit, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Store an entry indicating a Vtxo is being exited.

fn remove_exit_vtxo_entry<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 VtxoId, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Remove an exit entry for a given Vtxo ID.

fn get_exit_vtxo_entries<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<StoredExit>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

List all VTXOs currently tracked as being exited.

fn get_exit_vtxo_entries_with_states<'life0, 'life1, 'async_trait>( &'life0 self, states: &'life1 [ExitStateKind], ) -> Pin<Box<dyn Future<Output = Result<Vec<StoredExit>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List exit entries whose current state matches one of the given ExitStateKinds.

fn get_exit_vtxo_entry<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 VtxoId, ) -> Pin<Box<dyn Future<Output = Result<Option<StoredExit>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetch the exit entry for a single Vtxo ID, if any.

fn store_exit_child_tx<'life0, 'life1, 'async_trait>( &'life0 self, exit_txid: Txid, child_tx: &'life1 Transaction, origin: ExitTxOrigin, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Store a child transaction related to an exit transaction.

fn get_exit_child_tx<'life0, 'async_trait>( &'life0 self, exit_txid: Txid, ) -> Pin<Box<dyn Future<Output = Result<Option<(Transaction, ExitTxOrigin)>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieve a stored child transaction for a given exit transaction ID.

fn update_vtxo_state_checked<'life0, 'life1, 'async_trait>( &'life0 self, vtxo_id: VtxoId, new_state: VtxoState, allowed_old_states: &'life1 [VtxoStateKind], ) -> Pin<Box<dyn Future<Output = Result<WalletVtxo>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Updates the state of the VTXO corresponding to the given VtxoId, provided that their current state is one of the given allowed_states.

fn update_vtxo_states_checked<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, vtxo_ids: &'life1 [VtxoId], new_state: VtxoState, allowed_old_states: &'life2 [VtxoStateKind], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Transition multiple VTXOs to new_state atomically: either every vtxo’s state changes or none does. A failure must not affect any vtxo.

fn mark_vtxos_registered<'life0, 'life1, 'async_trait>( &'life0 self, vtxo_ids: &'life1 [VtxoId], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Set WalletVtxo::registered on the given VTXOs, recording that their recovery state (mailbox ID post + signed transaction chain) has been asserted with the server so the sync-time catch-up can skip them.

fn get_unregistered_vtxo_ids<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<VtxoId>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetch the IDs of all VTXOs whose recovery state still needs to be asserted with the server: not yet marked WalletVtxo::registered and in any state except VtxoStateKind::Spent, in unspecified order.

fn is_initialized<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Check if the wallet is initialized.

impl Clone for SqliteClient

fn clone(&self) -> SqliteClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SqliteClient

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

Formats the value using the given formatter.