Fields

• initializeWallet :: WalletId -> Wallet s -> WalletMetadata -> [( Tx , TxMeta )] -> GenesisParameters -> ExceptT ErrWalletAlreadyExists stm ()

  Initialize a database entry for a given wallet. putCheckpoint , putWalletMeta , putTxHistory or putProtocolParameters will actually all fail if they are called _first_ on a wallet.

• removeWallet :: WalletId -> ExceptT ErrNoSuchWallet stm ()

  Remove a given wallet and all its associated data (checkpoints, metadata, tx history ...)

• listWallets :: stm [ WalletId ]

  Get the list of all known wallets in the DB, possibly empty.

• walletsDB :: DBVar stm ( DeltaMap WalletId ( DeltaWalletState s))

  DBVar containing the WalletState of each wallet in the database. Currently contains all Checkpoints of the UTxO and the Discoveries , as well as the Prologue of the address discovery state.

  Intended to replace putCheckpoint and readCheckpoint in the short-term, and all other functions in the long-term.

• putCheckpoint :: WalletId -> Wallet s -> ExceptT ErrNoSuchWallet stm ()

  Replace the current checkpoint for a given wallet. We do not handle rollbacks yet, and therefore only stores the latest available checkpoint.

  If the wallet doesn't exist, this operation returns an error.

• readCheckpoint :: WalletId -> stm ( Maybe ( Wallet s))

  Fetch the most recent checkpoint of a given wallet.

  Return Nothing if there's no such wallet.

• listCheckpoints :: WalletId -> stm [ ChainPoint ]

  List all known checkpoint tips, ordered by slot ids from the oldest to the newest.

• putWalletMeta :: WalletId -> WalletMetadata -> ExceptT ErrNoSuchWallet stm ()

  Replace an existing wallet metadata with the given one.

  If the wallet doesn't exist, this operation returns an error

• readWalletMeta :: WalletId -> stm ( Maybe WalletMetadata )

  Fetch a wallet metadata, if they exist.

  Return Nothing if there's no such wallet.

• isStakeKeyRegistered :: WalletId -> ExceptT ErrNoSuchWallet stm Bool
• putDelegationCertificate :: WalletId -> DelegationCertificate -> SlotNo -> ExceptT ErrNoSuchWallet stm ()

  Binds a stake pool id to a wallet. This will have an influence on the wallet metadata: the last known certificate will indicate to which pool a wallet is currently delegating.

  This is done separately from putWalletMeta because certificate declarations are:

  1. Stored on-chain.
  2. Affected by rollbacks (or said differently, tied to a SlotNo ).
• putDelegationRewardBalance :: WalletId -> Coin -> ExceptT ErrNoSuchWallet stm ()

  Store the latest known reward account balance.

  This is separate from checkpoints because the data corresponds to the node tip. This is separate from putWalletMeta because it's not meta data

• readDelegationRewardBalance :: WalletId -> stm Coin

  Get the reward account balance.

  Returns zero if the wallet isn't found or if wallet hasn't delegated stake.

• putTxHistory :: WalletId -> [( Tx , TxMeta )] -> ExceptT ErrNoSuchWallet stm ()

  Augments the transaction history for a known wallet.

  If an entry for a particular transaction already exists it is not altered nor merged (just ignored).

  If the wallet doesn't exist, this operation returns an error.

• readTxHistory :: WalletId -> Maybe Coin -> SortOrder -> Range SlotNo -> Maybe TxStatus -> stm [ TransactionInfo ]

  Fetch the current transaction history of a known wallet, ordered by descending slot number.

  Returns an empty list if the wallet isn't found.

• getTx :: WalletId -> Hash "Tx" -> ExceptT ErrNoSuchWallet stm ( Maybe TransactionInfo )

  Fetch the latest transaction by id, returns Nothing when the transaction isn't found.

  If the wallet doesn't exist, this operation returns an error.

• putLocalTxSubmission :: WalletId -> Hash "Tx" -> SealedTx -> SlotNo -> ExceptT ErrPutLocalTxSubmission stm ()

  Add or update a transaction in the local submission pool with the most recent submission slot.

• readLocalTxSubmissionPending :: WalletId -> stm [ LocalTxSubmissionStatus SealedTx ]

  List all transactions from the local submission pool which are still pending as of the latest checkpoint of the given wallet. The slot numbers for first submission and most recent submission are included.

• updatePendingTxForExpiry :: WalletId -> SlotNo -> ExceptT ErrNoSuchWallet stm ()

  Removes any expired transactions from the pending set and marks their status as expired.

• removePendingOrExpiredTx :: WalletId -> Hash "Tx" -> ExceptT ErrRemoveTx stm ()

  Manually remove a pending transaction.

• putPrivateKey :: WalletId -> (k ' RootK XPrv , PassphraseHash ) -> ExceptT ErrNoSuchWallet stm ()

  Store or replace a private key for a given wallet. Note that wallet _could_ be stored and manipulated without any private key associated to it. A private key is only seldomly required for very specific operations (like transaction signing).

• readPrivateKey :: WalletId -> stm ( Maybe (k ' RootK XPrv , PassphraseHash ))

  Read a previously stored private key and its associated passphrase hash.

• readGenesisParameters :: WalletId -> stm ( Maybe GenesisParameters )

  Read the *Byron* genesis parameters.

• rollbackTo :: WalletId -> Slot -> ExceptT ErrNoSuchWallet stm ChainPoint

  Drops all checkpoints and transaction data which have appeared after the given ChainPoint .

  Returns the actual ChainPoint to which the database has rolled back. Its slot is guaranteed to be earlier than (or identical to) the given point of rollback but can't be guaranteed to be exactly the same because the database may only keep sparse checkpoints.

• prune :: WalletId -> Quantity "block" Word32 -> ExceptT ErrNoSuchWallet stm ()

  Prune database entities and remove entities that can be discarded.

  The second argument represents the stability window, or said length of the deepest rollback.

• atomically :: forall a. stm a -> m a

  Execute operations of the database in isolation and atomically.

Fields

• withDatabase :: forall a. WalletId -> ( DBLayer m s k -> IO a) -> IO a

  Creates a new or use an existing database, maintaining an open connection so long as necessary

• removeDatabase :: WalletId -> IO ()

  Erase any trace of the database

• listDatabases :: IO [ WalletId ]

  List existing wallet database found on disk.