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(&self, state: &[VtxoStateKind]) -> Result<Vec<WalletVtxo>>

Get all VTXOs that are in one of the provided states

fn store_lightning_receive( &self, payment_hash: PaymentHash, preimage: Preimage, invoice: &Bolt11Invoice, htlc_recv_cltv_delta: BlockDelta, ) -> Result<()>

Store a lightning receive

fn fetch_lightning_receive_by_payment_hash( &self, payment_hash: PaymentHash, ) -> Result<Option<LightningReceive>>

Fetch a lightning receive by payment hash

fn init_wallet(&self, properties: &WalletProperties) -> Result<()>

Initialize a wallet in storage with the provided properties.

fn initialize_bdk_wallet(&self) -> Result<ChangeSet>

Initialize the onchain BDK wallet and return any previously stored ChangeSet.

fn store_bdk_wallet_changeset(&self, changeset: &ChangeSet) -> Result<()>

Persist an incremental BDK ChangeSet.

fn read_properties(&self) -> Result<Option<WalletProperties>>

Read wallet properties from storage.

fn check_recipient_exists(&self, recipient: &str) -> Result<bool>

Check whether a recipient identifier already exists.

fn create_new_movement( &self, status: MovementStatus, subsystem: &MovementSubsystem, time: DateTime<Local>, ) -> Result<MovementId>

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

fn update_movement(&self, movement: &Movement) -> Result<()>

Persists the given movement state.

fn get_movement_by_id(&self, movement_id: MovementId) -> Result<Movement>

Gets the movement with the given MovementId.

fn get_all_movements(&self) -> Result<Vec<Movement>>

Gets every stored movement.

fn store_pending_board( &self, vtxo: &Vtxo, funding_tx: &Transaction, movement_id: MovementId, ) -> Result<()>

Store a pending board.

fn remove_pending_board(&self, vtxo_id: &VtxoId) -> Result<()>

Remove a pending board.

fn get_all_pending_board_ids(&self) -> Result<Vec<VtxoId>>

Get the VtxoId for each pending board.

fn get_pending_board_by_vtxo_id( &self, vtxo_id: VtxoId, ) -> Result<Option<PendingBoard>>

Get the PendingBoard associated with the given VtxoId.

fn store_round_state_lock_vtxos( &self, round_state: &RoundState, ) -> Result<RoundStateId>

Store a new ongoing round state and lock the VTXOs in round

fn update_round_state(&self, state: &StoredRoundState) -> Result<()>

Update an existing stored pending round state

fn remove_round_state(&self, round_state: &StoredRoundState) -> Result<()>

Remove a pending round state from the db

fn load_round_states(&self) -> Result<Vec<StoredRoundState>>

Load all pending round states from the db

fn store_recovered_round(&self, round: &UnconfirmedRound) -> Result<()>

Store a recovered past round

fn remove_recovered_round(&self, funding_txid: Txid) -> Result<()>

Remove a recovered past round

fn load_recovered_rounds(&self) -> Result<Vec<UnconfirmedRound>>

Load the recovered past rounds

fn store_vtxos(&self, vtxos: &[(&Vtxo, &VtxoState)]) -> Result<()>

Stores the given VTXOs in the given VtxoState.

fn get_wallet_vtxo(&self, id: VtxoId) -> Result<Option<WalletVtxo>>

Fetch a wallet Vtxo with its current state by ID.

fn get_all_vtxos(&self) -> Result<Vec<WalletVtxo>>

Fetch all wallet VTXOs in the database.

fn has_spent_vtxo(&self, id: VtxoId) -> Result<bool>

Check whether a Vtxo is already marked spent.

fn remove_vtxo(&self, id: VtxoId) -> Result<Option<Vtxo>>

Remove a Vtxo by ID.

fn store_vtxo_key(&self, index: u32, public_key: PublicKey) -> Result<()>

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

fn get_last_vtxo_key_index(&self) -> Result<Option<u32>>

Get the last revealed/used Vtxo key index.

fn get_public_key_idx(&self, public_key: &PublicKey) -> Result<Option<u32>>

Retrieves the derivation index of the provided PublicKey from the database

fn store_new_pending_lightning_send( &self, invoice: &Invoice, amount: &Amount, vtxos: &[VtxoId], movement_id: MovementId, ) -> Result<LightningSend>

Store a new pending lightning send.

fn get_all_pending_lightning_send(&self) -> Result<Vec<LightningSend>>

Get all pending lightning sends.

fn finish_lightning_send( &self, payment_hash: PaymentHash, preimage: Option<Preimage>, ) -> Result<()>

Mark a lightning send as finished.

fn remove_lightning_send(&self, payment_hash: PaymentHash) -> Result<()>

Remove a lightning send.

fn get_lightning_send( &self, payment_hash: PaymentHash, ) -> Result<Option<LightningSend>>

Get a lightning send by payment hash

fn get_all_pending_lightning_receives(&self) -> Result<Vec<LightningReceive>>

Returns a list of all pending lightning receives

fn set_preimage_revealed(&self, payment_hash: PaymentHash) -> Result<()>

Mark a Lightning receive preimage as revealed (e.g., after settlement).

fn update_lightning_receive( &self, payment_hash: PaymentHash, htlc_vtxo_ids: &[VtxoId], movement_id: MovementId, ) -> Result<()>

Set the VTXO IDs and MovementId for a LightningReceive.

fn finish_pending_lightning_receive( &self, payment_hash: PaymentHash, ) -> Result<()>

Remove a Lightning receive by its payment hash.

fn store_exit_vtxo_entry(&self, exit: &StoredExit) -> Result<()>

Store an entry indicating a Vtxo is being exited.

fn remove_exit_vtxo_entry(&self, id: &VtxoId) -> Result<()>

Remove an exit entry for a given Vtxo ID.

fn get_exit_vtxo_entries(&self) -> Result<Vec<StoredExit>>

List all VTXOs currently tracked as being exited.

fn store_exit_child_tx( &self, exit_txid: Txid, child_tx: &Transaction, origin: ExitTxOrigin, ) -> Result<()>

Store a child transaction related to an exit transaction.

fn get_exit_child_tx( &self, exit_txid: Txid, ) -> Result<Option<(Transaction, ExitTxOrigin)>>

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

fn update_vtxo_state_checked( &self, vtxo_id: VtxoId, new_state: VtxoState, allowed_old_states: &[VtxoStateKind], ) -> Result<WalletVtxo>

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

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.