Skip to content

Commit b152afe

Browse files
authored
Merge pull request #211 from filecoin-project/dev
Update readme.
2 parents 8d59979 + c53e7c0 commit b152afe

File tree

1 file changed

+4
-7
lines changed

1 file changed

+4
-7
lines changed

README.md

+4-7
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,10 @@ The specification for the on chain voting tool can be found [in this Google Doc]
1515
The system at a high level is composed of a few core components, each listed in a separate folder:
1616

1717
- [**docs**](https://github.com/filecoin-project/on-chain-voting/tree/main/docs): Documentation
18-
- [**power-oracle-contracts**](https://github.com/filecoin-project/on-chain-voting/tree/main/power-oracle-contracts): Contains smart contracts for the Oracle contract functionality, which stores voter info, miner id mappings, and other shared state.
19-
- [**power-oracle-node**](https://github.com/filecoin-project/on-chain-voting/tree/main/power-oracle-node): Contains the code for the Oracle nodes that power the Oracle contract
20-
- [**power-snapshot**](https://github.com/filecoin-project/on-chain-voting/tree/main/power-snapshot): Contains code for the snapshot service, used to take and store snapshots of key data for later use in calculating vote power.
21-
- [**power-voting**](https://github.com/filecoin-project/on-chain-voting/tree/main/power-voting): Contains the frontend dApp code that runs the UI, timelock encypts vote data, and stores proposals and ecnypted data in web3.storage.
22-
- [**powervoting-backend**](https://github.com/filecoin-project/on-chain-voting/tree/main/powervoting-backend): The powervoting backend contains code necessary to sync proposals and votes, decode all votes once the timelock encryption has expired, and calculate the final result based on the power of each respective vote. Everything this service does should be independently verifiable using on chain data.
23-
- [**powervoting-contracts**](https://github.com/filecoin-project/on-chain-voting/tree/main/powervoting-contracts): Contains smart contracts used for the core Power Voting functionality, including managing FIP Editors, creating proposals, and casting votes.
24-
- [**ucan-utils**](https://github.com/filecoin-project/on-chain-voting/tree/main/ucan-utils): Contains utility functions for UCAN delegations, which is currently used for delegating voting rights, associated miner addresses, and associating github accounts with a wallet.
18+
- [**snapshot**](https://github.com/filecoin-project/on-chain-voting/tree/main/snapshot): Contains code for the snapshot service, used to take and store snapshots of key data for later use in calculating vote power.
19+
- [**frontend**](https://github.com/filecoin-project/on-chain-voting/tree/main/frontend): Contains the frontend dApp code that runs the UI, timelock encypts vote data, and stores proposals and ecnypted data in web3.storage.
20+
- [**backend**](https://github.com/filecoin-project/on-chain-voting/tree/main/backend): The powervoting backend contains code necessary to sync proposals and votes, decode all votes once the timelock encryption has expired, and calculate the final result based on the power of each respective vote. Everything this service does should be independently verifiable using on chain data.
21+
- [**contracts**](https://github.com/filecoin-project/on-chain-voting/tree/main/contracts): Contains smart contracts used for the core Power Voting functionality, including managing FIP Editors, creating proposals, and casting votes.
2522

2623
### Testing
2724
Each component of the overall system is tested using a go test suite (or [`forge`](https://github.com/foundry-rs/foundry), in the case of smart contracts). The test suite for each component is run by CI anytime the code in that subfolder changes. You can view test history on theGithub actions page: https://github.com/filecoin-project/on-chain-voting/actions

0 commit comments

Comments
 (0)