Skip to content

Commit

Permalink
Merge branch 'main' into ontake_cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
dantaik authored Sep 20, 2024
2 parents b427447 + fd1c039 commit 343b3aa
Show file tree
Hide file tree
Showing 11 changed files with 41 additions and 22 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/protocol.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ jobs:
with:
access_token: ${{ github.token }}

- name: Install Git
run: sudo apt-get update && sudo apt-get install -y git
- name: Prepare environment
run: sudo apt-get update && sudo apt-get install -y git nc

- name: Checkout repository
uses: actions/checkout@v4
Expand Down
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"packages/bridge-ui": "2.12.0",
"packages/docs-site": "1.11.9",
"packages/docs-site": "1.12.0",
"packages/eventindexer": "0.13.0",
"packages/fork-diff": "0.6.0",
"packages/guardian-prover-health-check": "0.1.0",
Expand Down
19 changes: 19 additions & 0 deletions packages/docs-site/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# Changelog

## [1.12.0](https://github.com/taikoxyz/taiko-mono/compare/docs-site-v1.11.9...docs-site-v1.12.0) (2024-09-19)


### Features

* **docs-site:** sitewide banner for ontake fork notification ([#18111](https://github.com/taikoxyz/taiko-mono/issues/18111)) ([5ed6c80](https://github.com/taikoxyz/taiko-mono/commit/5ed6c8085e44b77283fe5ef8874f751126364d84))
* **docs-site:** update docs for ontake fork hekla ([#18143](https://github.com/taikoxyz/taiko-mono/issues/18143)) ([49b5071](https://github.com/taikoxyz/taiko-mono/commit/49b50712551849d185c98237098d236bb0cf884c))
* **docs-site:** update graphics and links for hekla ontake fork ([#18146](https://github.com/taikoxyz/taiko-mono/issues/18146)) ([48a27af](https://github.com/taikoxyz/taiko-mono/commit/48a27afe6be22fc7e1a9d2346ae292544faac0b3))


### Bug Fixes

* **docs-site:** remove duplicate wording ([#18105](https://github.com/taikoxyz/taiko-mono/issues/18105)) ([92c53f8](https://github.com/taikoxyz/taiko-mono/commit/92c53f8655dbdab4c7db1b023823a4e760240894))


### Documentation

* **docs-site:** fix broken link ([#18139](https://github.com/taikoxyz/taiko-mono/issues/18139)) ([e56b81b](https://github.com/taikoxyz/taiko-mono/commit/e56b81bbd83f26c95641cf7deab82dbb5a3da835))

## [1.11.9](https://github.com/taikoxyz/taiko-mono/compare/docs-site-v1.11.8...docs-site-v1.11.9) (2024-09-15)


Expand Down
2 changes: 1 addition & 1 deletion packages/docs-site/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "docs-site",
"type": "module",
"version": "1.11.9",
"version": "1.12.0",
"scripts": {
"dev": "astro dev",
"start": "astro dev",
Expand Down
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { Code } from '@astrojs/starlight/components';
## How can you determine when a Taiko block is `Safe` or `Finalized`?

The `Safe` block state on Taiko is analogous to a `Safe` block state on Ethereum.
Every Taiko L2 block has a corresponding Ethereum L1 block as it's origin that can be queried through a [`taiko-geth API`](https://github.com/taikoxyz/taiko-geth/blob/caf87509fe0f53fc937a3f5cc26325a380a1744e/eth/taiko_api_backend.go#L50).
Every Taiko L2 block has a corresponding Ethereum L1 block as it's origin that can be queried through a [`taiko-geth API`](https://github.com/taikoxyz/taiko-geth/blob/v1.8.0/eth/taiko_api_backend.go#L50).
When that Ethereum L1 block can be considered `Safe`, the corresponding Taiko L2 block can be considered to have reached the same block state.

The `Finalized` block state is referred to as the [`Verified` block state](/core-concepts/multi-proofs#verified-blocks-and-parallel-proving) on Taiko.
Expand All @@ -18,17 +18,17 @@ A Taiko block is `Finalized`/`Verified` when every state transition from genesis

<Code code='
{
"method": "taiko_l1OriginByID",
"id":1,
"jsonrpc":"2.0",
"method": "taiko_l1OriginByID",
"id":1,
"jsonrpc":"2.0",
"params":[ "0x19a3c" ]
}' lang="json" title="query.json" />
<Code code='
"result":
{
"blockID": "0x19a3c",
"l2BlockHash": "0x0905c85f9a288ebe94eb85743a65c8cf6266097b8b826cdca4f4018e6267c26a",
"l1BlockHeight": "0x16ef0f",
"result":
{
"blockID": "0x19a3c",
"l2BlockHash": "0x0905c85f9a288ebe94eb85743a65c8cf6266097b8b826cdca4f4018e6267c26a",
"l1BlockHeight": "0x16ef0f",
"l1BlockHash": "0x419f0c5b2cc90078c7040c3b90d174895ce83d76ebfdd75ad2dd5521036d0938"
}' lang="json" title="response.json" />

Expand Down
4 changes: 2 additions & 2 deletions packages/docs-site/src/content/docs/core-concepts/bridging.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ Taiko deploys two smart contracts which store the hashes of the other chain:
- TaikoL1 stores the L2 world state root on L1 (deployed on Ethereum)
- TaikoL2 stores the L1 world state root on L2 (deployed on Taiko)

Every time an L2 block is created on Taiko, the world state root of the enclosing block on L1 is stored in the [TaikoL2](https://github.com/taikoxyz/taiko-mono/blob/fbfcc7f3810d0122f46673944c39e5f4d759d4e0/packages/protocol/contracts/L2/TaikoL2.sol#L151) contract using the `anchor` transaction. To ensure validity, it is part of the (previously the zk circuits, now SGX and ZK) proof data submitted with each block, so no fake L1 world state root can be synchronized to L2."
Every time an L2 block is created on Taiko, the world state root of the enclosing block on L1 is stored in the [TaikoL2](https://github.com/taikoxyz/taiko-mono/blob/protocol-v1.9.0/packages/protocol/contracts/layer2/based/TaikoL2.sol#L145) contract using the `anchor` transaction. To ensure validity, it is part of the (previously the zk circuits, now SGX and ZK) proof data submitted with each block, so no fake L1 world state root can be synchronized to L2."

The L2 world state root is stored in the TaikoL1 contract using the `syncChainData` function call in
[`LibVerifying`](https://github.com/taikoxyz/taiko-mono/blob/fbfcc7f3810d0122f46673944c39e5f4d759d4e0/packages/protocol/contracts/L1/libs/LibVerifying.sol#L191).
[`LibVerifying`](https://github.com/taikoxyz/taiko-mono/blob/protocol-v1.9.0/packages/protocol/contracts/layer1/based/LibVerifying.sol#L179).

Taiko by default synchronizes the world state roots cross-chain with the above mechanism.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ This guide outlines how to achieve this with separate EOAs running prover and pr

5. **Configure the contract as necessary**

Manage the contract's allowance with [approveAllowance()](https://github.com/taikoxyz/taiko-mono/blob/116d3f4886dea01333b829677ec9b6d4492479c6/packages/protocol/contracts/team/proving/ProverSet.sol#L63). TaikoL1's contract allowance is by default set to `UINT256.MAX` in the init function.
Manage the contract's allowance with [approveAllowance()](https://github.com/taikoxyz/taiko-mono/blob/protocol-v1.9.0/packages/protocol/contracts/layer1/provers/ProverSet.sol#L64). TaikoL1's contract allowance is by default set to `UINT256.MAX` in the init function.

6. **Deposit your tokens and run your proposer + prover as usual!**

Expand All @@ -106,7 +106,7 @@ This guide outlines how to achieve this with separate EOAs running prover and pr
Ensure that you have set up the EOAs correctly to avoid problems.

<Aside>
You can withdraw the deposited tokens to the `admin` address with [withdrawToAdmin()](https://github.com/taikoxyz/taiko-mono/blob/116d3f4886dea01333b829677ec9b6d4492479c6/packages/protocol/contracts/team/proving/ProverSet.sol#L76).
You can withdraw the deposited tokens to the `admin` address with [withdrawToAdmin()](https://github.com/taikoxyz/taiko-mono/blob/protocol-v1.9.0/packages/protocol/contracts/layer1/provers/ProverSet.sol#L77).
</Aside>

</Steps>
Expand Down Expand Up @@ -164,7 +164,7 @@ If you've already deployed a ProverSet but would like to upgrade it through the
If you've managed to propose and prove some blocks, it's likely you're wondering where your tokens went after.
It's not missing, it's just been deposited as bond in the TaikoL1 contract; you can withdraw it from the ProverSet contract with [withdrawBond()](https://github.com/taikoxyz/taiko-mono/blob/dd09223de53669b84241672eeb4b8574e5c7f821/packages/protocol/contracts/team/proving/ProverSet.sol#L110) manually.
It's not missing, it's just been deposited as bond in the TaikoL1 contract; you can withdraw it to the ProverSet contract with [withdrawBond()](https://github.com/taikoxyz/taiko-mono/blob/protocol-v1.9.0/packages/protocol/contracts/layer1/provers/ProverSet.sol#L136) manually.
### How do I verify my ProverSet contract?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,4 @@ The owner has the ability to upgrade the contracts.

## Taiko Labs' bootnode addresses

Find the latest bootnodes here in [simple-taiko-node](https://github.com/taikoxyz/simple-taiko-node/blob/main/.env.sample).
Find the latest bootnodes here in [simple-taiko-node](https://github.com/taikoxyz/simple-taiko-node/blob/v1.7.0/.env.sample).
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: The network configuration page describes many of the configuration

## Tier configuration (Mainnet)

You can view the full `TierProviderV2` tier configuration [here](https://github.com/taikoxyz/taiko-mono/blob/main/packages/protocol/contracts/L1/tiers/TierProviderV2.sol):
You can view the full `TierProviderV2` tier configuration [here](https://github.com/taikoxyz/taiko-mono/blob/main/packages/protocol/contracts/layer1/tiers/TierProviderV2.sol):

![mainnet proof tiers](~/assets/content/docs/network-reference/proof-tier-config-mn.webp)

Expand All @@ -17,7 +17,7 @@ You can view the full network configuration by visiting the TaikoL1 contract on

## Tier configuration (Hekla)

You can view the full `TierProviderV2` tier configuration [here](https://github.com/taikoxyz/taiko-mono/blob/main/packages/protocol/contracts/L1/tiers/TierProviderV2.sol):
You can view the full post ontake fork `HeklaTierProvider` tier configuration [here](https://github.com/taikoxyz/taiko-mono/blob/main/packages/protocol/contracts/layer1/hekla/HeklaTierProvider.sol):

![hekla proof tiers](~/assets/content/docs/network-reference/proof-tier-config-hekla.webp)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,4 @@ The owner has the ability to upgrade the contracts.

## Taiko Labs' bootnode addresses

Find the latest bootnodes here in [simple-taiko-node](https://github.com/taikoxyz/simple-taiko-node/blob/main/.env.sample.hekla).
Find the latest bootnodes here in [simple-taiko-node](https://github.com/taikoxyz/simple-taiko-node/blob/v1.7.0/.env.sample.hekla).

0 comments on commit 343b3aa

Please sign in to comment.