@@ -4,8 +4,12 @@ These are convenience scripts for interacting with the contracts.
4
4
5
5
The scripts expect a ` .env ` file with the following setup:
6
6
```
7
- INFURA_KEY= <INSERT_INFURA_API_KEY>
8
- MNEMONIC= <INSERT_12_WORD_MNEMONIC>
7
+ MNEMONIC=
8
+ ETHERSCAN_API_KEY=
9
+ INFURA_KEY=
10
+ ADDRESS_BOOK="addresses.json"
11
+ GRAPH_CONFIG=""graph.config.yml""
12
+ PROVIDER_URL="http://localhost:8545"
9
13
```
10
14
11
15
Also, run the following:
@@ -19,9 +23,18 @@ the script calls.
19
23
## Usage
20
24
There are two aspects to the CLI right now
21
25
- ` /cli `
22
- - This folder is a CLI that allows for deploying contracts to ethereum networks
23
- - ` /contracts `
24
- - This is a CLI that allows for single calls to interact with deployed contracts
25
- - It also has ` populateData ` , which calls all functions the subgraph ingests, so that whenever
26
- contracts are lauched on a new network, we can quickly test, and get the front end filled
27
- with data. This data is in ` /mockdata `
26
+ - This folder is a CLI that allows for deploying contracts to ethereum networks. It uses yargs
27
+ - ` cli/cli.ts `
28
+ - This is the main entry point for the CLI
29
+ - ` /cli/contracts `
30
+ - This has functions to call the contract functions directly to interact on chain
31
+ - ` /cli/scenarios `
32
+ - This is where scenarios live. Scenarios are pre-planned interactions of many txs on chain.
33
+ They are useful for populating data in our contracts to see the subgraph, or to simulate
34
+ real world scenarios on chain
35
+ - There are also single files that provide a command for the cli, which are:
36
+ - ` deploy.ts ` - helper to deploy a single contract
37
+ - ` migrate.ts ` - helper to migrate all contracts for a new network on chain
38
+ - ` protocol.ts ` - set or get with any protocol parameter on any contract
39
+ - ` mintTeamTokens.ts ` - mint tokens for the whole team for testing purposes
40
+ - ` verify.ts ` - verify a contract is on chain
0 commit comments