taikoxyz / docs

Taiko's end user documentation.

Taiko docs

Welcome to Taiko docs!

Repo architecture

Here we will list the important folders within this repo.

src/content

This is where we store all of the content.

src/content/config.ts

This is where we extend the docsSchema.

Contributing

View CONTRIBUTING.md inside of the Taiko monorepo.

docs's Issues

feature request: configure gitpoap in this repo

feature request: Deploy Contracts on Taiko Katla with Hardhat Guide

Hey Taiko Team,

I noticed the documentation currently lacks a guide for deploying contracts on the Taiko Katla testnet using Hardhat. It would be extremely helpful for developers, especially those new to Taiko, to have a straightforward, step-by-step guide that covers:

• Setting up Hardhat for Taiko contract deployment.
• Writing and executing a deployment script for the Taiko Katla testnet.
• Basic troubleshooting tips for common issues during deployment.

Additionally, including a section on how to verify contracts on Taiko would make the guide more comprehensive. I plan to request a separate guide for contract verification section as well.

This addition would greatly assist developers in getting started with contract deployment on Taiko's network efficiently.

Thanks for considering this request.

Best,
Aayush Giri

bug report: The Client Driver fails parsing a transaction received

Current Behaviour: ERROR cannot unmarshal hex number with leading zero digits into Go struct field storageResult.storageProof.value of type *hexutil.Big

(Running holsky on: lighthouse + nethermind)

bug report: L2 node doesn't sync

I set up a Holesky node on my VPS. Node is fully synced (both consensus and execution).

I then set up an L2 node with my Holesky node as the L1 on the same machine. When I try to run it, everything looks good for 2-3 mins, node starts to sync but then it abruptly stops and no blocks get processed. See Grafana for L2 below

I have tried taking down both nodes and restarting multiple times, but to no avail. Multiple people including myself see this under docker compose logs -f on the L2 node. lastVerifiedBlock=10283 (the exact same for a few folks). I have had my L2 node running for 12h+ at this point, but no blocks have been processed after the first few mins.

Totally blocked and the only related FAQ in Discord is this wherein we're asked to ignore the error. I don't see any other error logs in the trace.

bug report: edit links in the docs are not working

See this page for example: https://docs.taiko.xyz/network-reference/differences-from-ethereum

Try to click "Edit page". It'll lead you to
https://github.com/taikoxyz/docs/edit/main/docs/src/content/docs/network-reference/differences-from-ethereum.md
while the correct link is
https://github.com/taikoxyz/docs/edit/main/src/content/docs/network-reference/differences-from-ethereum.md

See the PR #35

feature request: describe alternative bridging method

Add bridge depositEtherToL2, see Dani's tweet: https://x.com/dani_who_daniel/status/1747477406880067974?s=20

docker compose up description error

Describe the bug

When I run the command docker compose up --profile l2_execution_engine -d as per the documentation, it prompts unknown flag: --profile. I changed the command to docker compose --profile l2_execution_engine up -d, and it worked. This seems to be a description error.

Steps to reproduce

docker compose up --profile l2_execution_engine -d

Spam policy

• I verify that this issue is NOT SPAM and understand SPAM issues will be closed and reported to GitHub, resulting in ACCOUNT TERMINATION.

Add ANKR endpoint to Chainlist / docs

URL: https://rpc.ankr.com/taiko_katla

bug report: Errors trying to create priv.key using SGX V1 compatible cpu

I tried to build the image and it worked well
but for the Bootstrap i faced this issue

user@localserver:~/raiko/docker$ docker compose run --rm raiko --init
+ /restart_aesm.sh
aesm_service: warning: Turn to daemon. Use "--no-daemon" option to execute in foreground.
+ [[ 1 -eq 1 ]]
+ [[ --init == \-\-\i\n\i\t ]]
+ cd /opt/raiko/guests/sgx
+ gramine-sgx ./raiko-guest bootstrap
Gramine is starting. Parsing TOML manifest file, this may take some time...
error: EDMM feature was requested in manifest, but CPU doesn't support it
error: load_enclave() failed with error: Operation not permitted (EPERM)

as Patryk | Taiko suggested I even tried to disable EDMM (Enclave Dynamic Memory Management) but still didnt work

bug report: incorrect tiers

PSE zkEVM + SGX Proofs: 0.2%
SGX Proofs: 9.8%
Optimistic Proofs: 90%

^ from daniel, these are the correct ones.

feature request: mdx auto formatting is terrible with prettier

see run-a-taiko-node.mdx

Hardhat contract deployment on taiko

Describe the feature request

Install Hardhat EVM and the required plugins:

1. Install the Hardhat EVM plugin by running:

npm install --save-dev @nomiclabs/hardhat-ethers @nomiclabs/hardhat-waffle ethereum-waffle chai @nomiclabs/hardhat-etherscan hardhat-deploy hardhat-deploy-ethers hardhat-etherscan

2. Configure Hardhat for the Taiko network:

Update hardhat.config.js to include the Taiko network configuration. Example:

require("@nomiclabs/hardhat-waffle");
require("hardhat-deploy");
require("hardhat-deploy-ethers");

const { privateKeys, alchemyApiKey } = require('./secrets.json');

module.exports = {
      networks: {
          taiko: {
             url: `https://eth-rpc.alchemyapi.io/v2/${alchemyApiKey}`,
             accounts: [privateKeys],
          },
      },
     solidity: {
         version: "0.8.0",
         settings: {
            optimizer: {
                enabled: true,
                runs: 200,
            },
        },
    },    
    namedAccounts: {
        deployer: {
            default: 0,
         },
      },
    };

3. Write your deployment script:

Create a deployment script for your contract. For example, you can create a file named deploy.js in the scripts directory of your Hardhat project.

const { ethers, upgrades } = require("hardhat");

async function main() {
  const MyContract = await ethers.getContractFactory("MyContract");
  const myContract = await upgrades.deployProxy(MyContract, [initialValue]);
  await myContract.deployed();
  console.log("MyContract deployed to:", myContract.address);
}

main()
  .then(() => process.exit(0))
  .catch((error) => {
    console.error(error);
    process.exit(1);
  });

4. Run the deployment script:

Run the deployment script using the Hardhat command line interface:

npx hardhat run scripts/deploy.js --network taiko

Replace MyContract and initialValue with the actual contract name and deployment parameters. Additionally, ensure that you have the secrets.json file with the private keys and Alchemy API key for the Taiko network.

These steps will help you deploy a contract using Hardhat on the Taiko network. This is just a suggested code that could help.

Spam policy

• I verify that this issue is NOT SPAM and understand SPAM issues will be closed and reported to GitHub, resulting in ACCOUNT TERMINATION.

feature request: show some missing client diffs

eth_syncing did not behave as expected. please document. see: taikoxyz/taiko-client#537

feature request: add pre-EIP-155 transactions to the Differences from Ethereum

The network doesn't accept the legacy transactions (type 0) without a chain ID.

PoC:

curl -X POST \
-H "Content-Type: application/json" \
--data '{"jsonrpc": "2.0", "id": 1, "method": "eth_sendRawTransaction", "params": ["0xf8648085174876e80082520894353535353535353535353535353535353535353580801ca07abf02032ce93f91251e651d77871b43f2d6637e7adf3cf1ff59a6daf52ac871a07c72154b552a00fff061a578a8bd2516b2255acc81f961b6530d1ef3963a7971"]}' \
"https://rpc.katla.taiko.xyz"

The response:

{"jsonrpc":"2.0","id":1,"error":{"code":-32000,"message":"only replay-protected (EIP-155) transactions allowed over RPC"}}

See the PR #33

feature request: make it easy to add prover endpoints and healthcheck them

re-integrate what @2manslkh had on last docs site.

feature request: add info for simple-taiko-node prerequisites

• Docker may need google credentials to pull the images necessary to run the node, when running docker compose up -d without google cloud cli credentials (or missing google-cloud-sdk folder) the script hangs as shown below:

• Eventually it outputs this error message:
  error getting credentials - err: exec: "docker-credential-gcloud": executable file not found in $PATH, out:

• Add a pre-req and link to the gcloud CLI installation page

feature request: translation program

see taikoxyz/website#44 for initial discussion

Insufficient Deployment Documentation and UI Navigation Bug

Overview

Taiko's documentation currently lacks comprehensive guides for deploying smart contracts using Thirdweb and Hardhat, and the existing Foundry and Remix documentation is brief and lacks video tutorials. Additionally, a UI issue with the documentation's dropdown menu causes unintended expansions, disrupting user navigation.

Issues Identified

1. Missing Guides: No resources are available for deploying with Thirdweb and Hardhat.
2. Lacking Detail: Foundry and Remix documentation is not comprehensive and lacks video support.
3. UI Bug: The "Deploy a Contract" dropdown incorrectly expands when interacting with other sections.

Proposed Solutions

1. Develop New Guides: Introduce detailed deployment guides for Thirdweb and Hardhat, including step-by-step instructions and complemented video walkthroughs.
2. Enhance Existing Content: Update Foundry and Remix guides with detailed information and complemented video walkthroughs.
3. UI Fix: Correct the dropdown menu behavior to improve navigation and user experience.

Addressing these points will significantly enhance the developer experience by providing complete, accessible deployment resources and a smoother navigation interface.

I have am attaching a small demo preview of how the docs look - now after the changes that I have suggested here are implemented:

demo.mp4

feature request: add full taiko architecture spec

there is missing docs that we had before especially related to the rollup architecture:

• anchor tx
• proposing / proving blocks

Migrate all step guides to utilize Starlight's step component

Describe the feature request

In many of our guides (Deploy a contract, Run a node, etc.) we write step-by-step guides:

1. Like
2. This

We should utilize Starlight's new step component here.

Spam policy

• I verify that this issue is NOT SPAM and understand SPAM issues will be closed and reported to GitHub, resulting in ACCOUNT TERMINATION.

bug report: Node stopping

I don't understand what's happening. The node apparently works for a while and stops. I've reinstalled it several times and the error remains.

program aiding translation

need a program to aid translation during running node

feature request: add guide for registering SGX public key / running SGX prover

• add guide for running raiko
• add google form for manually registering SGX public key

feature request: remove all relative links and only refer to links with ~ symbol in astro

feature request: icon size and lettering size on Taiko docs tab

Icons and lettering are a different size on page tab when compared to other page tabs https://docs.taiko.xyz/start-here/getting-started

Update swagger UI links for Relayer and Event Indexer API to A6 testnet

The current swagger API references are pointed to the older testnet and needs to be updated

https://relayer-swagger.taiko.xyz/#/default/get-block-info - Relayer
https://eventindexer-swagger.taiko.xyz/#/ - event indexer

Reference page in docs - https://docs.taiko.xyz/api-reference/bridge-relayer-api/

Please add to chainlist/docs

Endpoint for dRPC: https://taiko-katla.drpc.org/