Add docs to the 'wallet' module #223
Conversation
src/wallet/coin_selection.rs
Outdated
| @@ -114,8 +114,9 @@ pub type DefaultCoinSelectionAlgorithm = BranchAndBoundCoinSelection; | |||
| #[cfg(test)] | |||
| pub type DefaultCoinSelectionAlgorithm = LargestFirstCoinSelection; // make the tests more predictable | |||
|
|
|||
| // Base weight of a Txin, not counting the weight needed for satisfaying it. | |||
| // prev_txid (32 bytes) + prev_vout (4 bytes) + sequence (4 bytes) + script_len (1 bytes) | |||
| /// Base weight of a Txin, not counting the weight needed for satisfaying it | |||
There was a problem hiding this comment.
Looks like you don't have spell check enabled in your editor, you should be able to configure your editor to spell check just the comments.
There was a problem hiding this comment.
Thanks for the catch, I have spell checking on but I guess I missed the warning on that one. Fixed now.
notmandatory
force-pushed
the
doc_fixes_wallet
branch
2 times, most recently
from
51023c6
to
a2582bb
Compare
src/wallet/coin_selection.rs
Outdated
| // prev_txid (32 bytes) + prev_vout (4 bytes) + sequence (4 bytes) + script_len (1 bytes) | ||
| /// Base weight of a Txin, not counting the weight needed for satisfying it | ||
| /// | ||
| /// prev_txid (32 bytes) + prev_vout (4 bytes) + sequence (4 bytes) + script_len (1 bytes) | ||
| pub const TXIN_BASE_WEIGHT: usize = (32 + 4 + 4 + 1) * 4; |
There was a problem hiding this comment.
I think we could make this private (like with pub(crate)), since it's only used internally
There was a problem hiding this comment.
Makes sense TXIN_BASE_WEIGHT should be pub(crate) but that made it out of scope for the example code and I couldn't find a way to make it visible. As a work around I put a (hidden) duplicate const in the example. Hopefully this is OK or maybe someone knows a better way to fix it?
src/wallet/signer.rs
Outdated
| PkHash(hash160::Hash), | ||
| /// The first 32 bits of the bitcoin HASH160 hash of an ECDSA public key |
There was a problem hiding this comment.
The fingerprint is actually the BIP32 key fingerprint, it's not the hash of a key.
I would just document this as The fingerprint of a BIP32 extended key
There was a problem hiding this comment.
Fixed.. I was a little too proud of myself for looking up the full definition. :-)
notmandatory
force-pushed
the
doc_fixes_wallet
branch
from
a2582bb
to
ad0c262
Compare
| TimeoutError, | ||
| /// Invalid fingerprint in HD key path | ||
| InvalidScript, |
There was a problem hiding this comment.
Probably a side note, but judging by the comment, shouldn't it be InvalidFingerprint instead?
There was a problem hiding this comment.
I originally put his doc because it was the situation I found this variant used in a TestValidator. But I think down the road it could be used for other AddressValidatorError::InvalidScript reasons, so I just changed the docs back to match the name.
notmandatory
force-pushed
the
doc_fixes_wallet
branch
from
ad0c262
to
148e8c6
Compare
No description provided.