blob: feaf9e65f7117d4d66dec87780338abd16d17958 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
# Contracts Gen
This package allows you to generate boilerplate TypeScript code and configs for smart contracts packages.
## Installation
`yarn add -g @0x/contracts-gen`
## Usage
Run it from within your smart contracts packages.
```bash
contracts-gen
```
You should run this tool after each time you move your contracts around to regenerate boilerplate code and configs.
## What can it generate
This tool does the following:
- Reads your `compiler.json`. Specifically the list of smart contracts.
- Creates `wrapper.ts` file which exports all contract wrappers.
- Creates `artifacts.ts` file which exports all contract artifacts.
- Generates list of JSON artifact files in `tsconfig.json`
- Generates a glob for abi-gen in `package.json`
On top of that - if your `compiler.json` has contracts referenced just by name - it will resolve the name to relative path and put it there.
It also sorts all the lists in it's output leading to smaller and cleaner diffs.
## Contributing
We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.
Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
### Install dependencies
If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
```bash
yarn config set workspaces-experimental true
```
Then install dependencies
```bash
yarn install
```
### Build
To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
```bash
PKG=@0x/contracts-gen yarn build
```
Or continuously rebuild on change:
```bash
PKG=@0x/contracts-gen yarn watch
```
### Clean
```bash
yarn clean
```
### Lint
```bash
yarn lint
```
|
