This repository was archived by the owner on Feb 18, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathsidebar-zkllvm.js
187 lines (184 loc) · 6.11 KB
/
sidebar-zkllvm.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
export default {
zkllvm: [
{
type: 'link',
label: 'GitHub',
href: 'https://github.com/NilFoundation/zkLLVM',
},
{
type: 'category',
label: 'Overview',
collapsible: true,
collapsed: false,
items: [
{
type: 'doc',
label: 'What is zkLLVM',
id: 'overview/what-is-zkllvm'
},
{
type: 'doc',
label: 'Key components and tools',
id: 'overview/key-components-tools'
},
{
type: 'doc',
label: 'Usage flow',
id: 'overview/usage-flow'
}
]
},
{
type: 'category',
label: 'Getting started',
collapsible: true,
collapsed: true,
items: [
{
type: 'doc',
label: 'Installation and configuration',
id: 'getting-started/installation'
},
{
type: 'doc',
label: 'Writing a simple circuit',
id: 'getting-started/writing-a-simple-circuit'
},
{
type: 'doc',
label: 'Preparing input files',
id: 'getting-started/preparing-input-files'
},
{
type: 'category',
label: 'Compiling a circuit',
collapsible: true,
collapsed: false,
link: {
type: 'doc',
id: 'getting-started/compiling-a-circuit',
},
items: [
{
type: 'doc',
label: 'Compiling C++ code',
id: 'getting-started/compiling-cpp-code'
},
{
type: 'doc',
label: 'Compiling Rust code',
id: 'getting-started/compiling-rust-code'
}
]
},
{
type: 'doc',
label: 'Verifying and proving a circuit',
id: 'getting-started/verifying-a-circuit'
},
{
type: 'doc',
label: 'Using built-in types and functions',
id: 'getting-started/built-ins'
}
]
},
{
type: 'category',
label: 'Best practices and limitations',
collapsible: true,
collapsed: true,
items: [
{
type: 'doc',
label: 'Refactoring if/else statements',
id: 'best-practices-limitations/avoiding-if-else-statements'
},
{
type: 'doc',
label: 'Using statically allocated structures',
id: 'best-practices-limitations/using-stat-structures'
},
{
type: 'doc',
label: 'Avoiding dynamic loops',
id: 'best-practices-limitations/dynamic-loops'
},
{
type: 'doc',
label: 'Passing arguments by value',
id: 'best-practices-limitations/passing-args-by-value'
},
{
type: 'doc',
label: 'Avoiding system interfaces',
id: 'best-practices-limitations/system-interfaces'
},
{
type: 'doc',
label: 'Unrolling loops',
id: 'best-practices-limitations/unrolling-loops'
},
{
type: 'doc',
label: 'Structs and enums in Rust',
id: 'best-practices-limitations/rust-derive'
}
]
},
{
type: 'category',
label: 'Use cases',
collapsible: true,
collapsed: true,
items: [
{
type: 'doc',
label: 'Primer',
id: 'use-cases/primer'
},
{
type: 'category',
label: 'Construct a zkBridge',
collapsible: true,
collapsed: true,
items: [
{
type: 'doc',
label: 'Write a circuit with hashes',
id: 'use-cases/zk-bridge/hashes'
},
{
type: 'doc',
label: 'Verify EdDSA signatures',
id: 'use-cases/zk-bridge/eddsa'
},
{
type: 'doc',
label: 'Create a Merkle tree commitment scheme',
id: 'use-cases/zk-bridge/merkle-tree'
},
{
type: 'doc',
label: 'Write an algorithm for state-proof verification',
id: 'use-cases/zk-bridge/zkbridge'
},
]
},
]
},
{
type: 'category',
label: 'Misc',
collapsible: true,
collapsed: true,
items: [
{
type: 'doc',
label: 'Code of conduct',
id: 'misc/code-of-conduct'
},
]
},
],
};