zilliqa / apidocs

JSON RPC Documentation for Zilliqa

Zilliqa JSON-RPC API documentation. Powered by Slate.

Overview

Zilliqa apidocs contains the documentation of all JSON-RPC methods used to interact with Zilliqa nodes in order to transact and deploy/call contracts. You may currently find support for:

• cURL
• JavaScript via zilliqa-js
• Java via laksa-j
• Ruby via laksa-ruby
• Go via gozilliqa-sdk

Contributing to Zilliqa apidocs

Prerequisites

You're going to need the following to contribute:

• Linux or macOS — Windows may work, but is unsupported.
• Ruby, version 2.3.1 or newer
• Bundler — If Ruby is already installed, but the bundle command doesn't work, just run gem install bundler in a terminal.

Running apidocs locally

1. Fork this repository on GitHub.

2. Clone your forked repository (not our original one) to your hard drive with

   git clone https://github.com/Zilliqa/apidocs.git && cd apidocs

3. Initialize and start Slate. You can either do this locally, or with Vagrant:

   # either run this to run locally
   bundle install
   bundle exec middleman server
   
   # OR run this to run with vagrant
   vagrant up

You can now see the docs at http://localhost:4567.

Contributing guidelines

• Learn more about editing Slate markdown HERE.
• Please adhere to the Code of Conduct when participating in the Zilliqa community.
• Please utilise the PR template when submitting Pull Requests to this repository.

apidocs's Issues

Missing module name in CreateTransaction

PROBLEM:

from pyzil.crypto import zilkey
from pyzil.zilliqa import chain
chain.set_active_chain(chain.MainNet)

my_key = zilkey.ZilKey(private_key="0xe19d05c5452598e24caad4a0d85a49146f7be089515c905ae6a19e8a578a6930")

payload = {
    "to_addr": "4baf5fada8e5db92c3d3242618c5b47133ae003c",
    "amount": "1000000000000",
    "gas_price": "1000000000",
    "gas_limit": 1,
    "code": "",
    "data": "",
    "priority": False,
}

params = active_chain.build_transaction_params(my_key, **payload)
txn_info = active_chain.api.CreateTransaction(params)
print(txn_info)

The active_chain in the third-last and the second last line are missing the module name chain.

SOLUTION:

from pyzil.crypto import zilkey
from pyzil.zilliqa import chain
chain.set_active_chain(chain.MainNet)

my_key = zilkey.ZilKey(private_key="0xe19d05c5452598e24caad4a0d85a49146f7be089515c905ae6a19e8a578a6930")

payload = {
    "to_addr": "4baf5fada8e5db92c3d3242618c5b47133ae003c",
    "amount": "1000000000000",
    "gas_price": "1000000000",
    "gas_limit": 1,
    "code": "",
    "data": "",
    "priority": False,
}

params = chain.active_chain.build_transaction_params(my_key, **payload)
txn_info = chain.active_chain.api.CreateTransaction(params)
print(txn_info)