You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-13Lines changed: 12 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,54 +2,53 @@
2
2
3
3
River's Proof of Reserves implementation in Elixir. This implementation is based on BitMEX's Proof of Reserves Python implementation, found [here](https://github.com/BitMEX/proof-of-reserves-liabilities).
4
4
5
-
This library is used by River to generate its Proof of Liabilities tree and to allow users to download and verify the Proof of Liabilities.
5
+
This library is used by River to generate its Proof of Liabilities tree and to allow users to download and verify the Proof of Liabilities.
6
6
7
7
See River's [Proof of Reserves page](https://river.com/reserves) for more information.
8
8
9
-
## Verifying River's Proof of Reserves
9
+
## Verifying River's Proof of Reserves
10
10
11
11
This library comes with a `verify_liabilities.exs` script that will verify River's Proof of Reserves and the balances of any accounts you provide. The following steps will walk you through the process of verifying River's Proof of Reserves.
12
12
13
13
### 1. Fetch the Proof of Reserves Data
14
14
15
-
Go to River's [Proof of Reserves](https://river.com/reserves) page. Log in with the email address you used to sign up for River.
15
+
Go to River's [Proof of Reserves](https://river.com/reserves) page. Log in with the email address you used to sign up for River.
16
16
17
-
Click "Verify Liabilities" and select the "Verify on your computer" option. This will allow you to download the Proof of Liabilities CSV file. Note the path to this CSV file, as you will need to provide it to the command in the next step.
17
+
Click "Verify Liabilities" and select the "Verify on your computer" option. This will allow you to download the Proof of Liabilities CSV file. Note the path to this CSV file, as you will need to provide it to the command in the next step.
18
18
19
19
Click "Continue" and you will be prompted to run the setup script also seen in the next step.
20
20
21
21
### 2. Setup the Project
22
22
23
-
In your terminal, run this command to clone the repository and install the dependencies. This step will install [asdf](https://asdf-vm.com/) and the Erlang/Elixir SDK.
23
+
In your terminal, run this command to clone the repository and install the dependencies. This step will install [mise](https://mise.run/) and the Erlang/Elixir SDK.
24
24
25
-
If you already have Erlang and Elixir installed or have already verified River's Proof of Reserves before, you can skip this step. If you have asdf installed but not Erlang/Elixir, you can install the SDK with asdf by running `asdf install` from this directory and skip this step.
25
+
If you already have Erlang and Elixir installed or have already verified River's Proof of Reserves before, you can skip this step. If you have mise installed but not Erlang/Elixir, you can install the SDK with mise by running `mise install` from this directory and skip this step.
This script will install Erlang/Elixir and the project dependencies. It will then compile the library.
33
+
This script will install Erlang/Elixir and the project dependencies. It will then compile the library.
35
34
36
-
Back in River's Proof of Reserves flow, click "Continue" and you will see the verification command, also shown in the step below.
35
+
Back in River's Proof of Reserves flow, click "Continue" and you will see the verification command, also shown in the step below.
37
36
38
37
### 2. Run the Verification Script
39
38
40
-
You will need to replace a few variables in the command below to run the script successfully. These values can be found in the River Proof of Reserves flow. If you followed the steps above, you will now see the command in the final screen. The command on the River page will already have your email and account string(s) filled in. You will need to fill in the `<CSV_PATH>` with the path to the CSV file you downloaded in Step 1.
39
+
You will need to replace a few variables in the command below to run the script successfully. These values can be found in the River Proof of Reserves flow. If you followed the steps above, you will now see the command in the final screen. The command on the River page will already have your email and account string(s) filled in. You will need to fill in the `<CSV_PATH>` with the path to the CSV file you downloaded in Step 1.
41
40
42
41
-`<EMAIL>` with the email address you used to sign up for River.
43
42
-`<ACCOUNT_STRING>` in the format `<ACCOUNT_ID>:<ACCOUNT_KEY>`. If you have multiple accounts, you can provide this flag multiple times, like so: `--account <ACCOUNT_STRING_1> --account <ACCOUNT_STRING_2>`. You can find your account ID and key in the Proof of Reserves flow.
44
-
-`<CSV_PATH>` with the path to the CSV file you downloaded in Step 1. The downloaded file will initially be zipped, so you will need to unzip it before providing the path to the CSV file.
43
+
-`<CSV_PATH>` with the path to the CSV file you downloaded in Step 1. The downloaded file will initially be zipped, so you will need to unzip it before providing the path to the CSV file.
45
44
46
45
```bash
47
46
mix run verify_liabilities.exs --email <EMAIL> --account <ACCOUNT_STRING> --file <CSV_PATH>
48
47
```
49
48
50
-
If the verification is successful, it will output your balance and a summary of the verification.
49
+
If the verification is successful, it will output your balance and a summary of the verification.
51
50
52
-
If you click continue on the River page, you can check that these balances are correct.
51
+
If you click continue on the River page, you can check that these balances are correct.
0 commit comments