Review and document the Asynchromix + eth example - Githubissues

initc3 / HoneyBadgerMPC

Robust MPC-based confidentiality layer for blockchains

GNU General Public License v3.0

128 stars 64 forks source link

Review and document the Asynchromix + eth example #425

Open sbellem opened 4 years ago

sbellem commented 4 years ago

Note that there's already a work-in-progress PR (:#424) for this but this issue will serve as some kind of checklist of things that need to be done.

Make sure that the Asynchromix example, which uses Ethereum as an MPC coordinator, works as expected. In that process, also document the app a bit. Some documentation can be added to https://github.com/initc3/HoneyBadgerMPC/tree/dev/apps/tutorial#iii-blockchain-integration.

[ ] Address all related open issues (#394, #395, #420).
[ ] Add some docs under https://github.com/initc3/HoneyBadgerMPC/tree/dev/apps/tutorial#iii-blockchain-integration.

Some notes

The class web3.contract.ConciseContract "is deprecated in favor of the ContractCaller API or the verbose syntax."

[ ] Use the ContractCaller API or the verbose syntax instead of ConciseContract. See the deprecation notes and the ContractCaller docs for help.

Perhaps not essential but would be nice ...

[ ] unit tests and/or integration tests -- mostly to prevent regression has the code evolves
[ ] upgrade solidity and node versions in Dockerfile