Merge #13843: [trivial] Add doxygen-compatible comments to CAffectedKeysVisitor
3339d84535
[trivial] add doxygen-compatible comments to CAffectedKeysVisitor (Pierre Rochard)
Pull request description:
Tree-SHA512: 0003fde198a6977d0c8988efc8f76428f9e095009fddf131b07bd9809ef76a778c86bb2b1305e33df16101b6b703cf43eb6193462bb9f3687f98c1d9b109dd96
This commit is contained in:
commit
e8f387f997
1 changed files with 11 additions and 0 deletions
|
@ -102,14 +102,25 @@ std::string COutput::ToString() const
|
||||||
return strprintf("COutput(%s, %d, %d) [%s]", tx->GetHash().ToString(), i, nDepth, FormatMoney(tx->tx->vout[i].nValue));
|
return strprintf("COutput(%s, %d, %d) [%s]", tx->GetHash().ToString(), i, nDepth, FormatMoney(tx->tx->vout[i].nValue));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** A class to identify which pubkeys a script and a keystore have in common. */
|
||||||
class CAffectedKeysVisitor : public boost::static_visitor<void> {
|
class CAffectedKeysVisitor : public boost::static_visitor<void> {
|
||||||
private:
|
private:
|
||||||
const CKeyStore &keystore;
|
const CKeyStore &keystore;
|
||||||
std::vector<CKeyID> &vKeys;
|
std::vector<CKeyID> &vKeys;
|
||||||
|
|
||||||
public:
|
public:
|
||||||
|
/**
|
||||||
|
* @param[in] keystoreIn The CKeyStore that is queried for the presence of a pubkey.
|
||||||
|
* @param[out] vKeysIn A vector to which a script's pubkey identifiers are appended if they are in the keystore.
|
||||||
|
*/
|
||||||
CAffectedKeysVisitor(const CKeyStore &keystoreIn, std::vector<CKeyID> &vKeysIn) : keystore(keystoreIn), vKeys(vKeysIn) {}
|
CAffectedKeysVisitor(const CKeyStore &keystoreIn, std::vector<CKeyID> &vKeysIn) : keystore(keystoreIn), vKeys(vKeysIn) {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Apply the visitor to each destination in a script, recursively to the redeemscript
|
||||||
|
* in the case of p2sh destinations.
|
||||||
|
* @param[in] script The CScript from which destinations are extracted.
|
||||||
|
* @post Any CKeyIDs that script and keystore have in common are appended to the visitor's vKeys.
|
||||||
|
*/
|
||||||
void Process(const CScript &script) {
|
void Process(const CScript &script) {
|
||||||
txnouttype type;
|
txnouttype type;
|
||||||
std::vector<CTxDestination> vDest;
|
std::vector<CTxDestination> vDest;
|
||||||
|
|
Loading…
Reference in a new issue