Kaya - Zilliqa's RPC client for testing and development
Kaya is Zilliqa's RPC server for testing and development. It is personal blockchain which makes developing application easier and faster. Kaya emulates the Zilliqa's blockchain behavior, and follows the expected server behavior as seen in the
Kaya is under development. See roadmap here.
Currently, Kaya supports the following functions:
Methods that are NOT supported:
In addition, the following features are not supported yet:
- Multi-contract calls
Kaya RPC server is distributed as a Node package via
npm. Ensure that you have Node.js (>= 10.13.0).
npm install -g kaya-cli
Scilla files must be processed using the
scilla-interpreter. The Scilla interpreter executable provides a calling interface that enables users to invoke transitions with specified inputs and obtain outputs.
Using Remote Scilla Interpreter (Default)
By default, Kaya RPC uses the remote scilla interpreter to process
.scilla files. You do not have to change any configurations.
Using Local Scilla Interpreter
You can choose to use your own scilla interpreter locally. To do it, you will have to compile the binaries yourself from the scilla repository and transfer it to the correct directory within Kaya RPC.
- Ensure that you have installed the related dependencies: INSTALL.md
- Then, run
make clean; make
- Copy the
config.jsfile and set the
false. Alternative, use
-r falseat startup.
$ kaya-cli <options>
--data: Relative path where state data will be stored. Creates directory if path does not exists
--fixtures: Load fixed account addresses and keys (fixtures) from a JSON-file
--load: Load data files from a JSON file
--numAccounts: Number of accounts to load at start up. Only used if fixtures file is not defined.
--port: Port number to listen to (Default:
--remote: Option to use remote interpreter or local interpreter. Remote if True
--save: Saves data files to
saved/directory by the end of the session
--verbose: Log all requests and responses to stdout
- Starts server based on predefined wallet files with verbose mode.
node server.js -v -f test/account-fixtures.json
- Load data files from a previous session and save the data at the end of the session
node server.js -v -s --load test/sample-export.json
KayaRPC comes with a few preset configurations for lazy programmers:
npm run debug: Use server with random account keypairs
npm run debug:fixtures: Use server with fixed account keypairs loaded from
npm start: The same as
node server.js- random account keypair generations with no verbosity
Some of the functions in Kaya RPC are covered under automated testing using
jest. However, scilla related transactions are not covered through automated testing. To test the
CreateTransaction functionalities, you will have to test it manually.
test/scripts/, you can use run
node TestBlockchain.js to test the Kaya RPC. The script will make a payment transaction, deployment transaction and transition invocation.
kaya is released under GPLv3. See license here