README ¶
Taiko
A based rollup.
Documentation
Get started with Taiko:
- Taiko docs — High-level concepts, guides, resources, and reference pages for getting started.
- Protocol specs — In-depth specifications of the Taiko protocol for deeper understanding.
- Smart contracts — Taiko protocol smart contracts, fully documented with NatSpec.
Packages
[!TIP] Make sure your node is using the latest version tags for taiko-client and taiko-geth. Check out the node releases page!
Package | Description | Release notes |
---|---|---|
bridge-ui | Bridge UI. | |
docs-site | End user documentation site. | |
eventindexer | Event indexer. | |
fork-diff | Fork diff page. | |
guardian-prover-health-check | Guardian prover health check service. | |
guardian-prover-health-check-ui | Guardian prover health check UI. | |
protocol | Taiko protocol smart contracts. | |
relayer | Bridge backend relayer. | |
snaefell-ui | Snaefell UI. | |
supplementary-contracts | Supplementary contracts not part of the Taiko protocol. | |
taiko-client | Taiko client implementation in Go. | |
taikoon-ui | Taikoon UI. | |
ui-lib | UI library. |
Issues
If you find a bug or have a feature request, please open an issue.
Contributing
Check out CONTRIBUTING.md for details on how to contribute. You can also check out our grants cycle at grants.taiko.xyz.
Getting support
Reach out to the community on Discord if you need any help!
Directories ¶
Path | Synopsis |
---|---|
packages
|
|
blobstorage/docs
Package docs Code generated by swaggo/swag.
|
Package docs Code generated by swaggo/swag. |
eventindexer/docs
Package docs Code generated by swaggo/swag.
|
Package docs Code generated by swaggo/swag. |
guardian-prover-health-check/docs
Code generated by swaggo/swag.
|
Code generated by swaggo/swag. |
relayer/docs
Package docs Code generated by swaggo/swag.
|
Package docs Code generated by swaggo/swag. |
Click to show internal directories.
Click to hide internal directories.