Skip to content

Commit 43a0352

Browse files
authored
add get_fingerprint(), remove wrong parameters, grammar fixes
BIP-0032 is a proper noun so should be capitalized in a sentence. "the" is not necessary. The get_xxxx(path) methods should not have "path" in them as they don't accept a parameter. Added two missing periods. Added documentation of get_fingerprint()
1 parent 0a26152 commit 43a0352

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# python-bip32
22

3-
A basic implementation of the [bip-0032](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki).
3+
A basic implementation of [BIP-0032](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki).
44

55
## Usage
66

@@ -112,18 +112,22 @@ path.
112112
Note that you don't need to have provided the master private key if the path doesn't
113113
include an index `>= HARDENED_INDEX`.
114114

115-
#### get_xpriv(path)
115+
#### get_xpriv()
116116

117117
Equivalent to `get_xpriv_from_path([])`.
118118

119-
#### get_xpriv_bytes(path)
119+
#### get_xpriv_bytes()
120120

121-
Equivalent to `get_xpriv([])`, but not serialized in base58
121+
Equivalent to `get_xpriv([])`, but not serialized in base58.
122122

123-
#### get_xpub(path)
123+
#### get_xpub()
124124

125125
Equivalent to `get_xpub_from_path([])`.
126126

127-
#### get_xpub_bytes(path)
127+
#### get_xpub_bytes()
128128

129-
Equivalent to `get_xpub([])`, but not serialized in base58
129+
Equivalent to `get_xpub([])`, but not serialized in base58.
130+
131+
#### get_fingerprint()
132+
133+
Returns `fingerprint (bytes)`, equivalent to `utils._pubkey_to_fingerprint(self.pubkey)`.

0 commit comments

Comments
 (0)