Skip to content
This repository has been archived by the owner on Dec 18, 2024. It is now read-only.

Commit

Permalink
Update README.md (#19)
Browse files Browse the repository at this point in the history
  • Loading branch information
coffeexcoin authored Dec 18, 2024
1 parent f33c24c commit 3dca842
Showing 1 changed file with 2 additions and 31 deletions.
33 changes: 2 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,3 @@
# Clave ZkSync Contracts
This repository is no longer being updated.

<img src="logo.svg" alt="Clave">

## Project structure

- `/contracts`: smart contracts.
- `/deploy`: deployment and contract interaction scripts.
- `/test`: test files
- `hardhat.config.ts`: configuration file.

## Commands

- `npx hardhat compile` will compile the contracts, typescript bindings are generated automatically.
- `npx hardhat deploy {contract name} {constructor arguments}` will deploy and verify the contract. Requires [environment variable setup](#environment-variables).
- `npm run test`: run tests.

### Environment variables

In order to prevent users to leak private keys, this project includes the `dotenv` package which is used to load environment variables. It's used to load the wallet private key, required to run the deploy script.

To use it, rename `.env.example` to `.env` and enter your private key.

```
PRIVATE_KEY=123cde574ccff....
```

## Official Links

- [Website](https://getclave.io/)
- [GitHub](https://github.com/getclave)
- [Twitter](https://twitter.com/getclave)
Please go to https://github.com/Abstract-Foundation/agw-contracts

0 comments on commit 3dca842

Please sign in to comment.