Skip to content
This repository has been archived by the owner on Oct 3, 2024. It is now read-only.

Commit

Permalink
fix: rename zk chains (#1073)
Browse files Browse the repository at this point in the history
  • Loading branch information
zk-Lumi authored May 14, 2024
1 parent 34c6c79 commit f80f1c9
Show file tree
Hide file tree
Showing 33 changed files with 216 additions and 199 deletions.
6 changes: 3 additions & 3 deletions docs/.vuepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export default defineUserConfig({
],
[
"meta",
{ name: "description", content: "zkSync Docs bring you all information you need about our protocol, APIs, SDKs, ZK Stack, and hyperchains. Start with our guides and tutorials, or go deep into our architecture and protocol specification." },
{ name: "description", content: "zkSync Docs bring you all information you need about our protocol, APIs, SDKs, ZK Stack, and ZK Chains. Start with our guides and tutorials, or go deep into our architecture and protocol specification." },
],
["meta", { name: "author", content: "https://matter-labs.io" }],

Expand All @@ -51,7 +51,7 @@ export default defineUserConfig({
"meta",
{
name: "og:description",
content: "zkSync Docs bring you all information you need about our protocol, APIs, SDKs, ZK Stack, and hyperchains. Start with our guides and tutorials, or go deep into our architecture and protocol specification.",
content: "zkSync Docs bring you all information you need about our protocol, APIs, SDKs, ZK Stack, and ZK Chains. Start with our guides and tutorials, or go deep into our architecture and protocol specification.",
},
],
["meta", { name: "twitter:card", content: "summary" }],
Expand All @@ -60,7 +60,7 @@ export default defineUserConfig({
"meta",
{
name: "twitter:description",
content: "zkSync Docs bring you all information you need about our protocol, APIs, SDKs, ZK Stack, and hyperchains. Start with our guides and tutorials, or go deep into our architecture and protocol specification.",
content: "zkSync Docs bring you all information you need about our protocol, APIs, SDKs, ZK Stack, and ZK Chains. Start with our guides and tutorials, or go deep into our architecture and protocol specification.",
},
],
["meta", { name: "twitter:image", content: "https://docs.zksync.io/share_image.png" }],
Expand Down
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 6 additions & 6 deletions docs/.vuepress/sidebar/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -611,8 +611,8 @@ export const enSidebar = sidebar({
link: "/zk-stack/concepts/system-upgrades.md"
},
{
text: "Hyperchains / Hyperscaling",
link: "/zk-stack/concepts/hyperchains-hyperscaling.md"
text: "ZK Chains",
link: "/zk-stack/concepts/zk-chains.md"
},
{
text: "Data Availability",
Expand Down Expand Up @@ -945,20 +945,20 @@ export const enSidebar = sidebar({
],
},
{
text: "Running a Hyperchain",
text: "Running a ZK Chain",
collapsible: true,
children: [
{
text: "Locally",
link: "/zk-stack/running-a-hyperchain/locally.html",
link: "/zk-stack/running-a-zk-chain/locally.html",
},
{
text: "In Production",
link: "/zk-stack/running-a-hyperchain/production.md"
link: "/zk-stack/running-a-zk-chain/production.md"
},
{
text: "Rollup as a Service",
link: "/zk-stack/running-a-hyperchain/raas.html",
link: "/zk-stack/running-a-zk-chain/raas.html",
},
]
},
Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,17 +30,17 @@ contributors: false
</div>
</RouterLink>
<RouterLink to="/zk-stack" class="card">
<img src="/images/landing/hyperchain.png" alt="zkStack">
<img src="/images/landing/zk-chain.png" alt="ZK Stack">
<div class="content">
<h3>ZK Stack</h3>
<p>Understand the protocol powering zkSync hyperchains, including zkSync Era.</p>
<p>Understand the protocol powering zkSync ZK Chains, including zkSync Era.</p>
</div>
</RouterLink>
<RouterLink to="/infra" class="card">
<img src="/images/landing/run-a-node.png" alt="run a node">
<div class="content">
<h3>Run a Node</h3>
<p>All the information you need to run a node for zkSync Era or your hyperchain.</p>
<p>All the information you need to run a node for zkSync Era or your ZK Chain.</p>
</div>
</RouterLink>
</div>
Expand Down
File renamed without changes
4 changes: 2 additions & 2 deletions docs/build/developer-reference/contract-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ Each zkEVM bytecode must adhere to the following format:
- Its length must be divisible by 32.
- Its length in words (32-byte chunks) should be odd. In other words, `bytecodeLength % 64 == 32`.
- There is a VM limit, the bytecode can not be more than `2^16` 32-byte words, i.e. `2^21` bytes.
- The bootloader has a memory limit for supplying pubdata of 450999 bytes, therefore limiting the contract size to it as well. This limit is valid for Validium hyperchains, that don’t have to publish the bytecode to the base layer.
- For rollups that must publish the deployed bytecode to the base layer (e.g. Ethereum), there is an additional pubdata limit, which is normally smaller. By default, for each batch, this limit is set to 100000 bytes for hyperchains using calldata DA, or 120000\*number_of_blobs, for hyperchains using EIP-4844 blobs.
- The bootloader has a memory limit for supplying pubdata of 450999 bytes, therefore limiting the contract size to it as well. This limit is valid for Validium ZK Chains, that don’t have to publish the bytecode to the base layer.
- For rollups that must publish the deployed bytecode to the base layer (e.g. Ethereum), there is an additional pubdata limit, which is normally smaller. By default, for each batch, this limit is set to 100000 bytes for ZK Chains using calldata DA, or 120000\*number_of_blobs, for ZK Chains using EIP-4844 blobs.

The 32-byte hash of the bytecode of a zkSync contract is calculated in the following way:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ All linking happens at compile-time. Deploy-time linking is not supported.
## Precompiles

Some EVM cryptographic precompiles (notably pairings and RSA) aren't currently available. However, pairing is
prioritized to allow deployment of both Hyperchains and protocols like Aztec/Dark Forest without modifications.
prioritized to allow deployment of both ZK Chains and protocols like Aztec/Dark Forest without modifications.

Ethereum cryptographic primitives like `ecrecover`, `keccak256`, `sha256`, `ecadd` and `ecmul` are supported as precompiles.
No actions are required from your side as all the calls to the precompiles are done by the compilers under the hood.
Expand Down
6 changes: 3 additions & 3 deletions docs/build/support/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ zkSync Era is a gigantic leap forward in Layer 2 technologies. It is a long-awai
- **Future Proof** - Ecosystem projects that adopt zkSync Era now will enjoy all future improvements without the need to change their code, in particular coming from:
- The prover technology: hardware acceleration and [new proof systems](https://zksync.mirror.xyz/HJ2Pj45EJkRdt5Pau-ZXwkV2ctPx8qFL19STM5jdYhc).
- The compiler: integration of LLVM-enabled modern programming languages. [Learn more about our compiler toolchain](../../zk-stack/components/compiler/toolchain/overview.md).
- Other innovations like [Hyperchains, Hyperbridges and ZK Stack](../../zk-stack/concepts/hyperchains-hyperscaling.md).
- Other innovations like [ZK Chains, Hyperbridges and ZK Stack](../../zk-stack/concepts/zk-chains.md).

## What is the zkEVM?

Expand Down Expand Up @@ -85,7 +85,7 @@ Almost every smart contract written for EVM will be supported by zkSync Era and
You can find more information about the [differences between Ethereum and zkSync Era in this section of the docs](../../build/developer-reference/differences-with-ethereum.md).
:::

There are a few other distinctions, for example, gas metering will be different (as is the case for other L2s as well). Some EVM’s cryptographic precompiles (notably pairings and RSA) won’t be available in the very first release but will be implemented soon after the launch, with pairing being a priority to allow both Hyperchains and protocols like Aztec/Dark Forest to be deployed without modifications too.
There are a few other distinctions, for example, gas metering will be different (as is the case for other L2s as well). Some EVM’s cryptographic precompiles (notably pairings and RSA) won’t be available in the very first release but will be implemented soon after the launch, with pairing being a priority to allow both ZK Chains and protocols like Aztec/Dark Forest to be deployed without modifications too.

## Security expectations

Expand Down Expand Up @@ -131,7 +131,7 @@ Optimistic rollups suffer from the following key downsides:
In contrast, zkSync Era is based on zero-knowledge proofs which have important characteristics that optimistic methods do not - they can hyperscale.

::: tip Hyperscalability
Read more about [Hyperscalability and ZK Stack here](../../zk-stack/concepts/hyperchains-hyperscaling.md).
Read more about [Hyperscalability and ZK Stack here](../../zk-stack/concepts/zk-chains.md).
:::

## Which Wallets are supported?
Expand Down
2 changes: 1 addition & 1 deletion docs/build/tooling/zksync-cli/commands/custom-chains.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ head:

# Using custom chains with zksync-cli

The [zksync-cli](../../zksync-cli/getting-started.md) tool provides a flexible way to add or edit custom chains, enabling you to specify your own chain configuration. This feature is essential for developers looking to interact with ZK Stack Hyperchains.
The [zksync-cli](../../zksync-cli/getting-started.md) tool provides a flexible way to add or edit custom chains, enabling you to specify your own chain configuration. This feature is essential for developers looking to interact with ZK Stack Chains.

## Configuring Custom Chains

Expand Down
12 changes: 6 additions & 6 deletions docs/zk-stack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ head:
<section>
<div class="card-container">
<RouterLink
to="/zk-stack/running-a-hyperchain/"
to="/zk-stack/running-a-zk-chain/"
class="card"
>
<img
src="/images/landing/run-a-hyperchain.png"
alt="Run a ZK Stack Hyperchain"
src="/images/landing/run-a-zk-chain.png"
alt="Run a ZK Stack ZK Chain"
/>
<div class="content">
<h3>Run a Hyperchain</h3>
<p>Quickly spin up a ZK Stack hyperchain on your own machine.</p>
<h3>Run a ZK Chain</h3>
<p>Quickly spin up a ZK Stack Chain on your own machine.</p>
</div>
</RouterLink>
<RouterLink
Expand Down Expand Up @@ -66,7 +66,7 @@ head:
class="card"
>
<img
src="/images/landing/hyperchain.png"
src="/images/landing/zk-chain.png"
alt="ZK Stack Concepts"
/>
<div class="content">
Expand Down
8 changes: 4 additions & 4 deletions docs/zk-stack/components/block-explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ head:

# Block Explorer

[The Block Explorer](https://github.com/matter-labs/block-explorer) is a module to allow exposing everything that is happening on your hyperchain to your users/developers. It comes with the following components:
[The Block Explorer](https://github.com/matter-labs/block-explorer) is a module to allow exposing everything that is happening on your ZK Chain to your users/developers. It comes with the following components:

- **Block Explorer Worker:** an indexer service for hyperchain data. The purpose of the service is to read the data from the blockchain in real-time, transform it and fill in its database to be used by the API.
- **Block Explorer Worker:** an indexer service for ZK Chain data. The purpose of the service is to read the data from the blockchain in real-time, transform it and fill in its database to be used by the API.

- **Block Explorer API:** a service that provides an HTTP API for retrieving structured hyperchain data. It must be connected to the block explorer worker database.
- **Block Explorer API:** a service that provides an HTTP API for retrieving structured ZK Chain data. It must be connected to the block explorer worker database.

- **Block Explorer App:** The UI that allows user/devs to explore transactions, blocks, batches, contracts, tokens, and much more, on your hyperchain.
- **Block Explorer App:** The UI that allows user/devs to explore transactions, blocks, batches, contracts, tokens, and much more, on your ZK Chain.
2 changes: 1 addition & 1 deletion docs/zk-stack/components/fee-withdrawer.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ head:

# Fee Withdrawer

[The Fee Withdrawer](https://github.com/matter-labs/era-fee-withdrawer) automates the withdrawal of the hyperchain collected fees to an address on the base layer.
[The Fee Withdrawer](https://github.com/matter-labs/era-fee-withdrawer) automates the withdrawal of the ZK Chain collected fees to an address on the base layer.

This helps ensure the ETH operator on the base layer side has a constant influx of the gas token to keep working properly.
4 changes: 2 additions & 2 deletions docs/zk-stack/components/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ head:

# Overview

ZK Stack is a modular framework for building sovereign ZK-powered Ethereum rollups (called hyperchains); it is a modular, open-source framework that is both free and designed to build custom hyperchains (ZK-powered L2s and L3s), based on the code of zkSync Era, the first hyperchain.
ZK Stack is a modular framework for building sovereign ZK-powered Ethereum rollups (called ZK Chains); it is a modular, open-source framework that is both free and designed to build custom ZK Chains (ZK-powered L2s and L3s), based on the code of zkSync Era, the first ZK Chain.

At its core, the ZK Stack offers two key features: sovereignty and seamless connectivity. The creator (you) possesses full rights to the code and enjoys unrestricted autonomy to customize and shape many aspects of your chain. Hyperchains operate independently but are interconnected by a network of hyperbridges, enabling trustless, fast (within minutes), and cheap (cost of a single transaction) interoperability.
At its core, the ZK Stack offers two key features: sovereignty and seamless connectivity. The creator (you) possesses full rights to the code and enjoys unrestricted autonomy to customize and shape many aspects of your chain. ZK Chains operate independently but are interconnected by a network of hyperbridges, enabling trustless, fast (within minutes), and cheap (cost of a single transaction) interoperability.
4 changes: 2 additions & 2 deletions docs/zk-stack/components/portal-wallet-bridge.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ head:

# Portal + Bridge

[The Portal](https://github.com/matter-labs/dapp-portal) is a dApp that allows you (and your users) to easily interact with your hyperchain.
[The Portal](https://github.com/matter-labs/dapp-portal) is a dApp that allows you (and your users) to easily interact with your ZK Chain.

This includes:

- Bridging assets to and from the L1,
- Sending them within your hyperchain,
- Sending them within your ZK Chain,
- Checking historical transactions, and
- Managing contracts

Expand Down
Loading

0 comments on commit f80f1c9

Please sign in to comment.