px-services


Namepx-services JSON
Version 0.1.24 PyPI version JSON
download
home_page
SummaryA blockchain Wallet Service APIs
upload_time2023-12-21 16:25:08
maintainer
docs_urlNone
authorPrince Foli
requires_python
licenseMIT
keywords blockchain wallet hdwallet blockcypher
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
```
This library is a service that can create Wallet Master Seed or Keys, create BlockCypher HD wallet and also hold internal wallet reference to it. 
```


#### Get Started
```sh
# open any command-line terminal

# install px-services (from pypi)
pip3 install px-services==0.1.23

# if you have access to the source code then install px-services by running this command
python3 setup.py install  

# run python3 interractive shell
python3 

Python 3.9.10 (main, Jan 15 2022, 11:48:00)
[Clang 13.0.0 (clang-1300.0.29.3)] on darwin
Type "help", "copyright", "credits" or "license" for more information

# import px_services package classes
from px_services.wallet import PxWallet
from px_services.wallet import PxWalletKeyGenerator

# This method `PxWalletKeyGenerator.generate_seed_phrase()` return a turple of 
# `secret_phrase` ( a.k.a `seed phrase` | `recovery phrase` | `backup phrase`)
# `seed` dictionary with these keys `hex`, `bytes`

secret_phrase, seed = PxWalletKeyGenerator.generate_seed_phrase()

# This method `PxWalletKeyGenerator.seedToMasterKey(seed['hex'])` take the seed (in hex format)
# as input and returns a turple of `info` dictionary object and `hdKey` Master key object
# (same object from which `info` dictionary object was constructed).

info, hdKey = PxWalletKeyGenerator.seedToMasterKey(seed['hex'])

# get Master Node or Master Key details from `info` dictionary object

info.get('master_key_info')

# get `account_keys` (account level extended public & private key) from `master_key_info`

info.get('master_key_info').get('account_keys')

# get `zprv` ( account level extended private key) from `account_keys`. This key can be 
# used to derive all account level addresses and it corresponding public & private keys. 
# Please DONOT share this key with any Blockchain Service Provider unless you have too.

info.get('master_key_info').get('account_keys').('zprv')

# get `zpub` ( account level extended public key) from `account_keys`. This key can be used 
# to derive all account level addresses and its corresponding `public keys` but cannot derive 
# its corresponding `private keys`. This key can be shared with any Blockchain Service 
# Providers since they will only be able to derive addresses and read its balances.

info.get('master_key_info').get('account_keys').('zpub')
```




Change Log
==========

0.1.24 (21/12/2023) 
------------------  
- Minor improvement

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "px-services",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "Blockchain,Wallet,HDWallet,BlockCypher",
    "author": "Prince Foli",
    "author_email": "princefoli@qodehub.com",
    "download_url": "https://files.pythonhosted.org/packages/83/6e/17497c7cba9983a6b41a59bf3fc4a88ac5f444ca151445a67d01891a1dff/px_services-0.1.24.tar.gz",
    "platform": null,
    "description": "\n```\nThis library is a service that can create Wallet Master Seed or Keys, create BlockCypher HD wallet and also hold internal wallet reference to it. \n```\n\n\n#### Get Started\n```sh\n# open any command-line terminal\n\n# install px-services (from pypi)\npip3 install px-services==0.1.23\n\n# if you have access to the source code then install px-services by running this command\npython3 setup.py install  \n\n# run python3 interractive shell\npython3 \n\nPython 3.9.10 (main, Jan 15 2022, 11:48:00)\n[Clang 13.0.0 (clang-1300.0.29.3)] on darwin\nType \"help\", \"copyright\", \"credits\" or \"license\" for more information\n\n# import px_services package classes\nfrom px_services.wallet import PxWallet\nfrom px_services.wallet import PxWalletKeyGenerator\n\n# This method `PxWalletKeyGenerator.generate_seed_phrase()` return a turple of \n# `secret_phrase` ( a.k.a `seed phrase` | `recovery phrase` | `backup phrase`)\n# `seed` dictionary with these keys `hex`, `bytes`\n\nsecret_phrase, seed = PxWalletKeyGenerator.generate_seed_phrase()\n\n# This method `PxWalletKeyGenerator.seedToMasterKey(seed['hex'])` take the seed (in hex format)\n# as input and returns a turple of `info` dictionary object and `hdKey` Master key object\n# (same object from which `info` dictionary object was constructed).\n\ninfo, hdKey = PxWalletKeyGenerator.seedToMasterKey(seed['hex'])\n\n# get Master Node or Master Key details from `info` dictionary object\n\ninfo.get('master_key_info')\n\n# get `account_keys` (account level extended public & private key) from `master_key_info`\n\ninfo.get('master_key_info').get('account_keys')\n\n# get `zprv` ( account level extended private key) from `account_keys`. This key can be \n# used to derive all account level addresses and it corresponding public & private keys. \n# Please DONOT share this key with any Blockchain Service Provider unless you have too.\n\ninfo.get('master_key_info').get('account_keys').('zprv')\n\n# get `zpub` ( account level extended public key) from `account_keys`. This key can be used \n# to derive all account level addresses and its corresponding `public keys` but cannot derive \n# its corresponding `private keys`. This key can be shared with any Blockchain Service \n# Providers since they will only be able to derive addresses and read its balances.\n\ninfo.get('master_key_info').get('account_keys').('zpub')\n```\n\n\n\n\nChange Log\n==========\n\n0.1.24 (21/12/2023) \n------------------  \n- Minor improvement\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A blockchain Wallet Service APIs",
    "version": "0.1.24",
    "project_urls": null,
    "split_keywords": [
        "blockchain",
        "wallet",
        "hdwallet",
        "blockcypher"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "836e17497c7cba9983a6b41a59bf3fc4a88ac5f444ca151445a67d01891a1dff",
                "md5": "2f8a1adb80214927b3640a40d87e2e39",
                "sha256": "b8b95aa1fcde1cf2134f4113c3ce087f45a1c30e04fc1e83ddf59741c89c15c5"
            },
            "downloads": -1,
            "filename": "px_services-0.1.24.tar.gz",
            "has_sig": false,
            "md5_digest": "2f8a1adb80214927b3640a40d87e2e39",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8655,
            "upload_time": "2023-12-21T16:25:08",
            "upload_time_iso_8601": "2023-12-21T16:25:08.653107Z",
            "url": "https://files.pythonhosted.org/packages/83/6e/17497c7cba9983a6b41a59bf3fc4a88ac5f444ca151445a67d01891a1dff/px_services-0.1.24.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-21 16:25:08",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "px-services"
}
        
Elapsed time: 0.23635s