{ "info": { "author": "Gully Chen", "author_email": "deepgully@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "License :: OSI Approved :: MIT License", "Programming Language :: Python" ], "description": "# Zilliqa-Python-Library API\n\n**pyzil** is the Python3 implement of Zilliqa BlockChain API. https://apidocs.zilliqa.com\n\n## Features\n\n* Zilliqa low-level APIs\n* Account and Transaction\n* Zilliqa ethash\n* Smart Contract\n\nPython 3.6+ on macOS or Linux.\n\n## Install\n\n```shell\npip install pyzil\n```\nor from source\n```shell\ngit clone https://github.com/deepgully/pyzil\ncd pyzil\npip install -r requirements.txt\npython setup.py install\n```\n\n## Usage\n\n\n### Import pyzil\n```python\nfrom pprint import pprint\n\nfrom pyzil.crypto import zilkey\nfrom pyzil.zilliqa import chain\nfrom pyzil.zilliqa.units import Zil, Qa\nfrom pyzil.account import Account, BatchTransfer\n```\n\n#### Set Active Chain, MainNet or TestNet\n```python\nchain.set_active_chain(chain.MainNet) \n``` \n\n#### ZILs Transaction\n```python\n# load account from wallet address\naccount = Account(address=\"95B27EC211F86748DD985E1424B4058E94AA5814\")\nbalance = account.get_balance()\nprint(\"{}: {}\".format(account, balance))\n\n# load account from private key\n# private key is required to send ZILs\naccount = Account(private_key=\"05C3CF3387F31202CD0798B7AA882327A1BD365331F90954A58C18F61BD08FFC\")\nbalance2 = account.get_balance()\nprint(\"Account balance: {}\".format(balance2))\n\n# to_addr must be bech32 address or 20 bytes checksum address\nto_addr = \"zil1k5xzgp8xn87eshm3ktplqvs9nufav4pmcm52xx\"\n# send ZILs\ntxn_info = account.transfer(to_addr=to_addr, zils=2.718)\npprint(txn_info)\ntxn_id = txn_info[\"TranID\"]\n\n# wait chain confirm, may takes 2-3 minutes on MainNet\ntxn_details = account.wait_txn_confirm(txn_id, timeout=300)\npprint(txn_details)\nif txn_details and txn_details[\"receipt\"][\"success\"]:\n print(\"Txn success: {}\".format(txn_id))\nelse:\n print(\"Txn failed: {}\".format(txn_id))\n``` \n\n#### Send by Qa\n```python\namount = Qa(1234567890)\ntxn_info = account.transfer(to_addr=to_addr, zils=amount)\npprint(txn_info)\ntxn_id = txn_info[\"TranID\"]\n``` \n\n#### Wait for confirm\n```python\namount = Zil(3.14)\ntxn_details = account.transfer(to_addr, zils=amount, \n confirm=True, timeout=300, sleep=20)\nprint(\"Transfer Result:\")\npprint(txn_details)\npprint(account.last_params)\npprint(account.last_txn_info)\npprint(account.last_txn_details)\n\n``` \n\n#### Batch Transfer (Send zils to multi addresses)\n```python\nbatch = [BatchTransfer(to_addr=to_addr, zils=i) for i in range(10)]\npprint(batch)\n\ntxn_info_list = account.transfer_batch(batch)\npprint(txn_info_list)\n\nfor txn_info in txn_info_list:\n if not txn_info:\n print(\"Failed to create txn\")\n continue\n\n txn_details = account.wait_txn_confirm(txn_info[\"TranID\"], timeout=300)\n pprint(txn_details)\n if txn_details and txn_details[\"receipt\"][\"success\"]:\n print(\"Txn success\")\n else:\n print(\"Txn failed\")\n\nbalance2 = account.get_balance()\nprint(\"Account balance: {}\".format(balance2))\n```\n\n#### Send ZILs from nodes to wallet\n```python\nnodes_keys = [\n \"private_key1\",\n \"private_key2\",\n \"private_key3\",\n]\n\nto_address = \"your wallet address\"\nto_account = Account(address=to_address)\nprint(\"Account balance: {}\".format(to_account.get_balance()))\n\nmin_gas = Qa(chain.active_chain.api.GetMinimumGasPrice())\n\ntxn_info_list = []\nfor key in nodes_keys:\n if not key:\n continue\n account = Account(private_key=key)\n # send all zils\n amount = account.get_balance_qa() - min_gas * 2\n if amount <= 0:\n continue\n\n txn_info = account.transfer(to_addr=to_account.bech32_address, zils=amount, gas_price=min_gas)\n pprint(txn_info)\n\n txn_info_list.append(txn_info)\n\nfor txn_info in txn_info_list: \n txn_details = chain.active_chain.wait_txn_confirm(txn_info[\"TranID\"], timeout=300)\n pprint(txn_details)\n if txn_details and txn_details[\"receipt\"][\"success\"]:\n print(\"Txn success\")\n else:\n print(\"Txn failed\")\n\nprint(\"Account balance: {}\".format(to_account.get_balance()))\n\n```\n\n#### load account from mykey.txt\n```python\naccount = Account.from_mykey_txt(\"mykey.txt\")\nprint(account)\n``` \n\n#### load account from keystore.json\n```python\naccount = Account.from_keystore(\"keystore.json\")\nprint(account)\n\n# see more examples in tests/test_account.py\n``` \n\n#### bech32 address\n```python\n# init from bech32 address\naccount1 = Account(address=\"zil1r5verznnwvrzrz6uhveyrlxuhkvccwnju4aehf\")\nprint(\"address: {}\".format(account1.address))\naccount2 = Account(address=\"1d19918a737306218b5cbb3241fcdcbd998c3a72\")\nprint(\"bech32 address: {}\".format(account2.bech32_address))\nassert account1 == account2\n\n# tranfer to bech32 address\naccount = Account.from_mykey_txt(\"mykey.txt\")\ntxn_info = account.transfer(to_addr=\"zil1r5verznnwvrzrz6uhveyrlxuhkvccwnju4aehf\", zils=0.01)\npprint(txn_info)\ntxn_id = txn_info[\"TranID\"]\n\n``` \n\n\n## Zilliqa Low-level APIs\n```python\nfrom pyzil.zilliqa.api import ZilliqaAPI, APIError\n\napi = ZilliqaAPI(\"https://api.zilliqa.com/\")\nprint(api)\n\ninfo = api.GetBlockchainInfo()\npprint(info)\n\nsharding = api.GetShardingStructure()\npprint(sharding)\n\nds_block = api.GetCurrentDSEpoch()\npprint(ds_block)\n\ntx_block = api.GetCurrentMiniEpoch()\npprint(tx_block)\n\n# see more examples in tests/test_lowlevel_api.py\n```\n\n\n## Zilliqa Currencies Units\n```python\nfrom pyzil.zilliqa.units import Zil, Qa\n\nzil = Zil(1000.123)\nprint(repr(zil))\nassert zil == Zil(\"1000.123\")\n\nqa = Qa(1000123000000000)\nprint(repr(qa))\nassert qa == zil\nassert zil == qa\n\nprint(repr(zil + qa))\nprint(repr(zil - 2))\nprint(repr(zil * 2))\nprint(repr(zil / 2.0))\n\nprint(repr(qa - 2))\nprint(repr(qa * 2))\nprint(repr(qa // 2))\n# see more examples in tests/test_units.py\n```\n\n\n## Zilliqa Smart Contract\n```python\nfrom pprint import pprint\nfrom pyzil.zilliqa import chain\nfrom pyzil.account import Account\nfrom pyzil.contract import Contract\n\n\nchain.set_active_chain(chain.TestNet)\n\naccount = Account.from_keystore(\"zxcvbnm,\", \"zilliqa_keystore.json\")\n```\n\n### Get contract from address\n```python\naddress = \"45dca9586598c8af78b191eaa28daf2b0a0b4f43\"\ncontract = Contract.load_from_address(address, load_state=True)\nprint(contract)\nprint(contract.status)\npprint(contract.state)\ncontract.get_state(get_code=True, get_init=True)\npprint(contract.code)\npprint(contract.init)\npprint(contract.state)\n```\n\n### New contract from code\n```python\ncode = open(\"HelloWorld.scilla\").read()\ncontract = Contract.new_from_code(code)\nprint(contract)\n\n# set account before deploy\ncontract.account = account\n\ncontract.deploy(timeout=300, sleep=10)\nassert contract.status == Contract.Status.Deployed\n```\n\n### Get contracts\n```python\nowner_addr = account.address\ncontracts = Contract.get_contracts(owner_addr)\npprint(contracts)\ncontracts2 = account.get_contracts()\npprint(contracts2)\n\nassert contracts == contracts2\n```\n\n### Call contract\n```python\ncontract_addr = \"45dca9586598c8af78b191eaa28daf2b0a0b4f43\"\ncontract = Contract.load_from_address(contract_addr)\n\ncontract.account = account\n\nresp = contract.call(method=\"getHello\", params=[])\npprint(resp)\npprint(contract.last_receipt)\n\nresp = contract.call(method=\"setHello\", params=[Contract.value_dict(\"msg\", \"String\", \"hi contract.\")])\npprint(resp)\npprint(contract.last_receipt)\n\nresp = contract.call(method=\"getHello\", params=[])\npprint(resp)\npprint(contract.last_receipt)\n\n# see more examples in test_contract.py\n```\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": "http://github.com/deepgully/pyzil", "keywords": "zilliqa api", "license": "MIT License", "maintainer": "", "maintainer_email": "", "name": "pyzil", "package_url": "https://pypi.org/project/pyzil/", "platform": "", "project_url": "https://pypi.org/project/pyzil/", "project_urls": { "Homepage": "http://github.com/deepgully/pyzil" }, "release_url": "https://pypi.org/project/pyzil/0.5.25/", "requires_dist": [ "requests", "jsonrpcclient", "jsonrpcclient[requests]", "protobuf", "fastecdsa", "pyethash", "pycryptodome", "eth-hash[pycryptodome]" ], "requires_python": "", "summary": "Zilliqa Python API", "version": "0.5.25" }, "last_serial": 5316431, "releases": { "0.3.31": [ { "comment_text": "", "digests": { "md5": "bcdb977c29a226ca1d9f361850ce8cce", "sha256": "eff0397ea7e334d2d4ee971cfe21b851f2365321a4c388b6139df1703207f3b5" }, "downloads": -1, "filename": "pyzil-0.3.31-py3-none-any.whl", "has_sig": false, "md5_digest": "bcdb977c29a226ca1d9f361850ce8cce", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 823950, "upload_time": "2019-03-31T14:15:59", "url": "https://files.pythonhosted.org/packages/1d/ca/1323257bbea86a115f823cc74274db01bdbd89a4c697511dfaec4915fe7b/pyzil-0.3.31-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "26b5b711f39412867779d381ddd7e818", "sha256": "5b8fb3a97dc88d7e1a69c98d3aa132989106992f7c193333b668442e7488a415" }, "downloads": -1, "filename": "pyzil-0.3.31.tar.gz", "has_sig": false, "md5_digest": "26b5b711f39412867779d381ddd7e818", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 16236, "upload_time": "2019-03-31T13:45:12", "url": "https://files.pythonhosted.org/packages/16/6a/57cbcffc7bad8c72a47f73c2ba63286b296a8c3a3d6879aff74a8b32436d/pyzil-0.3.31.tar.gz" } ], "0.4.4": [ { "comment_text": "", "digests": { "md5": "d5951b394cf4ca3f958db9e50bf25aed", "sha256": "1d48678ede255892dccd9baa7395d796ea22cc66e1dda121719927a3fc4a025a" }, "downloads": -1, "filename": "pyzil-0.4.4-py3-none-any.whl", "has_sig": false, "md5_digest": "d5951b394cf4ca3f958db9e50bf25aed", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 826011, "upload_time": "2019-04-04T10:09:06", "url": "https://files.pythonhosted.org/packages/b7/47/19633d99220f7635ab32419decdaa43817551cd8cdb4147ba780cc901639/pyzil-0.4.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "60c26ddcd8ca0187e1ae6de576c66e5d", "sha256": "be9b1faeb8e048ef1266a8597c86026ce58cb0f10714011d0d0fb7f65c92512e" }, "downloads": -1, "filename": "pyzil-0.4.4.tar.gz", "has_sig": false, "md5_digest": "60c26ddcd8ca0187e1ae6de576c66e5d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20004, "upload_time": "2019-04-04T10:09:08", "url": "https://files.pythonhosted.org/packages/02/78/7395dc65f43ebdc204355bc88dede98a7acc1a114524b92828e36f9a43bc/pyzil-0.4.4.tar.gz" } ], "0.4.9": [ { "comment_text": "", "digests": { "md5": "3b5955da0c8b98620a38805030703bde", "sha256": "8d081f72bfdab1a88f75875e25bdc9ce32ed97c30bbc76329b2fe4c30c950385" }, "downloads": -1, "filename": "pyzil-0.4.9-py3-none-any.whl", "has_sig": false, "md5_digest": "3b5955da0c8b98620a38805030703bde", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 829951, "upload_time": "2019-04-09T11:27:23", "url": "https://files.pythonhosted.org/packages/58/38/94a18f8aefd059f613be4c62cadab1f1fd54c67eae1ae111f5dcd7a0a2d4/pyzil-0.4.9-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d1879e9ed2c634ac79c9803bb3c73ca3", "sha256": "317a2cf681aa5d6ef7738e9081a1ba425b15b25e2913eb2ddb57aa60de6af51c" }, "downloads": -1, "filename": "pyzil-0.4.9.tar.gz", "has_sig": false, "md5_digest": "d1879e9ed2c634ac79c9803bb3c73ca3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22465, "upload_time": "2019-04-09T11:27:24", "url": "https://files.pythonhosted.org/packages/92/b2/304911e2baac834d85e79cb40ae75b0bff544dfd6c93c774aa3268d9dbd4/pyzil-0.4.9.tar.gz" } ], "0.5.23": [ { "comment_text": "", "digests": { "md5": "d69143769d600d26da513346514211c5", "sha256": "daf5d88559078ac769da30169c770cd6094441308aff465b7a93a67211ccad6a" }, "downloads": -1, "filename": "pyzil-0.5.23-py3-none-any.whl", "has_sig": false, "md5_digest": "d69143769d600d26da513346514211c5", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 834035, "upload_time": "2019-05-23T02:48:11", "url": "https://files.pythonhosted.org/packages/85/8e/8f2e62d4aa3624df2136822dec5444a416f9e1d0553b52103aeb88927a0a/pyzil-0.5.23-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b68b48c0dfef95b3e8490d41ad74f024", "sha256": "616cebd7b70babb3b4f8d89e3ffc633d70b196c96cdb83c7a1354dc602326a71" }, "downloads": -1, "filename": "pyzil-0.5.23.tar.gz", "has_sig": false, "md5_digest": "b68b48c0dfef95b3e8490d41ad74f024", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 25050, "upload_time": "2019-05-23T02:48:13", "url": "https://files.pythonhosted.org/packages/cd/32/4e7a68e5afecd397dcf975ffd1b63e890701c67ded0270c94e25db333f64/pyzil-0.5.23.tar.gz" } ], "0.5.25": [ { "comment_text": "", "digests": { "md5": "ebbca83a066bc1c51a9fda43c8cfd28b", "sha256": "4622bd330634baab8217d033008fcd047dc1df1fa93568b24ee39df1478b9a63" }, "downloads": -1, "filename": "pyzil-0.5.25-py3-none-any.whl", "has_sig": false, "md5_digest": "ebbca83a066bc1c51a9fda43c8cfd28b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 845456, "upload_time": "2019-05-25T13:16:17", "url": "https://files.pythonhosted.org/packages/f0/98/075955ab2e976622587a6419c5bc6eda849b02128de621cd25d54505fe42/pyzil-0.5.25-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "32ee4cfda53257a1586f3dd09aa6883a", "sha256": "05b1b4483824ad8e13c2b57b3bacb990fd367b3ef08a49ded8114c1f36bb178c" }, "downloads": -1, "filename": "pyzil-0.5.25.tar.gz", "has_sig": false, "md5_digest": "32ee4cfda53257a1586f3dd09aa6883a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26271, "upload_time": "2019-05-25T13:16:20", "url": "https://files.pythonhosted.org/packages/d6/37/be32c2b093349302da321adc16a08a3685bd7d9941ebcd3f86752ff901c0/pyzil-0.5.25.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ebbca83a066bc1c51a9fda43c8cfd28b", "sha256": "4622bd330634baab8217d033008fcd047dc1df1fa93568b24ee39df1478b9a63" }, "downloads": -1, "filename": "pyzil-0.5.25-py3-none-any.whl", "has_sig": false, "md5_digest": "ebbca83a066bc1c51a9fda43c8cfd28b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 845456, "upload_time": "2019-05-25T13:16:17", "url": "https://files.pythonhosted.org/packages/f0/98/075955ab2e976622587a6419c5bc6eda849b02128de621cd25d54505fe42/pyzil-0.5.25-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "32ee4cfda53257a1586f3dd09aa6883a", "sha256": "05b1b4483824ad8e13c2b57b3bacb990fd367b3ef08a49ded8114c1f36bb178c" }, "downloads": -1, "filename": "pyzil-0.5.25.tar.gz", "has_sig": false, "md5_digest": "32ee4cfda53257a1586f3dd09aa6883a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26271, "upload_time": "2019-05-25T13:16:20", "url": "https://files.pythonhosted.org/packages/d6/37/be32c2b093349302da321adc16a08a3685bd7d9941ebcd3f86752ff901c0/pyzil-0.5.25.tar.gz" } ] }