You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+26-5Lines changed: 26 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Example Implementations
2
2
3
-
A collection of Solidity contract examples that implement, integrate with or demonstrate the use of Toucan's contracts and infrastructure. Some of these may be used in production.
3
+
A collection of Solidity contract examples that integrate with or demonstrate the use of Toucan's contracts and infrastructure. Some of these may be used in production.
4
4
5
5
## Contracts
6
6
@@ -16,12 +16,33 @@ See [./docs/OffsetHelper.md](./docs/OffsetHelper.md) for detailed documentation.
16
16
17
17
### Development
18
18
19
-
Install the requirements:
19
+
## Preqrequisites
20
+
21
+
1. Install the required packages:
22
+
```
23
+
yarn
24
+
```
25
+
2. Copy `.env.example` to `.env` and modify values of the required environment variables:
26
+
1.`POLYGON_URL`/`MUMBAI_URL` to specify custom RPC endpoints for Polygon Mainnet, respectively, the Mumbai Testnet.
27
+
2.`PRIVATE_KEY` and `POLYGONSCAN_KEY` in order to deploy contract and publish source code on [polygonscan](https://polygonscan.com).
28
+
29
+
## Commands
30
+
31
+
Use the following commands to compile, test and deploy the contracts:
20
32
```
21
-
yarn install
33
+
yarn compile
34
+
yarn test # test using a polygon fork
35
+
yarn coverage # test using a polygon fork with coverage report
36
+
yarn deploy
22
37
```
23
38
24
-
Generate documentation from the contract's [natspec](https://docs.soliditylang.org/en/latest/natspec-format.html) comments in [./docs/](./docs/) using
39
+
Documentation can be auto-generated from the contract's [natspec](https://docs.soliditylang.org/en/latest/natspec-format.html) in [./docs/](./docs/) using
0 commit comments