-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(docs): Refactor
concepts
docs (#1120)
* refactor: Refactor concepts docs (up to Tokenomics) * refactor: Remove storage fund usages * refactor: Note inflation * refactor: Transactions * refactor: public struct * fix: Fixed non building docs due to broken references to removed docs * refactor: various fixes to the concepts docs, removed todo items from menu, removed graphql, fixed broken links and removed dead references * fix(devx): remove deleted docs from sidebar after rebasing * fix(devx): fix link * Update docs/content/about-iota/iota-architecture/indexer-functions.mdx Co-authored-by: salaheldinsoliman <[email protected]> --------- Co-authored-by: Dave de Fijter <[email protected]> Co-authored-by: Lucas Tortora <[email protected]> Co-authored-by: Lucas Tortora <[email protected]> Co-authored-by: salaheldinsoliman <[email protected]>
- Loading branch information
1 parent
652746c
commit f40049c
Showing
64 changed files
with
418 additions
and
1,412 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
Move is an open source language for writing safe packages to manipulate on-chain objects (sometimes referred to as "smart contracts"). Move is a platform-agnostic language to enable common libraries, tooling, and developer communities across blockchains with vastly different data and execution models. Move is adaptable to meet the needs of the blockchain the code operates on, see [Move on IOTA](../developer/iota-101/iota-move-concepts/iota-move-concepts.mdx) to review enhancements made to Move for optimization on the IOTA blockchain. | ||
Move is an open source language for writing safe packages to manipulate on-chain objects (sometimes referred to as "smart contracts"). Move is a platform-agnostic language to enable common libraries, tooling, and developer communities across blockchains with vastly different data and execution models. Move is adaptable to meet the needs of the blockchain the code operates on, see [Move on Iota](../developer/iota-101/iota-move-concepts/iota-move-concepts.mdx) to review enhancements made to Move for optimization on the Iota blockchain. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,57 +1,56 @@ | ||
--- | ||
title: IOTA Components | ||
title: Iota Components | ||
--- | ||
|
||
The name IOTA, pronounced swē in English, is derived from a Japanese word for the element of water. You can see this influence in the name of the blockchain, its native token elements (IOTA and MICROS), and the imagery used in its branding. | ||
The name Iota is the ninth letter of the Greek alphabet (Ι, ι) and is used figuratively in English to mean a very small amount, reflecting its status as one of the smallest Greek letters. | ||
|
||
When you read about IOTA in this documentation, it's referencing all the pieces of the system that comprise the blockchain. This includes the blockchain itself, its various networks (Mainnet, for example), the activity on the blockchain (transaction blocks), the distributed entities that verify this activity (validators), and the Full nodes that execute transaction blocks. The documentation refers to the entirety of these elements as the IOTA platform, or simply IOTA. | ||
When you read about Iota in this documentation, it's referencing all the pieces of the system that comprise the blockchain. This includes the blockchain itself, its various networks (Mainnet, for example), the activity on the blockchain (transaction blocks), the distributed entities that verify this activity (validators), and the Full nodes that execute transaction blocks. The documentation refers to the entirety of these elements as the IOTA platform, or simply IOTA. | ||
|
||
## The IOTA blockchain | ||
## The Iota blockchain | ||
|
||
IOTA is defined as a Layer 1 protocol blockchain. In basic terms, this means that IOTA performs its own consensus and validation for transaction blocks (activity) on its networks using its own native token (IOTA, in this case). Ethereum (ETH) and Bitcoin (BTC) are other examples of Layer 1 blockchains. | ||
Iota is defined as a Layer 1 protocol blockchain. In basic terms, this means that Iota performs its own consensus and validation for transaction blocks (activity) on its networks using its own native token (IOTA, in this case). Ethereum (ETH) and Bitcoin (BTC) are other examples of Layer 1 blockchains. | ||
|
||
Layer 2 blockchains, by contrast, leverage the infrastructure of Layer 1 networks, relying on the Layer 1 blockchain to finalize transaction blocks. Polygon (MATIC) is an example of a Layer 2 blockchain that extends Ethereum. | ||
|
||
## IOTA tokens | ||
|
||
The native token for IOTA is IOTA. Whenever the documentation mentions IOTA (all uppercase letters), it's referring to this token. Transaction blocks on IOTA often deal with small fractions of the value of one IOTA. To make these transaction blocks easier to work with, IOTA provides MICROS. It takes one billion MICROS to equal one IOTA. | ||
The native token for Iota is IOTA. Whenever the documentation mentions IOTA (all uppercase letters), it's referring to this token. Transaction blocks on Iota often deal with small fractions of the value of one IOTA. To make these transaction blocks easier to work with, Iota provides NANOS. It takes one billion NANOS to equal one IOTA. | ||
|
||
There is a cost associated with everything, and blockchain transactions are no exception. It costs money to provide computational power to process transaction blocks and store their results. The term for the cost of processing transaction blocks is "gas". You pay for gas and the cost of storing data with a blockchain's native tokens, in this case, IOTA (or MICROS). | ||
There is a cost associated with everything, and blockchain transactions are no exception. It costs money to provide computational power to process transaction blocks and store their results. The term for the cost of processing transaction blocks is "gas". You pay for gas and the cost of storing data with a blockchain's native tokens, in this case, IOTA (or NANOS). | ||
|
||
To learn more about the tokenomics of IOTA, see the following topics: | ||
|
||
- [IOTA Tokenomics](./tokenomics.mdx) | ||
- [IOTA Token](./tokenomics/iota-coin.mdx) | ||
- [Gas in IOTA](./tokenomics/gas-in-iota.mdx) | ||
- [IOTA Storage Fund](./tokenomics/storage-fund.mdx) | ||
- [Iota Tokenomics](./tokenomics.mdx) | ||
- [Iota Token](./tokenomics/iota-coin.mdx) | ||
- [Gas in Iota](./tokenomics/gas-in-iota.mdx) | ||
|
||
## Delegated proof-of-stake consensus | ||
|
||
IOTA uses a delegated proof-of-stake (DPoS) consensus mechanism to validate on-chain transaction blocks. This means that validators on the IOTA network must have a certain amount of IOTA secured on IOTA Mainnet, either with their own funds or in partnership with IOTA Foundation, to prove their interest in the security of the blockchain. This approach aligns the interest of all validators with that of IOTA users (an efficient, secure blockchain), without the high energy-resource demands of earlier blockchains. | ||
Iota uses a delegated proof-of-stake (DPoS) consensus mechanism to validate on-chain transaction blocks. This means that validators on the Iota network must have a certain amount of IOTA secured on Iota Mainnet, either with their own funds or in partnership with Iota Foundation, to prove their interest in the security of the blockchain. This approach aligns the interest of all validators with that of Iota users (an efficient, secure blockchain), without the high energy-resource demands of earlier blockchains. | ||
|
||
To learn more about consensus on IOTA, see the following guides and topics: | ||
To learn more about consensus on Iota, see the following guides and topics: | ||
|
||
- [Validator Committee](../operator/validator-committee.mdx) | ||
- [IOTA Full Node Data Management](../operator/data-management.mdx) | ||
- [Iota Full Node Data Management](../operator/data-management.mdx) | ||
|
||
|
||
|
||
## IOTA networks | ||
## Iota networks | ||
|
||
IOTA has several networks available, each serving a different purpose. | ||
Iota has several networks available, each serving a different purpose. | ||
|
||
- **Mainnet:** The network that processes production transaction blocks. When you trade IOTA or NFTs that are ultimately based on fiat currency, you are doing so on the Mainnet network of IOTA. | ||
- **Testnet:** Staging network to provide quality assurance that any planned changes to IOTA do not adversely impact performance. Developers can use this network to test their code before placing it in production. | ||
- **Devnet:** A more unstable network that is used to develop new features. Developers can leverage this network to code against the latest planned features of IOTA. | ||
- **Localnet:** You can run a IOTA network on your local computer. Developing on a local network provides an optimized workflow in an environment you control. | ||
- **Mainnet:** The network that processes production transaction blocks. When you trade IOTA or NFTs that are ultimately based on fiat currency, you are doing so on the Mainnet network of Iota. | ||
- **Testnet:** Staging network to provide quality assurance that any planned changes to Iota do not adversely impact performance. Developers can use this network to test their code before placing it in production. | ||
- **Devnet:** A more unstable network that is used to develop new features. Developers can leverage this network to code against the latest planned features of Iota. | ||
- **Localnet:** You can run an Iota network on your local computer. Developing on a local network provides an optimized workflow in an environment you control. | ||
|
||
To learn more about these networks and how to interact with them, see the following guides: | ||
|
||
- [Create a Local IOTA Network](../developer/getting-started/local-network.mdx) | ||
- [Connect to IOTA](../developer/getting-started/connect.mdx) | ||
- [Create a Local Iota Network](../developer/getting-started/local-network.mdx) | ||
- [Connect to Iota](../developer/getting-started/connect.mdx) | ||
|
||
## Move | ||
|
||
The Move language provides the logic for all activity on IOTA, like trading NFTs, playing IOTA-integrated games (dApps), and all other transaction-based events. The IOTA platform uses a concept novel to earlier blockchains, where blocks on the chain are actually objects that define assets rather than simple key-value stores that define addresses. The increased programmability inherent with objects required a more robust logic engine to maximize the benefits of this new approach to blockchain technology. | ||
The Move language provides the logic for all activity on Iota, like trading NFTs, playing Iota-integrated games (dApps), and all other transaction-based events. The Iota platform uses a concept novel to earlier blockchains, where blocks on the chain are actually objects that define assets rather than simple key-value stores that define addresses. The increased programmability inherent with objects required a more robust logic engine to maximize the benefits of this new approach to blockchain technology. | ||
|
||
To learn more about Move, see [Move Concepts](../developer/iota-101/iota-move-concepts/iota-move-concepts.mdx). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,35 @@ | ||
--- | ||
title: IOTA Architecture | ||
title: Iota Architecture | ||
--- | ||
|
||
IOTA shares some similarities with other blockchains but is unique in many ways. Use the topics in this section to understand the features that define the IOTA network. | ||
Iota shares some similarities with other blockchains but is unique in many ways. Use the topics in this section to understand the features that define the Iota network. | ||
|
||
## Understand IOTA Security | ||
## Understand Iota Security | ||
|
||
Learn about the mechanisms available to secure on-chain assets, and the assurances IOTA provides regarding asset security. Understand IOTA Security explores the overall IOTA security architecture to ensure the asset types you design leverage IOTA to provide a secure experience for asset holders. | ||
Learn about the mechanisms available to secure on-chain assets, and the assurances Iota provides regarding asset security. Understand Iota Security explores the overall Iota security architecture to ensure the asset types you design leverage Iota to provide a secure experience for asset holders. | ||
|
||
Go to [Understand IOTA Security](./iota-architecture/iota-security.mdx). | ||
Go to [Understand Iota Security](./iota-architecture/iota-security.mdx). | ||
|
||
## Life of a Transaction | ||
|
||
Life of a Transaction details the transitions that all transactions on IOTA go through from creation to finality. This topic also explores some features of the blockchain (like epochs and checkpoints) that play a role in the life of a transaction. | ||
Life of a Transaction details the transitions that all transactions on Iota go through from creation to finality. This topic also explores some features of the blockchain (like epochs and checkpoints) that play a role in the life of a transaction. | ||
|
||
Go to [Life of a Transaction](./iota-architecture/transaction-lifecycle.mdx). | ||
|
||
## Mempool and Consensus Engines | ||
|
||
Narwhal and Bullshark combine to form the basis of the IOTA mempool and consensus engine. This topic offers a brief introduction to the technologies that keep the activities on IOTA synchronized and secure. | ||
Narwhal and Bullshark combine to form the basis of the Iota mempool and consensus engine. This topic offers a brief introduction to the technologies that keep the activities on Iota synchronized and secure. | ||
|
||
Go to [Mempool and Consensus Engines](./iota-architecture/consensus.mdx). | ||
|
||
## IOTA Indexer | ||
## Iota Indexer | ||
|
||
Running a IOTA indexer offloads data processing from your Full node and stores it in a relational database. This topic explores some of the benefits running an indexer has and points to instruction on how to run your own. | ||
Running an Iota indexer offloads data processing from your Full node and stores it in a relational database. This topic explores some of the benefits running an indexer has and points to instruction on how to run your own. | ||
|
||
Go to [IOTA Indexer](./iota-architecture/indexer-functions.mdx). | ||
Go to [Iota Indexer](./iota-architecture/indexer-functions.mdx). | ||
|
||
## Protocol Upgrades | ||
|
||
The IOTA protocol, framework, and execution engine are frequently extended to include new functionality and bug fixes. This functionality is added in the form of new code which is released to validator operators as part of our regular software releases. The IOTA protocol, however, requires that all IOTA validators agree about the results of executing each transaction. | ||
The Iota protocol, framework, and execution engine are frequently extended to include new functionality and bug fixes. This functionality is added in the form of new code which is released to validator operators as part of our regular software releases. The Iota protocol, however, requires that all Iota validators agree about the results of executing each transaction. | ||
|
||
Go to [Protocol Upgrades](./iota-architecture/protocol-upgrades.mdx). |
Oops, something went wrong.