HDWallet¶
Class Hierarchical Deterministic Wallet
-
class
hdwallet.hdwallet.
HDWallet
(symbol: str = 'BTC', cryptocurrency: Optional[Any] = None, semantic: str = 'p2pkh', use_default_path: bool = False)¶ Hierarchical Deterministic Wallet
- Parameters
symbol (str) – Cryptocurrency symbol, defaults to
BTC
.cryptocurrency (Cryptocurrency) – Cryptocurrency instance, defaults to
None
.semantic (str) – Extended semantic, defaults to
P2PKH
.use_default_path (bool) – Use default derivation path, defaults to
False
.
- Returns
HDWallet – Hierarchical Deterministic Wallet instance.
Note
To initialize HDWallet symbol or cryptocurrency is required.
-
from_entropy
(entropy: str, language: str = 'english', passphrase: Optional[str] = None) → hdwallet.hdwallet.HDWallet¶ Master from Entropy hex string.
- Parameters
entropy (str) – Entropy hex string.
language (str) – Mnemonic language, default to
english
.passphrase (str) – Mnemonic passphrase or password, default to
None
.
- Returns
HDWallet – Hierarchical Deterministic Wallet instance.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_entropy(entropy="ee535b143b0d9d1f87546f9df0d06b1a", language="english", passphrase=None) <hdwallet.hdwallet.HDWallet object at 0x000001E8BFB98D60>
-
from_mnemonic
(mnemonic: str, language: Optional[str] = None, passphrase: Optional[str] = None) → hdwallet.hdwallet.HDWallet¶ Master from Mnemonic words.
- Parameters
mnemonic (str) – Mnemonic words.
language (str) – Mnemonic language, default to
None
.passphrase (str) – Mnemonic passphrase or password, default to
None
.
- Returns
HDWallet – Hierarchical Deterministic Wallet instance.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="sceptre capter séquence girafe absolu relatif fleur zoologie muscle sirop saboter parure", passphrase=None) <hdwallet.hdwallet.HDWallet object at 0x000001E8BFB98D60>
-
from_seed
(seed: str) → hdwallet.hdwallet.HDWallet¶ Master from Seed hex string.
- Parameters
seed (str) – Seed hex string.
- Returns
HDWallet – Hierarchical Deterministic Wallet instance.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import ETH >>> hdwallet = HDWallet(symbol=ETH) >>> hdwallet.from_seed(seed="8d5f4fe5b81a6a6a18b08603b6b3f59df9f4bbb25d10c55d23e0cbdc5ee385e5fddad9d7e6114f11afdec45928328081f9a598151a7613dc5f5a0c16a4612aa4") <hdwallet.hdwallet.HDWallet object at 0x000001E8BFB98D60>
-
from_root_xprivate_key
(xprivate_key: str, strict: bool = True) → hdwallet.hdwallet.HDWallet¶ Master from Root XPrivate Key.
- Parameters
xprivate_key (str) – Root xprivate key.
strict (bool) – Strict for must be root xprivate key, default to
True
.
- Returns
HDWallet – Hierarchical Deterministic Wallet instance.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_root_xprivate_key(xprivate_key="xprv9s21ZrQH143K3xPGUzpogJeKtRdjHkK6muBJo8v7rEVRzT83xJgNcLpMoJXUf9wJFKfuHR4SGvfgdShh4t9VmjjrE9usBunK3LfNna31LGF") <hdwallet.hdwallet.HDWallet object at 0x000001E8BFB98D60>
-
from_root_xpublic_key
(xpublic_key: str, strict: bool = True) → hdwallet.hdwallet.HDWallet¶ Master from Root XPublic Key.
- Parameters
xpublic_key (str) – Root xpublic key.
strict (bool) – Strict for must be root xpublic key, default to
True
.
- Returns
HDWallet – Hierarchical Deterministic Wallet instance.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_root_xpublic_key(xpublic_key="xpub661MyMwAqRbcGSTjb2Mp3Sb4STUDhD2x986ubXKjQa2QsFTCVqzdA98qeZjcncHT1AaZcMSjiP1HJ16jH97q72RwyFfiNhmG8zQ6KBB5PaQ") <hdwallet.hdwallet.HDWallet object at 0x000001E8BFB98D60>
-
from_xprivate_key
(xprivate_key: str) → hdwallet.hdwallet.HDWallet¶ Master from XPrivate Key.
- Parameters
xprivate_key (str) – XPrivate key.
- Returns
HDWallet – Hierarchical Deterministic Wallet instance.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_xprivate_key(xprivate_key="xprvA3BYGWQ9FmhyaNRRXB2f1LphNPnaY9T6gngw4BaTbkFtscSH4RCuJhgWUSKs9S6ciGioHd4TX4UeyUg53MkfN9Xh38xkS1j2Wb9YKsYpJHQ") <hdwallet.hdwallet.HDWallet object at 0x000001E8BFB98D60>
-
from_xpublic_key
(xpublic_key: str) → hdwallet.hdwallet.HDWallet¶ Master from XPublic Key.
- Parameters
xpublic_key (str) – XPublic key.
- Returns
HDWallet – Hierarchical Deterministic Wallet instance.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_xpublic_key(xprivate_key="xpub661MyMwAqRbcGSTjb2Mp3Sb4STUDhD2x986ubXKjQa2QsFTCVqzdA98qeZjcncHT1AaZcMSjiP1HJ16jH97q72RwyFfiNhmG8zQ6KBB5PaQ") <hdwallet.hdwallet.HDWallet object at 0x000001E8BFB98D60>
-
from_wif
(wif: str) → hdwallet.hdwallet.HDWallet¶ Master from Wallet Important Format (WIF).
- Parameters
wif (str) – Wallet important format.
- Returns
HDWallet – Hierarchical Deterministic Wallet instance.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_wif(wif="KzsHWUJsrTWUUhBGPfMMxLLydiH7NhEn6z7mKHXD5qNkUWaC4TEn") <hdwallet.hdwallet.HDWallet object at 0x000001E8BFB98D60>
-
from_private_key
(private_key: str) → hdwallet.hdwallet.HDWallet¶ Master from Private Key.
- Parameters
private_key (str) – Private key.
- Returns
HDWallet – Hierarchical Deterministic Wallet instance.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_private_key(private_key="6cd78b0d69eab1a47bfa53a52b9d8c4331e858b5d7a599270a95d9735fdb0b94") <hdwallet.hdwallet.HDWallet object at 0x000001E8BFB98D60>
-
from_public_key
(public_key: str) → hdwallet.hdwallet.HDWallet¶ Master from Public Key.
- Parameters
public_key (str) – Public key.
- Returns
HDWallet – Hierarchical Deterministic Wallet instance.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_public_key(public_key="02f93f58b97c3bb616645c3dda256ec946d87c45baf531984c022dd0fd1503b0a8") <hdwallet.hdwallet.HDWallet object at 0x000001E8BFB98D60>
-
from_path
(path: Union[str, hdwallet.derivations.Derivation]) → hdwallet.hdwallet.HDWallet¶ Derivation from Path.
- Parameters
path (str, Derivation) – Derivation path.
- Returns
HDWallet – Hierarchical Deterministic Wallet instance.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_root_xprivate_key(root_xprivate_key="xprv9s21ZrQH143K3xPGUzpogJeKtRdjHkK6muBJo8v7rEVRzT83xJgNcLpMoJXUf9wJFKfuHR4SGvfgdShh4t9VmjjrE9usBunK3LfNna31LGF") >>> hdwallet.from_path(path="m/44'/0'/'0/0/0") <hdwallet.hdwallet.HDWallet object at 0x000001E8BFB98D60>
-
from_index
(index: int, hardened: bool = False) → hdwallet.hdwallet.HDWallet¶ Derivation from Index.
- Parameters
index (int) – Derivation index.
hardened (bool) – Hardened address, default to
False
.
- Returns
HDWallet – Hierarchical Deterministic Wallet instance.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_root_xprivate_key(root_xprivate_key="xprv9s21ZrQH143K3xPGUzpogJeKtRdjHkK6muBJo8v7rEVRzT83xJgNcLpMoJXUf9wJFKfuHR4SGvfgdShh4t9VmjjrE9usBunK3LfNna31LGF") >>> hdwallet.from_index(index=44, hardened=True) >>> hdwallet.from_index(index=0, hardened=True) >>> hdwallet.from_index(index=0, hardened=True) >>> hdwallet.from_index(index=0) >>> hdwallet.from_index(index=0) <hdwallet.hdwallet.HDWallet object at 0x000001E8BFB98D60>
-
root_xprivate_key
(encoded: bool = True) → Optional[str]¶ Get Root XPrivate Key.
- Parameters
encoded (bool) – Encoded root xprivate key, default to
True
.- Returns
str – Root XPrivate Key.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_entropy(entropy="ee535b143b0d9d1f87546f9df0d06b1a") >>> hdwallet.from_path(path="m/44'/0'/'0/0/0") >>> hdwallet.root_xprivate_key() "xprv9s21ZrQH143K3xPGUzpogJeKtRdjHkK6muBJo8v7rEVRzT83xJgNcLpMoJXUf9wJFKfuHR4SGvfgdShh4t9VmjjrE9usBunK3LfNna31LGF"
-
root_xpublic_key
(encoded: bool = True) → Optional[str]¶ Get Root XPublic Key.
- Parameters
encoded (bool) – Encoded root xpublic key, default to
True
.- Returns
str – Root XPublic Key.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_entropy(entropy="ee535b143b0d9d1f87546f9df0d06b1a") >>> hdwallet.from_path(path="m/44'/0'/'0/0/0") >>> hdwallet.root_xpublic_key() "xpub661MyMwAqRbcGSTjb2Mp3Sb4STUDhD2x986ubXKjQa2QsFTCVqzdA98qeZjcncHT1AaZcMSjiP1HJ16jH97q72RwyFfiNhmG8zQ6KBB5PaQ"
-
xprivate_key
(encoded=True) → Optional[str]¶ Get XPrivate Key.
- Parameters
encoded (bool) – Encoded xprivate key, default to
True
.- Returns
str – Root XPrivate Key.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_entropy(entropy="ee535b143b0d9d1f87546f9df0d06b1a") >>> hdwallet.from_path(path="m/44'/0'/'0/0/0") >>> hdwallet.xprivate_key() "xprvA3BYGWQ9FmhyaNRRXB2f1LphNPnaY9T6gngw4BaTbkFtscSH4RCuJhgWUSKs9S6ciGioHd4TX4UeyUg53MkfN9Xh38xkS1j2Wb9YKsYpJHQ"
-
xpublic_key
(encoded: bool = True) → Optional[str]¶ Get XPublic Key.
- Parameters
encoded (bool) – Encoded xpublic key, default to
True
.- Returns
str – XPublic Key.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_entropy(entropy="ee535b143b0d9d1f87546f9df0d06b1a") >>> hdwallet.from_path(path="m/44'/0'/'0/0/0") >>> hdwallet.xpublic_key() "xpub6GAtg1w369GGnrVtdCZfNUmRvRd4wcAx41cXrZz5A5nskQmRbxX9rVzzKiRU4JruirBrfm4KQXNSU7GfqL1tzZWpZYe9Zo4xKGJYohWoQe7"
-
clean_derivation
() → hdwallet.hdwallet.HDWallet¶ Clean derivation Path or Indexes.
- Returns
HDWallet – Hierarchical Deterministic Wallet instance.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_root_xprivate_key(root_xprivate_key="xprv9s21ZrQH143K3xPGUzpogJeKtRdjHkK6muBJo8v7rEVRzT83xJgNcLpMoJXUf9wJFKfuHR4SGvfgdShh4t9VmjjrE9usBunK3LfNna31LGF") >>> hdwallet.from_path(path="m/44'/0'/'0/0/0") >>> hdwallet.path() "m/44'/0'/'0/0/0" >>> hdwallet.clean_derivation() <hdwallet.hdwallet.HDWallet object at 0x000001E8BFB98D60> >>> hdwallet.path() None
-
uncompressed
(compressed: Optional[str] = None) → str¶ Get Uncommpresed Public Key.
- Parameters
compressed (str) – Compressed public key, default to
None
.- Returns
str – Uncommpresed public key.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash") >>> hdwallet.from_path(path="m/44'/0'/0'/0/0") >>> hdwallet.uncompressed() "f93f58b97c3bb616645c3dda256ec946d87c45baf531984c022dd0fd1503b0a875f63285a539213ac241fc4a88e7137ba1c8d897b1c1e5efb81bfc6b45a22d40"
-
compressed
(uncompressed: Optional[str] = None) → str¶ Get Compresed Public Key.
- Parameters
uncompressed (str) – Uncompressed public key, default to
None
.- Returns
str – Commpresed public key.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash") >>> hdwallet.from_path(path="m/44'/0'/0'/0/0") >>> hdwallet.compressed() "02f93f58b97c3bb616645c3dda256ec946d87c45baf531984c022dd0fd1503b0a8"
-
private_key
() → str¶ Get Private Key.
- Returns
str – Private key.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash") >>> hdwallet.from_path(path="m/44'/0'/0'/0/0") >>> hdwallet.private_key() "6cd78b0d69eab1a47bfa53a52b9d8c4331e858b5d7a599270a95d9735fdb0b94"
-
public_key
(compressed: bool = True, private_key: Optional[str] = None) → str¶ Get Public Key.
- Parameters
compressed (bool) – Compressed public key, default to
True
.private_key (str) – Private key hex string, default to
None
.
- Returns
str – Public key.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash") >>> hdwallet.from_path(path="m/44'/0'/0'/0/0") >>> hdwallet.public_key() "02f93f58b97c3bb616645c3dda256ec946d87c45baf531984c022dd0fd1503b0a8"
-
strength
() → Optional[int]¶ Get Entropy strength.
- Returns
int – Entropy strength.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash") >>> hdwallet.strength() 160
-
entropy
() → Optional[str]¶ Get Entropy hex string.
- Returns
str – Entropy hex string.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash") >>> hdwallet.entropy() "f24afe7fc1418815ee7fd256beb55518e7c34ecd"
-
mnemonic
() → Optional[str]¶ Get Mnemonic words.
- Returns
str – Mnemonic words.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash") >>> hdwallet.mnemonic() "venture fitness paper little blush april rigid where find volcano fetch crack label polar dash"
-
passphrase
() → Optional[str]¶ Get Mnemonic passphrase.
- Returns
str – Mnemonic passphrase.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> hdwallet.passphrase() "meherett"
-
language
() → Optional[str]¶ Get Mnemonic language.
- Returns
str – Mnemonic language.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> hdwallet.language() "english"
-
cryptocurrency
() → Optional[str]¶ Get Cryptocurrency name.
- Returns
str – Cryptocurrency name.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> hdwallet.cryptocurrency() "Bitcoin"
-
symbol
() → Optional[str]¶ Get Cryptocurrency symbol.
- Returns
str – Cryptocurrency symbol.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> hdwallet.symbol() "BTC"
-
semantic
() → Optional[str]¶ Get Extended semantic.
- Returns
str – Extended semantic.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> hdwallet.semantic() "p2pkh"
-
network
() → Optional[str]¶ Get Cryptocurrency network type.
- Returns
str – Cryptocurrency network type.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> hdwallet.network() "mainnet"
-
seed
() → Optional[str]¶ Get Seed hex string.
- Returns
str – Seed hex string.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> hdwallet.from_path(path="m/44'/0'/0'/0/0") >>> hdwallet.seed() "8d5f4fe5b81a6a6a18b08603b6b3f59df9f4bbb25d10c55d23e0cbdc5ee385e5fddad9d7e6114f11afdec45928328081f9a598151a7613dc5f5a0c16a4612aa4"
-
path
() → Optional[str]¶ Get Derivation path.
- Returns
str – Drivation path.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> hdwallet.from_path(path="m/44'/0'/0'/0/0") >>> hdwallet.path() "m/44'/0'/0'/0/0"
-
chain_code
() → Optional[str]¶ Get Chain code.
- Returns
str – Chain code.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> hdwallet.from_path(path="m/44'/0'/0'/0/0") >>> hdwallet.chain_code() "ed45793b944d1f22522f2d6f48c487029fae2cfcd999ed23087a148bcdda6314"
-
hash
(private_key: Optional[str] = None)¶ Get Public Key Hash.
- Returns
str – Identifier.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> hdwallet.from_path(path="m/44'/0'/0'/0/0") >>> hdwallet.hash() "4d887566d408dfe5ea8090f2b716f9639523ca89"
-
finger_print
() → str¶ Get Finger print.
- Returns
str – Finger print.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> hdwallet.from_path(path="m/44'/0'/0'/0/0") >>> hdwallet.finger_print() "4d887566"
-
p2pkh_address
() → str¶ Get Pay to Public Key Hash (P2PKH) address.
- Returns
str – P2PKH address.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> hdwallet.from_path(path="m/44'/0'/0'/0/0") >>> hdwallet.p2pkh_address() "184xW5gWDnhS7LriL2JAZs1XGTJjimz7pq"
-
p2sh_address
() → str¶ Get Pay to Script Hash (P2SH) address.
- Returns
str – P2SH address.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> hdwallet.from_path(path="m/44'/0'/0'/0/0") >>> hdwallet.p2sh_address() "3Jp6ad4ErhibQmhSRfavbPRiUyg2xTTT4j"
-
p2wpkh_address
() → Optional[str]¶ Get Pay to Witness Public Key Hash (P2WPKH) address.
- Returns
str – P2WPKH address.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> hdwallet.from_path(path="m/44'/0'/0'/0/0") >>> hdwallet.p2wpkh_address() "bc1qfky82ek5pr07t65qjretw9hevw2j8j5fdrn5hc"
-
p2wpkh_in_p2sh_address
() → Optional[str]¶ Get P2WPKH nested in P2SH address.
- Returns
str – P2WPKH nested in P2SH address.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> hdwallet.from_path(path="m/44'/0'/0'/0/0") >>> hdwallet.p2wpkh_in_p2sh_address() "3CCrxPrHNa6ePbnB7qjh7S3vaPx9qiLc3e"
-
p2wsh_address
() → Optional[str]¶ Get Pay to Witness Script Hash (P2WSH) address.
- Returns
str – P2WSH address.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> hdwallet.from_path(path="m/44'/0'/0'/0/0") >>> hdwallet.p2wsh_address() "bc1qaj2xa9j6eegcxls3y8p6erw6vdgdxynasrd4hl3xuctht5edu3msdeshgf"
-
p2wsh_in_p2sh_address
() → Optional[str]¶ Get P2WSH nested in P2SH address.
- Returns
str – P2WSH nested in P2SH address.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> hdwallet.from_path(path="m/44'/0'/0'/0/0") >>> hdwallet.p2wsh_in_p2sh_address() "38YMonfh2yLFRViLrM2kdvZx8ctcp1vbbV"
-
wif
() → Optional[str]¶ Get Wallet Important Format.
- Returns
str – Wallet Important Format.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> hdwallet.from_path(path="m/44'/0'/0'/0/0") >>> hdwallet.wif() "KzsHWUJsrTWUUhBGPfMMxLLydiH7NhEn6z7mKHXD5qNkUWaC4TEn"
-
dumps
() → dict¶ Get All HDWallet imformations.
- Returns
dict – All HDWallet imformations.
>>> from hdwallet import HDWallet >>> from hdwallet.symbols import BTC >>> hdwallet = HDWallet(symbol=BTC) >>> hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> hdwallet.from_path(path="m/44'/0'/0'/0/0") >>> hdwallet.dumps() {'cryptocurrency': 'Bitcoin', 'symbol': 'BTC', 'network': 'mainnet', 'strength': 160, 'entropy': 'f24afe7fc1418815ee7fd256beb55518e7c34ecd', 'mnemonic': 'venture fitness paper little blush april rigid where find volcano fetch crack label polar dash', 'language': 'english', 'passphrase': None, 'seed': '8d5f4fe5b81a6a6a18b08603b6b3f59df9f4bbb25d10c55d23e0cbdc5ee385e5fddad9d7e6114f11afdec45928328081f9a598151a7613dc5f5a0c16a4612aa4', 'root_xprivate_key': 'xprv9s21ZrQH143K3xPGUzpogJeKtRdjHkK6muBJo8v7rEVRzT83xJgNcLpMoJXUf9wJFKfuHR4SGvfgdShh4t9VmjjrE9usBunK3LfNna31LGF', 'root_xpublic_key': 'xpub661MyMwAqRbcGSTjb2Mp3Sb4STUDhD2x986ubXKjQa2QsFTCVqzdA98qeZjcncHT1AaZcMSjiP1HJ16jH97q72RwyFfiNhmG8zQ6KBB5PaQ', 'xprivate_key': 'xprvA3BYGWQ9FmhyaNRRXB2f1LphNPnaY9T6gngw4BaTbkFtscSH4RCuJhgWUSKs9S6ciGioHd4TX4UeyUg53MkfN9Xh38xkS1j2Wb9YKsYpJHQ', 'xpublic_key': 'xpub6GAtg1w369GGnrVtdCZfNUmRvRd4wcAx41cXrZz5A5nskQmRbxX9rVzzKiRU4JruirBrfm4KQXNSU7GfqL1tzZWpZYe9Zo4xKGJYohWoQe7', 'uncompressed': 'f93f58b97c3bb616645c3dda256ec946d87c45baf531984c022dd0fd1503b0a875f63285a539213ac241fc4a88e7137ba1c8d897b1c1e5efb81bfc6b45a22d40', 'compressed': '02f93f58b97c3bb616645c3dda256ec946d87c45baf531984c022dd0fd1503b0a8', 'chain_code': 'ed45793b944d1f22522f2d6f48c487029fae2cfcd999ed23087a148bcdda6314', 'private_key': '6cd78b0d69eab1a47bfa53a52b9d8c4331e858b5d7a599270a95d9735fdb0b94', 'public_key': '02f93f58b97c3bb616645c3dda256ec946d87c45baf531984c022dd0fd1503b0a8', 'wif': 'KzsHWUJsrTWUUhBGPfMMxLLydiH7NhEn6z7mKHXD5qNkUWaC4TEn', 'identifier': '4d887566d408dfe5ea8090f2b716f9639523ca89', 'finger_print': '4d887566', 'path': "m/44'/0'/0'/0/0", 'addresses': {'p2pkh': '184xW5gWDnhS7LriL2JAZs1XGTJjimz7pq', 'p2sh': '3Jp6ad4ErhibQmhSRfavbPRiUyg2xTTT4j', 'p2wpkh': 'bc1qfky82ek5pr07t65qjretw9hevw2j8j5fdrn5hc', 'p2wpkh_in_p2sh': '3CCrxPrHNa6ePbnB7qjh7S3vaPx9qiLc3e', 'p2wsh': 'bc1qaj2xa9j6eegcxls3y8p6erw6vdgdxynasrd4hl3xuctht5edu3msdeshgf', 'p2wsh_in_p2sh': '38YMonfh2yLFRViLrM2kdvZx8ctcp1vbbV'}}
BIP32HDWallet¶
Class BIP32 Hierarchical Deterministic Wallet
-
class
hdwallet.hdwallet.
BIP32HDWallet
(symbol: str = 'BTC', cryptocurrency: Optional[Any] = None, purpose: Union[int, Tuple[int, bool]] = 0, coin_type: Union[int, Tuple[int, bool]] = 0, account: Union[int, Tuple[int, bool]] = 0, change: bool = False, address: Union[int, Tuple[int, bool]] = 0)¶ BIP32 Hierarchical Deterministic Wallet
- Parameters
symbol (str) – Cryptocurrency symbol, defaults to
BTC
.cryptocurrency (Cryptocurrency) – Cryptocurrency instance, default to
None
.purpose (int, tuple) – Purpose index, default to
0
.coin_type (int, tuple) – Coin type, default to
0
.account (int, tuple) – Account index, default to
0
.change (bool) – Change addresses, default to
False
.address (int, tuple) – Address index, default to
0
.
- Returns
BIP32HDWallet – BIP32 Hierarchical Deterministic Wallet instance.
>>> from hdwallet import BIP32HDWallet >>> from hdwallet.cryptocurrencies import QtumMainnet >>> bip32_hdwallet: BIP32HDWallet = BIP32HDWallet(cryptocurrency=QtumMainnet, purpose=0, coin_type=0, account=0, change=False, address=0) <hdwallet.hdwallet.BIP32HDWallet object at 0x000001EBC58E9F70>
-
address
() → str¶ Get Pay to Public Key Hash (P2PKH) address.
- Returns
str – P2PKH address.
>>> from hdwallet import BIP32HDWallet >>> from hdwallet.symbols import BTC >>> bip32_hdwallet: BIP32HDWallet = BIP32HDWallet(symbol=BTC, purpose=44, coin_type=0, account=0, change=False, address=0) >>> bip32_hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> bip32_hdwallet.address() "184xW5gWDnhS7LriL2JAZs1XGTJjimz7pq"
BIP44HDWallet¶
Class BIP44 Hierarchical Deterministic Wallet
-
class
hdwallet.hdwallet.
BIP44HDWallet
(symbol: str = 'BTC', cryptocurrency: Optional[Any] = None, account: Union[int, Tuple[int, bool]] = 0, change: bool = False, address: Union[int, Tuple[int, bool]] = 0)¶ BIP44 Hierarchical Deterministic Wallet
- Parameters
symbol (str) – Cryptocurrency symbol, defaults to
BTC
.cryptocurrency (Cryptocurrency) – Cryptocurrency instance, default to
None
.account (int, tuple) – Account index, default to
0
.change (bool) – Change addresses, default to
False
.address (int, tuple) – Address index, default to
0
.
- Returns
BIP44HDWallet – BIP44 Hierarchical Deterministic Wallet instance.
>>> from hdwallet import BIP44HDWallet >>> from hdwallet.cryptocurrencies import QtumMainnet >>> bip44_hdwallet: BIP44HDWallet = BIP44HDWallet(cryptocurrency=QtumMainnet, account=0, change=False, address=0) <hdwallet.hdwallet.BIP44HDWallet object at 0x000001EBC58E9F70>
-
address
() → str¶ Get Pay to Public Key Hash (P2PKH) address.
- Returns
str – P2PKH address.
>>> from hdwallet import BIP44HDWallet >>> from hdwallet.symbols import BTC >>> bip44_hdwallet: BIP44HDWallet = BIP44HDWallet(symbol=BTC, account=0, change=False, address=0) >>> bip44_hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> bip44_hdwallet.address() "184xW5gWDnhS7LriL2JAZs1XGTJjimz7pq"
BIP49HDWallet¶
Class BIP49 Hierarchical Deterministic Wallet
-
class
hdwallet.hdwallet.
BIP49HDWallet
(symbol: str = 'BTC', cryptocurrency: Optional[Any] = None, account: Union[int, Tuple[int, bool]] = 0, change: bool = False, address: Union[int, Tuple[int, bool]] = 0)¶ BIP49 Hierarchical Deterministic Wallet
- Parameters
symbol (str) – Cryptocurrency symbol, defaults to
BTC
.cryptocurrency (Cryptocurrency) – Cryptocurrency instance, default to
None
.account (int, tuple) – Account index, default to
0
.change (bool) – Change addresses, default to
False
.address (int, tuple) – Address index, default to
0
.
- Returns
BIP49HDWallet – BIP49 Hierarchical Deterministic Wallet instance.
>>> from hdwallet import BIP49HDWallet >>> from hdwallet.cryptocurrencies import QtumMainnet >>> bip49_hdwallet: BIP49HDWallet = BIP49HDWallet(cryptocurrency=QtumMainnet, account=0, change=False, address=0) <hdwallet.hdwallet.BIP49HDWallet object at 0x000001EBC58E9F70>
-
address
() → str¶ Get P2WPKH nested in P2SH address.
- Returns
str – P2PKH In P2SH address.
>>> from hdwallet import BIP49HDWallet >>> from hdwallet.symbols import BTC >>> bip49_hdwallet: BIP49HDWallet = BIP49HDWallet(symbol=BTC, account=0, change=False, address=0) >>> bip49_hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> bip49_hdwallet.address() "3HtjZPoiUh9DA3kzQL9XZ29aFdCzouWB6T"
BIP84HDWallet¶
Class BIP84 Hierarchical Deterministic Wallet
-
class
hdwallet.hdwallet.
BIP84HDWallet
(symbol: str = 'BTC', cryptocurrency: Optional[Any] = None, account: Union[int, Tuple[int, bool]] = 0, change: bool = False, address: Union[int, Tuple[int, bool]] = 0)¶ BIP84 Hierarchical Deterministic Wallet
- Parameters
symbol (str) – Cryptocurrency symbol, defaults to
BTC
.cryptocurrency (Cryptocurrency) – Cryptocurrency instance, default to
None
.account (int, tuple) – Account index, default to
0
.change (bool) – Change addresses, default to
False
.address (int, tuple) – Address index, default to
0
.
- Returns
BIP84HDWallet – BIP84 Hierarchical Deterministic Wallet instance.
>>> from hdwallet import BIP84HDWallet >>> from hdwallet.cryptocurrencies import QtumMainnet >>> bip84_hdwallet: BIP84HDWallet = BIP84HDWallet(cryptocurrency=QtumMainnet, account=0, change=False, address=0) <hdwallet.hdwallet.BIP84HDWallet object at 0x000001EBC58E9F70>
-
address
() → str¶ Get Pay to Witness Public Key Hash (P2WPKH) address.
- Returns
str – Pay to Witness Public Key Hash (P2WPKH) address.
>>> from hdwallet import BIP84HDWallet >>> from hdwallet.symbols import BTC >>> bip84_hdwallet: BIP84HDWallet = BIP84HDWallet(symbol=BTC, account=0, change=False, address=0) >>> bip84_hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> bip84_hdwallet.address() "bc1qs95czhkhawdq958gjscrw4mh6amu2ysx20w86d"
BIP141HDWallet¶
Class BIP141 Hierarchical Deterministic Wallet
-
class
hdwallet.hdwallet.
BIP141HDWallet
(symbol: str = 'BTC', cryptocurrency: Optional[Any] = None, path: Optional[Union[str, hdwallet.derivations.Derivation]] = None, semantic: str = 'p2wpkh')¶ BIP141 Hierarchical Deterministic Wallet
- Parameters
symbol (str) – Cryptocurrency symbol, defaults to
BTC
.cryptocurrency (Cryptocurrency) – Cryptocurrency instance, defaults to
None
.path (str) – Derivation path.
semantic (str) – Extended semantic, defaults to
P2WPKH
.
- Returns
BIP141HDWallet – BIP141 Hierarchical Deterministic Wallet instance.
>>> from hdwallet import BIP141HDWallet >>> from hdwallet.cryptocurrencies import QtumMainnet >>> bip141_hdwallet: BIP141HDWallet = BIP141HDWallet(cryptocurrency=QtumMainnet, path="m/0/0", semantic="p2wpkh") <hdwallet.hdwallet.BIP141HDWallet object at 0x000001EBC58E9F70>
-
address
() → str¶ Get P2WPKH, P2WPKH_IN_P2SH, P2WSH or P2WPKH_IN_P2SH addresses by semantic.
- Returns
str – P2WPKH, P2WPKH_IN_P2SH, P2WSH or P2WPKH_IN_P2SH addresses.
>>> from hdwallet import BIP141HDWallet >>> from hdwallet.symbols import BTC >>> bip141_hdwallet: BIP141HDWallet = BIP141HDWallet(symbol=BTC, path="m/44'/0'/0'/0/0", semantic="p2wsh") >>> bip141_hdwallet.from_mnemonic(mnemonic="venture fitness paper little blush april rigid where find volcano fetch crack label polar dash", passphrase="meherett") >>> bip141_hdwallet.address() "bc1qaj2xa9j6eegcxls3y8p6erw6vdgdxynasrd4hl3xuctht5edu3msdeshgf"