Merge branch 'main' into relayer_api

.all-contributorsrc

@@ -15,6 +15,16 @@
         "doc"
       ]
     },
+    {
+      "login": "davidtaikocha",
+      "name": "David",
+      "avatar_url": "https://avatars.githubusercontent.com/u/104078303?v=4",
+      "profile": "https://github.com/davidtaikocha",
+      "contributions": [
+        "doc",
+        "code"
+      ]
+    },
     {
       "login": "dantaik",
       "name": "dantaik",
@@ -24,6 +34,66 @@
         "doc",
         "code"
       ]
+    },
+    {
+      "login": "cyberhorsey",
+      "name": "cyberhorsey",
+      "avatar_url": "https://avatars.githubusercontent.com/u/113397187?v=4",
+      "profile": "https://github.com/cyberhorsey",
+      "contributions": [
+        "doc",
+        "code"
+      ]
+    },
+    {
+      "login": "RogerLamTd",
+      "name": "RogerLamTd",
+      "avatar_url": "https://avatars.githubusercontent.com/u/50648015?v=4",
+      "profile": "https://github.com/RogerLamTd",
+      "contributions": [
+        "doc",
+        "code"
+      ]
+    },
+    {
+      "login": "alexshliu",
+      "name": "alexshliu",
+      "avatar_url": "https://avatars.githubusercontent.com/u/104080237?v=4",
+      "profile": "https://github.com/alexshliu",
+      "contributions": [
+        "doc",
+        "code"
+      ]
+    },
+    {
+      "login": "kirataik",
+      "name": "kirataik",
+      "avatar_url": "https://avatars.githubusercontent.com/u/104244966?v=4",
+      "profile": "https://github.com/kirataik",
+      "contributions": [
+        "doc",
+        "code"
+      ]
+    },
+    {
+      "login": "mfinestone",
+      "name": "mfinestone",
+      "avatar_url": "https://avatars.githubusercontent.com/u/36642873?v=4",
+      "profile": "https://github.com/mfinestone",
+      "contributions": [
+        "business",
+        "content"
+      ]
+    },
+    {
+      "login": "shadab-taiko",
+      "name": "shadab-taiko",
+      "avatar_url": "https://avatars.githubusercontent.com/u/108871478?v=4",
+      "profile": "https://github.com/shadab-taiko",
+      "contributions": [
+        "doc",
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,29 @@
+name: Bug report 🐛
+description: Report a bug
+title: "[Bug] <insert descriptive title>"
+labels: ["bug", "triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Before submitting, please check if an existing issue already exists. Thanks for taking the time to improve Taiko!
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: A concise description of the problem and what you expected to happen.
+      value: Description of the bug here.
+    validations:
+      required: true
+  - type: textarea
+    id: steps-to-reproduce
+    attributes:
+      label: Steps to reproduce
+      description: Steps to reproduce the bug, a numbered list could be good.
+      value: Steps to reproduce here.
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Provide any additional context, screenshots, etc.
+      value: Additional context here.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,29 @@
+name: Feature request 💡
+description: Request a feature
+title: "[Feat] <insert descriptive title>"
+labels: ["feat", "triage"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Before submitting, please check if an existing issue already exists. Thanks for taking the time to improve Taiko!
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the feature request
+      description: A concise description of what the problem and proposed solution is.
+      value: Description of the feature request here.
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives you've considered
+      description: A concise description of any alternative solutions you've considered.
+      value: Description of the alternatives you've considered here.
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Provide any additional context, screenshots, etc.
+      value: Additional context here.

README.md

@@ -1,6 +1,8 @@
 <!-- BADGES -->
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+
 [![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
+
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 [![Solidity](https://github.com/taikoxyz/taiko-mono/actions/workflows/solidity.yml/badge.svg)](https://github.com/taikoxyz/taiko-mono/actions/workflows/solidity.yml)
@@ -17,20 +19,29 @@
   <h3>TAIKO</h3>
 
   <p>
-    A decentralized Ethereum equivalent ZK rollup
+    A decentralized Ethereum-equivalent ZK-Rollup
     <br />
     <a href="https://taiko.xyz" target="_blank"><strong>Explore the website »</strong></a>
     <br />
   </p>
 </div>
 
-## Packages
-
-- [branding](./packages/branding/): branding materials
-- [protocol](./packages/protocol/): L1 and L2 smart contracts
-- [relayer](./packages/relayer/): bridge relayer
-- [website](./packages/website/): main documentation website
-- [whitepaper](./packages/whitepaper): Latex source files for Taiko's whitepaper. A PDF will be published automatically to: https://taikoxyz.github.io/taiko-mono/taiko-whitepaper.pdf (linked from https://taiko.xyz).
+## Project structure
+
+<pre>
+taiko-mono
+├── <a href="./CONTRIBUTING.md">CONTRIBUTING.md</a>
+├── <a href="./README.md">README.md</a>
+...
+├── <a href="./packages">packages</a>
+│   ├── <a href="./packages/branding">branding</a>: Taiko branding materials
+│   ├── <a href="./packages/bridge-frontend">bridge-frontend</a>: Bridge frontend UI
+│   ├── <a href="./packages/protocol">protocol</a>: L1 and L2 protocol smart contracts
+│   ├── <a href="./packages/relayer">relayer</a>: Bridge relayer
+│   ├── <a href="./packages/website">website</a>: Main documentation website at taiko.xyz
+│   └── <a href="./packages/whitepaper">whitepaper</a>: Whitepaper source files with automated publishing
+...
+</pre>
 
 ## Contributing guide
 
@@ -43,14 +54,22 @@ Each commit will automatically trigger the GitHub Actions to run. If any commit
 ## Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->
 <table>
   <tbody>
     <tr>
       <td align="center"><a href="https://github.com/d1onys1us"><img src="https://avatars.githubusercontent.com/u/13951458?v=4?s=100" width="100px;" alt="d1onys1us"/><br /><sub><b>d1onys1us</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=d1onys1us" title="Documentation">📖</a></td>
+      <td align="center"><a href="https://github.com/davidtaikocha"><img src="https://avatars.githubusercontent.com/u/104078303?v=4?s=100" width="100px;" alt="David"/><br /><sub><b>David</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=davidtaikocha" title="Documentation">📖</a> <a href="https://github.com/taikoxyz/taiko-mono/commits?author=davidtaikocha" title="Code">💻</a></td>
       <td align="center"><a href="http://taiko.xyz"><img src="https://avatars.githubusercontent.com/u/99078276?v=4?s=100" width="100px;" alt="dantaik"/><br /><sub><b>dantaik</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=dantaik" title="Documentation">📖</a> <a href="https://github.com/taikoxyz/taiko-mono/commits?author=dantaik" title="Code">💻</a></td>
+      <td align="center"><a href="https://github.com/cyberhorsey"><img src="https://avatars.githubusercontent.com/u/113397187?v=4?s=100" width="100px;" alt="cyberhorsey"/><br /><sub><b>cyberhorsey</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=cyberhorsey" title="Documentation">📖</a> <a href="https://github.com/taikoxyz/taiko-mono/commits?author=cyberhorsey" title="Code">💻</a></td>
+      <td align="center"><a href="https://github.com/RogerLamTd"><img src="https://avatars.githubusercontent.com/u/50648015?v=4?s=100" width="100px;" alt="RogerLamTd"/><br /><sub><b>RogerLamTd</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=RogerLamTd" title="Documentation">📖</a> <a href="https://github.com/taikoxyz/taiko-mono/commits?author=RogerLamTd" title="Code">💻</a></td>
+      <td align="center"><a href="https://github.com/alexshliu"><img src="https://avatars.githubusercontent.com/u/104080237?v=4?s=100" width="100px;" alt="alexshliu"/><br /><sub><b>alexshliu</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=alexshliu" title="Documentation">📖</a> <a href="https://github.com/taikoxyz/taiko-mono/commits?author=alexshliu" title="Code">💻</a></td>
+      <td align="center"><a href="https://github.com/kirataik"><img src="https://avatars.githubusercontent.com/u/104244966?v=4?s=100" width="100px;" alt="kirataik"/><br /><sub><b>kirataik</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=kirataik" title="Documentation">📖</a> <a href="https://github.com/taikoxyz/taiko-mono/commits?author=kirataik" title="Code">💻</a></td>
+      <td align="center"><a href="https://github.com/mfinestone"><img src="https://avatars.githubusercontent.com/u/36642873?v=4?s=100" width="100px;" alt="mfinestone"/><br /><sub><b>mfinestone</b></sub></a><br /><a href="#business-mfinestone" title="Business development">💼</a> <a href="#content-mfinestone" title="Content">🖋</a></td>
+      <td align="center"><a href="https://github.com/shadab-taiko"><img src="https://avatars.githubusercontent.com/u/108871478?v=4?s=100" width="100px;" alt="shadab-taiko"/><br /><sub><b>shadab-taiko</b></sub></a><br /><a href="https://github.com/taikoxyz/taiko-mono/commits?author=shadab-taiko" title="Documentation">📖</a> <a href="https://github.com/taikoxyz/taiko-mono/commits?author=shadab-taiko" title="Code">💻</a></td>
     </tr>
   </tbody>
 </table>

packages/branding/README.md

@@ -0,0 +1,11 @@
+# Taiko branding
+
+This package contains all you need for Taiko branding.
+
+## Naming
+
+For naming, we use Taiko or Taiko Labs. For the handle, we refer to Taiko with `taikoxyz`, which is where you can find us (ie. twitter: @taikoxyz, github: @taikoxyz). Please maintain this convention.
+
+## Logos
+
+Use SVG and PNG where you can, as the image quality is better.

packages/website/faq/index.md

@@ -60,7 +60,3 @@ Taiko implements a ZK-EVM that supports every EVM opcode, producing a validity p
 A zero-knowledge proof is a method by which one party (the prover) can prove to another party (the verifier) that something is true, without revealing any information apart from the fact that this specific statement is true.
 
 There are 2 types of zero-knowledge proofs: ZK-SNARKs and ZK-STARKs. Taiko uses ZK-SNARKs in its design.
-
-## Where can I purchase the Taiko token?
-
-Currently, no token is available to purchase. The tokenomics are still under development.

packages/whitepaper/README.md

@@ -1,11 +1,11 @@
 # README
 
-The Taiko whitepaper. The automatically generated PDF file is hosted in this repository's GitHub Pages [link](https://taikoxyz.github.io/taiko-mono/taiko-whitepaper.pdf).
+Latex source files for Taiko's whitepaper. A PDF will be published automatically to this repository's GitHub Pages [link](https://taikoxyz.github.io/taiko-mono/taiko-whitepaper.pdf) (linked from https://taiko.xyz).
 
 ## Usage
 
 ```
 git clone https://github.com/taikoxyz/taiko-mono.git
 cd packages/whitepaper
 ./build.sh
-```
+```