README.md

Taiko

A based rollup.

Documentation

End user documentation can be found at docs.taiko.xyz. Protocol specs can be found here.

Each package of the monorepo is well documented and includes a README.

Project structure

taiko-mono/
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── packages
│   ├── branding: Taiko branding materials.
│   ├── 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.
│   ├── supplementary-contracts: Supplementary smart contracts that are not part of the Taiko rollup protocol.
│   ├── taiko-client: Taiko client implementation in Go.
│   ├── nfts: Taiko NFTs.
│   └── taikoon-ui: Taikoon NFT UI.
...

Issues

If you find a bug or have a feature request, please open an issue.

Contributing

Warning

Please refrain from submitting typo/comment-only pull requests with the expectation of receiving TKO airdrops.

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!