forked from aeternity/documentation-hub
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs_new.yamls
197 lines (196 loc) · 14.1 KB
/
mkdocs_new.yamls
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
site_name: æternity Documentation Hub
nav:
- Introduction: 'index.md'
- Quick Glossary: 'quick_glossary.md'
- Protocol:
- æternity Protocol: 'protocol/README.md'
- AENS Naming System: 'protocol/AENS.md'
- Gossip: 'protocol/GOSSIP.md'
- Stratum: 'protocol/STRATUM.md'
- Sync: 'protocol/SYNC.md'
- Serializations: 'protocol/serializations.md'
- Channels:
- State Channels: 'protocol/channels/README.md'
- Off-chain: 'protocol/channels/OFF-CHAIN.md'
- On-chain: 'protocol/channels/ON-CHAIN.md'
- Authentication: 'protocol/channels/authentication.md'
- State: 'protocol/channels/state.md'
- Consensus:
- Bitcoin-NG: 'protocol/consensus/bitcoin-ng.md'
- Coinbase: 'protocol/consensus/coinbase.md'
- Consensus: 'protocol/consensus/consensus.md'
- Inflation: 'protocol/consensus/inflation.png'
- Locking: 'protocol/consensus/locking.md'
- Contracts:
- AEVM: 'protocol/contracts/aevm.md'
- Contract Life Cycle Examples: 'protocol/contracts/contract_life_cycle.md'
- Contract State Tree: 'protocol/contracts/contract_state_tree.md'
- Contract Transactions: 'protocol/contracts/contract_transactions.md'
- Contract VMS: 'protocol/contracts/contract_vms.md'
- Contracts: 'protocol/contracts/contracts.md'
- The Solidity Language: 'protocol/contracts/solidity.md'
- The Sophia Language: 'protocol/contracts/sophia.md'
- Sophia Explained: 'protocol/contracts/sophia_explained.md'
- Standard Library: 'protocol/contracts/sophia_stdlib.md'
- The Varna Language: 'protocol/contracts/varna.md'
- Generalized Accounts:
- Generalized Accounts: 'protocol/generalized_accounts/ga_explained.md'
- Generic Accounts: 'protocol/generalized_accounts/generalized_accounts.md'
- Node:
- API:
- Account API Usage: 'protocol/node/api/account_api_usage.md'
- API Encoding: 'protocol/node/api/api_encoding.md'
- State Channel WebSocket API: 'protocol/node/api/channel_ws_api.md'
- Channels API Usage: 'protocol/node/api/channels_api_usage.md'
- Contract API Usage: 'protocol/node/api/contract_api_usage.md'
- Mining API Usage: 'protocol/node/api/mining_api_usage.md'
- Naming System API Usage: 'protocol/node/api/naming_system_api_usage.md'
- Oracle API Usage: 'protocol/node/api/oracle_api_usage.md'
- Spend API Usage: 'protocol/node/api/spend_api_usage.md'
- Examples:
- State Channels:
- WebSocket API Examples: 'protocol/node/api/examples/channels/README.md'
- JSON-RPS:
- Abort Updates:
- abort_deposit: 'protocol/node/api/examples/channels/json-rpc/abort_updates/sc_ws_abort_deposit.md'
- abort_offchain_update: 'protocol/node/api/examples/channels/json-rpc/abort_updates/sc_ws_abort_offchain_update.md'
- abort_settle: 'protocol/node/api/examples/channels/json-rpc/abort_updates/sc_ws_abort_settle.md'
- abort_shutdown: 'protocol/node/api/examples/channels/json-rpc/abort_updates/sc_ws_abort_shutdown.md'
- abort_slash: 'protocol/node/api/examples/channels/json-rpc/abort_updates/sc_ws_abort_slash.md'
- abort_snapshot_solo: 'protocol/node/api/examples/channels/json-rpc/abort_updates/sc_ws_abort_snapshot_solo.md'
- abort_withdraw: 'protocol/node/api/examples/channels/json-rpc/abort_updates/sc_ws_abort_withdraw.md'
- can_not_abort_while_open: 'protocol/node/api/examples/channels/json-rpc/abort_updates/sc_ws_can_not_abort_while_open.md'
- Changeable Fee:
- set_fee_close_mutual: 'protocol/node/api/examples/channels/json-rpc/changeable_fee/sc_ws_set_fee_close_mutual.md'
- set_fee_close_solo: 'protocol/node/api/examples/channels/json-rpc/changeable_fee/sc_ws_set_fee_close_solo.md'
- set_fee_create: 'protocol/node/api/examples/channels/json-rpc/changeable_fee/sc_ws_set_fee_create.md'
- set_fee_deposit: 'protocol/node/api/examples/channels/json-rpc/changeable_fee/sc_ws_set_fee_deposit.md'
- set_fee_settle: 'protocol/node/api/examples/channels/json-rpc/changeable_fee/sc_ws_set_fee_settle.md'
- set_fee_slash: 'protocol/node/api/examples/channels/json-rpc/changeable_fee/sc_ws_set_fee_slash.md'
- set_fee_snapshot: 'protocol/node/api/examples/channels/json-rpc/changeable_fee/sc_ws_set_fee_snapshot.md'
- set_fee_withdrawl: 'protocol/node/api/examples/channels/json-rpc/changeable_fee/sc_ws_set_fee_withdrawl.md'
- Continious:
- init_per_group: 'protocol/node/api/examples/channels/json-rpc/continuous/init_per_group.md'
- deposit: 'protocol/node/api/examples/channels/json-rpc/continuous/sc_ws_deposit.md'
- failed_update: 'protocol/node/api/examples/channels/json-rpc/continuous/sc_ws_failed_update.md'
- generic_messages: 'protocol/node/api/examples/channels/json-rpc/continuous/sc_ws_generic_messages.md'
- ping_pong: 'protocol/node/api/examples/channels/json-rpc/continuous/sc_ws_ping_pong.md'
- update_conflict: 'protocol/node/api/examples/channels/json-rpc/continuous/sc_ws_update_conflict.md'
- withdraw: 'protocol/node/api/examples/channels/json-rpc/continuous/sc_ws_withdraw.md'
- Contracts:
- init_per_group: 'protocol/node/api/examples/channels/json-rpc/contracts/init_per_group.md'
- environment_contract: 'protocol/node/api/examples/channels/json-rpc/contracts/sc_ws_environment_contract.md'
- nameservice_contract: 'protocol/node/api/examples/channels/json-rpc/contracts/sc_ws_nameservice_contract.md'
- oracle_contract: 'protocol/node/api/examples/channels/json-rpc/contracts/sc_ws_oracle_contract.md'
- remote_call_contract: 'protocol/node/api/examples/channels/json-rpc/contracts/sc_ws_remote_call_contract.md'
- remote_call_contract_refering_onchain_data: 'protocol/node/api/examples/channels/json-rpc/contracts/sc_ws_remote_call_contract_refering_onchain_data.md'
- wrong_call_data: 'protocol/node/api/examples/channels/json-rpc/contracts/sc_ws_wrong_call_data.md'
- Generalized Accounts:
- both:
- basic_open_close: 'protocol/node/api/examples/channels/json-rpc/generalized_accounts/both/basic_open_close.md'
- initiator:
- basic_open_close: 'protocol/node/api/examples/channels/json-rpc/generalized_accounts/initiator/basic_open_close.md'
- responder:
- basic_open_close: 'protocol/node/api/examples/channels/json-rpc/generalized_accounts/responder/basic_open_close.md'
- Reconnect:
- basic_client_reconnect_i: 'protocol/node/api/examples/channels/json-rpc/reconnect/basic_client_reconnect_i.md'
- basic_client_reconnect_i_w_reestablish: 'protocol/node/api/examples/channels/json-rpc/reconnect/basic_client_reconnect_i_w_reestablish.md'
- basic_client_reconnect_r: 'protocol/node/api/examples/channels/json-rpc/reconnect/basic_client_reconnect_r.md'
- With Meta:
- init_per_group: 'protocol/node/api/examples/channels/json-rpc/with_meta/init_per_group.md'
- deposit: 'protocol/node/api/examples/channels/json-rpc/with_meta/sc_ws_deposit.md'
- remote_call_contract: 'protocol/node/api/examples/channels/json-rpc/with_meta/sc_ws_remote_call_contract.md'
- withdraw: 'protocol/node/api/examples/channels/json-rpc/with_meta/sc_ws_withdraw.md'
- basic_open_close: 'protocol/node/api/examples/channels/json-rpc/sc_ws_basic_open_close_server.md'
- basic_open_close_server: 'protocol/node/api/examples/channels/json-rpc/sc_ws_basic_open_close.md'
- broken_open_params: 'protocol/node/api/examples/channels/json-rpc/sc_ws_broken_open_params.md'
- close_mutual: 'protocol/node/api/examples/channels/json-rpc/sc_ws_set_fee_close_mutual.md'
- close_solo: 'protocol/node/api/examples/channels/json-rpc/sc_ws_close_mutual.md'
- leave_reconnect: 'protocol/node/api/examples/channels/json-rpc/sc_ws_leave_reconnect.md'
- leave_reestablish: 'protocol/node/api/examples/channels/json-rpc/sc_ws_leave_reestablish.md'
- leave_reestablish_responder_stays: 'protocol/node/api/examples/channels/json-rpc/sc_ws_leave_reestablish_responder_stays.md'
- leave_reestablish_wrong_fsm_id: 'protocol/node/api/examples/channels/json-rpc/sc_ws_leave_reestablish_wrong_fsm_id.md'
- min_depth_is_modifiable: 'protocol/node/api/examples/channels/json-rpc/min_depth_is_modifiable.md'
- min_depth_not_reached_timeout: 'protocol/node/api/examples/channels/json-rpc/min_depth_not_reached_timeout.md'
- opening_ping_pong: 'protocol/node/api/examples/channels/json-rpc/opening_ping_pong.md'
- slash: 'protocol/node/api/examples/channels/json-rpc/slash.md'
- snapshot_solo: 'protocol/node/api/examples/channels/json-rpc/snapshot_solo.md'
- timeout_open: 'protocol/node/api/examples/channels/json-rpc/timeout_open.md'
- update_with_meta: 'protocol/node/api/examples/channels/json-rpc/update_with_meta.md'
- Oracles:
- Oracles: 'protocol/oracles/oracles.md'
- Oracle Life Cycle Examples: 'protocol/oracles/oracle_life_cycle.md'
- Oracle State Tree: 'protocol/oracles/oracle_state_tree.md'
- Oracle Transactions: 'protocol/oracles/oracle_transactions.md.'
- Aetmodel:
- Threat Model: 'aetmodel/ThreatModel.md'
- AEXs:
- AEX1: 'AEXs/AEXS/aex-1.md'
- AEX2: 'AEXs/AEXS/aex-2.md'
- AEX3: 'AEXs/AEXS/aex-3.md'
- AEX4: 'AEXs/AEXS/aex-4.md'
- AEX5: 'AEXs/AEXS/aex-5.md'
- AEX7: 'AEXs/AEXS/aex-7.md'
- AEX9: 'AEXs/AEXS/aex-9.md'
- AEX10: 'AEXs/AEXS/aex-10.md'
- AEX-Draft: 'AEXs/AEXS/aex-draft_data_serialization.md'
- Node Usage API:
- Latest Stable Release:
- Autogenerated æternity Node API Documentation: 'protocol/api-docs/README.md'
- Encoding Scheme: 'protocol/node/api/api_encoding.md'
- Account Managment: 'protocol/node/api/account_api_usage.md'
- Spending Tokens: 'protocol/node/api/spend_api_usage.md'
- Oracle: 'protocol/node/api/oracle_api_usage.md'
- Naming System: 'protocol/node/api/naming_system_api_usage.md'
- Contract: 'protocol/node/api/contract_api_usage.md'
- Channels: 'protocol/node/api/channels_api_usage.md'
- Mining: 'protocol/node/api/mining_api_usage.md'
- Developer Tools:
- æternity Framework:
- AEproject: 'developer-tools/æternity-frameworks/aepp-aeproject-js/README.md'
- Software Development Kits:
- Go: 'developer-tools/sdks/aepp-sdk-go/README.md'
- JavaScript: 'developer-tools/sdks/aepp-sdk-js/README.md'
- Python: 'developer-tools/sdks/aepp-sdk-python/README.md'
- Elixir: 'developer-tools/sdks/aepp-sdk-elixir/README.md'
- Java: 'developer-tools/sdks/aepp-sdk-java/README.md'
- Middleware: 'developer-tools/aepp-middleware/README.md'
- Token Faucet: 'developer-tools/aepp-faucet/README.md'
- Frameworks:
- æpp Components: 'developer-tools/frameworks/aepp-components/README.md'
- Contract Editor: 'developer-tools/aepp-contracts/README.md'
- AirGap:
- AirGap Coin Library: 'developer-tools/airgap/airgap-coin-lib/docs/README.md'
- AirGap Vault: 'developer-tools/airgap/airgap-vault/README.md'
- AirGap Wallet: 'developer-tools/airgap/airgap-wallet/README.md'
# - CLI Tools:
# - JavaScript
# - Stratum:
# - Library
# - Websocket
# - Online Test Tools:
# - Smart Contract Editor
# - Blockchain Explorer
# - Faucet
# - Token Faucet
# - æpp Faucet
- Sophia Compiler:
- aesophia: 'aesophia/README.md'
- Sophia Libraries:
- DateTime: 'aepp-sophia-examples/libraries/DateTime/README.md'
- List: 'aepp-sophia-examples/libraries/List/README.md'
- Ownable: 'aepp-sophia-examples/libraries/Ownable/README.md'
- FungibleToken: 'aepp-sophia-examples/libraries/FungibleToken/README.md'
- NonFungibleToken: 'aepp-sophia-examples/libraries/NonFungibleToken/README.md'
- MultisignatureWallet: 'aepp-sophia-examples/libraries/MultisignatureWallet/README.md'
extra_css: [site/assets/extra.css]
theme:
name: 'material'
palette:
primary: 'pink'
accent: 'white'
font:
text: 'Roboto'
code: 'Roboto Mono'
repo_name: 'aeternity/documentation-hub'
repo_url: 'https://github.com/aeternity/documentation-hub'