Modulesยง
- api
- backup ๐
- cli ๐
- client_
db - config
- deposit ๐
- Legacy, state-machine based peg-ins, replaced by
pegin_monitor
but retained for time being to ensure existing peg-ins complete. - endpoint_
constants - envs
- events
- keys
- pegin_
monitor ๐ - Peg-in monitor: a task monitoring deposit addresses for peg-ins.
- tweakable
- txoproof
- withdraw ๐
Structsยง
- Bitcoin
Transaction Data - PegOut
- PegOut
Fees - PegOut
Signature Item - Rbf
- Allows a user to bump the fees of a
PendingTransaction
- SpendableUTXO
- TxOutput
Summary - A transaction output, either unspent or consumed
- Unknown
Wallet Input Variant Error - Unknown
Wallet Output Outcome Variant Error - Unknown
Wallet Output Variant Error - Wallet
Client Context - Wallet
Client Init - Wallet
Client Module - Wallet
Client Module Data - The non-resource, just plain-data parts of
WalletClientModule
- Wallet
Common Init - Wallet
Input V0 - Wallet
Input V1 - Wallet
Module Types - Wallet
Operation Meta - Wallet
Output Outcome V0 - Contains the Bitcoin transaction id of the transaction created by the withdraw request
- Wallet
Summary - Summary of the coins within the wallet.
Enumsยง
- Deposit
State V1 - Deposit
State V2 - Process
PegOut SigError - Wallet
Client States - Wallet
Consensus Item - Wallet
Creation Error - Wallet
Input - Wallet
Input Error - Wallet
Operation Meta Variant - Wallet
Output - Wallet
Output Error - Wallet
Output Outcome - Wallet
Output V0 - Withdraw
State
Constantsยง
- CONFIRMATION_
TARGET - Used for estimating a feerate that will confirm within a target number of blocks.
- DEPRECATED_
RBF_ ERROR - FEERATE_
MULTIPLIER_ DEFAULT - To further mitigate the risk of a peg-out transaction getting stuck in the mempool, we multiply the feerate estimate returned from the backend by this value.
- KIND
- MODULE_
CONSENSUS_ VERSION - SAFE_
DEPOSIT_ MODULE_ CONSENSUS_ VERSION - Module consensus version that introduced support for processing Bitcoin
transactions that exceed the
ALEPH_BFT_UNIT_BYTE_LIMIT
. - WALLET_
TWEAK_ ๐CHILD_ ID
Functionsยง
- get_
next_ ๐peg_ in_ tweak_ child_ id - Returns the child index to derive the next peg-in tweak key from.
- next_
withdraw_ ๐state - poll_
supports_ ๐safe_ deposit_ version - Polls the federation checking if the activated module consensus version supports safe deposits, saving the result in the db once it does.
- proprietary_
tweak_ key