{"id":18437845,"url":"https://github.com/zilliqa/pyzil","last_synced_at":"2025-04-14T13:14:31.743Z","repository":{"id":217437319,"uuid":"743588947","full_name":"Zilliqa/pyzil","owner":"Zilliqa","description":"Zilliqa Python SDK","archived":false,"fork":false,"pushed_at":"2024-02-07T02:40:22.000Z","size":833,"stargazers_count":0,"open_issues_count":2,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-16T10:42:59.318Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Zilliqa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-15T14:58:06.000Z","updated_at":"2024-01-15T19:28:46.000Z","dependencies_parsed_at":"2024-02-05T11:26:24.831Z","dependency_job_id":"7840077e-be51-446c-a979-d9e578a58522","html_url":"https://github.com/Zilliqa/pyzil","commit_stats":null,"previous_names":["zilliqa/pyzil"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fpyzil","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fpyzil/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fpyzil/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fpyzil/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Zilliqa","download_url":"https://codeload.github.com/Zilliqa/pyzil/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248886341,"owners_count":21177645,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T06:16:24.076Z","updated_at":"2025-04-14T13:14:31.716Z","avatar_url":"https://github.com/Zilliqa.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 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~~ (No longer supported)\n* Smart Contract\n\nPython 3.6+ on macOS or Linux.\n\n## Install\n\n```shell\npip install -U 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)  \nchain.set_active_chain(chain.TestNet)  \nchain.set_active_chain(chain.IsolatedServer)\n\n# set a seed API server\nSeedNode = chain.BlockChain(\n    \"https://seed-api.zillab.com/\",\n    version=65537, network_id=1)     \nchain.set_active_chain(SeedNode)\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 \u003c= 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\ninit = [\n    Contract.value_dict(\"_scilla_version\", \"Uint32\", \"0\"),\n    Contract.value_dict(\"owner\", \"ByStr20\", account.address0x)\n]\ncontract.deploy(init_params=init, 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# call contract and deposit Zils to contract (default is 0)\nresp = contract.call(method=\"getHello\", params=[], amount=Qa(110))\npprint(resp)\npprint(contract.last_receipt)\n\n# see more examples in test_contract.py\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzilliqa%2Fpyzil","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzilliqa%2Fpyzil","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzilliqa%2Fpyzil/lists"}