Skip to content

Commit

Permalink
fix: update commands for quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
dutterbutter committed May 16, 2024
1 parent dce9eba commit f924bfd
Show file tree
Hide file tree
Showing 8 changed files with 65 additions and 64 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ Upon successful compilation, you'll receive output detailing the
of Solidity files compiled.

```bash
Compiling contracts for zkSync Era with zksolc v1.4.0 and solc v0.8.17
Compiling 2 Solidity file
Successfully compiled 2 Solidity file
Compiling contracts for zkSync Era with zksolc v1.4.1 and solc v0.8.17
Compiling 15 Solidity files
Successfully compiled 15 Solidity files
```

The compiled artifacts will be located in the `/artifacts-zk` folder.
Expand Down Expand Up @@ -141,9 +141,9 @@ deploys to the configured network in your Hardhat setup. For local deployment, a
::code-group

```bash [npm]
npm run hardhat deploy-zksync --script deployUsingFactory.ts
npx hardhat deploy-zksync --script deployUsingFactory.ts
# To deploy the contract on local in-memory node:
# npm run hardhat deploy-zksync --script deployUsingFactory.ts --network inMemoryNode
# npx hardhat deploy-zksync --script deployUsingFactory.ts --network inMemoryNode
```

```bash [yarn]
Expand All @@ -153,9 +153,9 @@ yarn hardhat deploy-zksync --script deployUsingFactory.ts
```

```bash [pnpm]
pnpm run hardhat deploy-zksync --script deployUsingFactory.ts
pnpx exec hardhat deploy-zksync --script deployUsingFactory.ts
# To deploy the contract on local in-memory node:
# pnpm run hardhat deploy-zksync --script deployUsingFactory.ts --network inMemoryNode
# pnpx exec hardhat deploy-zksync --script deployUsingFactory.ts --network inMemoryNode
```

```bash [bun]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ Upon successful compilation, you'll receive output detailing the
of Solidity files compiled.

```bash
Compiling contracts for zkSync Era with zksolc v1.4.0 and solc v0.8.17
Compiling 1 Solidity file
Successfully compiled 1 Solidity file
Compiling contracts for zkSync Era with zksolc v1.4.1 and solc v0.8.17
Compiling 15 Solidity files
Successfully compiled 15 Solidity files
```

The compiled artifacts will be located in the `/artifacts-zk` folder.
Expand Down Expand Up @@ -124,28 +124,28 @@ deploys to the configured network in your Hardhat setup. For local deployment, a
::code-group

```bash [npm]
npm run deploy
npx hardhat deploy-zksync --script deploy.ts
# The deploy keyword will trigger the `deploy` script command on `package.json`
# To deploy the contract on local in-memory node:
# npm run hardhat deploy-zksync --script deploy.ts --network inMemoryNode
# npx hardhat deploy-zksync --script deploy.ts --network inMemoryNode
```

```bash [yarn]
yarn deploy
yarn hardhat deploy-zksync --script deploy.ts
# The deploy keyword will trigger the `deploy` script command on `package.json`
# To deploy the contract on local in-memory node:
# yarn hardhat deploy-zksync --script deploy.ts --network inMemoryNode
```

```bash [pnpm]
pnpm run deploy
pnpx exec hardhat deploy-zksync --script deploy.ts
# The deploy keyword will trigger the `deploy` script command on `package.json`
# To deploy the contract on local in-memory node:
# pnpm run hardhat deploy-zksync --script deploy.ts --network inMemoryNode
# pnpx exec hardhat deploy-zksync --script deploy.ts --network inMemoryNode
```

```bash [bun]
bun run deploy
bun run hardhat deploy-zksync --script deploy.ts
# The deploy keyword will trigger the `deploy` script command on `package.json`
# To deploy the contract on local in-memory node:
# bun run hardhat deploy-zksync --script deploy.ts --network inMemoryNode
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -216,9 +216,9 @@ deploys to the configured network in your Hardhat setup. For local deployment, a
::code-group

```bash [npm]
npm run hardhat deploy-zksync --script deployApprovalFlowPaymaster.ts
npx hardhat deploy-zksync --script deployApprovalFlowPaymaster.ts
# To deploy the contract on local in-memory node:
# npm run hardhat deploy-zksync --script deployApprovalFlowPaymaster.ts --network inMemoryNode
# npx hardhat deploy-zksync --script deployApprovalFlowPaymaster.ts --network inMemoryNode
```

```bash [yarn]
Expand All @@ -228,9 +228,9 @@ yarn hardhat deploy-zksync --script deployApprovalFlowPaymaster.ts
```

```bash [pnpm]
pnpm run hardhat deploy-zksync --script deployApprovalFlowPaymaster.ts
pnpx exec hardhat deploy-zksync --script deployApprovalFlowPaymaster.ts
# To deploy the contract on local in-memory node:
# pnpm run hardhat deploy-zksync --script deployApprovalFlowPaymaster.ts --network inMemoryNode
# pnpx exec hardhat deploy-zksync --script deployApprovalFlowPaymaster.ts --network inMemoryNode
```

```bash [bun]
Expand Down Expand Up @@ -378,15 +378,15 @@ Execute the command corresponding to your package manager:
::code-group

```bash [npm]
npm run hardhat deploy-zksync --script interact/interactWithApprovalFlowPaymaster.ts
npx hardhat deploy-zksync --script interact/interactWithApprovalFlowPaymaster.ts
```

```bash [yarn]
yarn hardhat deploy-zksync --script interact/interactWithApprovalFlowPaymaster.ts
```

```bash [pnpm]
pnpm run hardhat deploy-zksync --script interact/interactWithApprovalFlowPaymaster.ts
pnpx exec hardhat deploy-zksync --script interact/interactWithApprovalFlowPaymaster.ts
```

```bash [bun]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -185,9 +185,9 @@ deploys to the configured network in your Hardhat setup. For local deployment, a
::code-group

```bash [npm]
npm run hardhat deploy-zksync --script deployGaslessPaymaster.ts
npx hardhat deploy-zksync --script deployGaslessPaymaster.ts
# To deploy the contract on local in-memory node:
# npm run hardhat deploy-zksync --script deployGaslessPaymaster.ts --network inMemoryNode
# npx hardhat deploy-zksync --script deployGaslessPaymaster.ts --network inMemoryNode
```

```bash [yarn]
Expand All @@ -197,9 +197,9 @@ yarn hardhat deploy-zksync --script deployGaslessPaymaster.ts
```

```bash [pnpm]
pnpm run hardhat deploy-zksync --script deployGaslessPaymaster.ts
pnpx exec hardhat deploy-zksync --script deployGaslessPaymaster.ts
# To deploy the contract on local in-memory node:
# pnpm run hardhat deploy-zksync --script deployGaslessPaymaster.ts --network inMemoryNode
# pnpx exec hardhat deploy-zksync --script deployGaslessPaymaster.ts --network inMemoryNode
```

```bash [bun]
Expand Down Expand Up @@ -329,15 +329,15 @@ Execute the command corresponding to your package manager:
::code-group

```bash [npm]
npm run hardhat deploy-zksync --script interact/interactWithGaslessPaymaster.ts
npx hardhat deploy-zksync --script interact/interactWithGaslessPaymaster.ts
```

```bash [yarn]
yarn hardhat deploy-zksync --script interact/interactWithGaslessPaymaster.ts
```

```bash [pnpm]
pnpm run hardhat deploy-zksync --script interact/interactWithGaslessPaymaster.ts
pnpx exec hardhat deploy-zksync --script interact/interactWithGaslessPaymaster.ts
```

```bash [bun]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,9 @@ Upon successful compilation, you'll receive output detailing the
of Solidity files compiled.

```bash
Compiling contracts for zkSync Era with zksolc v1.4.0 and solc v0.8.17
Compiling 2 Solidity file
Successfully compiled 2 Solidity file
Compiling contracts for zkSync Era with zksolc v1.4.1 and solc v0.8.17
Compiling 15 Solidity files
Successfully compiled 15 Solidity files
```

The compiled artifacts will be located in the `/artifacts-zk` folder.
Expand All @@ -148,8 +148,9 @@ during the initialization step in the `/tests` directory, specifically the
[`crowdFunding.test.ts` file](https://github.com/matter-labs/zksync-contract-templates/blob/main/templates/quickstart/hardhat/testing/test/crowdFunding.test.ts).

```typescript [crowdFunding.test.ts]
import "@nomicfoundation/hardhat-chai-matchers";
import { expect } from "chai";
import { ethers } from "hardhat";
import { ethers } from "ethers";
import { getWallet, LOCAL_RICH_WALLETS, deployContract } from "../deploy/utils";

describe("CrowdfundingCampaign", function () {
Expand Down Expand Up @@ -203,15 +204,15 @@ Execute the test command corresponding to your package manager:
::code-group

```bash [npm]
npm run hardhat test --network hardhat
npx hardhat test --network hardhat
```

```bash [yarn]
yarn hardhat test --network hardhat
```

```bash [pnpm]
pnpm run hardhat test --network hardhat
pnpx exec hardhat test --network hardhat
```

```bash [bun]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,8 @@ of Solidity files compiled.

```bash
Compiling contracts for zkSync Era with zksolc v1.4.0 and solc v0.8.17
Compiling 3 Solidity file
Successfully compiled 3 Solidity file
Compiling 29 Solidity file
Successfully compiled 29 Solidity file
```

The compiled artifacts will be located in the `/artifacts-zk` folder.
Expand Down Expand Up @@ -169,9 +169,9 @@ deploys to the configured network in your Hardhat setup. For local deployment, a
::code-group

```bash [npm]
npm run hardhat deploy-zksync --script deployBeaconProxy.ts
npx hardhat deploy-zksync --script deployBeaconProxy.ts
# To deploy the contract on local in-memory node:
# npm run hardhat deploy-zksync --script deployBeaconProxy.ts --network inMemoryNode
# npx hardhat deploy-zksync --script deployBeaconProxy.ts --network inMemoryNode
```

```bash [yarn]
Expand All @@ -181,9 +181,9 @@ yarn hardhat deploy-zksync --script deployBeaconProxy.ts
```

```bash [pnpm]
pnpm run hardhat deploy-zksync --script deployBeaconProxy.ts
pnpx exec hardhat deploy-zksync --script deployBeaconProxy.ts
# To deploy the contract on local in-memory node:
# pnpm run hardhat deploy-zksync --script deployBeaconProxy.ts --network inMemoryNode
# pnpx exec hardhat deploy-zksync --script deployBeaconProxy.ts --network inMemoryNode
```

```bash [bun]
Expand Down Expand Up @@ -344,15 +344,15 @@ Execute the test command corresponding to your package manager:
::code-group

```bash [npm]
npm run hardhat deploy-zksync --script upgrade-scripts/upgradeBeaconCrowdfundingCampaign.ts
npx hardhat deploy-zksync --script upgrade-scripts/upgradeBeaconCrowdfundingCampaign.ts
```

```bash [yarn]
yarn hardhat deploy-zksync --script upgrade-scripts/upgradeBeaconCrowdfundingCampaign.ts
```

```bash [pnpm]
pnpm run hardhat deploy-zksync --script upgrade-scripts/upgradeBeaconCrowdfundingCampaign.ts
pnpx exec hardhat deploy-zksync --script upgrade-scripts/upgradeBeaconCrowdfundingCampaign.ts
```

```bash [bun]
Expand Down Expand Up @@ -383,15 +383,15 @@ To proceed with verification, execute the following command:
::code-group

```bash [npm]
npm run hardhat verify <BEACON-PROXY-ADDRESS>
npx hardhat verify <BEACON-PROXY-ADDRESS>
```

```bash [yarn]
yarn hardhat verify <BEACON-PROXY-ADDRESS>
```

```bash [pnpm]
pnpm run hardhat verify <BEACON-PROXY-ADDRESS>
pnpx exec hardhat verify <BEACON-PROXY-ADDRESS>
```

```bash [bun]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,15 +94,15 @@ To compile the contracts in the project, run the following command:
::code-group

```bash [npm]
npm run compile
npx run compile
```

```bash [yarn]
yarn compile
```

```bash [pnpm]
pnpm run compile
pnpx run compile
```

```bash [bun]
Expand Down Expand Up @@ -164,9 +164,9 @@ deploys to the configured network in your Hardhat setup. For local deployment, a
::code-group

```bash [npm]
npm run hardhat deploy-zksync --script deployTransparentProxy.ts
npx hardhat deploy-zksync --script deployTransparentProxy.ts
# To deploy the contract on local in-memory node:
# npm run hardhat deploy-zksync --script deployTransparentProxy.ts --network inMemoryNode
# npx hardhat deploy-zksync --script deployTransparentProxy.ts --network inMemoryNode
```

```bash [yarn]
Expand All @@ -176,9 +176,9 @@ yarn hardhat deploy-zksync --script deployTransparentProxy.ts
```

```bash [pnpm]
pnpm run hardhat deploy-zksync --script deployTransparentProxy.ts
pnpx exec hardhat deploy-zksync --script deployTransparentProxy.ts
# To deploy the contract on local in-memory node:
# pnpm run hardhat deploy-zksync --script deployTransparentProxy.ts --network inMemoryNode
# pnpx exec hardhat deploy-zksync --script deployTransparentProxy.ts --network inMemoryNode
```

```bash [bun]
Expand Down Expand Up @@ -262,8 +262,8 @@ of Solidity files compiled.

```bash
Compiling contracts for zkSync Era with zksolc v1.4.0 and solc v0.8.17
Compiling 4 Solidity file
Successfully compiled 4 Solidity file
Compiling 29 Solidity file
Successfully compiled 29 Solidity file
```

The compiled artifacts will be located in the `/artifacts-zk` folder.
Expand Down Expand Up @@ -326,15 +326,15 @@ Execute the command corresponding to your package manager:
::code-group

```bash [npm]
npm run hardhat deploy-zksync --script upgrade-scripts/upgradeCrowdfundingCampaign.ts
npx hardhat deploy-zksync --script upgrade-scripts/upgradeCrowdfundingCampaign.ts
```

```bash [yarn]
yarn hardhat deploy-zksync --script upgrade-scripts/upgradeCrowdfundingCampaign.ts
```

```bash [pnpm]
pnpm run hardhat deploy-zksync --script upgrade-scripts/upgradeCrowdfundingCampaign.ts
pnpx exec hardhat deploy-zksync --script upgrade-scripts/upgradeCrowdfundingCampaign.ts
```

```bash [bun]
Expand Down Expand Up @@ -367,15 +367,15 @@ Replace <PROXY_ADDRESS> with the actual proxy address from your deployment.
::code-group

```bash [npm]
npm run hardhat verify <PROXY-ADDRESS>
npx hardhat verify <PROXY-ADDRESS>
```

```bash [yarn]
yarn hardhat verify <PROXY-ADDRESS>
```

```bash [pnpm]
pnpm run hardhat verify <PROXY-ADDRESS>
pnpx exec hardhat verify <PROXY-ADDRESS>
```

```bash [bun]
Expand Down
Loading

0 comments on commit f924bfd

Please sign in to comment.