Skip to content

Commit fd06ba1

Browse files
committed
review of docs against editorialGuide
1 parent 570165d commit fd06ba1

24 files changed

+374
-381
lines changed

docs/FACT token/economic-model.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@ slug: /economic-model
77
# Economic Model
88

99
The FACT token lies at the core of Orcfax's economic model. To access Orcfax
10-
feeds, consumers (e.g. dApps, smart contracts) must use $FACT for payment. While
10+
feeds, consumers (e.g. dApps, smart contracts) can use $FACT for payment. While
1111
consumers can also use ADA, these payments are exchanged for FACT tokens,
1212
creating a positive feedback loop that boosts demand for the FACT token.
1313

1414
Since consumers pay for on-chain publications, an increase in consumers leads to
1515
more publications, driving up the demand for the FACT token. The generated $FACT
1616
payments are distributed to entities crucial for network operation and security:
17-
Orcfax Validators and the Orcfax network.
17+
Orcfax Validators and the Orcfax Network.
1818

1919
![Orcfax Economic Model](/img/2024-02--Orcfax-economic-model2.jpg)
2020

2121
Initially, with a relatively low number of consumers and publications after the
22-
decentralized network launches on mainnet, validators and the Orcfax network
22+
decentralized network launches on mainnet, validators and the Orcfax Network
2323
will receive compensation through the
2424
'[Validator Rewards Allocation][rewards-1]'. This allocation, constituting 50%
2525
of the total FACT token supply, rewards Validators and the Orcfax Network. The
@@ -29,7 +29,7 @@ payments from these customers will compensate for the reduced emission from the
2929
Validator Rewards Allocation, and will eventually replace them completely.
3030

3131
Though other FACT holders aren't involved in operating and securing the initial
32-
version of the validator network (V1), [the community has decided][vote-1] to
32+
version of the validator Network (V1), the community has [decided][vote-1] to
3333
allocate a small portion of FACT rewards to be used as rewards for FACT holders
3434
willing to lock their tokens. The estimated APY for doing this is 3-8%. These
3535
rewards will partly come from the Validator Rewards Allocation and partly from

docs/FACT token/tokenomics.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,22 @@ sidebar_position: 1
44
slug: /tokenomics
55
---
66

7-
# FACT Tokenomics
7+
# FACT tokenomics
88

99
The FACT [utility token](utility-token) has a fixed supply of 1 billion tokens.
1010

1111
The FACT token minting policy ID is
1212
[a3931691f5c4e65d01c429e473d0dd24c51afdb6daf88e632a6c1e51][policyid-1].
1313

14-
The FACT token is tradeable on [Cardano DEX markets][dexes-1]. It is listed on
14+
The FACT token is tradeable on [Cardano DEX markets][dex-1]. It is listed on
1515
coin tracking sites like [CoinGecko][listing-1] and [CoinMarketCap][listing-2].
1616

1717
[policyid-1]: https://pool.pm/asset1kuwfd0esf9xcxurp2x4f9w65lvz4tkfw5epugq
1818
[listing-1]: https://www.coingecko.com/en/coins/orcfax
1919
[listing-2]: https://coinmarketcap.com/currencies/orcfax/
20-
[dexes-1]: https://www.taptools.io/charts/token?pairID=026a18d04a0c642759bb3d83b12e3344894e5c1c7b2aeb1a2113a570.2b4e632bf755fe5e33309a47216aa396106641edd056423e2ef2a08ce30bb604
20+
[dex-1]: https://www.taptools.io/charts/token?pairID=026a18d04a0c642759bb3d83b12e3344894e5c1c7b2aeb1a2113a570.2b4e632bf755fe5e33309a47216aa396106641edd056423e2ef2a08ce30bb604
2121

22-
## Token Distribution
22+
## Token distribution
2323

2424
Following the token generation event (TGE), the Orcfax team distributed all
2525
1,000,000,000 $FACT to a series of [ADA Handle][handle-1] wallets. Each of these
@@ -55,16 +55,16 @@ The biggest allocation is reserved to reward our decentralized validators for
5555
running Orcfax nodes.
5656

5757
500,000,000 (50%) $FACT have been allocated for rewarding Orcfax validator node
58-
operators for collecting, formatting, validating, publishing and archiving
58+
operators for collecting, normalizing, validating, publishing and archiving
5959
real-world data for consumption as eUTXO datum by Cardano dApps and smart
6060
contracts.
6161

6262
This allocation is meant to subsidize operations long enough for the network to
6363
become self-sustaining based on fee collection. This allocation is a serious
64-
signal that Orcfax understands a healthy, thriving validator pool network is
65-
required for the long-term viability and value of the network.
64+
signal that Orcfax understands that a healthy validator network is required for
65+
the long-term viability and value of the network.
6666

67-
This allocation has a cliff date or vesting schedule. However, How it is paid
67+
This allocation does not have a cliff date or vesting schedule. How it is paid
6868
out to validators will be made public after the close of the Orcfax Incentivized
6969
Testnet.
7070

@@ -76,14 +76,14 @@ way of $FACT airdrops and giveaways. The project will also leverage this
7676
allocation in various public relations campaigns going forward.
7777

7878
This allocation has a cliff date of 3 months after the start of the ISPO and a 6
79-
month vesting period.
79+
month vesting period (i.e. after 3 months, distributed monthly for 6 months).
8080

8181
## Team
8282

8383
150,000,000 (15%) $FACT have been allocated for disbursement among the founding
8484
team; this allocation will be distributed to the founder and team members in
85-
order to compensate for their significant investments, both in time and effort
86-
to launch the Orcfax network.
85+
order to compensate them for their significant investments, both in time and
86+
effort to launch the Orcfax Network.
8787

8888
This allocation has a cliff date of 3 months after the start of the ISPO and a
8989
24 month vesting period.
@@ -165,16 +165,15 @@ $FACT by delegating ADA to our ISPO pool.
165165

166166
The cliff date for the first ISPO drops was September 2023, with 10% of the
167167
total $FACT supply allocated to ISPO participants. This allocation had a cliff
168-
date of 6 months after the start of the ISPO and a 6 month vesting period (i.e.
169-
distributed monthly, for 6 months).
168+
date of 6 months after the start of the ISPO and a 6 month vesting period.
170169

171170
[ispo-1]: https://orcfax.io/assets/Orcfax-ISPO-Prospectus--March15-2023.pdf
172171
[ispo-2]: https://docs.orcfax.io/assets/files/2023-07-07--Orcfax-ISPO-reflection-0212f8cd59e995f75fc8d5c0ad2625e7.pdf
173172

174173
## Yield Farming APY
175174

176-
20,000,000 (2%) FACT tokens are used to enhance the appeal of our liquidity
177-
pool(s) by offering substantial Yield Farming Rewards to our liquidity
175+
20,000,000 (2%) FACT tokens were used to enhance the appeal of our liquidity
176+
pool(s) by offering substantial yield farming rewards to our liquidity
178177
providers.
179178

180179
Yield farming, also called liquidity mining, involves lending or staking
@@ -184,12 +183,13 @@ like WingRiders, or Minswap. In return, users receive (native) tokens or other
184183
fees as rewards. Rewards vary based on factors like asset type, amount,
185184
duration, and platform demand.
186185

187-
These tokens received by users as a reward have no cliff and/or vesting
188-
restrictions.
186+
The tokens received by users as a reward for their staked $FACT have no cliff
187+
and/or vesting restrictions.
189188

190189
### Disclaimer
191190

192-
The information provided above is for educational and informational
193-
purposes only. Yield farming involves financial risks, and individuals should
194-
carefully consider their own financial situation, risk tolerance, and investment
195-
goals before participating in any yield farming program.
191+
Orcfax does not offer financial advice. The information provided above is for
192+
educational and informational purposes only. Yield farming involves financial
193+
risks, and individuals should carefully consider their own financial situation,
194+
risk tolerance, and investment goals before participating in any yield farming
195+
program.

docs/FACT token/utility-token.md

+25-27
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
id: faq-1
2+
id: utility-token
33
sidebar_position: 3
44
slug: /utility-token
55
---
66

7-
# FACT utility
7+
# The FACT utility token
88

99
The Orcfax platform includes a Cardano-native utility token which has been named
1010
$FACT. This utility token has been designed with a limited number of explicit
@@ -13,7 +13,7 @@ uses. $FACT can be used for:
1313
1. Payment by consumers for data publication, either by a heartbeat publication
1414
model or an on-demand publication model
1515
2. Staking by our data validator nodes to participate in oracle processes
16-
3. Reward payments to validators for participation in the Orcfax node network
16+
3. Reward payments to validators for participation in the Orcfax Network
1717
4. Voting power in Orcfax DAO governance decisions
1818

1919
Importantly, Orcfax has grounded the utility of the token by minting a fixed
@@ -26,15 +26,15 @@ More information about the utility of the FACT token can be found in thr Orcfax
2626

2727
## Utility 1: Payment
2828

29-
The FACT token is used in the Orcfax network as the form of payment for the fees
30-
charged to publish new fact statements.
29+
The FACT token is used in the Orcfax Network as the form of payment for the fees
30+
charged to publish new Fact Statements.
3131

3232
Orcfax feed consumers (e.g. dApp, smart contract) seeking to fund feeds which
3333
are published on a user-stipulated heartbeat schedule will have the cost of
3434
publication quoted in FACT.
3535

3636
Alternatively, if an Orcfax feed consumer needs a more current update for a
37-
given datum feed (e.g. ADA/USD) than is available on-chain, then an on-demand
37+
given datum feed (e.g. ADA-USD) than is available on-chain, then an on-demand
3838
publication request can be triggered. The cost of publishing this new fact datum
3939
on-chain will likewise be quoted in $FACT.
4040

@@ -48,41 +48,39 @@ creating a positive feedback loop that boosts demand for the FACT token.
4848
$FACT will also be used by Orcfax validator node operators as staked collateral
4949
to incentivize good performance and trust in the network.
5050

51+
On January 9th, 2024 Orcfax published its
52+
[Orcfax Validator License Announcement][announce-1], which outlined what
53+
potential node operators, and non-validators, could look forward to as licenses
54+
became available and as the Incentivized Testnet (ITN) is being developed.
55+
5156
To become an Orcfax Validator, users are required to 1) mint and/or hold a
5257
Validator license, and 2) deposit $FACT tokens into the Orcfax validator smart
5358
contract.
5459

5560
1. There are only 100 validator licenses available for node operation. During
5661
the origin minting process, each license cost 100,000 $FACT.
57-
2. The required $FACT deposit will be determined by market value as of 1 March
58-
2024, whereby either 500,000 $FACT or 10,000 USD equivalent in $FACT will be
59-
required (i.e. whichever $FACT amount is larger on that date).
62+
2. When the validator nodes begin operating, a deposit of 500,000 $FACT will be
63+
required in the validator smart contract.
6064

6165
By requiring operators to put up a certain amount of $FACT to run a node,
6266
operators demonstrate their “skin in the game”. Orcfax decided on the required
6367
amount of $FACT which simultaneously encourages a diverse community of node
64-
operators while also discouraging bad actors.
65-
66-
On January 9th, 2024 Orcfax announced published its
67-
[Orcfax Validator License Announcement][announce-1], which outlined what
68-
potential node operators and non-validators could look forward to as licenses
69-
became available and as the incentivized testnet (ITN) was rolled out.
70-
71-
If, for whatever reason, a node reports irregular data or has persistent
72-
networking issues, then their deposited stake will be slashed by the protocol.
73-
This is both a penalty for jeopardizing the integrity of the Orcfax network, as
74-
well as an incentive to re-calibrate their node operations.
68+
operators while also discouraging bad actors. If, for whatever reason, a node
69+
reports irregular data or has persistent networking issues, then their deposited
70+
stake may be slashed by the protocol. This is both a penalty for jeopardizing
71+
the integrity of the Orcfax Network, as well as an incentive to diligently
72+
monitor and re-calibrate node operation as appropriate.
7573

7674
[announce-1]: https://medium.com/@orcfax/orcfax-validator-license-announcement-5da07ef1439c
7775

7876
## Utility 3: Rewards
7977

80-
When a fact statement is published on chain the validator that was randomly
78+
When a Fact is published on chain, the validator which was randomly
8179
selected to put that statement on-chain will be rewarded with FACT tokens. This
8280
means that because the amount of Validator licenses are limited, more feeds
83-
means more rewards will be distributed to each active validator.
81+
will result in more rewards being distributed to each active validator.
8482

85-
The initial version of the validator network (V1) will be designed to select
83+
The initial version of the Validator Network (v1) will be designed to select
8684
validators at random to publish a fact statement, giving all validators an equal
8785
chance of earning a reward. Future models will weight this random distribution
8886
by biasing rewards to those with higher $FACT delegation.
@@ -98,18 +96,18 @@ Validators have the ability to estimate potential rewards that they can expect
9896
by utilizing the [initial rewards calculator][calc-1].
9997

10098
The calculator allows users to simulate certain scenarios by modifying the most
101-
important parameters that define the estimated rewards (like number of feeds).
99+
important parameters that define the estimated rewards (e.g. number of feeds).
102100
The yellow fields can be modified by the user. Some fields include notes to help
103101
users understand how the calculation works.
104102

105103
[calc-1]: https://docs.google.com/spreadsheets/d/1aH4Zwtn8KUTtrdzBBZFK1_Kulb7_a4uJGjzLhmPTLFc/edit#gid=1934045699
106104

107105
## Utility 4: Voting
108106

109-
Governance of the Orcfax network, including its technical operations, R&D,
107+
Governance of the Orcfax Network, including its technical operations, R&D,
110108
community management, new feed nominations, fee schedule, etc., will all be
111-
transitioned from Orcfax Ltd. to a Decentralized Autonomous Organization after
112-
the network has proven to be healthy and self-sustaining.
109+
transitioned from Orcfax Ltd. to a Decentralized Autonomous Organization (DAO)
110+
after the network has proven to be healthy and self-sustaining.
113111

114112
As different proposals are brought to the Orcfax DAO for approval, the FACT
115113
token will serve as stake in weighted voting scores. That is to say, the more

docs/FAQ/faq-1.md

+38-34
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ slug: /oracle-basics
66

77
# Oracle basics
88

9-
## What is an oracle?
9+
## What is a blockchain oracle?
1010

11-
Oracles like [Orcfax](https://orcfax.io/), [Chainlink](https://chain.link),
12-
[Charli3](https://charli3.io), etc. are the technical component in blockchain
13-
architectures that deliver data about the real-world to on-chain smart
14-
contracts.
11+
Blockchain oracles such as [Orcfax][oracle-1], [Chainlink][oracle-2],
12+
[Charli3][oracle-3], etc. are the technical component in blockchain
13+
architectures which bring data about the real world on-chain for consumption by
14+
smart contracts.
1515

1616
The name is derived from people in the ancient world who delivered messages and
1717
knowledge from the gods to the mortals.
@@ -20,26 +20,30 @@ knowledge from the gods to the mortals.
2020

2121
Software oracles process information from online sources such as website
2222
content and open datasets but mostly from server-based application programming
23-
interfaces (API). These are the most common types of oracles and are used, for
24-
example, by algorithmic stablecoins or automated market maker (AMM) exchanges
25-
to monitor for changes in currency exchange rates.
23+
interfaces (API). These are the most common types of oracles and are used by
24+
algorithmic stablecoins or automated market maker (AMM) exchanges to monitor for
25+
changes in currency exchange rates.
2626

2727
See [this article](https://cointelegraph.com/learn/what-is-a-blockchain-oracle-and-how-does-it-work)
2828
for some further information about oracles and their role in blockchain networks
2929
.
3030

31+
[oracle-1]: https://orcfax.io/
32+
[oracle-2]: https://chain.link
33+
[oracle-3]: https://charli3.io
34+
3135
## What is a smart contract?
3236

3337
Smart contracts are software programs that execute conditional logic on
34-
next-generation blockchains like Cardano (e.g. when event X happens, trigger
35-
action Y). Because their source code is immutably stored and run on
38+
next-generation blockchains like Cardano (e.g. when event X happens, trigger
39+
action Y). Because their source code is immutably stored and run on
3640
decentralized blockchain networks, they constrain the range of permissible user
3741
actions and their effects.
3842

3943
This means that they can reasonably be expected to have the same outcome each
40-
time they are triggered. Therefore smart contracts are often referred to as
41-
having "trustless" qualities. The term "trustless" is a popular word to
42-
characterize blockchain technology because its cryptographic proofs and
44+
time they are triggered. It is for this reason that smart contracts are often
45+
referred to as having "trustless" qualities. The term "trustless" is a popular
46+
word to characterize blockchain technology because its cryptographic proofs and
4347
distributed consensus algorithms ensure that its shared data is authentic,
4448
accurate, and secure without reliance on a trusted third-party to verify the
4549
information.
@@ -55,24 +59,24 @@ because the execution of smart contract logic can have significant economic
5559
and social consequences. Especially considering that the consequences of a
5660
blockchain transaction are irreversible by their very design.
5761

58-
For example:
59-
60-
* A change in the Bitcoin to ADA price may trigger a limit order in a DeFi
61-
smart contract.
62-
* The final score in a sports event may trigger a payout in a betting dApp
63-
smart contract.
64-
* An extreme weather event may trigger a payout for a crop insurance smart
65-
contract.
66-
* The words spoken in a political speech and authenticated via blockchain
67-
notarization may trigger policy changes or protests.
62+
>Example:
63+
>
64+
>* A change in the Bitcoin to ADA price may trigger a limit order in a DeFi
65+
>smart contract.
66+
>* The final score in a sports event may trigger a payout in a betting dApp
67+
>smart contract.
68+
>* An extreme weather event may trigger a payout for a crop insurance smart
69+
>contract.
70+
>* The words spoken in a political speech and authenticated via blockchain
71+
>notarization may trigger policy changes.
6872
6973
## What is the oracle problem?
7074

71-
The blockchain industry refers to the "oracle problem" to refer to the various
75+
The blockchain industry uses the "oracle problem" to refer to the various
7276
issues related to ensuring that on-chain smart contracts can trust real world
7377
data inputs to be authentic and accurate.
7478

75-
The trillion dollar DeFi industry is critically dependent on real-world data
79+
The DeFi industry is critically dependent on real-world data
7680
provided by oracles. However, oracle engineering is still in an early stage.
7781
There are still many opportunities to introduce false data about real-world
7882
events into oracle data collection, validation and publication pipelines.
@@ -85,7 +89,7 @@ to smart contracts can be trusted to be authentic and accurate.
8589

8690
Most oracle providers provide little to no traceability on how their
8791
published, on-chain data is collected and validated to be authentic and
88-
accurate. Their users simply see a single magic data point appear on chain. The
92+
accurate. Their users simply see a data point appear on chain. The
8993
context of creation and use is provided by the on-chain transaction, not the
9094
oracle datum itself.
9195

@@ -100,9 +104,9 @@ often receive data from a single, black box provider. They then might use an
100104
oracle pool to arrive at a consensus about the *uniformity* of that data and
101105
not necessarily about its *authenticity* or *accuracy*.
102106

103-
Orcfax was intentionally designed as a
104-
[second-generation oracle](solution-overview) service that addresses multiple
105-
layers of the oracle problem in a more comprehensive way.
107+
Orcfax has been, and continues to be, intentionally designed to addresses
108+
the multiple layers of the oracle problem and to do so in a more comprehensive
109+
way than eny other oracle service.
106110

107111
## What is the real world?
108112

@@ -124,13 +128,13 @@ A fact is something that is known to have happened or to exist, especially
124128
something for which proof exists, or about which there is information.
125129
(Cambridge Dictionary, 2021)
126130

127-
Truths can be interpretive, opinionated, exclusionary, contextual or personal,
128-
e.g. "this cylinder makes pretty shadows that are blue and circular".
131+
Truths can be interpretive, opinionated, exclusionary, contextual or personal
132+
(e.g. "this cylinder makes pretty shadows that are blue and circular").
129133

130134
![Facts lead to truths](/img/2023-09-05--Orcfax--The-Nature-Of-Facts.png)
131135

132-
Fact statements are more definitive, e.g.
133-
"the name of this image file is what-is-true.png". Orcfax publishes fact
134-
statements about the real world to the Cardano blockchain.
136+
Fact statements are more definitive
137+
(e.g."the name of this image file is what-is-true.png"). Orcfax publishes Fact
138+
Statements about the real world to the Cardano blockchain.
135139

136140
![The nature of facts](/img/2023-09-06--Orcfax--Nature-of-Facts.png)

0 commit comments

Comments
 (0)