btmhdw

The implementation of Hierarchical Deterministic (HD) wallets generator for Bytom blockchain.

PyPI - Python Version PyPI License PyPI Version

Installation

Install btmhdw

pip install btmhdw

Development

Clone the repository and then run

pip install -e . -r requirements.txt

Running the test

You can run the tests with:

pip install -r test-requirements.txt

pytest tests

Or use tox to run the complete suite against the full set of build targets, or pytest to run specific tests against a specific version of Python.

Usage

Create a new Bytom wallet

from btmhdw import BTMHDW

# init BTMHDW
btmhdw = BTMHDW()

# Generate mnemonic english/japanese
mnemonic = btmhdw.generate_mnemonic("english")

# Checking mnemonic language
if not btmhdw.check_mnemonic(mnemonic, "english"):
    exit()

# Create a new wallet
wallet = btmhdw.create(mnemonic=mnemonic, network="mainnet")

print(wallet)

OUTPUT

{
  'mnemonic': 'gauge base climb fit output toast brave crush vacant predict hire remind',
  'address': 'bm1qn6g0tky8lx44j2ccz8cu88ngn4snfqr74d9ndw',
  'seed': 'b699dee73ef9be58fbf3490dab6e49071f96df97c5d2614a465b1fd3b76373f56edbac4e24b137f6226402e59902f0eaa882603f94b83618384500db1e30585b',
  'xprivate': '8007196f3e0841bbdf90d97df172a19cb18edda007466d362fa2d5ff23822a40189b8b295cc023e0b2c78f79725f859ac512afdfebc0b94cfd83faa59e42d82e',
  'xpublic': 'd47ece6097f93b5d19259886d210dab017f5b37520b4dad8160712fd5b1065e7189b8b295cc023e0b2c78f79725f859ac512afdfebc0b94cfd83faa59e42d82e',
  'program': '001468029bfd7635cec9100ed21ab6aee3a41986db71',
  'path': 'm/44/153/1/0/1',
}

Get wallet from XPrivate key

from btmhdw import BTMHDW

XPRIVATE = "8007196f3e0841bbdf90d97df172a19cb18edda007466d362fa2d5ff23822a40189b8b295cc023e0b2c78f79725f859ac512afdfebc0b94cfd83faa59e42d82e"

# init BTMHDW
btmhdw = BTMHDW()

# Wallet from xprivate
wallet = btmhdw.from_xprivate(xprivate=XPRIVATE, network="mainnet")

print(wallet)

OUTPUT

{
  'address': 'bm1qn6g0tky8lx44j2ccz8cu88ngn4snfqr74d9ndw',
  'xprivate': '8007196f3e0841bbdf90d97df172a19cb18edda007466d362fa2d5ff23822a40189b8b295cc023e0b2c78f79725f859ac512afdfebc0b94cfd83faa59e42d82e',
  'xpublic': 'd47ece6097f93b5d19259886d210dab017f5b37520b4dad8160712fd5b1065e7189b8b295cc023e0b2c78f79725f859ac512afdfebc0b94cfd83faa59e42d82e', 
  'program': '001468029bfd7635cec9100ed21ab6aee3a41986db71',
  'path': 'm/44/153/1/0/1'
}

Example

Here are more btmhdw/example

License

This project is licensed under the MIT License - see the LICENSE file for details

API

Class BTMHDW()

generate_mnemonic(): It is to generate new mnemonic.

Parameters

Optional:

String - strength, 128.
String - passphrase, password of the key.
String - language, mnemonic language of the key.

Returns

Object:

String - mnemonic, generated mnemonic 12 words.

Example

print(btmhdw.generate_mnemonic(language="english", passphrase="meherett"))
print(btmhdw.generate_mnemonic(language="japanese", passphrase="meherett"))

Output

"spare uniform possible grief attitude machine peace update tornado area evolve spread"
"あけがたãひていãぎじかがくãくうきãどうぐãだじゃれãおおうãりねんãこんだてãてわたしãはぶらしãちいき"

check_mnemonic(): It is to check mnemonic language.

Parameters

Object:

String - mnemonic, mnemonic 12 words.

Optional:

String - language, english/japanese by default english.

Returns

Object:

Boolean - boolean, True/False.

Example

MNEMONIC = "ancient young hurt bone shuffle deposit congress normal crack six boost despair"

print(btmhdw.check_mnemonic(MNEMONIC, "english"))
print(btmhdw.check_mnemonic(MNEMONIC, "japanese"))

Output

True
False

generate_entropy(): It is to generate new entropy.

Returns

Object:

String - entropy, generated entropy 32 length.

Example

print(btmhdw.generate_entropy())

Output

"fbb9d20ec1fb94762b56dbc9cd184e23"

create(): It is to create new Bytom wallet.

Parameters

Optional:

String - mnemonic, from mnemonic 12 words.
String - passphrase, password of the key.
String - account, account path index by default 1.
String - change, change path index 0 or 1 by default 0.
String - address, address path index by default 1.
String - path, string of index.
Array - indexes, array of index.
String - network, mainnet(bm)/testnet(tm)/solonet(sm) by default sm.

Returns

Object:

Object - object, keys are entropy, mnemonic, address, seed, xprivate, xpublic, program and path

Example

mnemonic = btmhdw.generate_mnemonic("english")

createdWallet = btmhdw.create(mnemonic=mnemonic, 
                                    network="mainnet")
print(createdWallet['address'])
print(createdWallet['xprivate'], '\n')
print(createdWallet)

Output

"bm1qsv6u5z2uxtefnehkyuetyx4llu27umqscu8vtk"
"983fc70dc7c4a26ff9af39af4c0cc3057565b8f70a31158a6f37e1804ae6414ea6cade89861c53fafa461e5f0e116f47a816b11ba05585b79c577531c6000ffe" 

{
  'mnemonic': 'alarm fix day evoke void hawk pistol pulp impact farm average mask',
  'address': 'bm1qsv6u5z2uxtefnehkyuetyx4llu27umqscu8vtk',
  'seed': '6e269a33fb2c65b9a1966bc9579628869630d7d647792eaa3692fdae1db1a719ff4dfef17acf6027fb20ba7ce04e4715460ea2d280f69f646df1f2a6ef6ffea1',
  'xprivate': '983fc70dc7c4a26ff9af39af4c0cc3057565b8f70a31158a6f37e1804ae6414ea6cade89861c53fafa461e5f0e116f47a816b11ba05585b79c577531c6000ffe',
  'xpublic': '4a7bfcbccbe97aa3f92795c761697f98b6b2350597ab73c85109b025301db1aaa6cade89861c53fafa461e5f0e116f47a816b11ba05585b79c577531c6000ffe',
  'program': '0014312b5e9ee3625a50847ffd5244dbc0d8f01b8566',
  'path': 'm/44/153/1/0/1',
}

from_xprivate(): It is to get wallet from xprivate key.

Parameters

Object:

String - xprivate, xprivate key.

Optional:

String - account, account path index by default 1.
String - change, change path index 0 or 1 by default 0.
String - address, address path index by default 1.
String - path, string of index.
Array - indexes, array of index.
String - network, mainnet(bm)/testnet(tm)/solonet(sm) by default sm.

Returns

Object:

Object - object, keys are address, xprivate, xpublic, program and path

Example

XPRIVATE = "c003f4bcccf9ad6f05ad2c84fa5ff98430eb8e73de5de232bc29334c7d074759d513bc370335cac51d77f0be5dfe84de024cfee562530b4d873b5f5e2ff4f57c"

wallet_from_xprivate = btmhdw.from_xprivate(xprivate=XPRIVATE, network="mainnet")

print(wallet_from_xprivate['address'])
print(wallet_from_xprivate['xprivate'], '\n')
print(wallet_from_xprivate)

Output

"bm1qtzg058tt5eyf2qqfy2650erxqxhfkt4p236708"
"c003f4bcccf9ad6f05ad2c84fa5ff98430eb8e73de5de232bc29334c7d074759d513bc370335cac51d77f0be5dfe84de024cfee562530b4d873b5f5e2ff4f57c" 

{
  'address': 'bm1qtzg058tt5eyf2qqfy2650erxqxhfkt4p236708', 
  'xprivate': 'c003f4bcccf9ad6f05ad2c84fa5ff98430eb8e73de5de232bc29334c7d074759d513bc370335cac51d77f0be5dfe84de024cfee562530b4d873b5f5e2ff4f57c',
  'xpublic': '1b0541a7664cee929edb54d9ef21996b90546918a920a77e1cd6015d97c56563d513bc370335cac51d77f0be5dfe84de024cfee562530b4d873b5f5e2ff4f57c',
  'program': '0014dcf6b21d83c978d3125d1330c928c38fee315200',
  'path': 'm/44/153/1/0/1',
}

Class BytomHDWallet()

master_key_from_mnemonic(): It is to get master key from mnemonic.

Parameters

Object:

String - mnemonic, mnemonic 12 words.

Optional:

String - passphrase, password of the key.

Returns

Object:

Object - BytomHDWallet, class.

Example

MNEMONIC = "ancient young hurt bone shuffle deposit congress normal crack six boost despair"

bytomHDWallet = BytomHDWallet.master_key_from_mnemonic(mnemonic=MNEMONIC, 
                                                       passphrase="Meheret Tesfaye")

master_key_from_xprivate(): It is to get master key from XPrivate.

Parameters

Object:

String - xprivate, xprivate key.

Returns

Object:

Object - BytomHDWallet, class.

Example

XPRIVATE = "c003f4bcccf9ad6f05ad2c84fa5ff98430eb8e73de5de232bc29334c7d074759d513bc370335cac51d77f0be5dfe84de024cfee562530b4d873b5f5e2ff4f57c"

bytomHDWallet = BytomHDWallet.master_key_from_xprivate(xprivate=XPRIVATE)

generate_entropy(): It is to generate new entropy.

Returns

Object:

String - entropy, generated entropy.

Example

print(bytomHDWallet.generate_entropy().hex())

Output

"7184af4506fb1b51c52d2e73251cc3a7"

master_key_from_entropy(): It is to get master key from mnemonic.

Parameters

Optional:

String - entropy, from entropy.
String - strength, 128.
String - passphrase, password of the key.
String - language, mnemonic language of the key.

Returns

Object:

Object - BytomHDWallet, class.
String - mnemonic, generated mnemonic 12 words.

Example

entropy = bytomHDWallet.generate_entropy()

bytomHDWallet, mnemonic = bytomHDWallet.master_key_from_entropy(entropy=entropy,
                                                                passphrase="meherett",
                                                                language="japanese")
print(mnemonic)
print(bytomHDWallet)

Output

"たいむãおまいりãたんめいãきちょうãろんぶんãいなかãしなぎれãほえるãいもうとãひしょãじゆうãにんむ"
<btmhdw.BytomHDWallet object at 0x7f3374618cf8>

xprivate_key(): It is to get XPrivate key.

Returns

Object:

String - xprivate, xprivate from master key.

Example

MNEMONIC = "ancient young hurt bone shuffle deposit congress normal crack six boost despair"

bytomHDWallet = BytomHDWallet()
bytomHDWallet = bytomHDWallet.master_key_from_mnemonic(mnemonic=MNEMONIC)
bytomHDWallet.from_path("m/44/153/1/0/1")

print(bytomHDWallet.xprivate_key())

Output

"302a25c7c0a68a83fa043f594a2db8b44bc871fced553a8a33144b31bc7fb84887c9e75915bb6ba3fd0b9f94a60b7a5897ab9db6a48f888c2559132dba9152b0"

xpublic_key(): It is to get XPublic key.

Parameters

Optional:

String - xprivate, from xprivate key.

Returns

Object:

String - xpublic, xpublic from xprivate/master key.

Example

XPRIVATE = "c003f4bcccf9ad6f05ad2c84fa5ff98430eb8e73de5de232bc29334c7d074759d513bc370335cac51d77f0be5dfe84de024cfee562530b4d873b5f5e2ff4f57c"

print(bytomHDWallet.xpublic_key(xprivate=XPRIVATE))

Output

"302a25c7c0a68a83fa043f594a2db8b44bc871fced553a8a33144b31bc7fb84887c9e75915bb6ba3fd0b9f94a60b7a5897ab9db6a48f888c2559132dba9152b0"

expand_xprivate_key(): It is to get Expand XPrivate key.

Parameters

Optional:

String - xprivate, from xprivate key.

Returns

Object:

String - expandPrivate, expand private key from xprivate/master key.

Example

XPRIVATE = "c003f4bcccf9ad6f05ad2c84fa5ff98430eb8e73de5de232bc29334c7d074759d513bc370335cac51d77f0be5dfe84de024cfee562530b4d873b5f5e2ff4f57c"

print(bytomHDWallet.expand_xprivate_key(xprivate=XPRIVATE))

Output

"c003f4bcccf9ad6f05ad2c84fa5ff98430eb8e73de5de232bc29334c7d074759b47fcbbf006db960004839862e694fb3647fdc081ae109bbfe3b07de83e39807"

public_key(): It is to get public key(length 64).

Parameters

Optional:

String - xpublic, from xpublic key.

Returns

Object:

String - public, public key(length 64) from xpublic/master key.

Example

XPUBLIC = "3c6664244d2d57168d173c4691dbf8741a67d972b2d3e1b0067eb825e2005d20c5eebd1c26ccad4de5142d7c339bf62cc1fb79a8b3e42a708cd521368dbc9286"

print(bytomHDWallet.public_key(xpublic=XPUBLIC))

Output

"3c6664244d2d57168d173c4691dbf8741a67d972b2d3e1b0067eb825e2005d20"

from_indexes(): It is to set collection of index.

Parameters

Object:

Array - indexes, array of index.

Returns

Object:

Object - BytomHDWallet, class.

Example

INDEXES = ['2c000000', '99000000', '01000000', '01000000', '99000000']

bytomHDWallet = bytomHDWallet.from_indexes(indexes=INDEXES)

from_index(): It is to set index.

Parameters

Object:

Number - index, number.

Returns

Object:

Object - BytomHDWallet, class.

Example

bytomHDWallet = BytomHDWallet()

bytomHDWallet.from_index(44)
bytomHDWallet.from_index(153)
bytomHDWallet.from_index(1)  # account
bytomHDWallet.from_index(0)  # change 0 or 1
bytomHDWallet.from_index(1)  # address

# Advanced BTMHDW_HARDEN

bytomHDWallet.from_index(44)
bytomHDWallet.from_index(153 + BTMHDW_HARDEN)
bytomHDWallet.from_index(1 + BTMHDW_HARDEN)
bytomHDWallet.from_index(0)
bytomHDWallet.from_index(1)

from_path(): It is to set index from path.

Parameters

Object:

String - path, string of index.

Returns

Object:

Object - BytomHDWallet, class.

Example

bytomHDWallet = BytomHDWallet()

bytomHDWallet.from_path("m/44/153/1/0/1")

# Advanced BTMHDW_HARDEN using "'"

bytomHDWallet.from_path("m/44/153'/1'/0/1")

get_indexes(): It is to get collection of index.

Returns

Object:

Array - indexes, collection of index.

Example

print(bytomHDWallet.get_indexes())

Output

['2c000000', '99000000', '01000000', '01000000', '99000000']

get_path(): It is to get path of indexes.

Parameters

Optional:

String - indexes, from array of index.

Returns

Object:

String - path, string of index from indexes/master key.

Example

from btmhdw import INDEXES

print(bytomHDWallet.get_path(indexes=INDEXES))

Output

"m/44/153/1/0/1"

child_xprivate_key(): It is to get child of XPrivate key.

Parameters

Optional:

String - xprivate, from xprivate key.
String - indexes, collection of index.
String - path, path of index.

Returns

Object:

String - childXPrivate, child xprivate key from xprivate/indexes/master key.

Example

from btmhdw import INDEXES

XPRIVATE = "c003f4bcccf9ad6f05ad2c84fa5ff98430eb8e73de5de232bc29334c7d074759d513bc370335cac51d77f0be5dfe84de024cfee562530b4d873b5f5e2ff4f57c"

child_xprivate_key = bytomHDWallet.child_xprivate_key(xprivate=XPRIVATE,
                                                      indexes=INDEXES)
print(child_xprivate_key)

Output

"d01acc504811886d732ea6ea19c066b0f1fb4d0b2a0b97414d1d3916c70c47596aca269da2343d4d7588ffa3c8b9244a156748276114e5f2b86fa69ec241b62a"

sing(): Singing message.

Parameters

Object:

String - message, message to sing.

Optional:

String - xprivate, xprivate key.

Returns

Object:

String - signature, signed message.

Example

MESSAGE = "27c42b40a7a35a6d489fb2e41bde15bdb4b4c276045bd0628525b88c2abbc4c0"

signature = bytomHDWallet.sign(message=MESSAGE)

print(signature)

Output

"75ca5b6cf7ba40c7a51f20e1fd03686666e09cf58d0d2978ab6072d8057cbbd3072eabbdefe96eefcbb0c8ec654239b82fa5efcbe24e8704c7d06efd79c40d0a"

verify(): Verifying signed message.

Parameters

Object:

String - message, message to sing.
String - signature, signed message.

Optional:

String - xpublic, xpublic key.

Returns

Object:

Boolean - bool, true or false.

Example

MESSAGE = "27c42b40a7a35a6d489fb2e41bde15bdb4b4c276045bd0628525b88c2abbc4c0"

verify_signature = bytomHDWallet.verify(message=MESSAGE, signature=signature)

print(verify_signature)

Output

True

child_xpublic_key(): It is to get child of XPublic key.

Parameters

Optional:

String - xpublic, from xpublic key.
String - indexes, collection of index.
String - path, path of index.

Returns

Object:

String - child_xpublic_key, child xpublic key from xpublic/indexes/master key.

Example

from btmhdw import INDEXES

XPUBLIC = "3c6664244d2d57168d173c4691dbf8741a67d972b2d3e1b0067eb825e2005d20c5eebd1c26ccad4de5142d7c339bf62cc1fb79a8b3e42a708cd521368dbc9286"

child_xpublic_key = bytomHDWallet.child_xpublic_key(xpublic=XPUBLIC,
                                                    indexes=INDEXES)
print(child_xpublic_key)

Output

"e87ca3acdebdcad9a1d0f2caecf8ce0dbfc73d060807a210c6f2254883479614bcde9cf9e8ee322097d639b33b398c2e419de4092409bf43b3632ddefc4beae9"

program(): It is to get control program.

Parameters

Optional:

String - xpublic, from xpublic key.
String - path, path of index.
String - indexes, collection of index.

Returns

Object:

String - program, control program from xpublic/master key.

Example

from btmhdw import INDEXES, PATH

# Getting contract Program from xpublic and path or indexes
print(BytomHDWallet().program(xpublic=XPUBLIC, path="m/44/153/2/0/8"))
print(BytomHDWallet().program(xpublic=XPUBLIC, path=PATH))
print(BytomHDWallet().program(xpublic=XPUBLIC, indexes=INDEXES))
print(BytomHDWallet().program(xpublic=XPUBLIC, indexes=['2c000000', '99000000', '01000000', '01000000', '01000000']))
print(BytomHDWallet().program(public=PUBLIC))

Output

"00140afb404c13a122306ee86f5ff9b177334d8e23b7"
"0014052620b86a6d5e07311d5019dffa3864ccc8a6bd"
"00140afb404c13a122306ee86f5ff9b177334d8e23b7"
"0014052620b86a6d5e07311d5019dffa3864ccc8a6bd"
"001478c3aa31753389fcde04d33d0779bdc2840f0ad4"

address(): It is to get address.

Parameters

Optional:

String - program, from control program.
String - network, mainnet(bm)/testnet(tm)/solonet(sm) by default sm.

Returns

Object:

String - address, address from control program/master key.

Example

XPUBLIC = "3c6664244d2d57168d173c4691dbf8741a67d972b2d3e1b0067eb825e2005d20c5eebd1c26ccad4de5142d7c339bf62cc1fb79a8b3e42a708cd521368dbc9286"

program = BytomHDWallet().program(xpublic=XPUBLIC, path="m/44/153/2/0/8")
print(bytomHDWallet.address(program=program,
                            network='mainnet'))  # or network bm
print(bytomHDWallet.address(program=program,
                            network='testnet'))  # or network tm
print(bytomHDWallet.address(program=program,
                            network='solonet'))  # or network sm

Output

"bm1qpta5qnqn5y3rqmhgda0lnvthxdxcugahcpaum5"
"tm1qpta5qnqn5y3rqmhgda0lnvthxdxcugahuhucm9"
"sm1qpta5qnqn5y3rqmhgda0lnvthxdxcugahesham6"

Extra Functions

sing(): Singing message.

Parameters

Object:

String - message, message to sing.
String - xprivate, xprivate key.

Returns

Object:

String - signature, signed message.

Example

from btmhdw import sign

MESSAGE = "27c42b40a7a35a6d489fb2e41bde15bdb4b4c276045bd0628525b88c2abbc4c0"
XPRIVATE = "302a25c7c0a68a83fa043f594a2db8b44bc871fced553a8a33144b31bc7fb84887c9e75915bb6ba3fd0b9f94a60b7a5897ab9db6a48f888c2559132dba9152b0"

signature = sign(message=MESSAGE, xprivate=XPRIVATE)

print(signature)

Output

"a39045f6c8b87b3adce39057e448b37c2300bb3dfce0d8b6034a28bbcccfa4353fc23cb158a310990205fed302bbdfa64255b49f7b1eb2fb502756f164922309"

verify(): Verifying signed message.

Parameters

Object:

String - message, message to sing.
String - signature, signed message.
String - xpublic, xpublic key.

Returns

Object:

Boolean - bool, true or false.

Example

from btmhdw import verify

MESSAGE = "27c42b40a7a35a6d489fb2e41bde15bdb4b4c276045bd0628525b88c2abbc4c0"
SIGNATURE = "a39045f6c8b87b3adce39057e448b37c2300bb3dfce0d8b6034a28bbcccfa4353fc23cb158a310990205fed302bbdfa64255b49f7b1eb2fb502756f164922309"
XPUBLIC = "9407d490e9dbc7762c924122368e6c5743d5829ff2a1e2eb4b219a08e080499687c9e75915bb6ba3fd0b9f94a60b7a5897ab9db6a48f888c2559132dba9152b0"

verify_signature = verify(message=MESSAGE, signature=SIGNATURE, xpublic=XPUBLIC)

print(verify_signature)

Output

True

Metadata

Release files for btmhdw 2.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for btmhdw 2.2.2
File	Size	Uploaded
btmhdw-2.2.2.tar.gz	27.7 kB	Mar 25, 2020	Details

Built distribution (wheel)

Table of built distributions (wheels) for btmhdw 2.2.2
File	Interpreter	ABI	Platform	Reset
btmhdw-2.2.2-py3-none-any.whl 21.4 kB Mar 25, 2020	Python 3	none	any	Details

Total release size: 49.1 kB

Release files / btmhdw-2.2.2.tar.gz

Download URL	btmhdw-2.2.2.tar.gz
Size	27.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`841665a12295f19d0ae7039d3443d79de2b7533271167f537c872545eef8ffc3`
BLAKE2b-256 checksum How to use checksums	`23a12528df721c2ac9d742bb4a31bd38de8256f5c38da93c8ae44f48afe4644a`
Upload date	Mar 25, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.1`

Release files / btmhdw-2.2.2-py3-none-any.whl

Download URL	btmhdw-2.2.2-py3-none-any.whl
Size	21.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`d4fb3ae4a25f21c318ad3daafe57677f0e2e8144606f4736d3f9230969bf8d3b`
BLAKE2b-256 checksum How to use checksums	`1a1d7a388721d1eb5bf55013ae82d5ac067ae62edd4013969ab0e158aee8c8d3`
Upload date	Mar 25, 2020
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.1`