generated from readthedocs/tutorial-template
-
Notifications
You must be signed in to change notification settings - Fork 60
/
mkdocs.yml
831 lines (762 loc) · 29.4 KB
/
mkdocs.yml
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
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
site_name: ErgoDocs
site_url: https://docs.ergoplatform.com
repo_url: https://github.com/glasgowm148/ergodocs
edit_uri: edit/main/docs/
theme:
name: material
custom_dir: overrides
#favicon: assets/favicon.png
palette: # dark scheme toggle on material + dark orange
- scheme: default
primary: red
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
primary: red
toggle:
icon: material/toggle-switch
name: Switch to light mode
features:
- content.action.edit
- content.action.view
- content.code.copy
- navigation.tabs
#- navigation.instant
#- navigation.sections # The bold sections in navigation
- navigation.tracking
- navigation.indexes
- content.tabs.link
- toc.follow
# - toc.integrate
logo: assets/logo.png
font:
text: Roboto
extra_css:
- assets/extra.css
- assets/neoteroi-mkdocs.css
#- https://unpkg.com/mermaid@8.5.1/dist/mermaid.css #404 ?
extra_javascript:
- assets/extra.js
#- assets/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
- https://unpkg.com/mermaid@8.5.1/dist/mermaid.min.js
# - https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS_HTML
extra:
version:
provider: mike
analytics:
provider: google
property: G-5XM6BXT041
#extra:
# generator: false
plugins:
- search
- render_swagger:
allow_arbitrary_locations: true
- neoteroi.mkdocsoad
- mkdocs-jupyter #https://github.com/danielfrg/mkdocs-jupyter
- section-index #https://github.com/oprypin/mkdocs-section-index
#- swagger
#- awesome-pages https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin
- autolinks
- tags: # https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/#
tags_file: tags.md
#- categories
#- exclude-search # https://github.com/chrieke/mkdocs-exclude-search
#- semiliterate # http://studioinfinity.org/semiliterate/mkdocs_semiliterate/plugin/
#- awesome-list
#- pagenav-generator #https://github.com/Andre601/mkdocs-pagenav-generator
markdown_extensions:
- pymdownx.details
- pymdownx.tasklist:
custom_checkbox: true
- codehilite
- extra
- tables
- neoteroi.cards
- meta
- fenced_code
- toc:
permalink: "#"
baselevel: 1
toc_depth: 3
- admonition
- pymdownx.inlinehilite
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_div_format
- pymdownx.arithmatex:
generic: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.blocks.admonition
- pymdownx.blocks.details
nav:
- Introduction:
- Getting Started: index.md
- Why Ergo: dev/protocol/why.md
- Key Features:
- dev/protocol/index.md
- Protocol: dev/protocol/index.md
- eUTxO:
- dev/protocol/eutxo.md
- UTxO vs Account: dev/protocol/eutxo/accountveutxo.md
- Atomic Swaps: dev/protocol/eutxo/atomic.md
- NIPoPoWs:
- dev/protocol/nipopows.md
- Light Clients: dev/protocol/nipopow/nipopow_nodes.md
- Light Miners: dev/protocol/nipopow/logspace.md
- Sidechains: dev/protocol/nipopow/nipopow-sidechains.md
- Privacy: dev/protocol/zkp.md
- Storage Rent: dev/protocol/storage-rent.md
- Autolykos: dev/protocol/autolykos-protocol.md
- Research & Whitepapers: documents.md
- Roadmap:
- roadmap.md
- Scaling:
- dev/protocol/scaling.md
- Layer 0:
- dev/protocol/scaling/layer0.md
- Sub Blocks: uses/sidechains/subblocks.md
- Layer 1: dev/protocol/scaling/layer1.md
- Layer 2: dev/protocol/scaling/layer2.md
- Discussions:
- Roadmaps: dev/protocol/scaling/scaling-roadmap.md
- Transactions Per Second: dev/protocol/scaling/TPS.md
- Atomic Composability: dev/protocol/scaling/atomic-composability.md
- Entities:
- Ergo Foundation:
- ef/ergo-foundation.md
- Scope: ef/ef-scope.md
- Treasury: ef/ef-treasury.md
- Future: ef/ef-future.md
- DevDao: devdao.md
- Sigmanauts: contribute/sigmanauts.md
- Events:
- Events: events/index.md
- ERGOHACK: events/ergohack.md
- ErgoSummit: events/ergosummit.md
- Contribute:
- contribute.md
- Developers:
- contribute/devs.md
- Bounties: contribute/bounties.md
- Grants: contribute/grants.md
- Roles: contribute/roles.md
- Marketing: contribute/marketing.md
- Sigmanauts: contribute/sigmanauts.md
- Contribute to the docs!: contribute/docs.md
- Wallets: dev/wallets.md
- Resources:
- Social Contract: social_contract.md
- Audit: dev/protocol/audit.md
- The Howey Test: security.md
- Privacy Guide: doc/privacy-guide.md
- Glossary: glossary.md
- FAQ: faq.md
- Common Misconceptions: fud-faq.md
- A CBDC For All: uses/cbdc.md
#
# Get Involved
#
#- Get Started:
# - getting-started.md
#
# ECOSYSTEM SECTION
#
- Ecosystem:
- uses/index.md
- Infrastructure:
- Rosen Bridge:
- eco/rosen.md
- Watchers:
- eco/rosen/watcher.md
- Prerequisites: eco/rosen/rosen-preq.md
- Ergo Watcher: eco/rosen/ergo-watcher.md
- Bitcoin Watcher: eco/rosen/bitcoin-watcher.md
- Guards: eco/rosen/rosen-guard.md
- Tokenomics: eco/rosen/rosen-tokenomics.md
- Team: eco/rosen/rosen-team.md
- Uses:
- eco/rosen/rosen-uses.md
- rsERG-LP: tutorials/rsERGLP.md
- Token Integration Guides: tutorials/token_integration.md
- Oracles:
- uses/oracles.md
- Oracle Pools V2: eco/oracles-v2.md
- Mixicles: uses/mixicles.md
- Sidechains:
- uses/sidechains.md
- Sub Blocks: uses/sidechains/subblocks.md
- Sigma Chains: uses/sidechains/sigma-chains.md
- PoUW: uses/pouw.md
# - Archived:
# - ErgoData: uses/ErgoData.md
# - SentientChain: uses/sentientchain.md
- Financial:
- Decentralized Exchanges:
- uses/dex.md
- Spectrum Finance: eco/spectrum.md
- Trade House: eco/ergo-auctions.md
- Palmyra: eco/palmyra.md
- Crystal Pool: eco/crystal-pool.md
- Machina Finance: eco/machina-finance.md
- Mew Finance: eco/mew-finance.md
- P2P:
- eco/p2p-trading.md
- Token Jay: eco/token-jay.md
- Analog Ergo: eco/analog-ergo.md
- Single Tx Swap: eco/single-tx-swap.md
- Monetary Systems:
- SigmaUSD: uses/sigmausd.md
#- Examples: uses/sigmausd/examples.md
#- Mining Incentives: uses/sigmausd/mining-incentives.md
#- Other Stablecoins: uses/sigmausd/comparison.md
#- Why?: uses/sigmausd/why-sigusd.md
- ChainCash: uses/chaincash.md
- Gluon: eco/gluon.md
- DexyGold: eco/dexy.md
- Local Exchange Trading Systems:
- uses/lets.md
- Basic Implementation: uses/lets/basic-imp.md
- Trustless LETS: uses/lets/trustless-lets.md
# - uses/stablecoins.md
- Decentralized Finance:
- Lending:
- uses/lending.md
- duckpools: eco/duckpools.md
- EXLE: eco/exle.md
- SigmaFi: eco/sigmafi.md
- Derivatives and Synthetics:
- uses/deriv.md
- Hodlbox: eco/hodlbox.md
- HodlCoin: eco/hodlcoin.md
- AuctionCoin: eco/auction-coin.md
- OptionCoin: eco/optioncoin.md
- OptionPools: eco/optionPools.md
- SigmaO: eco/sigmao.md
#- Tensile: eco/tensile.md
- Crowdfunding:
- uses/crowdfunding.md
- ErgoRaffle: eco/ergoraffle.md
- Sigma Subscriptions: eco/sigma-subscriptions.md
# - ErgoWell: eco/ergowell.md
# - ErgoFund: uses/ergofund.md
- Degenerate Finance:
- uses/degfi.md
- Hodlcoin: eco/hodlcoin.md
- Auction Coin: eco/auction-coin.md
- Grand Gambit: eco/grand-gambit.md
- Hodlbox: eco/hodlbox.md
- OptionCoin: eco/optioncoin.md
# - NightOwl Casino: eco/nightowl.md
- Obolflip: eco/obolflip.md
- Lotteries: uses/lottery.md
- The Field: eco/the-field.md
- NFTs:
- uses/nft.md
- ErgoAuctionHouse: eco/ergo-auctions.md
- SkyHarbor: eco/skyharbor.md
- Lilium: eco/lilium.md
# - SigmaStamp: eco/sigma-stamp.md
- Gaming:
- uses/gaming.md
- BlitzTCG: eco/blitz.md
#- Metaverse:
# - uses/metaverse.md
- Cyberverse: eco/cyberverse.md
# - Sigmavalley: eco/sigmavalley.md
# - BlobsTopia: eco/blobstopia.md
# - ErgoGames.io:
# - Digigoats: eco/digigoats.md
# - Monster Pub Brawl: eco/monsterpub.md
# - Project Tesseract: eco/project-tesseract.md
- Tooling:
- Crux Finance: eco/crux.md
#- Azorus: eco/azorus.md
- ErgoNames: eco/ergonames.md
- Reputation System: eco/reputation-system.md
- SigmaRand: eco/sigmarand.md
- Moria Finance: eco/moria-finance.md
- Grid Trading: uses/grid_trading.md
- Applications:
- Thz.FM: eco/thz-fm.md
- TabbyPOS: eco/tabbypos.md
- PandaV: eco/pandav.md
- ZenGate Global:
- eco/zengate.md
- Solaris Portal: eco/solaris.md
- Cyberiad: eco/cyberaid.md
- Privacy:
- Mixing:
- uses/mixer.md
- ErgoMixer:
- eco/ergomixer.md
- Identifiability: eco/ergomixer/identifiability.md
- Best Practices: eco/ergomixer/best-practices.md
- FAQ: eco/ergomixer/mixer-faq.md
- Token: eco/ergomixer/token.md
- Install on Android: eco/ergomixer/mixer-android.md
- SigmaJoin: eco/sigmajoin.md
- Stealth Addresses: uses/stealth-address.md
#- ZK Treasury: uses/zkt.md
#- Decentralised Anon ID:
# - Ergo Nation: eco/ergonation.md
- DAOs:
- uses/dao.md
- Paideia: eco/paideia.md
- ErgoPad: eco/ergopad.md
- The Field: eco/the-field.md
- Thz.FM: eco/thz-fm.md
- Miners:
- eco/miner-tooling.md
- Lithos: eco/lithos.md
- GuapSwap: eco/guapswap.md
- CYTI: eco/cyti.md
- Further Ideas:
- Profit Sharing: uses/profit.md
- Email Client for Blocked Internet: uses/blocked_web.md
- Flash Loans: uses/flash-loans.md
- Prediction Markets: uses/prediction_markets.md
- Insurance: uses/insurance.md
- Micro Credit: dev/scs/microcredit.md
- Mutual Credit: uses/mutual_credit.md
- Bonding Curve: uses/bonding.md
- Tokens:
- ICOs: uses/ergo-ico.md
- Index Coins: uses/index_coins.md
- PoW Tokens: uses/PoW_tokens.md
- Perpetual Tokens: uses/perpetual.md
- Buy Back Guarantees: uses/dex-buyback.md
- Standards:
- contribute/standards.md
- Chat Bridge: contribute/standards/chat-bridge.md
- ErgoTipperBot: contribute/standards/tipbot.md
- KYA: contribute/standards/kya.md
- Community Guidelines: contribute/standards/guidelines.md
- Analytics: contribute/standards/analytics.md
# - Context Claims: uses/context-claims.md
# - Asset Tokenisation: uses/tokenisation.md
# - Privacy: uses/privacy.md
# - Collateral Mining: uses/collateral-mining.md
# - Math Fun: uses/math_fun.md
# - CDBC: uses/cbdc.md
# - Atomic Swaps: dev/protocol/atomic.md
- Developers:
- dev/get-started.md
- 📌 Getting Started:
- dev/get-started.md
- Students: students/index.md
- Data Model:
- Box:
- dev/data-model/box.md
- Registers: dev/data-model/box/registers.md
- Assets:
- Tokens:
- dev/data-model/box/tokens.md
- Creating a perpetual token: dev/tokens/perpetual.md
- Burning a token: dev/tokens/burn.md
- Non-Fungible Tokens:
- NFTs: dev/tokens/nfts/index.md
- Minting a NFT:
- dev/tokens/nfts/create.md
- Design V1 v V2: dev/tokens/nfts/v1v2.md
- Simple Example: dev/tokens/nfts/nft-examples.md
- On-chain NFTs: dev/tokens/nfts/on-chain.md
- Royalties: dev/tokens/nfts/royalties.md
- Singletons: dev/tokens/singletons.md
- Standards:
- Asset Standard: dev/tokens/standards/eip4.md
- Geniune Token Verification: dev/tokens/standards/eip21.md
- Auction Contract: dev/tokens/standards/eip22.md
- Artwork Contract: dev/tokens/standards/eip24.md
- Modelling: dev/data-model/box/box_modeling.md
- Addresses:
- dev/wallet/address.md
- Types: dev/wallet/address/address_types.md
- Validation: dev/wallet/address/address_validation.md
# - Encoding: assets/py/Ergo_Address_Encoding.ipynb
- Transactions:
- dev/protocol/transactions.md
- Composing Transactions:
- dev/protocol/tx/composing.md
- Sending A Chained Transaction: dev/anatomy/transactions/chained.md
- Interacting with an Ergo Wallet:
- Format: dev/protocol/tx/format.md
- Merkle Tree: dev/protocol/tx/tx-merkle.md
- Signing: dev/protocol/tx/signing.md
- Signing Backend: tutorials/sign-tx.md
- Validation: dev/protocol/tx/validation.md
- Data Inputs: dev/protocol/tx/read-only-inputs.md
- Fees: dev/protocol/tx/min-fee.md
- Unified Transactions: dev/protocol/tx/unified.md
- Resources:
- Standards:
- Babel Fees: dev/protocol/tx/babel-fees.md
- Proxy Contracts: dev/wallet/payments/standards/eip17.md
- ErgoPay Protocol: dev/wallet/payments/standards/eip20.md
- Payment Request URI: dev/wallet/payments/standards/eip25.md
- Just-In-Time Costing: node/jitc.md
- ErgoTool: dev/stack/ergotool.md
- Model Transaction: dev/protocol/tx/model-tx.md
- Payments: dev/anatomy/transactions/payments.md
- Block:
- dev/data-model/block.md
- Extension Section: dev/data-model/extension-section.md
#- UTXO-State:
- Infrastructure:
- dev/interact.md
- Node:
- node/install.md
- Setup:
- node/install/manual.md
- Troubleshooting: node/install/troubleshooting.md
- FAQ: node/install/node-faq.md
- Pi: node/install/pi.md
- Android: node/install/node-android.md
- Docker: node/install/docker.md
- Testnet:
- node/testnet.md
- Full Sync: node/testnet/testnet-full.md
- CPU Mining: node/testnet/cpu-mining.md
- Fork your own chain: node/testnet/mine-your-own-chain.md
- Resources: node/testnet/testnet-resources.md
#- Architecture: node/architecture.md
- Protocol:
- node/protocol.md
- P2P:
- dev/p2p/index.md
- Handshaking: dev/p2p/p2p-handshake.md
- Network Messages: dev/p2p/network.md
- Peer Management: node/peer-management.md
# - BlockP2P: dev/p2p/BlockP2P.md
- Modifiers:
- node/modifiers.md
- Modifiers Exchange: dev/p2p/modifiers-exchange.md
- Modifiers Processing: node/modifiers-processing.md
- Modifiers Validation: node/modifiers-validation.md
- Synchronisation: node/synchronisation.md
- EIPs: dev/protocol/eip.md
- Configuration:
- Node Wallet:
- node/wallet.md
- Hierarchical keys: dev/wallet/keys.md
- Wallet Setup: node/wallet-setup.md
- Swagger API:
- node/swagger.md
- OpenAPI Spec: node/swagger/openapi.md
- Try it out!: node/swagger/swagger_api.md
- Indexed Node API: node/indexed-node.md
- Configuration Files:
- application.conf:
- node/conf.md
- ergo:
- node: node/conf/conf-node.md
- cache: node/conf/conf-cache.md
- chain: node/conf/conf-chain.md
- wallet: node/conf/conf-wallet.md
- voting: node/conf/conf-voting.md
- bounded-mailbox: node/conf/conf-bounded.md
- akka: node/conf/conf-akka.md
- scorex: node/conf/conf-scorex.md
- critical-dispatcher: node/conf/conf-crit.md
- api-dispatcher: node/conf/conf-api.md
- testnet.conf:
- node/testnet/testnetconf.md
- devnet.conf: node/testnet/devnetconf.md
- Tor: node/tor.md
- Modes of Operation:
- node/modes.md
- Archival Full Node:
- node/modes/archival-node.md
- Technical Details: node/modes/archive-node-workflow.md
- Pruned Full Node:
- node/modes/pruned-full-node.md
- Technical Details: node/modes/pruned/pruned-impl.md
- Light Full Node:
- node/modes/light-full-node.md
- Digest State: node/digest-state.md
- blocksToKeep: node/history-pruning.md
- Technical Details: node/modes/light-techworkflow.md
- Light SPV:
- node/modes/light-spv-node.md
- Simplified Payment Verification: node/modes/spv.md
- Technical Details: node/modes/light-spv-mode-workflow.md
- Explorer:
- dev/stack/explorer.md
- Local Setup: dev/stack/explorer/explorer_local.md
- Pi Blockchain Explorer: dev/stack/rpi-blockchain-explorer.md
- GraphQL: dev/stack/explorer/graphql.md
- APIs: dev/stack/api.md
- Off-Chain:
- off-chain.md
- Oracle-Core:
- dev/oc/oracle.md
- Bootstrap an Oracle Pool: tutorials/oracle-bootstrap.md
- Off-Chain Bots: dev/oc/dex_bots.md
- Rust Utilities: dev/oc/ergo_utilities.md
- Plasma: dev/lib/plasma.md
- Wallets:
- dev/wallets.md
- Types:
- Satergo: dev/wallet/satergo.md
- Nautilus: dev/wallet/nautilus.md
- Minotaur:
- dev/wallet/minotaur.md
- Multi-Sig: dev/wallet/minotaur-multisig.md
- SAFEW: dev/wallet/safew.md
- Ledger: dev/wallet/payments/ledger.md
- Resources:
- Access Issues: tutorials/access-issues.md
- MultiSig: dev/wallet/multisig.md
- Standards:
- UTXO-Set Scanning Wallet API: dev/wallet/standards/eip1.md
- Deterministic Wallet Standard: dev/wallet/standards/eip3.md
- Cold Wallet: dev/wallet/standards/eip19.md
- Integration Guide: dev/Integration/guide.md
- Tooling:
- Pathways:
- Development Stack:
- dev/start.md
- Starter Tutorial: dev/stack/basics.md
- Server: dev/stack/server.md
- Browser: dev/stack/browser.md
- Desktop: dev/stack/desktop.md
- Mobile:
- dev/stack/mobile.md
- iOS: dev/stack/iOS.md
- Android: dev/stack/android.md
- Programming Languages:
- JVM:
- dev/lang/jvm.md
- Scala: dev/lang/scala.md
- Java: dev/lang/java.md
- Kotlin: dev/lang/kotlin.md
- JavaScript: dev/lang/js.md
- Rust: dev/lang/rust.md
- Others:
- Python: dev/lang/python.md
- C#: dev/lang/csharp.md
- Go: dev/lang/go.md
- Frameworks:
- dev/stack/frameworks.md
- AppKit:
- dev/stack/appkit.md
- Tutorial: dev/stack/appkit/tutorial.md
- Interacting with a local Node: dev/stack/appkit/appkit-node.md
- Gradle: dev/stack/appkit/gradle.md
- Using Appkit from Python: dev/stack/appkit/appkit_py.md
- SigmaRust: dev/stack/sigma-rust.md
- Fleet (JS): dev/stack/fleet.md
- FleetSharp: dev/stack/fleetsharp.md
- Others:
- Ergpy: dev/stack/ergpy.md
- RustKit: dev/stack/rustkit.md
- Mosaik:
- dev/stack/mosaik/intro.md
- Tutorial:
- dev/stack/mosaik/intro.md
- A simple UI: dev/stack/mosaik/tutorial2.md
- Processing data: dev/stack/mosaik/tutorial3.md
- ErgoPay: dev/stack/mosaik/tutorial4.md
- Web UI: dev/stack/mosaik/tutorial5.md
- Deployment: dev/stack/mosaik/mosaik-docker-flux.md
- Example apps: dev/stack/mosaik/examples.md
- JSON dApp Environment: dev/stack/jde.md
- Headless dApp Framework:
- dev/stack/headless.md
- Modules: dev/stack/headless/modules.md
- Payments:
- ErgoPay:
- ErgoPay: dev/wallet/payments/ergopay/ergo-pay.md
- Tutorial: dev/wallet/payments/ergopay/ep-tutorial.md
- ErgoAuth: dev/wallet/payments/ergoauth.md
- dApp Connector: dev/wallet/payments/dApp.md
- Proxy Contracts:
- dev/wallet/payments/proxy.md
- Assembler: dev/stack/assembler.md
- Libaries:
- dev/libraries.md
- Plasma: dev/lib/plasma.md
- Scrypto: dev/lib/scrypto.md
- EIP12-Types: dev/lib/eip12-types.md
- SigmaJS: dev/lib/sigmajs.md
#- Bookmarks: dev/start/resources.md
- ErgoScript:
- dev/scs/ergoscript.md
- Sigma Language:
- dev/scs/sigma-lang.md
- Core Concepts: dev/scs/ergoscript/ergoscript-key-concepts.md
- Simple Syntax: dev/scs/syntax.md
- Language Description: dev/scs/sigma/lang-spec.md
- Sigma Propositions: dev/scs/sigma/sigma-prop.md
- SigmaBoolean: dev/scs/types/sigmaboolean.md
- The Blockchain context: dev/scs/blockchain-context.md
- Accessing boxes and registers: dev/scs/boxes-and-registers.md
- Global Functions: dev/scs/global-functions.md
- Language Operations: dev/scs/sigma/lang-ops.md
- Interacting with an Ergo Wallet:
#- dev/anatomy/transactions/payments.md
- Format: dev/protocol/tx/format.md
- Merkle Tree: dev/protocol/tx/tx-merkle.md
- Signing: dev/protocol/tx/signing.md
- Signing Backend: tutorials/sign-tx.md
- Validation: dev/protocol/tx/validation.md
- Data Inputs: dev/protocol/tx/read-only-inputs.md
- Fees: dev/protocol/tx/min-fee.md
- Unified Transactions: dev/protocol/tx/unified.md
- Examples:
- Public Contracts: dev/scs/contracts.md
- Anyone Can Spend: dev/scs/ergoscript/anyone-can-spend.md
- No-one-Can Spend: dev/scs/ergoscript/no-one-can-spend.md
- Context Variables: dev/scs/ergoscript/context-variables.md
- Code-blocks: dev/scs/ergoscript/code-blocks.md
- Public-keys: dev/scs/ergoscript/public-keys.md
- Functional Programming: dev/scs/ergoscript/functional-programming.md
- Box Structure: dev/scs/ergoscript/box-structure.md
- Storing Data: dev/scs/ergoscript/storing-data.md
- Creating a simple P2S app: dev/scs/p2s.md
#- Data Inputs: uses/context-claims.md
- Tooling:
- dev/scs/ergoscript-tooling.md
- Interpreters & Compilers:
- dev/stack/interpreters.md
- Compiler Phases: dev/scs/ergoscript/compiler-phases.md
- sigmastate-interpreter: dev/scs/sigmastate-interpreter.md
- sigma-rust: dev/stack/sigma-rust.md
- ErgoScala: dev/stack/ergoscala.md
- CLI Compiler: dev/stack/compiler.md
- Playgrounds:
#- escript
- Scastie: dev/scs/ergoscript/scastie.md
- P2S Playground: dev/stack/utilities/plutomonkey.md
- Kiosk: dev/stack/kiosk.md
- ErgoPuppet: dev/scs/puppet.md
- Debugging: dev/scs/debugging.md
- FlowCards: dev/scs/flowcards.md
- ErgoTree:
- dev/scs/ergotree.md
- Introduction: dev/scs/ergotree/ergotree-intro.md
- As a Language: dev/scs/ergotree/ergotree-lang.md
- Typing: dev/scs/ergotree/typing.md
- Evaluation: dev/scs/ergotree/evaluation.md
- Serialization: dev/scs/ergotree/serialization.md
- Predefined Types: dev/scs/ergotree/types.md
- Predefined Functions: dev/scs/ergotree/functions.md
- Encoding: dev/scs/ergotree/encoding.md
- Script Validation: dev/scs/ergotree/script-validation.md
- Script Optimisation: dev/scs/ergotree/script-optimisation.md
- Templates: dev/scs/ergotree/ergotree-templates.md
- Features:
# - Paradigm: dev/scs/index.md
- Data Inputs: dev/protocol/tx/read-only-inputs.md
- Multi-Stage Protocols:
- dev/scs/multi.md
- Transaction Chains: dev/scs/tx/tx-chains.md
- Transaction Trees: dev/scs/tx/tx-tree.md
- Transaction Graphs: dev/scs/tx/tx-graphs.md
- Context Enrichment: dev/scs/tx/context-enrichment.md
- Examples:
- Reversible Address: dev/scs/tx/reversible-address.md
- Rock/Paper/Scissors: dev/scs/tx/rock-paper-scissor.md
- ICO: dev/scs/tx/ico.md
- Cryptographic:
- crypto.md
- Sigma Protocols:
- dev/scs/sigma.md
- Schnorr:
- dev/scs/sigma/schnorr.md
- Verifying Schnorr Signatures: dev/scs/sigma/verifying.md
- Diffie:
- dev/scs/sigma/diffie.md
- Ring Signatures:
- 3-out-of-5 Threshold Signature: dev/scs/sigma/3-out-of-5.md
- Distributed Signatures: node/sigs.md
#- Signature Scheme Internals: sig-scheme.md
- ZeroJoin: dev/crypto/zerojoin.md
- Data Structures:
- dev/data-model/data-structures.md
- Merkle Tree:
- dev/data-model/structures/merkle/merkle-tree.md
- Format: dev/data-model/structures/merkle/merkle-format.md
- Validation: dev/data-model/structures/merkle/merkle-validation.md
- Implementations:
- Extension Block Merkle: dev/data-model/structures/merkle/merkle-extension.md
- Transaction Merkle Trees: dev/protocol/tx/tx-merkle.md
- Merkle Batch Proofs:
- dev/data-model/structures/merkle/merkle-batch-proof.md
- Implementation: dev/data-model/structures/merkle/merkle-batch-impl.md
- Testing: dev/data-model/structures/merkle/merkle-batch-testing.md
- Lightweight Client Proofs: dev/data-model/structures/merkle/merkle-light-proof.md
- AVL Trees:
- dev/protocol/avl.md
- Plasma: dev/lib/plasma.md
- Proof of Proof-of-Work:
- dev/data-model/structures/popow.md
- Interlink Vectors: dev/data-model/structures/interlink-vectors.md
# - Resources:
#- dev/stack/introduction.md
- Miners:
- Autolykos:
- mining/autolykos.md
- Algorithm:
- mining/algorithm.md
- Emission:
- mining/emission.md
- EFYT: efyt.md
- Difficulty Adjustment: mining/difficulty.md
- Solution Verification: mining/solution-verification.md
- Technical Breakdown: mining/algo-technical.md
- Storage Rent:
- mining/rent.md
- Fees: mining/rent/rent-fees.md
- Tokens: mining/rent/rent-tokens.md
- Spending: mining/rent/rent-spending.md
- State Growth: mining/rent/rent-paper.md
- ASIC Resistance: mining/asic.md
- Resources:
- mining/mining-resources.md
- CPU vs GPU: mining/cpu.md
- EIPs:
- Emission Retargeting Soft-Fork: mining/standards/eip27.md
- Tweaking Difficulty Adjustment Algorithm: mining/standards/eip37.md
- Mining: mining/index.md
- Start Mining:
- mining/setup/join.md
- Software: mining/software.md
- Operating Systems: mining/os.md
- Overclocking: mining/overclocking.md
- Pools: mining/pools.md
- Solo Mining:
- mining/setup/solo.md
- Node Configuration: mining/setup/solo-node.md
- Withdraw: mining/withdraw.md
- FAQ: mining/setup/solo-faq.md
- Host a Pool:
- mining/setup/pool.md
- Stratum: mining/setup/stratum.md
- MiningCore: mining/setup/miningcore.md
- Governance:
- mining/governance.md
- Voting: mining/gov/voting.md
- Forking:
- mining/gov/forking.md
- Soft Forks: mining/gov/soft-fork.md
- Velvet Forks: mining/gov/velvet-fork.md
- Hard Forks: mining/gov/hard-fork.md
- Revenue: mining/revenue.md
- Tooling:
- eco/miner-tooling.md
- GuapSwap: eco/guapswap.md
- Lithos:
- eco/lithos.md
- SNISPs: eco/snisp.md
- CYTI: eco/cyti.md
- Log-Space Mining: mining/log_space.md
- Smartpools:
- mining/smartpools.md
- Subpooling: mining/setup/subpool.md