diff --git a/.github/workflows/protocol.yml b/.github/workflows/protocol.yml index 1592a7c642..5ac4436e39 100644 --- a/.github/workflows/protocol.yml +++ b/.github/workflows/protocol.yml @@ -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 diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 2b917b1ff4..ac778b6582 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -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", diff --git a/packages/docs-site/CHANGELOG.md b/packages/docs-site/CHANGELOG.md index e8aa445a8c..44440981f9 100644 --- a/packages/docs-site/CHANGELOG.md +++ b/packages/docs-site/CHANGELOG.md @@ -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) diff --git a/packages/docs-site/package.json b/packages/docs-site/package.json index f2328535ac..bdbc04bc0c 100644 --- a/packages/docs-site/package.json +++ b/packages/docs-site/package.json @@ -1,7 +1,7 @@ { "name": "docs-site", "type": "module", - "version": "1.11.9", + "version": "1.12.0", "scripts": { "dev": "astro dev", "start": "astro dev", diff --git a/packages/docs-site/src/assets/content/docs/network-reference/proof-tier-config-hekla.webp b/packages/docs-site/src/assets/content/docs/network-reference/proof-tier-config-hekla.webp index 651f8c7f2d..840d7eadfb 100644 Binary files a/packages/docs-site/src/assets/content/docs/network-reference/proof-tier-config-hekla.webp and b/packages/docs-site/src/assets/content/docs/network-reference/proof-tier-config-hekla.webp differ diff --git a/packages/docs-site/src/content/docs/core-concepts/block-states.mdx b/packages/docs-site/src/content/docs/core-concepts/block-states.mdx index 1655172bd0..734d9a3891 100644 --- a/packages/docs-site/src/content/docs/core-concepts/block-states.mdx +++ b/packages/docs-site/src/content/docs/core-concepts/block-states.mdx @@ -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. @@ -18,17 +18,17 @@ A Taiko block is `Finalized`/`Verified` when every state transition from genesis diff --git a/packages/docs-site/src/content/docs/core-concepts/bridging.md b/packages/docs-site/src/content/docs/core-concepts/bridging.md index 2cde2c7e1d..d5bc0333a8 100644 --- a/packages/docs-site/src/content/docs/core-concepts/bridging.md +++ b/packages/docs-site/src/content/docs/core-concepts/bridging.md @@ -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. diff --git a/packages/docs-site/src/content/docs/guides/node-operators/deploy-a-proverset.mdx b/packages/docs-site/src/content/docs/guides/node-operators/deploy-a-proverset.mdx index a0364bcec8..780c0adbaf 100644 --- a/packages/docs-site/src/content/docs/guides/node-operators/deploy-a-proverset.mdx +++ b/packages/docs-site/src/content/docs/guides/node-operators/deploy-a-proverset.mdx @@ -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!** @@ -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. @@ -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? diff --git a/packages/docs-site/src/content/docs/network-reference/mainnet-addresses.md b/packages/docs-site/src/content/docs/network-reference/mainnet-addresses.md index 33dbf6a175..32101e0930 100644 --- a/packages/docs-site/src/content/docs/network-reference/mainnet-addresses.md +++ b/packages/docs-site/src/content/docs/network-reference/mainnet-addresses.md @@ -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). diff --git a/packages/docs-site/src/content/docs/network-reference/network-configuration.md b/packages/docs-site/src/content/docs/network-reference/network-configuration.md index f847c1aa2f..3010e04252 100644 --- a/packages/docs-site/src/content/docs/network-reference/network-configuration.md +++ b/packages/docs-site/src/content/docs/network-reference/network-configuration.md @@ -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) @@ -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) diff --git a/packages/docs-site/src/content/docs/network-reference/testnet-addresses.md b/packages/docs-site/src/content/docs/network-reference/testnet-addresses.md index a72de95583..b9032e4b47 100644 --- a/packages/docs-site/src/content/docs/network-reference/testnet-addresses.md +++ b/packages/docs-site/src/content/docs/network-reference/testnet-addresses.md @@ -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).