From 43a03529665aad1ce47a49f0d151628217b6672a Mon Sep 17 00:00:00 2001 From: Ben Westgate Date: Sat, 7 Sep 2024 09:53:27 -0500 Subject: [PATCH] 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() --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ad1e26f..f7ea9b4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # python-bip32 -A basic implementation of the [bip-0032](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki). +A basic implementation of [BIP-0032](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki). ## Usage @@ -112,18 +112,22 @@ path. Note that you don't need to have provided the master private key if the path doesn't include an index `>= HARDENED_INDEX`. -#### get_xpriv(path) +#### get_xpriv() Equivalent to `get_xpriv_from_path([])`. -#### get_xpriv_bytes(path) +#### get_xpriv_bytes() -Equivalent to `get_xpriv([])`, but not serialized in base58 +Equivalent to `get_xpriv([])`, but not serialized in base58. -#### get_xpub(path) +#### get_xpub() Equivalent to `get_xpub_from_path([])`. -#### get_xpub_bytes(path) +#### get_xpub_bytes() -Equivalent to `get_xpub([])`, but not serialized in base58 +Equivalent to `get_xpub([])`, but not serialized in base58. + +#### get_fingerprint() + +Returns `fingerprint (bytes)`, equivalent to `utils._pubkey_to_fingerprint(self.pubkey)`.