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: android/ExampleApp/README.md
+37-5Lines changed: 37 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,24 +2,56 @@
2
2
3
3
## Zkey files
4
4
5
-
As zkey files are quite large, none of the example circuits' zkey files are part of the repo. They must be downloaded separately and added to each zkey_pack_X as follows:
5
+
As zkey files are quite large, none of the example circuits' zkey files are part of the repo. They must be downloaded separately and placed in the correct directory structure for Android asset packs.
6
6
7
-
- zkey_pack_0 should contain:
7
+
### Important: Correct Directory Structure
8
+
9
+
The .zkey files must be placed in the `src/main/assets/` subdirectory within each zkey_pack directory:
10
+
11
+
```
12
+
ExampleApp/
13
+
├── zkey_pack_0/
14
+
│ └── src/main/assets/
15
+
│ ├── 100k_circuit_final.zkey
16
+
│ ├── 200k_circuit_final.zkey
17
+
│ └── 400k_circuit_final.zkey
18
+
├── zkey_pack_1/
19
+
│ └── src/main/assets/
20
+
│ ├── 800k_circuit_final.zkey
21
+
│ ├── 1600k_circuit_final.zkey
22
+
│ ├── keccak_circuit_final.zkey
23
+
│ └── sha256_circuit_final.zkey
24
+
├── zkey_pack_rarimo/
25
+
│ └── src/main/assets/
26
+
│ └── rarimo_circuit_final.zkey
27
+
└── zkey_pack_zkp2p/
28
+
└── src/main/assets/
29
+
├── aes_128_ctr_circuit_final.zkey
30
+
├── aes_256_ctr_circuit_final.zkey
31
+
└── chacha20_circuit_final.zkey
32
+
```
33
+
34
+
### Required Files by Asset Pack
35
+
36
+
-**zkey_pack_0** should contain in `src/main/assets/`:
8
37
- 100k_circuit_final.zkey
9
38
- 200k_circuit_final.zkey
10
39
- 400k_circuit_final.zkey
11
-
- zkey_pack_1 should contain:
40
+
-**zkey_pack_1** should contain in `src/main/assets/`:
12
41
- 800k_circuit_final.zkey
13
42
- 1600k_circuit_final.zkey
14
43
- keccak_circuit_final.zkey
15
44
- sha256_circuit_final.zkey
16
-
- zkey_pack_rarimo should contain:
45
+
-**zkey_pack_rarimo** should contain in `src/main/assets/`:
17
46
- rarimo_circuit_final.zkey
18
-
- zkey_pack_zkp2p should contain:
47
+
-**zkey_pack_zkp2p** should contain in `src/main/assets/`:
19
48
- aes_128_ctr_circuit_final.zkey
20
49
- aes_256_ctr_circuit_final.zkey
21
50
- chacha20_circuit_final.zkey
22
51
52
+
### Note
53
+
The .wtns and .json files are placed in the main app's assets directory (`app/src/main/assets/`), while the .zkey files go in the asset pack directories as shown above.
54
+
23
55
## Build
24
56
25
57
Use the [build_example_app](../scripts/build_example_app.sh) to build the app for both debug and release buildTypes.
0 commit comments