Skip to content

Commit

Permalink
Docs: update stale package links + unused info (#2)
Browse files Browse the repository at this point in the history
* Docs: update stale package links + unused info

* docs: delete unused test info
  • Loading branch information
Evalir authored Feb 4, 2021
1 parent b0baf85 commit d5c9125
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 12 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ Smart contracts and additional resources for the Wrapped POKT Token, forked from

This repo contains the package for the wPOKT contract:

- [`wPOKT`](packages/wPOKT): the latest wPOKT token contract. [Check it out](packages/v2/contracts/wPOKT.sol)
- [`wPOKT`](packages/wPOKT): the latest wPOKT token contract. [Check it out](packages/wPOKT/contracts/wPOKT.sol)

## Important contract info

### wPOKT

- [wPOKT.sol](packages/v2/contracts/wPOKT.sol): Main contract for the token. Lightweight and supports [ERC-2612](https://eips.ethereum.org/EIPS/eip-2612), [ERC-3009](https://eips.ethereum.org/EIPS/eip-3009), token mints, and token burns.
- [wPOKT.sol](packages/wPOKT/contracts/wPOKT.sol): Main contract for the token. Lightweight and supports [ERC-2612](https://eips.ethereum.org/EIPS/eip-2612), [ERC-3009](https://eips.ethereum.org/EIPS/eip-3009), token mints, and token burns.

11 changes: 1 addition & 10 deletions packages/wPOKT/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,14 @@ yarn install
yarn test
```

This will compile the mocks in [`mocks/`](mocks/) and run the [unit tests](test/).
This will run the [unit tests](test/).

CI for this package is run through the [`ci_v2` Github action](../../.github/workflows/ci_v2.yml).

### Code style

To limit changes, [`wPOKT.sol`](contracts/wPOKT.sol) carries over the code style of the original `ANTv2` codebase.

## E2E tests

[E2E tests](e2e) are performed through a Ganache-based fork of mainnet state. To run them:

```sh
FORK_NODE=<URL of mainnet RPC> yarn test:e2e:pre-deploy
FORK_NODE=<URL of mainnet RPC> yarn test:e2e:post-deploy
```

## Credits

- UNI-LP: Uniswap
Expand Down

0 comments on commit d5c9125

Please sign in to comment.