rosetta-kaia provides an implementation of the Rosetta API for Kaia in Golang, based off the rosetta-ethereum reference implementation provided by Coinbase. If you haven't heard of the Rosetta API, you can find more information here.
The project started with a fork of 23561f903bc93d4fa97bebc1fbbe4c7e5b374e5e commit, a commit on February 25, 2022.
- Comprehensive tracking of all ETH balance changes
- Stateless, offline, curve-based transaction construction (with address checksum validation)
- Atomic balance lookups using go-ethereum's GraphQL Endpoint
- Idempotent access to all transaction traces and receipts
rosetta-kaia has been tested on an AWS c5.2xlarge instance.
This instance type has 8 vCPU and 16 GB of RAM. If you use a computer with less than 16 GB of RAM,
it is possible that rosetta-kaia will exit with an OOM error.
To increase the load rosetta-kaia can handle, it is recommended to tune your OS
settings to allow for more connections. On a linux-based OS, you can run the following
commands (source):
sysctl -w net.ipv4.tcp_tw_reuse=1
sysctl -w net.core.rmem_max=16777216
sysctl -w net.core.wmem_max=16777216
sysctl -w net.ipv4.tcp_max_syn_backlog=10000
sysctl -w net.core.somaxconn=10000
sysctl -p (when done)
We have not tested rosetta-kaia with net.ipv4.tcp_tw_recycle and do not recommend
enabling it.
You should also modify your open file settings to 100000. This can be done on a linux-based OS
with the command: ulimit -n 100000.
For Kaia Node, you should operate an EN(Endpoint Node) with archive mode.
And also you can see the system requirements for Endpoint Node in here.
To serve rosetta-kaia API, EN should enable rpc api like RPC_ENABLE=1 and serve klay, debug, txpool, governance and admin(admin rpc api is optional) rpc apis.
# rpc options setting
RPC_ENABLE=1 # if this is set, the following options will be used
RPC_API="admin,debug,klay,txpool,governance"
RPC_CONCURRENCYLIMIT=48000
RPC_READ_TIMEOUT=48000
RPC_WRITE_TIMEOUT=48000
RPC_IDLE_TIMEOUT=48000
RPC_EXECUTION_TIMEOUT=48000
# Raw options e.g) "--txpool.nolocals"
ADDITIONAL="--gcmode archive"
To run EN in archive mode, you can append the --gcmode archive flag to ADDITIONAL.
As specified in the Rosetta API Principles,
all Rosetta implementations must be deployable via Docker and support running via either an
online or offline mode.
YOU MUST INSTALL DOCKER FOR THE FOLLOWING INSTRUCTIONS TO WORK. YOU CAN DOWNLOAD DOCKER HERE.
Running the following commands will create a Docker image called rosetta-kaia:latest.
To download the pre-built Docker image from the latest release, run:
curl -sSfL https://raw.githubusercontent.com/klaytn/rosetta-klaytn/master/install.sh | sh -s
Do not try to install rosetta-kaia using GitHub Packages!
After cloning this repository, run:
make build-local
Running the following commands will start a Docker container in
detached mode with
a data directory at <working directory>/kaia-data and the Rosetta API accessible
at port 8080.
MODE(required) - Determines if Rosetta can make outbound connections. Options:ONLINEorOFFLINE.NETWORK(required) - Kaia network to launch and/or communicate with. Options:MAINNETorTESTNET.PORT(required) - Which port to use for Rosetta.KEN(optional) - Point to a remotekaiaEN node instead of initializing oneSKIP_ADMIN(optional, default:FALSE) - Instruct Rosetta to not use thekenadminRPC calls. This is typically disabled by hosted blockchain node services.
docker run -d --rm --ulimit "nofile=100000:100000" -v "$(pwd)/kaia-data:/data" -e "MODE=ONLINE" -e "NETWORK=MAINNET" -e "PORT=8080" -p 8080:8080 -p 30303:30303 rosetta-kaia:latest
If you cloned the repository, you can run make run-mainnet-online.
docker run -d --rm --ulimit "nofile=100000:100000" -e "MODE=ONLINE" -e "NETWORK=MAINNET" -e "PORT=8080" -e "KEN=<NODE URL>" -p 8080:8080 -p 30303:30303 rosetta-kaia:latest
If you cloned the repository, you can run make run-mainnet-remote ken=<NODE URL>.
docker run -d --rm -e "MODE=OFFLINE" -e "NETWORK=MAINNET" -e "PORT=8081" -p 8081:8081 rosetta-kaia:latest
If you cloned the repository, you can run make run-mainnet-offline.
docker run -d --rm --ulimit "nofile=100000:100000" -v "$(pwd)/kaia-data:/data" -e "MODE=ONLINE" -e "NETWORK=TESTNET" -e "PORT=8080" -p 8080:8080 -p 30303:30303 rosetta-kaia:latest
If you cloned the repository, you can run make run-testnet-online.
docker run -d --rm --ulimit "nofile=100000:100000" -e "MODE=ONLINE" -e "NETWORK=TESTNET" -e "PORT=8080" -e "KEN=<NODE URL>" -p 8080:8080 -p 30303:30303 rosetta-kaia:latest
If you cloned the repository, you can run make run-testnet-remote ken=<NODE URL>.
docker run -d --rm -e "MODE=OFFLINE" -e "NETWORK=TESTNET" -e "PORT=8081" -p 8081:8081 rosetta-kaia:latest
If you cloned the repository, you can run make run-testnet-offline.
If you are using MacOS M1, you might need to add --platform linux/amd64 flag like below when you run docker container.
docker run --platform linux/amd64 -d --rm -e "MODE=OFFLINE" -e "NETWORK=TESTNET" -e "PORT=8081" -p 8081:8081 rosetta-kaia:latestTo validate rosetta-kaia, install rosetta-cli
and run one of the following commands:
rosetta-cli check:data --configuration-file rosetta-cli-conf/testnet/config.json- This command validates that the Data API implementation is correct using the Kaiatestnetnode. It also ensures that the implementation does not miss any balance-changing operations.rosetta-cli check:construction --configuration-file rosetta-cli-conf/testnet/config.json- This command validates the Construction API implementation. It also verifies transaction construction, signing, and submissions to thetestnetnetwork.rosetta-cli check:data --configuration-file rosetta-cli-conf/mainnet/config.json- This command validates that the Data API implementation is correct using the Kaiamainnetnode. It also ensures that the implementation does not miss any balance-changing operations.
Interested in helping fix issues in this repository? You can find to-dos in the Issues section. Be sure to reach out on our community before you tackle anything on this list.
make depsto install dependenciesmake testto run testsmake lintto lint the source codemake salusto check for security concernsmake build-localto build a Docker image from the local contextmake coverage-localto generate a coverage report
We need to execute client_test.go by generating the API result and creating the expected result as json data.
You can create test data by sending a transaction to the network.
Alternatively, it is okay to use data that already exists in the network.
In this step, the return data of the API called when the client function is executed is made into a json file, and when the actual test is performed, the data is returned using a mock.
Create a block_{block number}.json file using the value of the "result" field of the API result below.
curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"klay_getBlockByNumber","params":["0x{block number}", true],"id":1}' http://{your en url}:8551 > block.txtCreate a block_receipts_0x{block hash}.json file using the value of the "result" field of the API result below.
curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"klay_getBlockReceipts","params":["0x{block hash}"],"id":1}' http://{your en url}:8551 > receipts.txtCreate a block_trace_0x{block hash}.json file using the value of the "result" field of the API result below.
curl -H "Content-Type: application/json" --data '{"jsonrpc":"2.0","method":"debug_traceBlockByHash","params":["0x{block hash}", {"tracer": "fastCallTracer"}],"id":1}' http://{your en url}:8551 > trace.txtCreate a response object to be returned based on the above result in the block_response_{block number}.json file.
You can refer to block_response_1078.json file.
This project is available open source under the terms of the Apache 2.0 License.
© 2021 Coinbase