1 | ## ethereum-types
|
2 |
|
3 | TypeScript types shared across Ethereum-related packages/libraries/tools.
|
4 |
|
5 | ## Installation
|
6 |
|
7 | ```bash
|
8 | yarn add -D ethereum-types
|
9 | ```
|
10 |
|
11 | ## Usage
|
12 |
|
13 | ```javascript
|
14 | import { TransactionReceipt, TxData, TxDataPayable } from 'ethereum-types';
|
15 | ```
|
16 |
|
17 | ## Contributing
|
18 |
|
19 | We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.
|
20 |
|
21 | Please read our [contribution guidelines](../../CONTRIBUTING.md) before getting started.
|
22 |
|
23 | ### Install dependencies
|
24 |
|
25 | If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:
|
26 |
|
27 | ```bash
|
28 | yarn config set workspaces-experimental true
|
29 | ```
|
30 |
|
31 | Then install dependencies
|
32 |
|
33 | ```bash
|
34 | yarn install
|
35 | ```
|
36 |
|
37 | ### Build
|
38 |
|
39 | To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:
|
40 |
|
41 | ```bash
|
42 | PKG=ethereum-types yarn build
|
43 | ```
|
44 |
|
45 | Or continuously rebuild on change:
|
46 |
|
47 | ```bash
|
48 | PKG=ethereum-types yarn watch
|
49 | ```
|
50 |
|
51 | ### Clean
|
52 |
|
53 | ```bash
|
54 | yarn clean
|
55 | ```
|
56 |
|
57 | ### Lint
|
58 |
|
59 | ```bash
|
60 | yarn lint
|
61 | ```
|
62 |
|
\ | No newline at end of file |