Improve Doxygen for note locking
This commit is contained in:
parent
06553d1399
commit
69ab52cb3e
|
@ -160,10 +160,6 @@ private:
|
||||||
int anchorHeight;
|
int anchorHeight;
|
||||||
|
|
||||||
public:
|
public:
|
||||||
/**
|
|
||||||
* This class locks the `SpendableInputs` provided to it. `UnlockSpendable` must be called to
|
|
||||||
* release them before the instance goes out of scope.
|
|
||||||
*/
|
|
||||||
TransactionEffects(
|
TransactionEffects(
|
||||||
uint32_t anchorConfirmations,
|
uint32_t anchorConfirmations,
|
||||||
SpendableInputs spendable,
|
SpendableInputs spendable,
|
||||||
|
@ -192,13 +188,18 @@ public:
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This is automatically called by the constructor, so it’s not generally necessary to call this
|
* This should be called upon creating `TransactionEffects`, it locks exactly the notes that
|
||||||
* otherwise.
|
* will be spent in the built transaction.
|
||||||
*/
|
*/
|
||||||
void LockSpendable(CWallet& wallet) const;
|
void LockSpendable(CWallet& wallet) const;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This should be called just before the `TransactionEffects` goes out of scope.
|
* This should be called when we are finished with the transaction (whether it succeeds or
|
||||||
|
* fails).
|
||||||
|
*
|
||||||
|
* TODO: This currently needs to be called while the `TransactionEffects` exists. In future, it
|
||||||
|
* would be useful to keep these notes locked until we have confirmation that the tx is on
|
||||||
|
* the chain or not.
|
||||||
*/
|
*/
|
||||||
void UnlockSpendable(CWallet& wallet) const;
|
void UnlockSpendable(CWallet& wallet) const;
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue