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

Commit

Permalink
docs: add warning for local-node docker image support (#999)
Browse files Browse the repository at this point in the history
  • Loading branch information
MexicanAce authored Mar 29, 2024
1 parent adff98b commit d840b0e
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 4 deletions.
2 changes: 2 additions & 0 deletions cspell-zksync.txt
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@ Dappradar
Zetta
Zetta
Plonky
Zeeve

// NFT Marketplaces
Kreatorland
Expand Down Expand Up @@ -208,6 +209,7 @@ Invb
REDC
ECADD
ECMUL
raas


// Used programming language words
Expand Down
3 changes: 1 addition & 2 deletions docs/build/sdks/rust/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ async fn main() {

## Connecting to zkSync Era

To interact with the zkSync network users need to know the endpoint of the operator node. In this tutorial, we will be using the `localnet` from [`matter-labs/local-setup`][localnet]. The localnet runs both an Ethereum node (L1) on port `8545` and an Era node (L2) on port `3050`. You can connect to the zkSync Era network using the following code:
To interact with the zkSync network users need to know the endpoint of the operator node. In this tutorial, we will be using the `localnet` from [Dockerized L1 - L2 Nodes](../../test-and-debug/dockerized-l1-l2-nodes.md). The `localnet` runs both an Ethereum node (L1) on port `8545` and an Era node (L2) on port `3050`. You can connect to the zkSync Era network using the following code:

```rust
use zksync_web3_rs::providers::{Http, Middleware, Provider};
Expand Down Expand Up @@ -290,4 +290,3 @@ let withdraw_receipt_l1 = zk_wallet_2.get_eth_provider().unwrap().get_transactio
[sdk]: https://github.com/lambdaclass/zksync-web3-rs/
[ethers]: https://crates.io/crates/ethers
[tokio]: https://tokio.rs/
[localnet]: https://github.com/matter-labs/local-setup
4 changes: 4 additions & 0 deletions docs/build/test-and-debug/dockerized-l1-l2-nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ Welcome to this step-by-step guide on establishing a local testing environment u
1. **Docker and docker-compose**: Ensure that Docker and docker-compose are installed on your machine. If you haven't already installed them, follow the installation [guide](https://docs.docker.com/get-docker/).
2. **zkSync Hardhat plugins**: A foundational understanding of the zkSync Hardhat plugins will be beneficial. New to zkSync development with Hardhat? Explore the getting started section.

:::warning
The `matterlabs/local-node` Docker image is currently based on the protocol `Version19` (deprecated on February 5, 2024), and it will be upgraded in the coming months. It should only be used for testing L1 <-> L2 communication.
:::

### **Setting Up the Testing Environment**

Clone the dockerized zkSync project repository to your local machine:
Expand Down
2 changes: 1 addition & 1 deletion docs/build/tutorials/how-to/send-transaction-l1-l2.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ Along with zkSync Era's built-in censorship resistance that requires multi-layer

User needs to perform next steps:

1. Run local node dockerized containers. [`Instructions how to run it`](https://github.com/matter-labs/local-setup/tree/main) or use [`zksync-cli`](https://github.com/matter-labs/zksync-cli):
1. Run local node dockerized containers. [`Instructions how to run it`](../../test-and-debug/dockerized-l1-l2-nodes.md) or use [`zksync-cli`](https://github.com/matter-labs/zksync-cli):

```npx
npx zksync-cli dev config
Expand Down
2 changes: 1 addition & 1 deletion docs/zk-stack/running-a-hyperchain/raas.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ ZK Stack is still under development. We advise you to only use for local and tes

## Deploying and running using a Rollup as a Service provider

Looking to deploy a ZK Stack chain but worried about complexities? RaaS providers are here to simplify the process! Providers offer scalable and secure nodes, and may provide quick and user-friendly interfaces, allowing you to deploy your ZK Stack chain with ease and efficiency. Experience the seamless integration of advanced blockchain technology without the hassle. Get started today and revolutionise your product with the power of RaaS and ZK Stack!
Looking to deploy a ZK Stack chain but worried about complexities? RaaS providers are here to simplify the process! Providers offer scalable and secure nodes, and may provide quick and user-friendly interfaces, allowing you to deploy your ZK Stack chain with ease and efficiency. Experience the seamless integration of advanced blockchain technology without the hassle. Get started today and revolutionize your product with the power of RaaS and ZK Stack!

Use RaaS in to improve scalability, reduce costs, access specialized services, speed up development, enhance interoperability, and maintain flexibility in an ever-evolving technological landscape.

Expand Down

0 comments on commit d840b0e

Please sign in to comment.