Skip to content

Commit

Permalink
update "usage" section of README
Browse files Browse the repository at this point in the history
  • Loading branch information
0age committed Mar 24, 2022
1 parent 9407184 commit c29bb52
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 13 deletions.
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,16 +160,22 @@ The following features are good candidates for investigation and potential integ
- **Native support for attempting fulfillment for a group of orders without requiring that every order fulfillment succeeds.** One potential solution would be to implement a `fulfillAvailableOrders` function that iterates over the supplied orders and attempts to transfer all offer items for each order to the fulfiller; if a particular transfer fails, all prior offer item transfers and order status updates for that order would be rolled back and the order would be excluded from the group. Then, remaining consideration items can be aggregated by item type + token + identifier + recipient and transferred from the fulfiller to the recipient.
- **General gas efficiency and code size optimizations.**

## Local Development

1. Installing Packages:
`yarn install`

2. Running Tests:
`REPORT_GAS=true npx hardhat test`

3. Other commands
`npx hardhat coverage`
`npx hardhat compile`
`npx solhint 'contracts/**/*.sol'`
`npx hardhat node`
## Usage

First, install dependencies and compile:
```bash
yarn install
yarn build
```

Next, run linters and tests:
```bash
yarn lint
yarn test
yarn coverage
```

To profile gas usage:
```bash
yarn profile
```
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
"scripts": {
"build": "npx hardhat compile",
"test": "npx hardhat test",
"profile": "REPORT_GAS=true npx hardhat test",
"coverage": "npx hardhat coverage",
"lint": "npx hardhat compile && npx solhint 'contracts/**/*.sol'"
}
Expand Down

0 comments on commit c29bb52

Please sign in to comment.