Skip to content

Commit

Permalink
chore: update proj structure for zksync 101 and qs (#73)
Browse files Browse the repository at this point in the history
# What 💻 
* update proj structure for zksync 101 and qs

# Why ✋
* Makes sense

# Evidence 📷
Include screenshots, screen recordings, or `console` output here
demonstrating that your changes work as intended

<!-- All sections below are optional. You can uncomment any section
applicable to your Pull Request. -->

<!-- # Notes 📝
* Any notes/thoughts that the reviewers should know prior to reviewing
the code? -->
  • Loading branch information
dutterbutter authored May 17, 2024
1 parent 23bc172 commit d68785a
Show file tree
Hide file tree
Showing 42 changed files with 40 additions and 41 deletions.
12 changes: 6 additions & 6 deletions content/00.build/00.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,17 @@ configure your wallet with the network. To add zkSync Era, see [Connect to zkSyn
::card-group
::card
---
title: zkSync 101
icon: i-heroicons-academic-cap-solid
to: /build/zksync-101
title: Quickstart
icon: i-heroicons-rocket-launch-solid
to: /build/quick-start
---
Experience a quick tutorial on building and deploying smart contracts on zkSync Era.
::
::card
---
title: Quickstart
icon: i-heroicons-rocket-launch-solid
to: /build/quick-start
title: zkSync 101
icon: i-heroicons-academic-cap-solid
to: /build/zksync-101
---
Learn to build projects locally for zkSync Era using zksync-cli.
::
Expand Down
2 changes: 1 addition & 1 deletion content/00.build/01.connect-to-zksync.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ To manually add zkSync Era as a custom network in your wallet, follow these step

## Funding your wallet

Once you have your wallet connected to a zkSync Era environment, [get testnet funds](/ecosystem/network-faucets) and [deploy your first smart contract](/build/zksync-101/deploy-your-first-contract)
Once you have your wallet connected to a zkSync Era environment, [get testnet funds](/ecosystem/network-faucets) and [deploy your first smart contract](/build/quick-start/deploy-your-first-contract)
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ to help you learn as quickly and efficiently as possible.
## Get started

- If you haven't already added zkSync Era to your wallet, follow the instructions in [Connect zkSync Era to your wallet](/build/connect-to-zksync).
- Continue to [Deploy your first contract](/build/zksync-101/deploy-your-first-contract) to learn how to use Remix or Atlas
- Continue to [Deploy your first contract](/build/quick-start/deploy-your-first-contract) to learn how to use Remix or Atlas
to deploy a contract onto zkSync Era.
- If you are familiar with zkSync Era and want to develop using `zksync-cli` locally
on your machine, you can jump over to the [Quickstart](/build/quick-start) section.
on your machine, you can jump over to the [zkSync 101](/build/zksync-101) section.
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ ZK is the endgame ✌️

## Next steps

- Continue learning by [deploying an ERC20 token to zkSync](/build/zksync-101/erc20-token).
- Continue learning by [deploying an ERC20 token to zkSync](/build/quick-start/erc20-token).
- Join the [zkSync developer community in Discord](https://join.zksync.dev/) where you can ask any questions about this tutorial in the #dev-101
channel
- Join our [GitHub Discussions Community](%%zk_git_repo_zksync-developers%%/discussions/) to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,6 @@ items: [{

- Join the [zkSync developer community in Discord](https://join.zksync.dev/) where you can ask any questions about this tutorial in the #dev-101
channel
- Continue learning about [paymasters and paying fees with this ERC20 token](/build/zksync-101/paymasters-introduction).
- Continue learning about [paymasters and paying fees with this ERC20 token](/build/quick-start/paymasters-introduction).
- Join our [GitHub Discussions Community](%%zk_git_repo_zksync-developers%%/discussions/) to
help other devs building on zkSync or share your project.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Learn about paymasters and use one to pay transaction fees with you
---

This tutorial makes use of smart contracts deployed in the previous two tutorials,
[Deploy your first contract](/build/zksync-101/deploy-your-first-contract) and [Create an ERC20 token](/build/zksync-101/erc20-token).
[Deploy your first contract](/build/quick-start/deploy-your-first-contract) and [Create an ERC20 token](/build/quick-start/erc20-token).
This section introduces one of the custom features
of zkSync: native account abstraction and paymasters.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
title: Quickstart
layout: docs
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,8 @@ Finally we retrieve and print the ETH and ERC20 balances to see how they’ve ch
## Run the script

To run the script, first enter the addresses of the `ZeekSecretMessages.sol` and `TestToken.sol` contracts that we
deployed previously ([Deploy your first contract](/build/zksync-101/deploy-your-first-contract) and
[Erc20 Token](/build/zksync-101/erc20-token)) in the following variables at the beginning of
deployed previously ([Deploy your first contract](/build/quick-start/deploy-your-first-contract) and
[Erc20 Token](/build/quick-start/erc20-token)) in the following variables at the beginning of
the script:

```typescript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,8 @@ Finally we retrieve and print the ETH and ERC20 balances to see how they’ve ch
## Run the script

To run the script, first enter the addresses of the `ZeekSecretMessages.sol` and `TestToken.sol` contracts that we
deployed previously ([Deploy your first contract](/build/zksync-101/deploy-your-first-contract) and
[Erc20 Token](/build/zksync-101/erc20-token)) in the following variables at the beginning of
deployed previously ([Deploy your first contract](/build/quick-start/deploy-your-first-contract) and
[Erc20 Token](/build/quick-start/erc20-token)) in the following variables at the beginning of
the script:

```typescript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,6 @@ To deploy contracts, you'll need to securely add your wallet's private key to th
You should now have a fully working local environment to build new projects on zkSync!
- Continue to [Hello zkSync!](/build/quick-start/hello-zksync) to begin the series on building a crowdfunding campaign for Zeek.
- Continue to [Hello zkSync!](/build/zksync-101/hello-zksync) to begin the series on building a crowdfunding campaign for Zeek.
- This setup provides you everything you need to build in zkSync.
You can skip on to creating your own projects using `zksync-cli` with your fully set up local dev environment.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Let's dive in and start your developer journey on zkSync!

This Quickstart series requires some initial setup of tools to elevate your
development experience building for zkSync.
Make sure to go through the setup provided in the initial [Getting started](/build/quick-start) section.
Make sure to go through the setup provided in the initial [Getting started](/build/zksync-101) section.

Select the framework you want to get started using zkSync Era with.

Expand Down Expand Up @@ -49,7 +49,7 @@ Having successfully deployed your first contract on zkSync, you're well on your
a proficient zkSync developer. To expand your expertise:

- **Explore Contract Factories:** Enhance your project by building a contract factory
for the `CrowdfundingCampaign` contract in the [next guide](/build/quick-start/contract-factory). This will allow you to efficiently
for the `CrowdfundingCampaign` contract in the [next guide](/build/zksync-101/contract-factory). This will allow you to efficiently
manage multiple crowdfunding campaigns, each with its own unique parameters.
- **Dive Deeper into zkSync Features:** Investigate advanced zkSync features such as account abstraction,
and paymasters.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ that enhance the testing process.
With a solid foundation in contract testing, you're well-equipped to advance your zkSync
development journey. Consider the following steps to further your expertise:

- **Upgradeability**: Dive into the [Upgradeability article](/build/quick-start/upgrading) focusing on contract upgradeability.
- **Upgradeability**: Dive into the [Upgradeability article](/build/zksync-101/upgrading) focusing on contract upgradeability.
Learning to make your contracts upgradeable will enable you to update and improve your smart contracts
over time without losing state or funds.
- **Advanced zkSync Integrations:** Explore deeper into zkSync's ecosystem by
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ functionalities evolve. This approach provides a resilient framework for your dA

## Next Steps

- **Exploring Paymasters:** Continue on to the next guide focused on [using paymasters](/build/quick-start/paymaster)
- **Exploring Paymasters:** Continue on to the next guide focused on [using paymasters](/build/zksync-101/paymaster)
with your smart contracts. Paymasters abstract gas payments in transactions,
offering new models for transaction fee management and enhancing user experience in dApps.
- **Advanced zkSync Integrations:** Explore deeper into zkSync's ecosystem by
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ cd foundry-contract-factory-quickstart

## Set up your wallet

:display-partial{path="build/quick-start/_partials/_setup-wallet"}
:display-partial{path="build/zksync-101/_partials/_setup-wallet"}

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ cd contract-factory-quickstart

## Set up your wallet

:display-partial{path="build/quick-start/_partials/_setup-wallet"}
:display-partial{path="build/zksync-101/_partials/_setup-wallet"}

---

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ cd hello-zksync-foundry-quickstart

## Set up your wallet

:display-partial{path = "/build/quick-start/_partials/_setup-wallet"}
:display-partial{path = "/build/zksync-101/_partials/_setup-wallet"}

## Compile your first contract

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ cd hello-zksync-quickstart

## Set up your wallet

:display-partial{path="build/quick-start/_partials/_setup-wallet"}
:display-partial{path="build/zksync-101/_partials/_setup-wallet"}

## Compile the CrowdfundingCampaign.sol contract

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ title: Set up your wallet
Deploying contracts on the %%zk_testnet_name%% requires having testnet ETH.
If you're working within the local development environment,
you can utilize pre-configured rich wallets and skip this step.
For testnet deployments, you should have your wallet funded from the [previous step](/build/quick-start#fund-your-wallet).
For testnet deployments, you should have your wallet funded from the [previous step](/build/zksync-101#fund-your-wallet).

Ensure your project is configured to [use your wallet via the `.env` file](/build/quick-start#configure-your-wallet-in-a-project).
Ensure your project is configured to [use your wallet via the `.env` file](/build/zksync-101#configure-your-wallet-in-a-project).
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ cd contract-paymaster-quickstart

## Set up your wallet

:display-partial{path = "/build/quick-start/_partials/_setup-wallet"}
:display-partial{path = "/build/zksync-101/_partials/_setup-wallet"}

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ cd contract-paymaster-quickstart

## Set up your wallet

:display-partial{path = /build/quick-start/_partials/_setup-wallet"}
:display-partial{path = /build/zksync-101/_partials/_setup-wallet"}

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ While setting up a local development environment was previously optional, testin
a more structured setup. We'll use `hardhat-zksync` to run tests against an In-memory node,
which operates seamlessly within a separate process for an optimized testing workflow.

If you have not set up your local era node yet, follow the instructions in the [Getting Started](/build/quick-start#setup-era-local-node-optional) section.
If you have not set up your local era node yet, follow the instructions in the [Getting Started](/build/zksync-101#setup-era-local-node-optional) section.

Within the `hardhat.config.ts`, you'll observe the `zksync` flag set to `true` under the
`hardhat` network, indicating the integration with zkSync's testing environment.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ cd contract-upgrade-quickstart

## Set up your wallet

:display-partial{path = "/build/quick-start/_partials/_setup-wallet"}
:display-partial{path = "/build/zksync-101/_partials/_setup-wallet"}

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ cd contract-upgrade-quickstart

## Set up your wallet

:display-partial{path = "build/quick-start/_partials/_setup-wallet"}
:display-partial{path = "build/zksync-101/_partials/_setup-wallet"}

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ cd contract-upgrade-quickstart

## Set up your wallet

:display-partial{path="build/quick-start/_partials/_setup-wallet"}
:display-partial{path="build/zksync-101/_partials/_setup-wallet"}

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To use the `hardhat-zksync-deploy` in your project, we recommend that:
- You have a Node installation and `yarn` or `npm` package manager.
- You are already familiar with deploying smart contracts on zkSync Era.

If not, please refer to the first section of the [quickstart material](/build/quick-start/hello-zksync).
If not, please refer to the first section of the [zkSync 101 material](/build/zksync-101/hello-zksync).

- A wallet with sufficient Sepolia `ETH` on Ethereum and %%zk_testnet_name%% to pay for deploying smart contracts on testnet.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,6 @@ allowed to increment their nonces by calling this contract. That's why the calls
most of the non-view methods of the nonce holder were restricted to be called only
with a special `isSystem` flag, so that interactions with important system contracts could be consciously managed by the developer of the account.

The same applies to the [ContractDeployer](20.system-contracts.md#contractdeployer--immutablesimulator) system contract. This
The same applies to the `ContractDeployer` system contract. This
means that, for instance, you would need to explicitly allow your users to deploy
contracts, as it is done in the DefaultAccount's [implementation](https://github.com/matter-labs/era-contracts/blob/6250292a98179cd442516f130540d6f862c06a16/system-contracts/contracts/DefaultAccount.sol#L125).
Original file line number Diff line number Diff line change
Expand Up @@ -109,14 +109,14 @@ A callout should not contain anything essential to understanding the main conten

#### Example
::callout{icon="i-heroicons-exclamation-triangle" color="amber"}
This is a `callout` with full **markdown** support. It can be used to link to [another page](/build/quick-start).
This is a `callout` with full **markdown** support. It can be used to link to [another page](/build/zksync-101).
::

#### Code

```md
::callout{icon="i-heroicons-exclamation-triangle" color="amber"}
This is a `callout` with full **markdown** support. It can be used to link to [another page](/build/quick-start).
This is a `callout` with full **markdown** support. It can be used to link to [another page](/build/zksync-101).
::
```

Expand Down Expand Up @@ -181,7 +181,7 @@ For example, the file `/content/1.quick-start/2.deploy-contract.md` is defined a
Link to internal pages using markdown format.

```md
[Getting Started](/build/quick-start)
[Getting Started](/build/zksync-101)
```

### Anchor Tags
Expand All @@ -191,7 +191,7 @@ Link to the page the anchor point is located in and add
the name of the anchor tag separated by dashes.

```md
[Getting Started](/build/quick-start)
[Getting Started](/build/zksync-101)
```

## Localization
Expand Down
2 changes: 1 addition & 1 deletion content/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ features:
- title: 'Getting Started with zkSync'
description: 'Jumpstart your zkSync journey with quickstart guides and fundamental concepts for developers.'
icon: 'i-zksync-zksync-logo'
to: '/build/zksync-101'
to: '/build/quick-start'
- title: 'Develop with zksync-cli'
description: 'Boost your development workflow with the zksync-cli tool.'
icon: 'i-simple-icons-windowsterminal'
Expand Down

0 comments on commit d68785a

Please sign in to comment.