README.md

taiko-client

Taiko protocol's client software implementation in Go. Learn more about Taiko nodes with the docs.

Path	Description
`bindings/`	Go contract bindings for Taiko smart contracts, and few related utility functions
`cmd/`	Main executable for this project
`docs/`	Documentation
`driver/`	Driver sub-command
`integration_test/`	Scripts to do the integration testing of all client software
`metrics/`	Metrics related
`pkg/`	Library code which used by all sub-commands
`proposer/`	Proposer sub-command
`prover/`	Prover sub-command
`scripts/`	Helpful scripts
`testutils/`	Test utils
`version/`	Version information

Building the taiko-client binary requires a Go compiler. Once installed, run:

make build

Review all available sub-commands:

bin/taiko-client --help

Review each sub-command's command line flags:

bin/taiko-client <sub-command> --help

Ensure you have Docker running, and pnpm installed.

Then, run the integration tests:

make test