Skip to content

Commit 447d5e3

Browse files
authored
restructure & edits per meeting (#39)
* restructure & edits per meeting * MD errors fixed * fixed caps in headings
1 parent fd06ba1 commit 447d5e3

35 files changed

+101
-328
lines changed

docs/FAQ/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"label": "FAQ",
3-
"position": 19
3+
"position": 8
44
}

docs/FAQ/faq-3.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
id: faq-3
33
sidebar_position: 3
4-
slug: /$FACT-launch
4+
slug: /$fact-launch
55
---
66

7-
# The $FACT Launch
7+
# The $FACT launch
88

99
On September 8th 2023, Orcfax launched the $FACT utility token in collaboration
1010
with the Wingriders’ Launchpad, and quickly reached the max contributions,
@@ -20,7 +20,7 @@ came online with Wingriders.
2020
update -->
2121
Yield farming rewards are available on both Wingriders and Minswap.
2222

23-
## What is the Fact policy ID?
23+
## What is the $FACT policy ID?
2424

2525
It has been reported that multiple fake FACT tokens, and pools, have been
2626
found. **Always** check our FACT Policy ID before making any trades:

docs/FAQ/faq-4.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
id: faq-4
33
sidebar_position: 4
4-
slug: /Technical-questions
4+
slug: /technical-questions
55
---
66

7-
# Technical Questions
7+
# Technical questions
88

99
## What are the minimum technical requirements for node operations?
1010

docs/Feeds/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"label": "Feeds",
3-
"position": 20
3+
"position": 3
44
}

docs/ITN/_category_.json

-4
This file was deleted.

docs/cardano-network/Catalyst/_category_.json

-4
This file was deleted.

docs/cardano-network/_category_.json

-4
This file was deleted.

docs/developer-manual/_category_.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"label": "Developer manual",
3-
"position": 10
3+
"position": 4
44
}

docs/developer-manual/deployments.md renamed to docs/developer-manual/orcfax-deployments.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
2-
id: orcfax deployments
2+
id: protocol deployments
33
sidebar_position: 3
44
slug: /deployments
55
---
66

7+
# Protocol deployments
8+
79
<!-- note:
810
Use &#x2011; to replace dashes below, e.g. for datetime stamps.
911
1012
2024-01-01 becomes 2024&#x2011;01&#x2011;01.
1113
-->
1214

13-
# Protocol deployments
14-
1515
The following documents current and historical deployments of the Orcfax
1616
protocol. The hashes can be used to navigate Orcfax Fact Statements and archival
1717
packages on Cardano and Arweave blockchains.
@@ -21,14 +21,14 @@ Integrators should consult the [integrator docs][consume] for an explanation
2121
an the role of different scripts used in the protocol and how to correctly use
2222
the Orcfax protocol.
2323

24-
## V1
24+
## v1
2525

26-
Orcfax V1 introduces the FSP (FactStatementPointer) script. The FSP will not
26+
Orcfax v1 introduces the FSP (FactStatementPointer) script. The FSP will not
2727
change in the lifetime of a deployment. The FSP is used to record the current
2828
FS (FactStatement) script hash. The FSP, FS, and C (Constitution) script
29-
hashes are documented below for each V1 deployment.
29+
hashes are documented below for each v1 deployment.
3030

31-
### V1: Mainnet
31+
### v1: Mainnet
3232

3333
A summary of mainnet deployments is listed below.
3434

@@ -51,7 +51,7 @@ A per-FSP breakdown is documented below.
5151
| Slot no. | - |
5252
| Block | - |
5353

54-
### V1: Preview
54+
### v1: Preview
5555

5656
A summary of preview deployments is listed below.
5757

@@ -78,7 +78,7 @@ A per-FSP breakdown is documented below.
7878

7979
<br/>
8080

81-
## V0
81+
## v0
8282

8383
Orcfax V0 used a series of scripts built in collaboration with MLabs, the
8484
protocol itself was called the Cardano Open Oracle Protocol (COOP). For more
@@ -90,7 +90,7 @@ to interpret the data published on-chain using this version.
9090
For brevity, only the primary script hash used for publication using COOP is
9191
listed below.
9292

93-
### V0: Mainnet
93+
### v0: Mainnet
9494

9595
| | Details |
9696
|------------------|---------|
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"label": "FACT token",
3-
"position": 3
3+
"position": 6
44
}
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Incentivized Testnet (ITN)",
3+
"position": 5
4+
}

docs/ITN/overview.md renamed to docs/incentivized-testnet/itn-overview.md

+54-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
id: overview
2+
id: ITN overview
33
sidebar_position: 1
4-
slug: /overview
4+
slug: /itn-overview
55
---
66

7-
# Incentivized Testnet overview
7+
# ITN overview
88

99
This section will be routinely updated and added to in order to keep our
1010
validators apprised of the most current information pertaining to the upcoming
@@ -36,8 +36,25 @@ strengthening the Mainnet protocol.
3636

3737
To join the ITN, participants must meet the following:
3838

39+
## Validator model introduction
40+
41+
Orcfax validators are the software nodes run by a decentralized network of
42+
operators around the world. These Orcfax software nodes collect, validate,
43+
publish and archive real world data on-chain for Cardano decentralized apps
44+
(dApps) to use. Instead of having off-chain business deals and contracts with
45+
hand-picked validators, Orcfax is implementing a permissionless and
46+
decentralized Oracle pool model for its validator network.
47+
48+
This means that anyone can become an Orcfax validator as long as they are able
49+
to meet the minimum [requirements](#technical-requirements).
50+
3951
### Validator license
4052

53+
The Validator License is an NFT that represents the right to operate an Orcfax
54+
validator node. The NFT is non-redeemable, but tradable on the secondary
55+
markets. The use of a license and the required deposit is strategically designed
56+
to provide network security, clarity, and fairness within the Validator Network.
57+
4158
Initially, participants may only be required to hold a validator license on a
4259
Mainnet wallet. However, as we progress through the more advanced phases of the
4360
ITN, participants will also need one on Testnet.
@@ -51,10 +68,23 @@ Testnet.
5168
5269
### 500,000 FACT deposit
5370

71+
On March 1, 2024 The required $FACT deposit for node operation was set at
72+
500,000 $FACT. This sum was determined through market value, whereby either
73+
500,000 $FACT or 10,000 USD equivalent in $FACT on March 1st would be required
74+
(i.e. whichever $FACT amount is larger on that date).
75+
5476
Participants need to maintain this balance in their Mainnet wallet, which will
5577
later need to be secured in a smart contract on the Testnet with tFACT
5678
(Testnet FACT).
5779

80+
The Deposit is a redeemable amount of $FACT staked by validators for network
81+
participation. It ensures validator accountability and is subject to slashing
82+
(penalty) for actions that harm the oracle network (e.g. poor node network
83+
response time, contributing non-conformant data, etc). Validators will be able
84+
to reclaim their deposited $FACT anytime. However, removing the required stake
85+
amount will result in losing the ability to run their node until a deposit is
86+
added once again.
87+
5888
### Technical requirements
5989

6090
The minimum hardware requirements for each phase will be published within their
@@ -92,6 +122,27 @@ for validator rewards. The first month will make 1,500,000 $FACT available for
92122
ITN participants to claim. This amount will be adjusted monthly to balance the
93123
rewards, based on the required effort and actual validator participation.
94124

125+
#### Non-validator rewards
126+
127+
All Orcfax $FACT holders were invited to vote on the first-ever Orcfax proposal:
128+
the implementation of rewards for $FACT holders. The proposal passed. More than
129+
28 million $FACT voted in favor of rewarding $FACT holders, and the results can
130+
be found [here][vote-1].
131+
132+
Orcfax facilitated this community vote in alignment with our decentralization
133+
goals, and to allow opportunities for community members to participate in
134+
(and shape) the future of the Orcfax network.
135+
136+
This proposal was requested by community members and introduced rewards for
137+
$FACT holders who may not have the capacity to join the Orcfax network as a
138+
validator, yet wish to receive $FACT rewards for locking (and not moving) their
139+
FACT tokens.
140+
141+
Orcfax is investigating methods to implement non-validator staking for the
142+
initial version (V1) of the validator network.
143+
144+
[vote-1]: https://app.summonplatform.io/poll/640336f9-0047-4055-91cf-4238ad4d182f
145+
95146
### Rewards calculation method
96147

97148
Rewards will be calculated based on the daily number of collections,

docs/intro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ society at large.
2727
[cardano-1]: https://medium.com/coinmonks/why-cardano-in-2023-b481846028bc
2828
[smart-1]: oracle-basics#what-is-a-smart-contract
2929

30-
## Getting Started
30+
## Getting started
3131

3232
Check our developer manual for instructions on how to:
3333

docs/node-operation/_category_.json

-4
This file was deleted.

docs/node-operation/operational-requirements.md

-100
This file was deleted.

0 commit comments

Comments
 (0)