{ "info": { "author": "Alistair O'Brien", "author_email": "alistair.o'brien@ellesmere.com", "bugtrack_url": null, "classifiers": [], "description": "# BPL CLI\n\n> A simple CLI client for the Blockpool Blockchain\n\nThis is an easy-to-use Python Command Line Interface (CLI) client for interacting with a Blockpool Blockchain. This client provides the majority of the functionality provided by [BPL-desktop](https://github.com/blockpool-io/BPL-desktop)\n\n## Features\n\n### Account\n- [x] Delegate registration\n- [x] Transferring BPL\n- [x] Vote for a delegate\n- [x] Status of account\n- [x] List of transactions (in chronological order)\n- [x] Create a new address and public key from a BIP39 mnemonic\n\n### Message\n- [x] Sign a message\n- [x] Verify a message\n\n### Network\n- [x] Network status\n- [x] Network config new\n- [x] Network config use\n- [x] Showing network config\n- [x] Showing network peers\n\n### Command Entity\n- [x] Constructor\n- [x] Run method\n\n### Exceptions\n- [x] BPLClientNetworkException\n- [x] BPLClientAccountsException\n\n## Installation\n\n```sh\npython -m pip install bpl-client\n```\n\n## Usage\n\n### Help\n\n```sh\nC:\\>bpl-cli -help\nBPL Client\n\nUsage:\n bpl-cli network config setup\n bpl-cli network config show\n bpl-cli network status\n bpl-cli account status
\n bpl-cli account transactions
\n bpl-cli account send \n bpl-cli account vote \n bpl-cli account delegate \n bpl-cli message sign \n bpl-cli message verify \n\nOptions:\n -h --help Show this screen.\n --version Show version.\n\nHelp:\n For help using this client, please see https://github.com/DuneRoot/bpl-cli\n```\n\n### Network config new\n\nTo create a new custom network config the command ``bpl-cli network config new`` must be used. It should be noted that if the network config has not been selected using `network config new` or `network config use` and a different command is used then a ``BPLClientNetworkException`` is raised.\n\n```sh\nC:\\>bpl-cli network config new\nEnter config identifier: testnet_01\nEnter peer address and port: 35.180.64.83:9028\nEnter version: 25\nEnter begin epoch: 2017-03-21 13:00:00\n\nNetwork Config (testnet_01)\n +--------------+------------------------------------------------------------------+\n | Name | Value |\n +--------------+------------------------------------------------------------------+\n | version | 25 |\n | peer address | 35.180.64.83:9028 |\n | begin epoch | 2017-03-21 13:00:00 |\n | nethash | f9b98b78d2012ba8fd75538e3569bbc071ce27f0f93414218bc34bc72bdeb3db |\n +--------------+------------------------------------------------------------------+\n\n ```\n\n### Network config use\n\nTo use or select a default or custom network config the command ``bpl-cli network config use`` must be used. It should be noted that if an invalid config identifier is inputted then a `BPLClientNetworkException` is raised.\n\n```sh\nC:\\>bpl-cli network config use\n\nConfig Identifiers\n +------------+\n | Configs |\n +------------+\n | testnet1 |\n | testnet |\n | mainnet |\n | testnet_01 |\n +------------+\n\nEnter config identifier: mainnet\n\nNetwork Config (mainnet)\n +--------------+------------------------------------------------------------------+\n | Name | Value |\n +--------------+------------------------------------------------------------------+\n | version | 25 |\n | peer address | 13.56.163.57:9030 |\n | begin epoch | 2017-03-21 13:00:00 |\n | nethash | 7bfb2815effb43592ccdd4fd0f657c082a7b318eed12f6396cc174d8578293c3 |\n +--------------+------------------------------------------------------------------+\n```\n\n### Transferring BPL\n\nTo transfer BPL the command ``bpl-cli account send
`` must be used. A prompt for the secret passphrase is then displayed, which masks the input.\n\n```sh\nC:\\>bpl-cli account send 0.1 BFCKaUEkmG8ULYitaharStcdn7ijuDxxpK\nEnter secret passphrase:\nConfirm (y/n): y\nSending 0.1 BPL to BFCKaUEkmG8ULYitaharStcdn7ijuDxxpK.\nTransaction sent successfully with id 295fb4d1c128f6319a2ebfe688dd762c6d15fc1e40ccde92ca531cce25d4ae74.\n```\n\n### Listing transactions\n\nTo list the transactions of an address, the command ``bpl-cli account transactions
`` must be used.\n\n```sh\nC:\\>bpl-cli account transactions B8a5sk4SBzWTxURX3sw5iMy7py26QgA4NY\n\nTransactions (Address: B8a5sk4SBzWTxURX3sw5iMy7py26QgA4NY)\n +------------------------------------------------------------------+---------------------+------------------------------------+------------------------------------+--------------+------------+---------------+\n | Transaction ID | Timestamp | Sender | Recipient | Amount | Fee | Confirmations |\n +------------------------------------------------------------------+---------------------+------------------------------------+------------------------------------+--------------+------------+---------------+\n | 295fb4d1c128f6319a2ebfe688dd762c6d15fc1e40ccde92ca531cce25d4ae74 | 2018-08-08 09:08:54 | B8a5sk4SBzWTxURX3sw5iMy7py26QgA4NY | BFCKaUEkmG8ULYitaharStcdn7ijuDxxpK | 10000000 | 10000000 | 30 |\n | bfcdc447bacb31cc7b53794bdbafb88d26e0fb03cee1363aba733cd1a2a1b4c7 | 2018-08-07 15:49:22 | B8a5sk4SBzWTxURX3sw5iMy7py26QgA4NY | BFCKaUEkmG8ULYitaharStcdn7ijuDxxpK | 10000000 | 10000000 | 4002 |\n | 73e6d46a070825bbaeb69a7a522446b5f46f563cc1da0f180dfde8ad17e96d96 | 2018-08-07 15:42:47 | B8a5sk4SBzWTxURX3sw5iMy7py26QgA4NY | BFCKaUEkmG8ULYitaharStcdn7ijuDxxpK | 1000000 | 10000000 | 4023 |\n | 4942794d20170637c5c9853bce7ce488bfc56bc2697745bb19ccba81ad224e2a | 2018-08-07 15:39:54 | B8a5sk4SBzWTxURX3sw5iMy7py26QgA4NY | B8a5sk4SBzWTxURX3sw5iMy7py26QgA4NY | 1000000 | 10000000 | 4038 |\n | a52cf29d2d2825ff5a6d7fb6bc4d7d07e0e395908a9d840207d65466b2068d3c | 2018-08-07 12:46:58 | B8a5sk4SBzWTxURX3sw5iMy7py26QgA4NY | N/A | 0 | 1000000000 | 4695 |\n | 5530522fc3371f6c3527d138f0eb48a8fe6cf50329440fcfe54991d05e4ebe59 | 2018-08-07 12:21:26 | B8a5sk4SBzWTxURX3sw5iMy7py26QgA4NY | B8a5sk4SBzWTxURX3sw5iMy7py26QgA4NY | 0 | 100000000 | 4801 |\n | 4fdea05eb8c17f00e6f1db0b0b0869e1b7ea428a61760c157f789f6e497c8c05 | 2018-08-07 10:05:33 | B8a5sk4SBzWTxURX3sw5iMy7py26QgA4NY | BFCKaUEkmG8ULYitaharStcdn7ijuDxxpK | 100 | 10000000 | 5301 |\n | ee3270bacf2ada607915b38154618c78174698afcf02680d5f37734bf18bc9e7 | 2018-08-07 10:04:04 | B8a5sk4SBzWTxURX3sw5iMy7py26QgA4NY | BFCKaUEkmG8ULYitaharStcdn7ijuDxxpK | 100 | 10000000 | 5301 |\n | a754cefa329ba2c1966f6346bc69300e7ae55e4c2b8c331765319b19e215e0c2 | 2018-08-06 15:19:36 | BFCKaUEkmG8ULYitaharStcdn7ijuDxxpK | B8a5sk4SBzWTxURX3sw5iMy7py26QgA4NY | 500000000000 | 10000000 | 9641 |\n +------------------------------------------------------------------+---------------------+------------------------------------+------------------------------------+--------------+------------+---------------+\n```\n\n## Security or Errors\n\nIf you discover a security vulnerability or error within this package, please email [me](mailto:alistair.o'brien@ellesmere.com) or message me on the [BPL discord](https://discordapp.com/invite/67HxSKq).\n\n\n## Credits\n\n- [Alistair O'Brien](https://github.com/johnyob)\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/DuneRoot/bpl-cli", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "bpl-client", "package_url": "https://pypi.org/project/bpl-client/", "platform": "", "project_url": "https://pypi.org/project/bpl-client/", "project_urls": { "Homepage": "https://github.com/DuneRoot/bpl-cli" }, "release_url": "https://pypi.org/project/bpl-client/0.1.1/", "requires_dist": [ "docopt", "bpl-lib (>=0.1.0)", "bpl-api (>=0.1.0)", "ascii-table (>=0.1.0)", "mnemonic" ], "requires_python": "", "summary": "A CLI Client for the Blockpool Blockchain.", "version": "0.1.1" }, "last_serial": 4187792, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "953f74f3deadf1840321f6faf1644ce6", "sha256": "36a2e7907b4fd4547684886da59f782887fdcdf3d0c0bf3cb26455d91e979880" }, "downloads": -1, "filename": "bpl_client-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "953f74f3deadf1840321f6faf1644ce6", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 21742, "upload_time": "2018-08-14T10:37:40", "url": "https://files.pythonhosted.org/packages/53/59/42f7d94262fcf3cd383c1a3f97bf82d138bc44662eac2b2c2d71b4071e09/bpl_client-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c26f331fd008a13550a16707eef54cd7", "sha256": "56bd8545e1c795567c1e6fb6bbb35e7f08b1babfeaa6ee699dde9b9448c37ec0" }, "downloads": -1, "filename": "bpl-client-0.1.0.tar.gz", "has_sig": false, "md5_digest": "c26f331fd008a13550a16707eef54cd7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11669, "upload_time": "2018-08-14T10:37:42", "url": "https://files.pythonhosted.org/packages/62/9e/c064d3d3288116c04a2b80cb65c066212505f36f4121f119743898fd64ae/bpl-client-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "77a0abf3e936047df172d1ed0299cf19", "sha256": "618f8ddec485930c7b8be9b6acfd64b9a22281ddc1607d5f5092973929996ea3" }, "downloads": -1, "filename": "bpl_client-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "77a0abf3e936047df172d1ed0299cf19", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 22063, "upload_time": "2018-08-20T09:43:59", "url": "https://files.pythonhosted.org/packages/81/bf/8c1a864c4765667b848ef6a8ac55e7590d3f40098d0ac5cbeb339089826d/bpl_client-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "254f147796d9408a0b14f754f69e7558", "sha256": "4b0b2c71edadfc90eb2f2544c2d72013a530da83076c86b183ce789e71d3050a" }, "downloads": -1, "filename": "bpl-client-0.1.1.tar.gz", "has_sig": false, "md5_digest": "254f147796d9408a0b14f754f69e7558", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11726, "upload_time": "2018-08-20T09:44:01", "url": "https://files.pythonhosted.org/packages/f2/80/a3ad9c8446051a6324cde22c08e549d119a4d1893c9be78f9ccfbc8a4c1b/bpl-client-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "77a0abf3e936047df172d1ed0299cf19", "sha256": "618f8ddec485930c7b8be9b6acfd64b9a22281ddc1607d5f5092973929996ea3" }, "downloads": -1, "filename": "bpl_client-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "77a0abf3e936047df172d1ed0299cf19", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 22063, "upload_time": "2018-08-20T09:43:59", "url": "https://files.pythonhosted.org/packages/81/bf/8c1a864c4765667b848ef6a8ac55e7590d3f40098d0ac5cbeb339089826d/bpl_client-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "254f147796d9408a0b14f754f69e7558", "sha256": "4b0b2c71edadfc90eb2f2544c2d72013a530da83076c86b183ce789e71d3050a" }, "downloads": -1, "filename": "bpl-client-0.1.1.tar.gz", "has_sig": false, "md5_digest": "254f147796d9408a0b14f754f69e7558", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11726, "upload_time": "2018-08-20T09:44:01", "url": "https://files.pythonhosted.org/packages/f2/80/a3ad9c8446051a6324cde22c08e549d119a4d1893c9be78f9ccfbc8a4c1b/bpl-client-0.1.1.tar.gz" } ] }