update README

This commit is contained in:
Andrea Franz 2022-02-07 01:38:06 +01:00
parent 6836a83f56
commit 9d210445ef
No known key found for this signature in database
GPG Key ID: 4F0D2F2D9DE7F29D
2 changed files with 50 additions and 46 deletions

View File

@ -1,48 +1,4 @@
# Status ENS Airdrop
## Setup
`git@github.com:status-im/status-ens-airdrop.git`
`cd status-end-airdrop`
`yarn`
## Compile Smart Contracts
`npx hardhat compile`
## Deploy the StatusENSAirdrop
`npx hardhat run scripts/deploy/deploy.js`
It will shoe the following output:
```
chainId: 31337
network: [NETWORK_NAME]
account: 0x...
account balance: 10000000000000000000000 ( 10000.0 )
MERKLE_ROOT: 0x...
do you want to deploy the StatusENSAirdrop contract? [y/n]: y
```
Write `y` or `yes` to confirm.
```
StatusENSAirdrop deployed to: 0x...
```
## Test
`TODO`
## TODO
- [x] Airdrop Contract
- [ ] Airdrop Contract unit tests
- [x] Deploy script
- [ ] Script to send ENS tokens to the contract
- [ ] Integration test script with ethereum fork
- [ ] Client app
[Client DOCS](./client/README.md)
[Contracts DOCS](./contracts/README.md)

48
contracts/README.md Normal file
View File

@ -0,0 +1,48 @@
# Status ENS Airdrop / Contracts
## Setup
`git@github.com:status-im/status-ens-airdrop.git`
`cd status-end-airdrop/contracts`
`yarn`
## Compile Smart Contracts
`npx hardhat compile`
## Deploy the StatusENSAirdrop
`npx hardhat run scripts/deploy/deploy.js`
It will shoe the following output:
```
chainId: 31337
network: [NETWORK_NAME]
account: 0x...
account balance: 10000000000000000000000 ( 10000.0 )
MERKLE_ROOT: 0x...
do you want to deploy the StatusENSAirdrop contract? [y/n]: y
```
Write `y` or `yes` to confirm.
```
StatusENSAirdrop deployed to: 0x...
```
## Test
`TODO`
## TODO
- [x] Airdrop Contract
- [ ] Airdrop Contract unit tests
- [x] Deploy script
- [ ] Script to send ENS tokens to the contract
- [ ] Integration test script with ethereum fork
- [ ] Client app