PyWallet
===========
.. image:: https://img.shields.io/pypi/pyversions/pywallet.svg?maxAge=60
:target: https://pypi.python.org/pypi/pywallet
:alt: Python version
.. image:: https://img.shields.io/pypi/v/pywallet.svg?maxAge=60
:target: https://pypi.python.org/pypi/pywallet
:alt: PyPi version
.. image:: https://img.shields.io/pypi/status/pywallet.svg?maxAge=60
:target: https://pypi.python.org/pypi/pywallet
:alt: PyPi status
\
**Simple BIP32 (HD) wallet creation for: BTC, BTG, BCH, ETH, LTC, DASH, DOGE**
BIP32 (or HD for "hierarchical deterministic") wallets allow you to create
child wallets which can only generate public keys and don't expose a
private key to an insecure server.
This library simplify the process of creating new wallets for the
BTC, BTG, BCH, ETH, LTC, DASH and DOGE cryptocurrencies.
Most of the code here is forked from:
- Steven Buss's `Bitmerchant <https://github.com/sbuss/bitmerchant>`_ (original)
- BlockIo's `multimerchant-python <https://github.com/BlockIo/multimerchant-python>`_ (fork of Bitmerchant)
- Michail Brynard's `Ethereum BIP44 Python <https://github.com/michailbrynard/ethereum-bip44-python>`_
I simply added support for a few more cryptocurrencies (BCH, BTG, DASH), as well as created
methods to simplify the creation of HD wallets and child wallets.
Enjoy!
--------------
Installation
-------------
Install via PiP:
.. code:: bash
$ sudo pip install pywallet
Example code:
=============
Create HD Wallet
----------------
The following code creates a new Bitcoin HD wallet:
.. code:: python
# create_btc_wallet.py
from pywallet import wallet
# generate 12 word mnemonic seed
seed = wallet.generate_mnemonic()
# create bitcoin wallet
w = wallet.create_wallet(network="BTC", seed=seed, children=1)
print(w)
Output looks like this:
.. code:: bash
$ python create_btc_wallet.py
{
"coin": "BTC",
"seed": "guess tiny intact poet process segment pelican bright assume avocado view lazy",
"address": "1HwPm2tcdakwkTTWU286crWQqTnbEkD7av",
"xprivate_key": "xprv9s21ZrQH143K2Dizn667UCo9oYPdTPSMWq7D5t929aXf1kfnmW79CryavzBxqbWfrYzw8jbyTKvsiuFNwr1JL2qfrUy2Kbwq4WbBPfxYGbg",
"xpublic_key": "xpub661MyMwAqRbcEhoTt7d7qLjtMaE7rrACt42otGYdhv4dtYzwK3RPkfJ4nEjpFQDdT8JjT3VwQ3ZKjJaeuEdpWmyw16sY9SsoY68PoXaJvfU",
"wif": "L1EnVJviG6jR2oovFbfxZoMp1JknTACKLzsTKqDNUwATCWpY1Fp4",
"children": [{
"address": "1E3btRwsoJx2jUcMnATyx7poHhV2tomL8g",
"path": "m/0",
"xpublic_key": "xpub69Fho5TtAbdoXyWzgUV1ZYst9K4bVfoGNLZxQ9u5js4Rb1jEyUjDtoATXbWvAcV8cERCMMnH8wYRVVUsRDSfaMjLqaY3TvD7Am9ALjq5PsG",
"wif": "KysRDiwJNkS9VPzy1UH76DrCDizsWKtEooSzikich792RVzcUaJP"
}]
}
Similarly, you can do the same for an Ethereum wallet:
.. code:: python
# create_eth_wallet.py
from pywallet import wallet
seed = wallet.generate_mnemonic()
w = wallet.create_wallet(network="ETH", seed=seed, children=1)
print(w)
Output looks like this (no WIF for Ethereum):
.. code:: bash
$ python create_eth_wallet.py
{
"coin": "ETH",
"seed": "traffic happy world clog clump cattle great toy game absurd alarm auction",
"address": "0x3b777f60eb04fcb13e6b27e468532e491409722e",
"xprivate_key": "xprv9yTuSjwb95QZznV6epMWpb4Kpc2S8ZRaQuAf5B697YXtQD2tDmmJ5KvwJWVjtbVrdJ1WBKNnuodrpTKGfHfiPSEgrAxUjL5RP1gQwwT3fFx",
"xpublic_key": "xpub6GhhMtkVjoPi5DKtqapKzMzrzdGjo1EPc7Ka6KdeoXYdCrTBH1Hu1wKysm8boWSy8VeTKVJi6gQJ2qJ4YG2ZhvFDcUUgMJrFCJWN1PGtBry",
"wif": "",
"children": [{
"address": "0x87eb82d43fa7316df0a989c0d951a9037ed02f9b",
"path": "m/0",
"xpublic_key": "xpub6LnpVXD73jNuAYXxzQCnEY6wXQspwkiAEkZWoX4BW9Tzx6KbUrMUYAU1Yvw4kebPHSPiEJPo8irHWHSwQR6WuVwUj85xURsugPWeJVH6sau",
"wif": ""
}]
}
\* Valid options for `network` are: BTC, BTG, BCH, LTC, DASH, DOGE
Create Child Wallet
-------------------
You can create child-wallets (BIP32 wallets) from the HD wallet's
**Extended Public Key** to generate new public addresses without
revealing your private key.
Example:
.. code-block:: python
# create_child_wallet.py
from pywallet import wallet
WALLET_PUBKEY = 'YOUR WALLET XPUB'
# generate address for specific user (id = 10)
user_addr = wallet.create_address(network="BTC", xpub=WALLET_PUBKEY, child=10)
# or generate a random address, based on timestamp
rand_addr = wallet.create_address(network="BTC", xpub=WALLET_PUBKEY)
print("User Address\n", user_addr)
print("Random Address\n", rand_addr)
Output looks like this:
.. code:: bash
$ python create_child_wallet.py
User Address
{
"address": "13myudz3WhpBezoZue6cwRUoHrzWs4vCrb",
"path": "m/0/395371597"
}
Random Address
{
"address": "1KpS2wC5J8bDsGShXDHD7qdGvnic1h27Db",
"path": "m/0/394997119"
}
-----
IMPORTANT
=========
I **highly** recommend that you familiarize yourself with the Blockchain technology and
be aware of security issues.
Reading `Mastering Bitcoin <https://github.com/bitcoinbook/bitcoinbook>`_ and going over
Steven Buss's security notes on the `Bitmerchant repository <https://github.com/sbuss/bitmerchant>`_
is a good start.
Enjoy!
Raw data
{
"_id": null,
"home_page": "https://github.com/ranaroussi/pywallet",
"name": "pywallet",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "bitcoin",
"author": "Ran Aroussi",
"author_email": "ran@aroussi.com",
"download_url": "https://files.pythonhosted.org/packages/f4/0c/4f96d7770650c78032a3d5ca14d99ac74b4e64f85eae1bf3ff5172c93f98/pywallet-0.1.0.tar.gz",
"platform": "any",
"description": "\nPyWallet\n===========\n\n.. image:: https://img.shields.io/pypi/pyversions/pywallet.svg?maxAge=60\n :target: https://pypi.python.org/pypi/pywallet\n :alt: Python version\n\n.. image:: https://img.shields.io/pypi/v/pywallet.svg?maxAge=60\n :target: https://pypi.python.org/pypi/pywallet\n :alt: PyPi version\n\n.. image:: https://img.shields.io/pypi/status/pywallet.svg?maxAge=60\n :target: https://pypi.python.org/pypi/pywallet\n :alt: PyPi status\n\n\\\n\n**Simple BIP32 (HD) wallet creation for: BTC, BTG, BCH, ETH, LTC, DASH, DOGE**\n\nBIP32 (or HD for \"hierarchical deterministic\") wallets allow you to create\nchild wallets which can only generate public keys and don't expose a\nprivate key to an insecure server.\n\nThis library simplify the process of creating new wallets for the\nBTC, BTG, BCH, ETH, LTC, DASH and DOGE cryptocurrencies.\n\nMost of the code here is forked from:\n\n- Steven Buss's `Bitmerchant <https://github.com/sbuss/bitmerchant>`_ (original)\n- BlockIo's `multimerchant-python <https://github.com/BlockIo/multimerchant-python>`_ (fork of Bitmerchant)\n- Michail Brynard's `Ethereum BIP44 Python <https://github.com/michailbrynard/ethereum-bip44-python>`_\n\nI simply added support for a few more cryptocurrencies (BCH, BTG, DASH), as well as created\nmethods to simplify the creation of HD wallets and child wallets.\n\nEnjoy!\n\n--------------\n\nInstallation\n-------------\n\nInstall via PiP:\n\n.. code:: bash\n\n $ sudo pip install pywallet\n\n\nExample code:\n=============\n\nCreate HD Wallet\n----------------\n\nThe following code creates a new Bitcoin HD wallet:\n\n.. code:: python\n\n # create_btc_wallet.py\n\n from pywallet import wallet\n\n # generate 12 word mnemonic seed\n seed = wallet.generate_mnemonic()\n\n # create bitcoin wallet\n w = wallet.create_wallet(network=\"BTC\", seed=seed, children=1)\n\n print(w)\n\nOutput looks like this:\n\n.. code:: bash\n\n $ python create_btc_wallet.py\n\n {\n \"coin\": \"BTC\",\n \"seed\": \"guess tiny intact poet process segment pelican bright assume avocado view lazy\",\n \"address\": \"1HwPm2tcdakwkTTWU286crWQqTnbEkD7av\",\n \"xprivate_key\": \"xprv9s21ZrQH143K2Dizn667UCo9oYPdTPSMWq7D5t929aXf1kfnmW79CryavzBxqbWfrYzw8jbyTKvsiuFNwr1JL2qfrUy2Kbwq4WbBPfxYGbg\",\n \"xpublic_key\": \"xpub661MyMwAqRbcEhoTt7d7qLjtMaE7rrACt42otGYdhv4dtYzwK3RPkfJ4nEjpFQDdT8JjT3VwQ3ZKjJaeuEdpWmyw16sY9SsoY68PoXaJvfU\",\n \"wif\": \"L1EnVJviG6jR2oovFbfxZoMp1JknTACKLzsTKqDNUwATCWpY1Fp4\",\n \"children\": [{\n \"address\": \"1E3btRwsoJx2jUcMnATyx7poHhV2tomL8g\",\n \"path\": \"m/0\",\n \"xpublic_key\": \"xpub69Fho5TtAbdoXyWzgUV1ZYst9K4bVfoGNLZxQ9u5js4Rb1jEyUjDtoATXbWvAcV8cERCMMnH8wYRVVUsRDSfaMjLqaY3TvD7Am9ALjq5PsG\",\n \"wif\": \"KysRDiwJNkS9VPzy1UH76DrCDizsWKtEooSzikich792RVzcUaJP\"\n }]\n }\n\nSimilarly, you can do the same for an Ethereum wallet:\n\n.. code:: python\n\n # create_eth_wallet.py\n\n from pywallet import wallet\n\n seed = wallet.generate_mnemonic()\n w = wallet.create_wallet(network=\"ETH\", seed=seed, children=1)\n\n print(w)\n\nOutput looks like this (no WIF for Ethereum):\n\n.. code:: bash\n\n $ python create_eth_wallet.py\n\n {\n \"coin\": \"ETH\",\n \"seed\": \"traffic happy world clog clump cattle great toy game absurd alarm auction\",\n \"address\": \"0x3b777f60eb04fcb13e6b27e468532e491409722e\",\n \"xprivate_key\": \"xprv9yTuSjwb95QZznV6epMWpb4Kpc2S8ZRaQuAf5B697YXtQD2tDmmJ5KvwJWVjtbVrdJ1WBKNnuodrpTKGfHfiPSEgrAxUjL5RP1gQwwT3fFx\",\n \"xpublic_key\": \"xpub6GhhMtkVjoPi5DKtqapKzMzrzdGjo1EPc7Ka6KdeoXYdCrTBH1Hu1wKysm8boWSy8VeTKVJi6gQJ2qJ4YG2ZhvFDcUUgMJrFCJWN1PGtBry\",\n \"wif\": \"\",\n \"children\": [{\n \"address\": \"0x87eb82d43fa7316df0a989c0d951a9037ed02f9b\",\n \"path\": \"m/0\",\n \"xpublic_key\": \"xpub6LnpVXD73jNuAYXxzQCnEY6wXQspwkiAEkZWoX4BW9Tzx6KbUrMUYAU1Yvw4kebPHSPiEJPo8irHWHSwQR6WuVwUj85xURsugPWeJVH6sau\",\n \"wif\": \"\"\n }]\n }\n\n\\* Valid options for `network` are: BTC, BTG, BCH, LTC, DASH, DOGE\n\nCreate Child Wallet\n-------------------\n\nYou can create child-wallets (BIP32 wallets) from the HD wallet's\n**Extended Public Key** to generate new public addresses without\nrevealing your private key.\n\nExample:\n\n.. code-block:: python\n\n # create_child_wallet.py\n\n from pywallet import wallet\n\n WALLET_PUBKEY = 'YOUR WALLET XPUB'\n\n # generate address for specific user (id = 10)\n user_addr = wallet.create_address(network=\"BTC\", xpub=WALLET_PUBKEY, child=10)\n\n # or generate a random address, based on timestamp\n rand_addr = wallet.create_address(network=\"BTC\", xpub=WALLET_PUBKEY)\n\n print(\"User Address\\n\", user_addr)\n print(\"Random Address\\n\", rand_addr)\n\nOutput looks like this:\n\n.. code:: bash\n\n $ python create_child_wallet.py\n\n User Address\n {\n \"address\": \"13myudz3WhpBezoZue6cwRUoHrzWs4vCrb\",\n \"path\": \"m/0/395371597\"\n }\n Random Address\n {\n \"address\": \"1KpS2wC5J8bDsGShXDHD7qdGvnic1h27Db\",\n \"path\": \"m/0/394997119\"\n }\n\n-----\n\nIMPORTANT\n=========\n\nI **highly** recommend that you familiarize yourself with the Blockchain technology and\nbe aware of security issues.\nReading `Mastering Bitcoin <https://github.com/bitcoinbook/bitcoinbook>`_ and going over\nSteven Buss's security notes on the `Bitmerchant repository <https://github.com/sbuss/bitmerchant>`_\nis a good start.\n\nEnjoy!\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Simple BIP32 (HD) wallet creation for BTC, BTG, BCH, LTC, DASH, USDT, QTUM and DOGE",
"version": "0.1.0",
"split_keywords": [
"bitcoin"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f40c4f96d7770650c78032a3d5ca14d99ac74b4e64f85eae1bf3ff5172c93f98",
"md5": "4a671e66242b467befdfc2c4ccab37ec",
"sha256": "5793a294454b40902b62db7448e7393d264fe0784e67fab823d7d3bc502c5f2c"
},
"downloads": -1,
"filename": "pywallet-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "4a671e66242b467befdfc2c4ccab37ec",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 32391,
"upload_time": "2018-09-03T06:09:32",
"upload_time_iso_8601": "2018-09-03T06:09:32.681425Z",
"url": "https://files.pythonhosted.org/packages/f4/0c/4f96d7770650c78032a3d5ca14d99ac74b4e64f85eae1bf3ff5172c93f98/pywallet-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2018-09-03 06:09:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "ranaroussi",
"github_project": "pywallet",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pywallet"
}
JSON
