This repository has been archived by the owner on Dec 18, 2024. It is now read-only.
forked from getclave/clave-contracts
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f33c24c
commit 3dca842
Showing
1 changed file
with
2 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |