wallet::AvailableCoins

Populate the CoinsResult struct with vectors of available COutputs, organized by OutputType.

Synopsis

Declared in <wallet/spend.h>

[[requires_capability(0x7f2e1e652a00)]]
CoinsResult
AvailableCoins(
    CWallet const& wallet,
    CCoinControl const* coinControl = nullptr,
    std::optional<CFeeRate> feerate = std::nullopt,
    CoinFilterParams const& params = {});

Return Value

The available outputs organized by OutputType.

Parameters

Name

Description

wallet

The wallet whose outputs are examined.

coinControl

Optional coin control settings restricting which outputs are considered.

feerate

Optional fee rate used to compute each output's effective value.

params

Filter parameters constraining which outputs are returned.

Created with MrDocs