Crate bitcoinwallet_library

Modules

• db_keys

Structs

• AddressBookData
  | Address book data |
• ReserveDestination
  | A wrapper to reserve an address from | a wallet | | ReserveDestination is used to reserve | an address. | | It is currently only used inside of CreateTransaction. | | Instantiating a ReserveDestination | does not reserve an address. To do so, | | GetReservedDestination() needs to | be called on the object. Once an address | has been reserved, call KeepDestination() | on the ReserveDestination object to | make sure it is not returned. Call ReturnDestination() | to return the address so it can be re-used | (for example, if the address was used | in a new transaction and that transaction | was not completed and needed to be aborted). | | If an address is reserved and KeepDestination() | is not called, then the address will | be returned when the ReserveDestination | goes out of scope. |
• Wallet
  | A Wallet maintains a set of transactions | and balances, and provides the ability | to create new transactions. |
• WalletImpl
• WalletInner
• WalletScanState

Constants

• DEFAULT_ADDRESS_TYPE
  | Default for -addresstype |
• DEFAULT_CONSOLIDATE_FEERATE
  | -consolidatefeerate default |
• DEFAULT_DISABLE_WALLET
• DEFAULT_DISCARD_FEE
  | -discardfee default |
• DEFAULT_FALLBACK_FEE
  | -fallbackfee default |
• DEFAULT_FLUSHWALLET
  | Overview of wallet database classes: | | - WalletBatch is an abstract modifier | object for the wallet database, and | encapsulates a database batch update | as well as methods to act on the database. | It should be agnostic to the database | implementation. | | The following classes are implementation | specific: | | - BerkeleyEnvironment is an environment | in which the database exists. | | - BerkeleyDatabase represents a wallet | database. | | - BerkeleyBatch is a low-level database | batch update. |
• DEFAULT_MAX_AVOIDPARTIALSPEND_FEE
  | maximum fee increase allowed to do partial | spend avoidance, even for nodes with | this feature disabled by default | | A value of -1 disables this feature completely. | | A value of 0 (current default) means | to attempt to do partial spend avoidance, | and use its results if the fees remain | unchanged | | A value > 0 means to do partial spend avoidance | if the fee difference against a regular | coin selection instance is in the range | [0..value]. |
• DEFAULT_PAY_TX_FEE
  | -paytxfee default |
• DEFAULT_SPEND_ZEROCONF_CHANGE
  | Default for -spendzeroconfchange |
• DEFAULT_TRANSACTION_MAXFEE
  -maxtxfee default
• DEFAULT_TRANSACTION_MINFEE
  | -mintxfee default |
• DEFAULT_TX_CONFIRM_TARGET
  | -txconfirmtarget default |
• DEFAULT_WALLETBROADCAST
• DEFAULT_WALLET_RBF
  | -walletrbf default |
• DEFAULT_WALLET_REJECT_LONG_CHAINS
  | Default for -walletrejectlongchains |
• DUMMY_NESTED_P2WPKH_INPUT_SIZE
  | Pre-calculated constants for input | size estimation in virtual size |
• HIGH_APS_FEE
  | discourage APS fee higher than this | amount |
• HIGH_MAX_TX_FEE
  | -maxtxfee will warn if called with a | higher fee than this amount (in satoshis) |
• HIGH_TX_FEE_PER_KB
  | Discourage users to set fees higher | than this amount (in satoshis) per kB |
• WALLET_INCREMENTAL_RELAY_FEE
  | minimum recommended increment for | BIP 125 replacement txs |

Traits

• AddWalletOptions
• AttachChain
• Construct
• Create
• FindAddressBookEntry
• HasWalletSupport
• ParameterInteraction
• WalletInitInterface

Functions

• add_wallet
• create_dummy_wallet_database
  | Return object for accessing dummy database | with no read/write capabilities. |
• create_mock_wallet_database
  | Return object for accessing temporary | in-memory database. |
• create_wallet
• dummy_sign_input
• execute_wallet_tool_func
• get_wallet
• get_wallet_dir
  | Get the path of the wallet directory. |
• get_wallets
• handle_load_wallet
• load_wallet
• make_wallet
• make_wallet_database
• make_wallet_tx
  | Construct wallet tx struct. |
• make_wallet_tx_out
  | Construct wallet TxOut struct. |
• make_wallet_tx_status
  | Construct wallet tx status struct. |
• make_wallet_with_context
  | Return implementation of Wallet | interface. This function is defined in | dummywallet.cpp and throws if the wallet | component is not compiled.
• maybe_compact_walletdb
  | Compacts BDB state so that wallet.dat | is self-contained (if there are changes) |
• maybe_resend_wallet_txs
  | Called periodically by the schedule | thread. Prompts individual wallets | to resend their transactions. Actual | rebroadcast schedule is managed by | the wallets themselves. |
• read_key_value
  | Unserialize a given Key-Value pair | and load it into the wallet |
• read_key_value_with_wallet_scan_state
• unload_wallet
  | Explicitly unload and delete the wallet. | | Blocks the current thread after signaling the | unload intent so that all wallet clients | release the wallet. | | Note that, when blocking is not required, the | wallet is implicitly unloaded by the shared | pointer deleter.
• wallet_create
• wallet_show_info
• wallet_tool_release_wallet
  | The standard wallet deleter function blocks on | the validation interface queue, which doesn’t | exist for the bitcoin-wallet. Define our own | deleter here.

Type Definitions

• AddressBookDataStringMap
• KeyFilterFn
  | Callback for filtering key types to | deserialize in ReadKeyValue |