diff --git a/README.md b/README.md index f0eb4e7c..b50090e3 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,8 @@ The Witnet oracle is currently available on Ethereum, Polygon, Avalanche, Celo, ### Featured sections -{% content-ref url="introduction/wit-coin.md" %} -[wit-coin.md](introduction/wit-coin.md) +{% content-ref url="introduction/about/wit-coin.md" %} +[wit-coin.md](introduction/about/wit-coin.md) {% endcontent-ref %} {% content-ref url="introduction/supported-chains.md" %} diff --git a/SUMMARY.md b/SUMMARY.md index 3c58db2d..ccdebed1 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -4,16 +4,16 @@ ## Introduction -* [❓ What is Witnet?](introduction/what-is-witnet.md) -* [🤔 Frequently Asked Questions](introduction/frequently-asked-questions.md) +* [❓ What is Witnet?](introduction/about/README.md) + * [⚙ Architecture](introduction/about/architecture.md) + * [🤔 Frequently Asked Questions](introduction/about/frequently-asked-questions.md) + * [🪙 The Witnet Coin (Wit)](introduction/about/wit-coin.md) + * [👛 Sheikah Witnet Wallet](introduction/about/sheikah-witnet-wallet.md) * [🚀 Quick Tutorials](introduction/quick-tutorials/README.md) * [📈 Price Feeds](introduction/quick-tutorials/data-feeds-tutorial.md) * [🔀 Randomness](introduction/quick-tutorials/randomness.md) * [📡 APIs and HTTP GET/POST](introduction/quick-tutorials/apis-and-http-get-post.md) * [⛏ Mining Wit](introduction/quick-tutorials/mining-wit.md) -* [🪙 The Witnet Coin (Wit)](introduction/wit-coin.md) -* [👛 Sheikah Witnet Wallet](introduction/sheikah-witnet-wallet.md) -* [⚙ Architecture](introduction/architecture.md) * [⛓ Supported chains](introduction/supported-chains.md) * [💥 Awesome Witnet](introduction/awesome-witnet.md) diff --git a/introduction/what-is-witnet.md b/introduction/about/README.md similarity index 100% rename from introduction/what-is-witnet.md rename to introduction/about/README.md diff --git a/introduction/architecture.md b/introduction/about/architecture.md similarity index 91% rename from introduction/architecture.md rename to introduction/about/architecture.md index c3395c14..95764d26 100644 --- a/introduction/architecture.md +++ b/introduction/about/architecture.md @@ -1,7 +1,7 @@ # ⚙ Architecture {% hint style="info" %} -This article explores the characteristics and intricacies of Witnet from a purely internal perspective. This can be useful to understand the processes supporting the security and data integrity properties of the protocol. +This article explores the characteristics and intricacies of Witnet from a purely internal perspective. This can be useful to understand the processes supporting the security and data integrity properties of the protocol. However, it is important to note that in practice all this complexity is totally hidden away from the average smart contract developer. Using the Witnet oracle from Ethereum or any other smart contracts platform feels exactly like interacting with a native contract on that network. {% endhint %} @@ -25,7 +25,7 @@ Having its own blockchain also guarantees that the fate of the Witnet oracle is {% hint style="success" %} Even though Witnet runs on its own blockchain, it is connected to the most popular smart contract enabled blockchains, and from the perspective of the average smart contract developer, using Witnet feels totally like using a native contract on each of those chains. -In addition, many oracle use cases (like [price feeds](quick-tutorials/data-feeds-tutorial.md) or [random number generation](quick-tutorials/randomness.md)) are also served through simpler interfaces that do not require the user to create and deploy any data requests. +In addition, many oracle use cases (like [price feeds](../quick-tutorials/data-feeds-tutorial.md) or [random number generation](../quick-tutorials/randomness.md)) are also served through simpler interfaces that do not require the user to create and deploy any data requests. {% endhint %} ### Capabilities of Data Requests @@ -42,9 +42,9 @@ Namely, data requests allow to: The Witnet protocol was designed to be agnostic over the nature of the sourced data, and currently supports the following types of data sources: -* [HTTP GET,](quick-tutorials/apis-and-http-get-post.md) which easily allows to read from most [REST APIs](quick-tutorials/apis-and-http-get-post.md) today. -* [HTTP POST](quick-tutorials/apis-and-http-get-post.md), which provides a convenient way to query more sophisticated [REST and GraphQL APIs](quick-tutorials/apis-and-http-get-post.md). -* [RNG](quick-tutorials/randomness.md), which allows to generate [random numbers and byte arrays](quick-tutorials/randomness.md). +* [HTTP GET,](../quick-tutorials/apis-and-http-get-post.md) which easily allows to read from most [REST APIs](../quick-tutorials/apis-and-http-get-post.md) today. +* [HTTP POST](../quick-tutorials/apis-and-http-get-post.md), which provides a convenient way to query more sophisticated [REST and GraphQL APIs](../quick-tutorials/apis-and-http-get-post.md). +* [RNG](../quick-tutorials/randomness.md), which allows to generate [random numbers and byte arrays](../quick-tutorials/randomness.md). {% hint style="success" %} Witnet uses an RFC-8949 based binary format named RADON to encode and decode data requests. @@ -59,12 +59,12 @@ Once a data request is published into a Witnet block, it will undergo the follow * Commitment: in this stage, each node in the Witnet network will independently and secretly compute their elegibility to participate in solving the data request. If a node finds itself to be eligible, it will retrieve and aggregate the data sources as specified by the request, and will publish a cryptographic commitment to the resulting value (i.e., alike to a closed envelope that contains a commitment to a specific piece of data). In doing so, the witnessing also need to collateralize (stake) a certain amount of Witnet tokens. * Reveal: once the witnesses have published their commitments, they will need to reveal the actual data they committed to. * Tally: once all the commitments have been followed up by a reveal, miners apply the multi-witness aggregation as specified in the request, publish the final _tallied_ result and execute all corresponding payments of rewards as well as slashing any misreporters. -* Completed: once a _Tally_ transaction has been published and confirmed into the Witnet network, the eventually resulting data point is considered final and will be ready for the requester to read and use. +* Completed: once a _Tally_ transaction has been published and confirmed into the Witnet network, the eventually resulting data point is considered final and will be ready for the requester to read and use. _Commit_, _Reveal_, and _Tally_ are performed on-chain through special types of transactions in the Witnet protocol that are allocated each a reserved amount of block space, ensuring that data requests are resolved timely even when there is a big number of value transfer transactions (VTTs) happening in the network. {% hint style="success" %} -When publishing a data request from Ethereum or any other smart contracts platform, the data request and its eventual result will be relayed to the Witnet blockchain by a set of _bridge nodes_ that is different from the witnessing nodes of the Witnet network. +When publishing a data request from Ethereum or any other smart contracts platform, the data request and its eventual result will be relayed to the Witnet blockchain by a set of _bridge nodes_ that is different from the witnessing nodes of the Witnet network. {% endhint %} ### Algorithmic Reputation System @@ -79,7 +79,7 @@ Reputation points cannot be transferred and cannot be hoarded: they expire a cer ### Transaction Finality -In the Witnet protocol, finality is guaranteed by superblocks. Every 10 blocks (specifically, those blocks whose epoch number / block height is a multiple of 10), the protocol samples a committee of 100 nodes from the Active Reputation Set, i.e. nodes with a proven record of reliability. +In the Witnet protocol, finality is guaranteed by superblocks. Every 10 blocks (specifically, those blocks whose epoch number / block height is a multiple of 10), the protocol samples a committee of 100 nodes from the Active Reputation Set, i.e. nodes with a proven record of reliability. A super-majority of 2/3rds of this committee is required to digitally sign a message that gets derived from the hash of the last 10 blocks in the chain. In this way, the network can build strong consensus on the chain state, without having to gather signatures for each individual block. diff --git a/introduction/frequently-asked-questions.md b/introduction/about/frequently-asked-questions.md similarity index 85% rename from introduction/frequently-asked-questions.md rename to introduction/about/frequently-asked-questions.md index f51e6fe1..45623e02 100644 --- a/introduction/frequently-asked-questions.md +++ b/introduction/about/frequently-asked-questions.md @@ -6,10 +6,10 @@ Unlike other popular oracle designs, Witnet achieves data integrity and bases its security on cryptoeconomic incentives, i.e. rewards and slashing. -For more information about alternative oracle designs and general oracle ecosystem overviews, please check these sections from the [Awesome Witnet](awesome-witnet.md) compilation: +For more information about alternative oracle designs and general oracle ecosystem overviews, please check these sections from the [Awesome Witnet](../awesome-witnet.md) compilation: -* [On the importance of oracles](awesome-witnet.md#on-the-importance-of-oracles) -* [Other oracles](awesome-witnet.md#other-oracles) +* [On the importance of oracles](../awesome-witnet.md#on-the-importance-of-oracles) +* [Other oracles](../awesome-witnet.md#other-oracles) #### How much does it cost to use the Witnet oracle? @@ -33,6 +33,6 @@ You can find all the information relative to the Wit coin in its own section of The currently supported networks are listed here: -{% content-ref url="supported-chains.md" %} -[supported-chains.md](supported-chains.md) +{% content-ref url="../supported-chains.md" %} +[supported-chains.md](../supported-chains.md) {% endcontent-ref %} diff --git a/introduction/sheikah-witnet-wallet.md b/introduction/about/sheikah-witnet-wallet.md similarity index 100% rename from introduction/sheikah-witnet-wallet.md rename to introduction/about/sheikah-witnet-wallet.md diff --git a/introduction/wit-coin.md b/introduction/about/wit-coin.md similarity index 95% rename from introduction/wit-coin.md rename to introduction/about/wit-coin.md index e34b5bff..2f4d9f7b 100644 --- a/introduction/wit-coin.md +++ b/introduction/about/wit-coin.md @@ -1,4 +1,4 @@ -# 🪙 The Witnet Token (Wit) +# 🪙 The Witnet Coin (Wit) ### Utility of the Wit coins @@ -18,7 +18,7 @@ Node operators need to stake Wit coins in their nodes to increase their chance t ### Tokenomics of the Wit coin -![(click to enlarge)](../.gitbook/assets/image.png) +![(click to enlarge)](../../.gitbook/assets/image.png) #### Maximum supply @@ -45,6 +45,5 @@ Until a first halvening in 2025, there will be 1920 blocks mined every day, with The remaining 30% of the total Wit supply (750,000,000 Wits) were pre-mined in the mainnet genesis block (the first block in the blockchain). * 250,000,000 Wits (10%) went to founders and early contributors. All these tokens were subject to a lockup period: 6 months cliff in April 2021, followed by 18 months of bi-weekly unlocks of 1/24th of each allocation. -* 250,000,000 (10%) was allocated with no lock-ups to the Witnet Foundation to support ongoing efforts. +* 250,000,000 (10%) was allocated with no lock-ups to the Witnet Foundation to support ongoing efforts. * 250,000,000 (10%) were preassigned with no lock-ups to participants in the [Republic.co](https://republic.co/witnet) token pre-sale and SAFT participants. -