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
{{ message }}
This repository was archived by the owner on Mar 25, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: docs/getting-started/deployment/client.md
+53-50Lines changed: 53 additions & 50 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,22 +33,40 @@ NOTARY_SERVER_HOST=127.0.0.1
33
33
## Installation
34
34
There are three ways to install the client CLI:
35
35
36
-
### 1. Using Pre-Built Binary
36
+
### 1. From Source Code
37
+
This method involves building the client entirely from the source code, offering the most security through full transparency and control.
38
+
39
+
- Bandwidth requirement: Moderate
40
+
- Downloads one repository and dependencies for a Rust executable and a Python3 script. Additionally, it may require downloading Rust, Python3, and Poetry if not already installed.
41
+
42
+
#### Steps
43
+
1. Clone the repository and cd to the repository root:
This method relies on trusting pre-compiled binary. It is the least secure but the simplest and fastest way to install the client.
38
57
39
58
- Bandwidth requirement: Low
40
59
- Downloads a shell script and two binaries (less than 50MB).
41
60
42
61
Note: The binaries are built directly from the source code using public GitHub workflows, defined and available in this repository. This ensures participants can verify the process and confirm binary integrity.
43
-
44
62
#### Steps
45
63
1. Download the script to fetch and execute appropriate binary
This method involves building the client entirely from the source code, offering the most security through full transparency and control.
84
-
85
-
- Bandwidth requirement: Moderate
86
-
- Downloads one repository and dependencies for a Rust executable and a Python3 script. Additionally, it may require downloading Rust, Python3, and Poetry if not already installed.
87
-
88
-
#### Steps
89
-
1. Clone the repository and cd to the repository root:
1. Get the Binance API key and secret, following the instructions in [Get Your Binance API Key](https://github.com/ZKStats/mpc-demo-infra/blob/main/mpc_demo_infra/client_cli/docker/README.md#step-1-get-your-binance-api-key)
100
98
101
99
1. Follow the instructions in Client CLI Configuration to create a `.env.client_cli` in the repository root directory
102
100
103
101
1. Execute `Client CLI`:
104
-
```bash
105
-
poetry run client-share-data <eth-address><binance-api-key><binance-api-secret>
106
-
```
107
-
108
-
## Execution
109
102
110
-
1. Get the Binance API key and secret, following the instructions in [Get Your Binance API Key](https://github.com/ZKStats/mpc-demo-infra/blob/main/mpc_demo_infra/client_cli/docker/README.md#step-1-get-your-binance-api-key)
103
+
- Using Source Code
111
104
112
-
1. Get a voucher from the Coordination Server
113
-
```bash
114
-
poetry run get-api-key
115
-
```
105
+
Make sure that you are at the repository root before proceeding.
116
106
117
-
### Sharing ETH Balance
118
-
1. Share your ETH balance at Binance with the voucher:
107
+
- Single-Server Local Configuration
108
+
1. Get the container ID of the Notary Server container:
0 commit comments