modify README.md

This commit is contained in:
jiangyuanshu 2019-08-09 14:19:20 +08:00
parent 0e325a6df8
commit 669f7ac40c
1 changed files with 18 additions and 10 deletions

View File

@ -1,17 +1,17 @@
# sapling-mpc
This code can be used to participate PC phase 2 and verify the result.
This code can be used to participate Multi-party Computation(MPC) phase 2 and verify the result.
## Instructions
Contact **jiangyuanshu@tron.network** to schedule a time to participate and get an index num. You'll need the latest (stable) [Rust compiler](https://www.rust-lang.org/) to participate using this code. When it's your turn, you'll receive a `params` file from us.
Contact **jiangyuanshu@tron.network** to schedule a time to participate and get an index num. When it's your turn, you'll receive a `params` file from us.
1.Download and install IM tool [keybase](https://keybase.io/). if you don't have an account, create it first. you can use tool to send file back to tron foundation. The TronFoundation's keybase account is `tron_brown`.
1.Download and install IM tool [keybase](https://keybase.io/), if you don't have an account, create it first. You can use it to send file back to us later, our keybase account is `tron_brown`.
2.If you are running on macOS, Linux, or another Unix-like OS, download Rustup and install Rust, run the following in your terminal, then follow the on-screen instructions.
2.If you are running on macOS / Linux / another Unix-like OS, download Rustup and install Rust, run the following in your terminal, then follow the on-screen instructions:
```
curl https://sh.rustup.rs -sSf | sh
# curl https://sh.rustup.rs -sSf | sh
```
If you are running on windows, refer to [rust](https://www.rust-lang.org/learn/get-started) homepage for installation.
@ -19,19 +19,27 @@ If you are running on windows, refer to [rust](https://www.rust-lang.org/learn/g
3.Get the source code of project sapling-mpc:
```
git clone https://github.com/tronprotocol/sapling-mpc
# git clone https://github.com/tronprotocol/sapling-mpc
```
if git not installed, please refer to [git](https://git-scm.com/downloads) first.
4.Download [phase_1_files](https://mpcfilepub.oss-us-east-1.aliyuncs.com/powersoftau/phase_1_files.tar), uncompress it into the directory sapling-mpc. Place `params` file in the sapling-mpc directory. Then run:
4.Download [phase_1_files](https://mpcfilepub.s3.amazonaws.com/powersoftau/powersoftau_phase1_files.tar), uncompress it into the directory sapling-mpc.
If running on macOS / Linux / Unix-like OS:
```
cargo run --release --bin compute
# wget https://mpcfilepub.s3.amazonaws.com/powersoftau/powersoftau_phase1_files.tar
# tar xvf phase_1_files.tar
```
The process could take one to four hours according to your hardware, occupies 1.5 ~ 2GB of memory, and then spits out a `new_params` file. The tool also prints a hash. This hash is what you and others can use to verify that your contribution actually ended up in the final parameters.
Place `params` file in the sapling-mpc directory, then run:
5.You are encouraged to save this file `new_params` and upload it back to us with keybase. After we receive this `new_params` file, we will check its correctness and upload it to aliyun cloud if ok, so that next participant can use it. we will also publish the file link and hash on [github wiki]().
```
# cargo run --release --bin compute
```
The process could take one to four hours according to your hardware, occupies 1.5 ~ 2GB of memory, and then spits out a `new_params` file. The process also prints a hash. This hash is what you and others can use to verify that your contribution actually ended up in the final parameters.
5.You are encouraged to send file `new_params` to us with keybase, and send us the hash value and your system configuration information with email, such as os version, cpu model. After we receive this `new_params` file, we will check the correctness of transformation and upload it to amazon storage if ok that next participant can use it, then we will also publish hash on [project wiki](https://github.com/tronprotocol/sapling-mpc/wiki).
## License