orcfax-solution, editorial review

Author: Christian-MK

.vscode/settings.json

@@ -39,6 +39,8 @@
         "Wingriders",
         "bytearray",
         "timeframe",
-        "pubkey"
+        "pubkey",
+        "readablility",
+        "remediative"
     ]
 }

docs/intro.md

@@ -41,15 +41,16 @@ published by Orcfax, including its source data and validation history.
 ## Learn more
 
 The **[Solution Overview](solution-overview)** section provides a high level
-description the Orcfax technical architecture and its primary components.
+description of the Orcfax technical architecture and its primary components.
 
 Learn more about the **[tokenomics](tokenomics)** and
 **[utility](utility-token)** of the Orcfax service's native FACT token.
 
-Read our FAQ sections to answer any further questions you may have about Orcfax
-or oracles in general.
+Read our [FAQ](oracle-basics) sections to answer any further questions you may
+have about Orcfax or oracles in general.
 
-You can also join our **[Discord][Discord-1]** to engage directly
+You can subscribe to our content on [Medium][med-1] to stay up to date on new
+developments and join our **[Discord][Discord-1]** to engage directly
 with Orcfax team members.
-
+[med-1]: https://medium.com/@orcfax
 [Discord-1]: https://dsc.gg/orcfax

docs/orcfax-solution/The-Orcfax-vision.md

@@ -26,27 +26,29 @@ dashboard which enables users to quickly and easily navigate all data published
 by Orcfax, along with complete documentation for all processes leading to
 publication.
 
-Each Orcfax fact statement that is published on the Cardano blockchain has a
+Each Orcfax Fact Statement that is published on the Cardano blockchain has a
 corresponding audit trail that documents how the primary source data was
 collected and validated before it was published as a Cardano transaction datum.
 These audit logs are marked up using both industry-standards and open-data
-standards that enable machine-readable interoperability, like
-[IETF Bagit][bagit-1], which improves digital repository interoperability for
-digital archival packages.
+standards that enable machine-readablility, like [IETF Bagit][bagit-1], which
+improves digital repository interoperability for digital archival packages.
 
-While navigating through the Explorer, users can click on a fact statement card
-to see the detailed summary for that fact statement. The Archive Explorer viewer
+While navigating through the Explorer, users can click on a Fact Statement card
+to see the detailed summary for that Fact Statement. The Archive Explorer viewer
 loads the archival audit log package from the Arweave network (via Arkly.io) and
 provides the user with an intuitive view of all the audit log files.
 
-Click on the link below to view a walkthrough of the Orcfax Explorer!
+Click on the link below to view a walkthrough of the Orcfax Explorer.
 [![Explorer walkthrough](https://img.youtube.com/vi/MVLOBT58PlA/0.jpg)](https://www.youtube.com/watch?v=MVLOBT58PlA)
 
-This product brings additional value to the Orcfax solution by giving users the
-ability to freely search for, and review, all Fact Statements published by
-Orcfax. The Explorer does this through purposeful user-centered design decisions
-which have prioritized accessibility and ease of use for a dynamic and diverse
-user group.
+This product brings additional value to the Orcfax solution by providing tooling
+for users which enables them to freely search for, and review, all Fact
+Statements published by Orcfax. The Explorer does this through purposeful
+user-centered design decisions which have prioritized accessibility and ease of
+use for a dynamic and diverse user group.
+
+Orcfax will continue to build upon this service in order to deliver meaningful
+user tools which allow them to "trust but verify".
 
 [explorer-1]: https://explorer.orcfax.io/
 [bagit-1]: https://datatracker.ietf.org/doc/rfc8493/
@@ -66,23 +68,23 @@ And schema.org is the single most impactful markup language for making any type
 of metadata machine-readable. In Orcfax's case, that means metadata related to
 [Claims][claim-1] made about events happening in the real world.
 
-The use of these taxonomies, and the highly structured data as aa result, will
+The use of these taxonomies, and the resulting highly structured data, will
 perfectly position Orcfax feeds to serve as the source of a growing data lake of
-real world fact statements that will have many secondary reference uses beyond
+real world Fact Statements that will have many secondary reference uses beyond
 DeFi oracle publication. The highly machine and human readable data lake of
-validated fact statements can be used, for example, to train enterprise or
+validated Fact Statements can be used, for example, to train enterprise or
 personal AI models with reliable real-world data.
 
 Some of the most [current research on AI][ai-2]
 progress makes it clear that the in-deterministic nature of Large Language
 Models (LLM) cannot be relied upon for factual citations; these technologies
-need to be supported and trained by highly structured fact statements about the
+need to be supported and trained by highly structured Fact Statements about the
 real world that humans inhabit. We anticipate that the Orcfax protocol, anchored
 by the decentralized resiliency of the Cardano blockchain network, will have the
 ability to provide this foundational layer.
 
 We anticipate a suite of enterprise service layers on top of this data lake of
-decentralized, validated fact statements as a secondary revenue stream for the
+decentralized, validated Fact Statements as a secondary revenue stream for the
 Orcfax protocol once we reach a critical mass of feed types, data sources, and
 validator nodes.
 

docs/orcfax-solution/auditability.md

@@ -8,27 +8,32 @@ slug: /data-collection
 
 ## Decentralizing data collection​
 
-Since the roll out of our ADA-USD / USD-ADA feed, Orcfax has committed to
+Since the roll out of our ADA-USD feed, Orcfax has committed to
 educating users on the critical importance of rejecting data derived from single
 sources and the necessity for source redundancy. Orcfax addresses both of these
-and avoids single points of failure or attack by leveraging the scientific
+and avoids single points of failure or attack by leveraging the
 principle of triangulation, which is concerned with the utilization of multiple
 methods, or sources of information, in order to derive a comprehensive
 understanding of phenomena; this principle also aids in testing the validity of
 source information by providing the ability to compare the data across sources.
-Orcfax has enshrined this principle in node development and how nodes collect
-data.
+This principle has been enshrined in Orcfax node development and made evident in
+the processes by which Orcfax nodes collect data.
 
-Each Orcfax node is required to query, and receive data from a minimum of 3
+Each Orcfax node is required to query, and receive data from, a minimum of 3
 primary sources. This principle of triangulation protects the reliability and
 authenticity of oracle data. In practice, Orcfax node design uses the principle
 of triangulation in order to enable nodes to function even in scenarios where
 sources fail to return data, are compromised, or report anomalous data. In each
 of these scenarios, the principle means that nodes remain flexible and resilient
-given that they meet the threshold for minimum data sources (e.g. nodes query 5
-sources, and receive inputs from 4 which meets and exceeds the 3 source
-minimum), which enables the network to maintain data integrity and reliability
-while being unaffected by outliers.
+given that they meet the threshold for minimum data sources which enables the
+network to maintain data integrity and reliability while being unaffected by
+outliers.
+
+> Example
+>
+> If nodes query 5 sources, but only receive inputs from 4, the nodes can still
+successfully triangulate the data as the received inputs still meet the 3 source
+minimum.
 
 ![Triangulation of primary sources](/img/2024-02--source-triangulation.jpg)
 
@@ -44,12 +49,12 @@ leverage DEX Liquidity pools in order to report token pair values. This is
 because liquidity pools provide a unique and efficient price discovery
 mechanism. Within the pool, a token pair derives comparative value according to
 a simple mathematical formula that calculates price, in real time, as users
-affect the token-to-token ratio by adding or removing from either side. Because
-of this innate price discovery mechanism in liquidity pools, Orcfax now has the
-ability to provide a simple and elegant solution for decentralized Cardano
-Native Token feeds.
+affect the token-to-token ratio by adding or removing from either side of the
+currency pair. Because of this innate price discovery mechanism in liquidity
+pools, Orcfax has the ability to provide a simple and elegant solution for
+decentralized CNT feeds.
 
-Regardless of the target tokens requested by integrators, Orcfax will leverage
+Regardless of the CNT feed requested by integrators, Orcfax will leverage
 its network of validator nodes to execute the collection process. Each node will
 be responsible for querying the cardano ledger, in order to collect the total
 liquidity per token pair on each DEX. These liquidity values are then calculated
@@ -58,8 +63,8 @@ that token pair.
 
 ![Virtual liquidity pooling](/img/2024-02--virtual-liquidity-pooling.jpg)
 
-This virtual pooling will then reflect the aggregated price of that token pair,
-as observed by that specific node. This approach removes the risk of low
+The virtual liquidity pool will then reflect the aggregated price of that token
+pair, as observed by that specific node. This approach removes the risk of low
 liquidity DEXes skewing the price to allow manipulation.
 
 Each Orcfax node will perform the same process and share their derived values

docs/orcfax-solution/data-collection.md

@@ -6,30 +6,31 @@ slug: /publication-models
 
 # Publication models
 
-How data is brought on-chain through an Orcfax oracle feed depends entirely on
-the use case and the needs of integrating dApps; there are many different oracle
-use cases, and each needs something different from Orcfax. While there can be
-overlap in the data needs of smart contracts, many of these use cases have their
-own distinct requirements regarding when data is needed. Because of the varied
-needs of our integrators, Orcfax is developing publication options that allow
-integrators to choose services that best meet their needs. Orcfax feeds will now
-support two distinct publication models: our existing heartbeat model, and a new
-on-demand model.
-
-By providing the ability for consumers to choose the publication model, Orcfax
+How data is brought on-chain through an Orcfax oracle feed depends largely on
+the use case and the needs of integrators and their dApps; there are many
+different oracle use cases, and each needs something different from Orcfax.
+While there can be overlap in the data needs of smart contracts, many of these
+use cases have their own distinct requirements regarding when data is needed.
+Because of the varied needs of our integrators, Orcfax is developing publication
+options that allow integrators to choose services that best meet their needs.
+
+Orcfax feeds will now support two distinct publication models: our existing
+heartbeat model, and a new on-demand model.
+
+By providing integrators the ability to choose the publication model, Orcfax
 will enable dApps to increase flexibility and cost efficiency by choosing how
 best to receive their data: hourly, daily or when there’s a real-time
 requirement for the data (e.g. liquidations).
 
 ## The heartbeat publication model
 
 The heartbeat publication model gives integrators the ability to access data at
-regular intervals which can be set according to their needs (e.g. every 5
-minutes, once per hour, etc.). This model can be further enhanced when paired
-with a monitoring feature which adds a deviation formula; heartbeat publication
-models with deviation add improved precision by guaranteeing data at both a
-consistent interval and when user-stipulated thresholds have been met (e.g.
-publish immediately before the next heartbeat if price changes by x%).
+regular intervals which can be parameterized according to their needs
+(e.g. every 5 minutes, once per hour, etc.). This model can be further enhanced
+when paired with a monitoring feature which adds a deviation formula; heartbeat
+publication models with deviation add improved precision by guaranteeing data at
+both a consistent interval and when integrator-stipulated thresholds have been
+met (e.g. publish immediately before the next heartbeat if price changes by x%).
 
 In the heartbeat publication model, nodes request and cache primary source data
 every minute. Publications are made at a fixed rate (in this case on the hour)
@@ -38,28 +39,29 @@ utilizing the monitoring function in the event of deviations.
 
 ![the heartbeat model](/img/2024-02--heartbeat.gif)
 
-This publication model is often referred to as a Push based oracle, as the
-oracle service is parameterized to publish (push)
-data, and does so continuously at predefined intervals so long as the feed
-remains funded.
+This publication model is often referred to as a *push* based oracle, as the
+oracle service is parameterized to publish (push) data, and does so continuously
+at predefined intervals so long as the feed remains funded.
 
-The benefits of the heartbeat (or push) publication model is that integrators
-receive data continuously. However, if the dApp provides services which only
-need data inputs for specific actions, at unpredictable times, or to verify
-components of a transaction, then this model can be nonoptimal or costly given
-the rate at which data is received versus instances of data use.
+The benefits of the heartbeat publication model is that integrators receive data
+continuously. However, if the dApp provides services which only need data inputs
+for specific actions, at unpredictable times, or to verify components of a
+transaction, then this model can be nonoptimal or costly given the rate at which
+data is received versus instances of data use; this inefficiency for some of our
+integrator's use cases led us to begin development on the Orcfax on-demand
+model.
 
 ## The on-demand publication model
 
 The on-demand publication model allows complete flexibility and gives dApps even
-more control of data use by allowing them to request data collection, validation
-and publication whenever it’s needed by their smart contracts.
+more control of data use by allowing them to request data collection,
+validation, and publication whenever it’s needed by their smart contracts.
 
-If an Orcfax feed consumer needs a more current update for a given datum feed
-(e.g. ADA/FACT) than is available on-chain or through an existing heartbeat
+If an Orcfax feed integrator needs a more current update for a given Orcfax feed
+(e.g. ADA-FACT) than is available on-chain or through an existing heartbeat
 publication schedule, then:
 
-1. A dApp can request an updated datum by posting an utxo with a specific datum
+1. A dApp can request an updated datum by posting a utxo with a specific datum
 in an orders smart contract;
 1. This request is observed by the validator scripts;
 1. A validator node will be selected to submit the requested datum to the feeds
@@ -71,10 +73,10 @@ And all of these actions can happen within the same block.
 
 ![the on-demand model](/img/2024-02--on-demand.gif)
 
-This publication model is often referred to as a Pull based oracle, as the
+This publication model is often referred to as a *pull* based oracle, as the
 oracle service is directly triggered by requests made through a smart contract.
 
-The benefits of the on-demand (or pull) publication model is that integrators
+The benefits of the on-demand publication model is that integrators
 experience greater control over when data is made available. This service
 dramatically increases feed utility for dApps with use cases that can’t justify
 a consistent heartbeat. Instead, the on demand publication model allows their