-
Notifications
You must be signed in to change notification settings - Fork 58
/
sidebars.js
629 lines (629 loc) · 20.4 KB
/
sidebars.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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
module.exports = {
tutorialSidebar: [
{
type: 'category',
label: 'Getting Started',
link: {
type: 'doc',
id: 'docs-home',
},
items: [
'getting-started/introduction',
'getting-started/farming-guide',
'getting-started/wallet-guide',
'getting-started/using-the-gui',
'getting-started/bridge-guide',
{
type: 'category',
label: 'Cloud Wallet',
items: [
'getting-started/cloud-wallet/getting-started',
'getting-started/cloud-wallet/faq',
'getting-started/cloud-wallet/tooltips',
'getting-started/cloud-wallet/unfinished',
'getting-started/cloud-wallet/known-issues',
]
}
],
},
{
type: 'category',
label: 'Advanced User Docs',
items: [
'getting-started/installation',
'getting-started/testnets',
'getting-started/timelords',
{
type: 'category',
label: 'Plotting',
items: [
'plotting/plotting-basics',
'plotting/plotting-hardware',
'plotting/plotting-software',
'plotting/plotting-compression',
'plotting/plotting-how-to',
'plotting/ssd-endurance',
'plotting/moving-plots',
'plotting/plotting-faq',
],
},
{
type: 'category',
label: 'Farming',
items: [
'farming/farming-basics',
'farming/farming-compressed-plots',
'farming/farming-many-machines',
'farming/pool-farming',
'farming/reference-farming-hardware',
'farming/farming-considerations',
'farming/dual-farming-testnet-mainnet',
],
},
{
type: 'category',
label: 'Reference Client',
items: [
'reference-client/key-management',
'reference-client/password-protected-keys',
'reference-client/headless-node',
'reference-client/coin-selection',
],
},
{
type: 'category',
label: 'RPC Reference',
items: [
'rpc-reference/rpc',
'rpc-reference/daos',
'rpc-reference/daemon',
'rpc-reference/datalayer',
'rpc-reference/dids',
'rpc-reference/nfts',
'rpc-reference/offers',
'rpc-reference/simulator',
'rpc-reference/vcs',
'rpc-reference/wallet',
'rpc-reference/farmer',
'rpc-reference/full-node',
'rpc-reference/harvester',
],
},
{
type: 'category',
label: 'CLI Reference',
items: [
'cli-reference/cli',
'cli-reference/daos',
'cli-reference/datalayer',
'cli-reference/dids',
'cli-reference/nfts',
'cli-reference/offers',
'cli-reference/plotters',
'cli-reference/simulator',
'cli-reference/vcs',
'cli-reference/wallet',
'cli-reference/cat-admin',
'cli-reference/clawback',
'cli-reference/custody-tool',
'cli-reference/asic-hwvdf',
],
},
{
type: 'category',
label: 'WalletConnect',
items: [
'walletconnect/general',
'walletconnect/cats',
'walletconnect/nfts',
'walletconnect/dids',
'walletconnect/offers',
],
},
],
},
{
type: 'category',
label: 'Troubleshooting',
items: [
'troubleshooting/check-if-things-are-working',
'troubleshooting/checking-farm-health',
'troubleshooting/farming-faq',
'troubleshooting/node-syncing',
'troubleshooting/logging-reference',
'troubleshooting/locating-keys',
'troubleshooting/timelords',
],
},
{
type: 'category',
label: 'Contributing',
items: [
'contribution/using-github',
],
},
{
type: 'category',
label: 'Learn More',
items: [
{
type: 'category',
label: 'Coin Set Model',
items: [
'coin-set-model/intro',
'coin-set-model/costs',
'coin-set-model/conditions',
'coin-set-model/spend-bundles',
'coin-set-model/addresses',
'coin-set-model/security',
'coin-set-model/coin-set-vs-utxo',
'coin-set-model/coin-set-vs-account',
'coin-set-model/clvm-vs-evm',
],
},
{
type: 'category',
label: 'Architecture',
items: [
'architecture/architecture-overview',
'architecture/full-nodes',
'architecture/farmers',
'architecture/harvesters',
'architecture/timelords',
'architecture/pools',
'architecture/wallets',
'architecture/mempool',
],
},
{
type: 'category',
label: 'Consensus',
items: [
'consensus/consensus-intro',
'consensus/proof-of-space',
{
type: 'category',
label: 'New Proof Format',
items: [
'new-proof-format/new-proof-introduction',
'new-proof-format/new-proof-plotting-requirements',
'new-proof-format/new-proof-farming-requirements',
'new-proof-format/new-proof-timeline',
'new-proof-format/new-proof-faq',
'new-proof-format/new-proof-technical-overview',
'new-proof-format/new-proof-technical-details',
],
},
'consensus/proof-of-time',
{
type: 'category',
label: 'Chains',
items: [
'consensus/challenges',
'consensus/signage-and-infusion-points',
'consensus/harvester-algorithm',
'consensus/multiple-blocks',
'consensus/three-vdf-chains',
'consensus/overflow-blocks',
'consensus/foliage',
'consensus/epoch-and-difficulty',
],
},
{
type: 'category',
label: 'Block Validation',
items: [
'block-validation/block-validation',
'consensus/light-clients',
'block-validation/block-format',
'block-validation/block-rewards',
],
},
'consensus/timelords',
'consensus/attacks-and-countermeasures',
'consensus/analysis',
'consensus/forks',
],
},
{
type: 'category',
label: 'Keys',
items: [
'keys/architecture',
'keys/keys-and-signatures',
'keys/plot-ids',
'keys/plot-public-keys',
],
},
{
type: 'category',
label: 'Protocol',
items: [
'protocol/protocol',
'protocol/networking-protocol',
'protocol/serialization-protocol',
'protocol/harvester-protocol',
'protocol/peer-protocol',
{
type: 'category',
label: 'Pool Protocol',
items: [
'protocol/pool/pool-protocol',
'protocol/pool/pool-protocol-specification',
],
},
'protocol/wallet-protocol',
],
},
{
type: 'category',
label: 'Green Paper',
items: [
'green-paper/green-paper-abstract',
'green-paper/constants-variables-notation',
'green-paper/green-paper-introduction',
'green-paper/longest-chain-protocols',
'green-paper/rational-attackers',
'green-paper/hash-and-vdf-chains',
'green-paper/the-chia-blockchain',
'green-paper/recovering-from-51-percent-attacks',
'green-paper/green-paper-references',
'green-paper/green-paper-appendix',
],
},
{
type: 'category',
label: 'Resources',
items: [
'resources/cryptocurrency-intro',
'resources/references',
'resources/chia-farming-workload',
'resources/k-sizes',
'resources/faq',
'resources/storage-benchmarks',
'resources/glossary',
{
type: 'category',
label: 'Timelord Contest',
collapsible: true,
collapsed: true,
link: {
type: 'generated-index',
slug: '/resources/timelord-contest',
title: 'Timelord Contest',
description:
"We’re holding a contest for community members! May 1-May 31, 2024 at 11:59 p.m. EST, you could win a timelord for submitting a winning Chia Academy course. Not the strongest community-created courses for Chia Academy. Courses should be relevant to the Chia community and blockchain and neutral to third-party projects.",
},
items: [
'resources/timelord-contest/timelord-contest',
'resources/timelord-contest/timelord-contest-rules',
],
},
],
},
],
},
],
guides: [
{
type: 'category',
label: 'Crash Course',
collapsible: true,
collapsed: false,
link: {
type: 'doc',
id: 'dev-guides-home',
},
items: [
'guides/crash-course/introduction',
'guides/crash-course/intro-to-chialisp',
'guides/crash-course/smart-coins',
'guides/crash-course/signatures',
'guides/crash-course/state',
'guides/crash-course/inner-puzzles',
'guides/crash-course/cats-offers-nfts',
'guides/crash-course/chialisp-and-typescript',
],
},
{
type: 'category',
label: 'Primitives',
collapsible: true,
collapsed: true,
link: {
type: 'generated-index',
slug: '/guides/primitives',
title: 'Chia Primitives',
description:
"These guides will guide you through interacting with the various Chia primitives.",
},
items: [
{
type: 'category',
label: 'NFT Guide',
collapsible: true,
collapsed: true,
link: {
type: 'generated-index',
slug: '/guides/nft-developer-guide',
title: 'NFT Developer Guide',
description:
"This tutorial will guide you through the process of creating DIDs that conform to Chia's DID standard, as well as minting NFTs that adhere to Chia's NFT standard.",
},
items: [
'guides/nft/nft-intro',
'guides/nft/nft-cli',
'guides/nft/nft-rpc',
'guides/nft/nft-bulk-mint',
],
},
{
type: 'category',
label: 'CAT Guide',
collapsible: true,
collapsed: true,
link: {
type: 'generated-index',
slug: '/guides/cat-developer-guide',
title: 'CAT Developer Guide',
description:
"These guides will guide you through the process of creating CATs that conform to Chia's CAT standard.",
},
items: [
{
'CAT2 Upgrade': [
'guides/cat/cat2-upgrade/cat2-intro',
'guides/cat/cat2-upgrade/cat2-snapshot',
'guides/cat/cat2-upgrade/cat2-issuance',
],
},
'guides/cat/cat-creation-tutorial',
'guides/cat/cr-cat-tutorial',
],
},
{
type: 'category',
label: 'DataLayer™',
collapsible: true,
collapsed: true,
link: {
type: 'generated-index',
slug: '/guides/datalayer-developer-guide',
title: 'DataLayer™ Developer Guide',
description:
"These guides will guide you through interacting with DataLayer™.",
},
items: [
'guides/datalayer/datalayer-user-guide',
'guides/datalayer/datalayer-permissions',
],
},
{
type: 'category',
label: 'Clawback',
collapsible: true,
collapsed: true,
link: {
type: 'generated-index',
slug: '/guides/clawback-developer-guide',
title: 'Clawback Developer Guide',
description:
"These guides will guide you through interacting with Clawback.",
},
items: [
'guides/clawback/clawback-user-guide',
'guides/clawback/clawback-primitive-guide',
],
},
{
type: 'category',
label: 'Offers',
collapsible: true,
collapsed: true,
link: {
type: 'generated-index',
slug: '/guides/offers-developer-guide',
title: 'Offers Developer Guide',
description:
"These guides will guide you through interacting with Offers.",
},
items: ['guides/tutorials/offers-gui', 'guides/tutorials/offers-cli'],
},
{
type: 'category',
label: 'DAOs',
collapsible: true,
collapsed: true,
link: {
type: 'generated-index',
slug: '/guides/daos-developer-guide',
title: 'DAOs Developer Guide',
description:
"These guides will guide you through interacting with DAOs.",
},
items: ['guides/dao/dao-cli-guide', 'guides/dao/dao-known-issues'],
},
'guides/verifiable-credentials-guide',
],
},
{
type: 'category',
label: 'Tutorials',
collapsible: true,
collapsed: true,
link: {
type: 'generated-index',
slug: '/guides/tutorials',
title: 'Tutorials',
description:
"These tutorials overview interacting with the Chia client.",
},
items: [
'guides/tutorials/application-structure',
'guides/tutorials/custom-puzzle-lock',
{
type: 'category',
label: 'Custody Tool',
collapsible: true,
collapsed: true,
link: {
type: 'generated-index',
slug: '/guides/custody-tool',
title: 'Custody Tool',
description:
"These documents overview the Chia internal custody tool, how to use it, and how to audit the pre-farm.",
},
items: [
'guides/custody/custody-tool-description',
'guides/custody/custody-tool-user-guide',
'guides/custody/prefarm-audit',
],
},
'guides/observer-wallet-guide',
'guides/tutorials/coin-spend-rpc',
'guides/seeder-user-guide',
'guides/simulator-user-guide',
{
type: 'category',
label: 'WalletConnect',
collapsible: true,
collapsed: true,
link: {
type: 'generated-index',
slug: '/guides/walletconnect',
title: 'WalletConnect',
description:
"These documents overview WalletConnect integration, how to use it and how to develop upon it.",
},
items: [
'guides/walletconnect/walletconnect-user-guide',
'guides/walletconnect/walletconnect-developer-guide',
],
},
],
},
{
type: 'category',
label: 'Video Series',
collapsible: true,
collapsed: true,
link: {
type: 'generated-index',
slug: '/guides/video-series',
title: 'Video Series',
description:
"This video series introduces you to Chia and overviews how to develop in ChiaLisp.",
},
items: [
'guides/tutorials/video-series/why-chia-is-great',
'guides/tutorials/video-series/developing-applications',
'guides/tutorials/video-series/tools-and-setup',
'guides/tutorials/video-series/programming-chialisp',
'guides/tutorials/video-series/coin-lifecycle-and-testing',
'guides/tutorials/video-series/singleton-contracts',
'guides/tutorials/video-series/state-coins-announcements',
'guides/tutorials/video-series/security-arguments-signing',
'guides/tutorials/video-series/announcements-oracles',
'guides/tutorials/video-series/single-issuance-cat',
'guides/tutorials/video-series/multiple-issuance-cat',
],
},
],
academy: [
{
type: 'category',
label: 'Chia Academy Intro',
collapsible: true,
collapsed: false,
link: {
type: 'generated-index',
slug: '/academy-intro',
title: 'Chia Academy Intro',
description:
'Welcome to Chia Academy, the scholarly hub for delving deep into Chia blockchain technology. In an age characterized by rapid digital transformation, this institution offers a comprehensive exploration of the Chia blockchain, dissecting its technical intricacies, real-world applications, and the nuances of its secure data handling. The Chia blockchain, created by Bram Cohen, stands out from traditional cryptocurrencies with its unique Proof of Space and Time (PoST) model, which contrasts with the energy-intensive Proof of Work model (PoW) used by Bitcoin. This innovation is notable for its eco-friendly approach to blockchain. Check out the pages below to start your journey!',
},
items: [
'academy/academy-intro/academy-home',
'academy/academy-intro/academy-overview',
],
},
{
type: 'category',
label: 'Chialisp Overview',
collapsible: true,
collapsed: true,
link: {
type: 'generated-index',
slug: '/academy/chialisp',
title: 'Chialisp Overview',
description:
'These lessons cover the basics of Chialisp, the smart coin language used on the Chia blockchain.',
},
items: [
'academy/chialisp/chialisp-intro',
'academy/chialisp/chialisp-smart-coin',
'academy/chialisp/chialisp-signatures',
'academy/chialisp/chialisp-inner-puzzle',
],
},
{
type: 'category',
label: 'Plotting & Farming',
collapsible: true,
collapsed: true,
link: {
type: 'generated-index',
slug: '/academy/plotting-farming',
title: 'Plotting & Farming',
description:
'These lessons cover the basics of Plotting and Farming. How challenges are distributed and processed, and how pooling and plot filters benefit the network. At the end, we include a tutorial on creating your first plot.',
},
items: [
'academy/plotting-farming/farming-overview',
'academy/plotting-farming/challenges-plot-filters',
'academy/plotting-farming/pools',
'academy/plotting-farming/first-plot',
],
},
{
type: 'category',
label: 'Blockchain Basics Overview',
collapsible: true,
collapsed: true,
link: {
type: 'generated-index',
slug: '/academy/blockchain-basics',
title: 'Blockchain Basics Overview',
description:
'These lessons cover the basics of the Chia Blockchain including consensus, timelords, block formation, the coin-set model, and security.',
},
items: [
'academy/blockchain-basics/consensus-basics',
'academy/blockchain-basics/timelord-basics',
'academy/blockchain-basics/block-formation-basics',
'academy/blockchain-basics/coinset-basics',
'academy/blockchain-basics/security-basics',
],
},
{
type: 'category',
label: 'Primitives',
collapsible: true,
collapsed: true,
link: {
type: 'generated-index',
slug: '/academy/primitives',
title: 'Primitives',
description:
'These lessons serve as an overview of the natively supported features available on the Chia Blockchain.',
},
items: [
'academy/primitives/primitives-overview',
'academy/primitives/academy-nft',
'academy/primitives/academy-did',
'academy/primitives/academy-cat',
'academy/primitives/academy-offers',
],
},
],
};