Skip to content

Commit

Permalink
add get_fingerprint(), remove wrong parameters, grammar fixes
Browse files Browse the repository at this point in the history
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()
  • Loading branch information
BenWestgate authored Sep 7, 2024
1 parent 0a26152 commit 43a0352
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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)`.

0 comments on commit 43a0352

Please sign in to comment.