Skip to content

Commit

Permalink
feat: uses zksync-cli for quickstart templates (#31)
Browse files Browse the repository at this point in the history
Leaving as a DRAFT until the following PRs are merged:
- matter-labs/zksync-cli#132
- matter-labs/zksync-contract-templates#11

# What 💻 
* Uses zksync-cli for quickstart bootstrapping

# Why ✋
* Easiest way to get started

# 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 6, 2024
1 parent 6d32fbc commit c1a9a70
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 217 deletions.
Original file line number Diff line number Diff line change
@@ -1,38 +1,13 @@
---
title: Hardhat | Deploy Contract Factory
---
<!-- TODO: @dutterbutter determine best approach to leverage ZKsync cli for project
bootstrapping for this guide series. -->
Run the following command in your terminal to initialize the project.

```sh
git clone https://github.com/dutterbutter/zksync-quickstart-guide.git
cd zksync-quickstart-guide
git checkout db/contract-factories
npx zksync-cli create --template qs-factories contract-factory-quickstart
cd contract-factory-quickstart
```

Install the dependencies:

::code-group

```bash [npm]
npm install
```

```bash [yarn]
yarn install
```

```bash [pnpm]
pnpm install
```

```bash [bun]
bun install
```

::

## Set up your wallet

:display-partial{path="build/quick-start/_partials/_setup-wallet"}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,36 +4,11 @@ title: Hardhat | Deploy Contract

Run the following command in your terminal to initialize the project.

<!-- TODO: @dutterbutter determine best approach to leverage ZKsync cli for project
bootstrapping for this guide series. -->

```sh
git clone https://github.com/dutterbutter/zksync-quickstart-guide.git
cd zksync-quickstart-guide
```

Install the dependencies:

::code-group

```bash [npm]
npm install
```

```bash [yarn]
yarn install
npx zksync-cli create --template qs-hello-zksync hello-zksync-quickstart
cd hello-zksync-quickstart
```

```bash [pnpm]
pnpm install
```

```bash [bun]
bun install
```

::

## Set up your wallet

:display-partial{path="build/quick-start/_partials/_setup-wallet"}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,39 +3,13 @@ title: Approval Paymaster
description: Learn to deploy contract factories in the ZKsync environment.
---

<!-- TODO: @dutterbutter determine best approach to leverate ZKsync cli for project
bootstrapping for this guide series. -->
Run the following command in your terminal to initialize the project.

```sh
git clone https://github.com/dutterbutter/zksync-quickstart-guide.git
cd zksync-quickstart-guide
git checkout db/contract-paymaster
npx zksync-cli create --template qs-paymaster contract-paymaster-quickstart
cd contract-paymaster-quickstart
```

Install the dependencies:

::code-group

```bash [npm]
npm install
```

```bash [yarn]
yarn install

```

```bash [pnpm]
pnpm install
```

```bash [bun]
bun install
```

::

## Set up your wallet

:display-partial{path = "/build/quick-start/_partials/_setup-wallet"}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,38 +3,13 @@ title: General Paymaster
description: Learn to deploy contract factories in the ZKsync environment.
---

<!-- TODO: @dutterbutter determine best approach to leverate ZKsync cli for project
bootstrapping for this guide series. -->
Run the following command in your terminal to initialize the project.

```sh
git clone https://github.com/dutterbutter/zksync-quickstart-guide.git
cd zksync-quickstart-guide
git checkout db/contract-paymaster
npx zksync-cli create --template qs-paymaster contract-paymaster-quickstart
cd contract-paymaster-quickstart
```

Install the dependencies:

::code-group

```bash [npm]
npm install
```

```bash [yarn]
yarn install
```

```bash [pnpm]
pnpm install
```

```bash [bun]
bun install
```

::

## Set up your wallet

:display-partial{path = /build/quick-start/_partials/_setup-wallet"}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,10 @@ title: Hardhat | Contract Testing
bootstrapping for this guide series. -->
Run the following command in your terminal to initialize the project.

```sh
git clone https://github.com/dutterbutter/zksync-quickstart-guide.git
cd zksync-quickstart-guide
git checkout db/contract-testing
```

Install the dependencies:

::code-group

```bash [npm]
npm install
```

```bash [yarn]
yarn install
```

```bash [pnpm]
pnpm install
```

```bash [bun]
bun install
```

::
```sh
npx zksync-cli create --template qs-testing contract-testing-quickstart
cd contract-testing-quickstart
```

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,38 +2,13 @@
title: Hardhat | Contract Upgrading
---

<!-- TODO: @dutterbutter determine best approach to leverate ZKsync cli for project
bootstrapping for this guide series. -->
Run the following command in your terminal to initialize the project.

```sh
git clone https://github.com/dutterbutter/zksync-quickstart-guide.git
cd zksync-quickstart-guide
git checkout db/contract-upgrade
npx zksync-cli create --template qs-upgrade contract-upgrade-quickstart
cd contract-upgrade-quickstart
```

Install the dependencies:

::code-group

```bash [npm]
npm install
```

```bash [yarn]
yarn install
```

```bash [pnpm]
pnpm install
```

```bash [bun]
bun install
```

::

## Set up your wallet

:display-partial{path = "/build/quick-start/_partials/_setup-wallet"}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,38 +1,13 @@
---
title: Hardhat | Contract Upgrading
---
<!-- TODO: @dutterbutter determine best approach to leverate ZKsync cli for project
bootstrapping for this guide series. -->
Run the following command in your terminal to initialize the project.

```sh
git clone https://github.com/dutterbutter/zksync-quickstart-guide.git
cd zksync-quickstart-guide
git checkout db/contract-upgrade
npx zksync-cli create --template qs-upgrade contract-upgrade-quickstart
cd contract-upgrade-quickstart
```

Install the dependencies:

::code-group

```bash [npm]
npm install
```

```bash [yarn]
yarn install
```

```bash [pnpm]
pnpm install
```

```bash [bun]
bun install
```

::

---

## Set up your wallet
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,38 +2,13 @@
title: Hardhat | Contract Upgrading
---

<!-- TODO: @dutterbutter determine best approach to leverate ZKsync cli for project
bootstrapping for this guide series. -->
Run the following command in your terminal to initialize the project.

```sh
git clone https://github.com/dutterbutter/zksync-quickstart-guide.git
cd zksync-quickstart-guide
git checkout db/contract-upgrade
npx zksync-cli create --template qs-upgrade contract-upgrade-quickstart
cd contract-upgrade-quickstart
```

Install the dependencies:

::code-group

```bash [npm]
npm install
```

```bash [yarn]
yarn install
```

```bash [pnpm]
pnpm install
```

```bash [bun]
bun install
```

::

## Set up your wallet

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

0 comments on commit c1a9a70

Please sign in to comment.