Skip to content

Commit

Permalink
updating README
Browse files Browse the repository at this point in the history
  • Loading branch information
signorecello committed Feb 19, 2024
1 parent fab501a commit 45a3c8a
Showing 1 changed file with 9 additions and 18 deletions.
27 changes: 9 additions & 18 deletions vite-hardhat/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,11 @@ In the meantime, follow these simple steps to work on your own machine:
yarn
```

## Generate verifier contract
6. Generate the verifier contract

### Contract

The deployment assumes a verifier contract has been generated by nargo. In order to do this, run:

```bash
cd circuits
nargo codegen-verifier
```

A file named `plonk_vk.sol` should appear in the `circuit/contracts/noirstarter` folder.
```bash
yarn prep
```

### Test locally

Expand All @@ -70,9 +63,7 @@ The test demonstrates basic usage of Noir in a TypeScript Node.js environment.

### Deploy locally

1. Copy `vite-hardhat/.env.example` to a new file `vite-hardhat/.env`.

2. Start a local development EVM at <http://localhost:8545> with
1. Start a local development EVM at <http://localhost:8545> with

```bash
npx hardhat node
Expand All @@ -84,13 +75,13 @@ The test demonstrates basic usage of Noir in a TypeScript Node.js environment.
anvil
```

3. Build the project and deploy contracts to the local development chain with
2. Build the project and deploy contracts to the local development chain with

```bash
yarn build
```

4. Once your contracts are deployed and the build is finished, you can preview the built website with
3. Once your contracts are deployed and the build is finished, you can preview the built website with

```bash
yarn preview
Expand All @@ -100,7 +91,7 @@ The test demonstrates basic usage of Noir in a TypeScript Node.js environment.

For convenience, we added two configurations for deployment on various testnets. You can find them in `hardhat.config.cts`.

To deploy on these testnets, copy the `.env.example` and add your own [alchemy](https://www.alchemy.com/) keys for these networks.
To deploy on these testnets, rename `.env.example` to `.env` and add your own [alchemy](https://www.alchemy.com/) keys for these networks.

Then, prepend your commands with your desired network in a `NETWORK` environment variable. For example, to deploy on sepolia:

Expand All @@ -110,6 +101,6 @@ NETWORK=sepolia yarn build`

Feel free to add more networks, just make sure you:

- Add deployer private keys and alchemy API keys in `vite-hardhat/.env`
- Add deployer private keys and alchemy API keys in `.env`
- Have funds in these accounts
- Add a configuration in `hardhat.config.cts`

0 comments on commit 45a3c8a

Please sign in to comment.