-
Notifications
You must be signed in to change notification settings - Fork 86
/
mkdocs.yml
374 lines (371 loc) · 21.6 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
site_name: Documentation
validation:
omitted_files: warn
absolute_links: ignore
unrecognized_links: warn
theme:
name: material
custom_dir: docs/assets/overrides
palette:
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: flaredark
# toggle:
# icon: material/weather-sunny
# name: Switch to light mode
# Palette toggle for light mode
# - media: "(prefers-color-scheme: light)"
# scheme: default
# primary: white
# toggle:
# icon: material/weather-night
# name: Switch to dark mode
logo: logo.svg # Put it in the overrides folder!
favicon: /favicon.png
icon:
edit: material/pencil
features:
- navigation.top # "Back to top" button appears upon upward scrolling
- navigation.indexes # Allow section headers to have a page (see tech/index.md)
- navigation.sections # to show first level of sections expanded
- content.tabs.link
- search.suggest # Search will display the likeliest completion for the last word
- search.highlight # Highlight all occurrences after following the link
- content.code.copy # Code blocks render a button to allow the user to copy a code
- content.action.edit # Edit icon
markdown_extensions:
- admonition # Info boxes (in different colors)
- pymdownx.details # "
- pymdownx.superfences # Info boxes, tabs
- pymdownx.caret # Allow superscript and insertion marks (^ and ^^)
- pymdownx.tilde # Allow subscript and deletion marks (~ and ~~)
- pymdownx.keys # Allow Keyboard marks (++)
- pymdownx.mark # Allow selection marks (==)
- pymdownx.inlinehilite # Syntax-highlight inline code
- pymdownx.tabbed: # Tabbed content
alternate_style: true
- toc: # TOC control
permalink: "#" # Add permalinks to headers
- pymdownx.arithmatex: # Math blocks
generic: true
- attr_list # { Annotations }
- md_in_html # Markdown inside HTML
- def_list # Definition lists (Glossary)
- pymdownx.snippets # Import files with --8<--
- footnotes # Footnotes with [^1]
plugins:
- search: # Search box at the top
separator: '[$\s\-,:!=\[\]()"/]+'
- git-revision-date # Last edit timestamp at the bottom
- swagger-ui-tag: # Renders OpenApi Spec
extra_css:
- assets/stylesheets/extra.css
- macros: # Jinja2 macros
include_dir: include
- autolinks # Use just filenames instead of full or relative paths
- redirects: # Allow creating redirects for moved pages
redirect_maps:
'en/data-connector.md': 'tech/data-connector.md'
'technology/glossary.md': 'tech/glossary.md'
'technology/data-connector.md': 'tech/data-connector.md'
'networks/songbird.md': 'developer-hub.md'
'networks/coston-testnet.md': 'developer-hub.md'
'tech/flare-launch-process.md': 'tech/archive/flare-launch-process.md'
'tutorials/wallets/index.md': 'user/wallets/index.md'
'tutorials/wallets/bifrost-wallet.md': 'user/wallets/bifrost-wallet.md'
'tutorials/wallets/dcent-wallet.md': 'user/wallets/dcent-wallet.md'
'tutorials/wallets/how-to-access-flare-network-with-a-ledger-device.md': 'user/wallets/how-to-access-flare-network-with-a-ledger-device.md'
'tutorials/wallets/how-to-access-flare-network-with-a-trezor-device.md': 'user/wallets/how-to-access-flare-network-with-a-trezor-device.md'
'tutorials/wallets/how-to-access-flare-network-with-metamask.md': 'user/wallets/how-to-access-flare-network-with-metamask.md'
'tutorials/wallets/safepal-s1-wallet.md': 'user/wallets/safepal-s1-wallet.md'
'tutorials/wallets/brave-wallet.md': 'user/wallets/brave-wallet.md'
'tutorials/explorer/songbird-explorer.md': 'developer-hub.md'
'tutorials/explorer/coston-explorer.md': developer-hub.md
'tutorials/developing-on-top-of-flare/README.md': 'developer-hub.md'
'tutorials/developing-on-top-of-flare/important-links.md': 'developer-hub.md'
'tutorials/delegation/README.md': 'user/delegation/index.md'
'tutorials/delegation/delegation-in-detail.md': 'tech/ftso/index.md'
'tutorials/delegation-faq/README.md': 'tech/ftso/index.md'
'tutorials/delegation-faq/block-explorer-+-metamask.md': 'user/delegation/managing-delegations.md'
'tutorials/reward-claiming/README.md': 'tech/ftso/index.md'
'tutorials/reward-claiming/reward-claiming-in-detail.md': 'user/delegation/managing-rewards.md'
'tutorials/reward-faq/README.md': 'tech/ftso/index.md'
'tutorials/reward-faq/block-explorer-+-metamask.md': 'user/delegation/managing-rewards.md'
'tutorials/price-provider/setting-up-an-observation-node/README.md': 'developer-hub.md'
'tutorials/price-provider/setting-up-an-observation-node/observation-node-faq.md': 'developer-hub.md'
'tutorials/price-provider/ftso-price-provider/README.md': 'developer-hub.md'
'tutorials/price-provider/ftso-price-provider/price-provider-faq.md': 'developer-hub.md'
'tutorials/price-provider/ftso-price-provider/whitelisting-a-price-provider.md': 'developer-hub.md'
'tutorials/price-provider/ftso-price-provider/whitelisting-price-provider-faq.md': 'developer-hub.md'
'tutorials/price-provider/troubleshooting/price-provider.md': 'developer-hub.md'
'infra/data/deploying.md': 'developer-hub.md'
'tutorials/price-provider/troubleshooting/observation-node.md': 'developer-hub.md'
'tutorials/price-provider/whitelisting.md': 'developer-hub.md'
'dev/getting-started/index.md': 'developer-hub.md'
'dev/getting-started/setup/index.md': 'developer-hub.md'
'dev/getting-started/setup/remix.md': 'developer-hub.md'
'dev/getting-started/setup/hardhat.md': 'developer-hub.md'
'dev/getting-started/setup/foundry.md': 'developer-hub.md'
'dev/getting-started/contract-addresses.md': 'developer-hub.md'
'dev/tutorials/network-access/index.md': 'developer-hub.md'
'dev/tutorials/network-access/transaction-finalization.md': 'developer-hub.md'
'dev/tutorials/network-access/reliable-event-reading.md': 'developer-hub.md'
'dev/tutorials/network-access/obtaining-revert-reason.md': 'developer-hub.md'
'dev/tutorials/ftso/index.md': 'developer-hub.md'
'dev/tutorials/ftso/getting-data-feeds.md': 'developer-hub.md'
'dev/tutorials/ftso/getting-random-numbers.md': 'developer-hub.md'
'dev/tutorials/sc/index.md': 'developer-hub.md'
'dev/tutorials/sc/address-validity.md': 'developer-hub.md'
'dev/reference/automatic-claiming.md': 'developer-hub.md'
'dev/reference/personal-delegation-account.md': 'developer-hub.md'
'dev/reference/explorers-and-indexers.md': 'developer-hub.md'
'dev/reference/the-flaredrop.md': 'developer-hub.md'
'dev/reference/wallets.md': 'developer-hub.md'
'dev/external-resources.md': 'developer-hub.md'
'dev/tools.md': 'developer-hub.md'
'security/index.md': 'developer-hub.md'
'apis/index.md': 'developer-hub.md'
'apis/smart-contracts/index.md': 'developer-hub.md'
'apis/smart-contracts/AddressUpdatable.md': 'developer-hub.md'
'apis/smart-contracts/AddressUpdater.md': 'developer-hub.md'
'apis/smart-contracts/AddressValidityVerification.md': 'developer-hub.md'
'apis/smart-contracts/BalanceDecreasingTransactionVerification.md': 'developer-hub.md'
'apis/smart-contracts/CheckPointable.md': 'developer-hub.md'
'apis/smart-contracts/ClaimSetupManager.md': 'developer-hub.md'
'apis/smart-contracts/CleanupBlockNumberManager.md': 'developer-hub.md'
'apis/smart-contracts/CloneFactory.md': 'developer-hub.md'
'apis/smart-contracts/ConfirmedBlockHeightExistsVerification.md': 'developer-hub.md'
'apis/smart-contracts/Delegatable.md': 'developer-hub.md'
'apis/smart-contracts/EVMTransactionVerification.md': 'developer-hub.md'
'apis/smart-contracts/FlareContractRegistry.md': 'developer-hub.md'
'apis/smart-contracts/FlareDaemon.md': 'developer-hub.md'
'apis/smart-contracts/Ftso.md': 'developer-hub.md'
'apis/smart-contracts/FtsoManager.md': 'developer-hub.md'
'apis/smart-contracts/FtsoRegistry.md': 'developer-hub.md'
'apis/smart-contracts/FtsoRewardManager.md': 'developer-hub.md'
'apis/smart-contracts/GovernanceSettings.md': 'developer-hub.md'
'apis/smart-contracts/GovernanceVotePower.md': 'developer-hub.md'
'apis/smart-contracts/Governed.md': 'developer-hub.md'
'apis/smart-contracts/GovernedAndFlareDaemonized.md': 'developer-hub.md'
'apis/smart-contracts/GovernedAtGenesis.md': 'developer-hub.md'
'apis/smart-contracts/GovernedBase.md': 'developer-hub.md'
'apis/smart-contracts/Inflation.md': 'developer-hub.md'
'apis/smart-contracts/PaymentVerification.md': 'developer-hub.md'
'apis/smart-contracts/PChainStake.md': 'developer-hub.md'
'apis/smart-contracts/PChainStakeMirror.md': 'developer-hub.md'
'apis/smart-contracts/PriceSubmitter.md': 'developer-hub.md'
'apis/smart-contracts/ReferencedPaymentNonexistenceVerification.md': 'developer-hub.md'
'apis/smart-contracts/RevertErrorTracking.md': 'developer-hub.md'
'apis/smart-contracts/VoterWhitelister.md': 'developer-hub.md'
'apis/smart-contracts/VPContract.md': 'developer-hub.md'
'apis/smart-contracts/VPToken.md': 'developer-hub.md'
'apis/smart-contracts/WNat.md': 'developer-hub.md'
'apis/smart-contracts/IAddressValidityVerification.md': 'developer-hub.md'
'apis/smart-contracts/IBalanceDecreasingTransactionVerification.md': 'developer-hub.md'
'apis/smart-contracts/IClaimSetupManager.md': 'developer-hub.md'
'apis/smart-contracts/IConfirmedBlockHeightExistsVerification.md': 'developer-hub.md'
'apis/smart-contracts/IEVMTransactionVerification.md': 'developer-hub.md'
'apis/smart-contracts/IFlareContractRegistry.md': 'developer-hub.md'
'apis/smart-contracts/IFlareDaemonize.md': 'developer-hub.md'
'apis/smart-contracts/IFtso.md': 'developer-hub.md'
'apis/smart-contracts/IFtsoGenesis.md': 'developer-hub.md'
'apis/smart-contracts/IFtsoManager.md': 'developer-hub.md'
'apis/smart-contracts/IFtsoManagerGenesis.md': 'developer-hub.md'
'apis/smart-contracts/IFtsoRegistry.md': 'developer-hub.md'
'apis/smart-contracts/IFtsoRegistryGenesis.md': 'developer-hub.md'
'apis/smart-contracts/IFtsoRewardManager.md': 'developer-hub.md'
'apis/smart-contracts/IGovernanceSettings.md': 'developer-hub.md'
'apis/smart-contracts/IGovernanceVotePower.md': 'developer-hub.md'
'apis/smart-contracts/IInflationGenesis.md': 'developer-hub.md'
'apis/smart-contracts/IMerkleRootStorage.md': 'developer-hub.md'
'apis/smart-contracts/IPaymentVerification.md': 'developer-hub.md'
'apis/smart-contracts/IPChainStakeMirror.md': 'developer-hub.md'
'apis/smart-contracts/IPChainVotePower.md': 'developer-hub.md'
'apis/smart-contracts/IPriceSubmitter.md': 'developer-hub.md'
'apis/smart-contracts/IReferencedPaymentNonexistenceVerification.md': 'developer-hub.md'
'apis/smart-contracts/IStateConnector.md': 'developer-hub.md'
'apis/smart-contracts/IVoterWhitelister.md': 'developer-hub.md'
'apis/smart-contracts/IVPContractEvents.md': 'developer-hub.md'
'apis/smart-contracts/IVPToken.md': 'developer-hub.md'
'apis/smart-contracts/IWNat.md': 'developer-hub.md'
'apis/smart-contracts/IIAddressUpdatable.md': 'developer-hub.md'
'apis/smart-contracts/IIAddressUpdater.md': 'developer-hub.md'
'apis/smart-contracts/IIClaimSetupManager.md': 'developer-hub.md'
'apis/smart-contracts/IICleanable.md': 'developer-hub.md'
'apis/smart-contracts/IIFtso.md': 'developer-hub.md'
'apis/smart-contracts/IIFtsoManager.md': 'developer-hub.md'
'apis/smart-contracts/IIFtsoRegistry.md': 'developer-hub.md'
'apis/smart-contracts/IIFtsoRewardManager.md': 'developer-hub.md'
'apis/smart-contracts/IIGovernanceVotePower.md': 'developer-hub.md'
'apis/smart-contracts/IIInflationReceiver.md': 'developer-hub.md'
'apis/smart-contracts/IIPriceSubmitter.md': 'developer-hub.md'
'apis/smart-contracts/IITokenPool.md': 'developer-hub.md'
'apis/smart-contracts/IIVoterWhitelister.md': 'developer-hub.md'
'apis/smart-contracts/IIVPContract.md': 'developer-hub.md'
'apis/smart-contracts/IIVPToken.md': 'developer-hub.md'
'apis/REST/index.md': 'developer-hub.md'
'apis/REST/attestation-client.md': 'developer-hub.md'
'apis/REST/btcverifier.md': 'developer-hub.md'
'apis/REST/dogeverifier.md': 'developer-hub.md'
'apis/REST/evmverifier.md': 'developer-hub.md'
'apis/REST/xrpverifier.md': 'developer-hub.md'
'apis/attestation-types/index.md': 'developer-hub.md'
'apis/attestation-types/AddressValidity.md': 'developer-hub.md'
'apis/attestation-types/BalanceDecreasingTransaction.md': 'developer-hub.md'
'apis/attestation-types/ConfirmedBlockHeightExists.md': 'developer-hub.md'
'apis/attestation-types/EVMTransaction.md': 'developer-hub.md'
'apis/attestation-types/Payment.md': 'developer-hub.md'
'apis/attestation-types/ReferencedPaymentNonexistence.md': 'developer-hub.md'
'dev/index.md': 'developer-hub.md'
'dev/reference/ftso.md': 'developer-hub.md'
'dev/reference/network-config.md': 'developer-hub.md'
'dev/reference/flare.md': 'developer-hub.md'
'dev/reference/songbird.md': 'developer-hub.md'
'dev/reference/coston-testnet.md': 'developer-hub.md'
'dev/reference/network-configs.md': 'developer-hub.md'
'dev/contracts.md': 'developer-hub.md'
'exchange/index.md': 'developer-hub.md'
'exchange/architecture.md': 'developer-hub.md'
'exchange/delegation.md': 'developer-hub.md'
'exchange/troubleshooting.md': 'developer-hub.md'
'get-started-building/index.md': 'developer-hub.md'
'user/delegation/delegation-overview.md': 'tech/ftso/index.md'
'user/block-explorers/index.md': 'developer-hub.md'
'user/block-explorers/finding-reward-epoch.md': 'developer-hub.md'
'user/block-explorers/managing-delegations.md': 'developer-hub.md'
'user/block-explorers/managing-rewards.md': 'developer-hub.md'
'user/block-explorers/verifying-vote-power-block.md': 'developer-hub.md'
'user/block-explorers/viewing-nfts.md': 'developer-hub.md'
'user/block-explorers/viewing-token-balances.md': 'developer-hub.md'
'user/block-explorers/viewing-token-transfers.md': 'developer-hub.md'
'user/block-explorers/viewing-transactions.md': 'developer-hub.md'
'user/block-explorers/user-interface.md': 'developer-hub.md'
'user/delegation/delegation-faq.md': 'tech/ftso/index.md'
'user/delegation/delegation-in-detail.md': 'tech/ftso/index.md'
'user/delegation/manual-delegation.md': 'user/delegation/managing-delegations.md'
'user/delegation/manual-reward-claiming.md': 'user/delegation/managing-rewards.md'
'user/delegation/reward-claiming.md': 'tech/ftso/index.md'
'user/delegation/reward-claiming-faq.md': 'tech/ftso/index.md'
'user/delegation/reward-claiming-in-detail.md': 'tech/ftso/index.md'
'infra/data/operating.md': 'developer-hub.md'
'infra/validation/staking-cli.md': 'user/staking/staking-cli.md'
'infra/observation/faq.md': 'developer-hub.md'
'infra/observation/index.md': 'developer-hub.md'
'infra/observation/deploying.md': 'developer-hub.md'
'infra/observation/deploying-docker.md': 'developer-hub.md'
'infra/validation/index.md': 'developer-hub.md'
'infra/validation/deploying.md': 'developer-hub.md'
'infra/data/index.md': 'developer-hub.md'
'infra/data/whitelisting.md': 'developer-hub.md'
'infra/data/managing-ecosystem/index.md': 'developer-hub.md'
'infra/data/managing-ecosystem/exploring-collusion.md': 'developer-hub.md'
'infra/data/managing-ecosystem/monitoring-price-history.md': 'developer-hub.md'
'tech/ftso/ftso-scaling.md': 'https://dev.flare.network/ftso/overview/'
'tech/ftso/ftso-fast-updates.md': 'https://dev.flare.network/ftso/overview/'
'infra/fassets/index.md': 'https://dev.flare.network/category/fassets-guides'
'infra/fassets/deploying-agent.md': 'https://dev.flare.network/fassets/guides/deploy-fassets-agent'
'infra/fassets/managing-agent.md': 'https://dev.flare.network/fassets/guides/create-fasset-agent-ui'
'infra/fassets/liquidator.md': 'https://dev.flare.network/fassets/guides/deploy-fassets-agent'
'tech/fassets/index.md': 'https://dev.flare.network/fassets/overview'
'tech/fassets/collateral.md': 'https://dev.flare.network/fassets/collateral'
'tech/fassets/minting.md': 'https://dev.flare.network/fassets/minting'
'tech/fassets/redemption.md': 'https://dev.flare.network/fassets/redemption'
'tech/fassets/liquidation.md': 'https://dev.flare.network/fassets/liquidation'
'tech/fassets/open-beta.md': 'https://dev.flare.network/fassets/songbird'
'tech/fassets/parameters.md': 'https://dev.flare.network/fassets/operational-parameters'
'user/fassets/index.md': 'developer-hub.md'
'user/fassets/depositing-collateral-cli.md': 'developer-hub.md'
'user/fassets/minting-redeeming-cli.md': 'developer-hub.md'
'user/fassets/minting-redeeming-dapp.md': 'developer-hub.md'
extra_css:
- assets/stylesheets/extra.css
extra_javascript:
- assets/javascripts/images.js
- assets/javascripts/links.js
extra:
social:
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/flarenetwork/
- icon: fontawesome/solid/house
link: https://flare.network
- icon: fontawesome/brands/x-twitter
link: https://twitter.com/FlareNetworks
- icon: fontawesome/brands/github
link: https://github.com/flare-foundation
- icon: fontawesome/brands/telegram
link: https://t.me/FlareNetwork
- icon: fontawesome/brands/discord
link: https://discord.com/invite/flarenetwork
analytics:
provider: gtm # Custom Google Tag Manager integration
property: GTM-WX2D2TR
consent:
title: Cookie consent
description: >-
We use cookies to recognize your repeated visits and preferences, as well
as to measure the effectiveness of our documentation and whether users
find what they're searching for. With your consent, you're helping us to
make our documentation better.
copyright: >-
© Flare Networks 2024
site_url: https://docs.flare.network
repo_url: https://github.com/flare-foundation/docs
edit_uri: edit/main/docs/
site_dir: public
nav:
- Home:
- index.md
- tech/flare.md
- developer-hub.md
- User Guides:
- user/index.md
- Wallets:
- user/wallets/index.md
- user/wallets/bifrost-wallet.md
- user/wallets/brave-wallet.md
- user/wallets/dcent-wallet.md
- user/wallets/enkrypt-wallet.md
- user/wallets/how-to-access-flare-network-with-a-ledger-device.md
- user/wallets/how-to-access-flare-network-with-metamask.md
- user/wallets/safepal-s1-wallet.md
- user/wallets/how-to-access-flare-network-with-a-trezor-device.md
- user/wrapping-tokens.md
- FTSO Delegation:
- user/delegation/index.md
- Managing Delegations: user/delegation/managing-delegations.md
- Managing Rewards: user/delegation/managing-rewards.md
- user/personal-delegation-account.md
- Staking on Validators:
- user/staking/index.md
- user/staking/staking-flarestake.md
- user/staking/staking-portal.md
- user/staking/staking-cli.md
- user/claiming-the-flaredrop.md
- user/automatic-claiming.md
- Governance:
- user/governance/index.md
- user/governance/voting.md
- Products:
- products/index.md
- FTSO:
- tech/ftso/index.md
- tech/data-connector.md
- tech/api-portal.md
- Concepts:
- tech/index.md
- tech/automatic-claiming.md
- tech/flare-beta.md
- tech/flare-systems-protocol.md
- tech/validators.md
- tech/governance.md
- tech/personal-delegation-account.md
- tech/the-flaredrop.md
- tech/tokenomics.md
- tech/glossary.md
- Archive:
- tech/archive/index.md
- tech/archive/flare-launch-process.md
- tech/archive/ftso-v1.md
- Infrastructure:
- infra/index.md
- infra/connected-networks.md