Skip to content

Commit

Permalink
docs(learn/protocol): add token and airdrop information (#868)
Browse files Browse the repository at this point in the history
Adds token and airdrop information to learn and protocol sections

task: none
  • Loading branch information
idea404 authored Apr 19, 2024
1 parent 56c365c commit 3ff85a2
Show file tree
Hide file tree
Showing 13 changed files with 155 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/site/docs/learn/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The native token is integral to Omni's ecosystem, serving three primary function

This design allows Omni to manage DDoS attacks, provide "gas liquidity" for seamless transactions across rollups, and progressively decentralize governance. This approach ensures backward compatibility with local gas tokens through an abstracted gas marketplace, highlighting the native token's role in enhancing the network's functionality and security.

For detailed information on how the native token is utilized for gas abstraction and supports global application development, refer to the protocol [Fees](../protocol/xmessages/fees.md) section.
For detailed information on how the native token is utilized for gas abstraction and supports global application development, refer to the protocol [Fees](../protocol/xmessages/fees/fees.md) section.

## Restaking ETH

Expand Down
16 changes: 16 additions & 0 deletions docs/site/docs/learn/omni/token/airdrop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
sidebar_position: 2
---

# Genesis Airdrop

The **\$OMNI** Genesis airdrop event marks a pivotal milestone for Omni on its path towards a fully decentralized network. The Genesis airdrop retroactively rewards the Omni community and its partners across the Ethereum ecosystem with 3,000,000 **\$OMNI** (3% of total supply). The Genesis airdrop went live on April 17, 2024 and is live for 45 days. Unclaimed **\$OMNI** rewards will be returned to the Omni Foundation on June 1, 2024.

The **\$OMNI** Genesis airdrop is broken down across the following categories:

<figure>
<img src="/img/airdrop.png" alt="Genesis Airdrop" />
<figcaption>*Genesis airdrop allocations*</figcaption>
</figure>

More details regarding the **\$OMNI** Genesis airdrop can be found in [this post](https://news.omni.network/the-omni-genesis-airdrop/).
74 changes: 74 additions & 0 deletions docs/site/docs/learn/omni/token/token.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
sidebar_position: 1
---

# Token Supply & Distribution

**\$OMNI** is an ERC-20 token launched on Ethereum L1 with a maximum supply of **100,000,000**.

At genesis, **\$OMNI** had a circulating supply of 10,391,492 (10.39% of total supply). **\$OMNI** is distributed across the following categories:

<figure>
<img src="/img/supply-distribution.png" alt="Supply Distribution" />
<figcaption>*Token supply distribution among all categories*</figcaption>
</figure>

## Public Launch

**9.27% – 9,270,000 **\$OMNI****

The Omni Foundation retroactively rewarded the Omni community and its partners across the Ethereum ecosystem with 3,000,000 **\$OMNI** (3% of total supply) during the **\$OMNI** Genesis airdrop. More details on the Genesis airdrop can be found [here](https://news.omni.network/the-omni-genesis-airdrop/). The remaining Public Launch tokens are used for public launch pools and liquidity.

## Ecosystem Development

**29.5% – 29,500,000 **\$OMNI****

Developers building with Omni are the key to ushering in a new generation of globally accessible applications across all Ethereum rollups. Omni is committed to fostering a thriving developer community building on the Omni EVM and across Ethereum’s rollup ecosystem. **\$OMNI** tokens reserved for the Ecosystem Development category will be initially used at the discretion of the Omni Foundation. In the future, this responsibility will be transitioned to token holder governance. At genesis, 496,492 **\$OMNI** entered the circulating supply for early validator rewards and network bootstrapping.

## Community Growth

**12.67% – 12,666,667 **\$OMNI****

Future initiatives, such as grant funding and other relevant programs, will be vital for Omni’s growth and adoption. Community Growth tokens will be initially used at the discretion of the Omni Foundation. In the future, this responsibility will be transitioned to token holder governance.

## Core Contributors

**25.25% – 25,250,000 **\$OMNI****

<figure>
<img src="/img/core-contributors.png" alt="Core Contributors" />
<figcaption>*Core contibutor unlock schedule*</figcaption>
</figure>

A portion of **\$OMNI** supply is allocated to the protocol’s current and future contributors. Individual contributors are subject to a 4 year vesting period (beginning at the date of joining the project) with a 1 year cliff for ¼ of their total tokens followed by stepwise unlocks every 6 months for the remaining ¾ of tokens. All tokens allocated to core contributors are subject to a 3 year unlock schedule after the token generation event that includes a 1 year cliff for ⅓ of the total tokens followed by stepwise unlocks every 6 months for the remaining ⅔ of tokens.

## Investors

**20.06% – 20,063,334 **\$OMNI****

<figure>
<img src="/img/investors.png" alt="Investors" />
<figcaption>*Investors unlock schedule*</figcaption>
</figure>

Since its founding, Omni Network has enjoyed the backing of influential investors from the Ethereum community, whose knowledge and strategic advice have significantly contributed to Omni's expansion and evolution over the past two years. All tokens allocated to investors are subject to a 3 year unlock schedule that includes a 1 year cliff for ⅓ of the total tokens followed by stepwise unlocks every 6 months for the remaining ⅔ of tokens.

## Advisors

**3.25% – 3,250,000 **\$OMNI****

<figure>
<img src="/img/advisors.png" alt="Advisors" />
<figcaption>*Advisors unlock schedule*</figcaption>
</figure>

The final portion of **\$OMNI** is allocated to advisors for expertise and guidance on network development. 625,000 **\$OMNI** will be unlocked at genesis while the remaining tokens will be subject to a 3 year unlock schedule that includes a 1 year cliff. 875,000 **\$OMNI** will be unlocked after the 1 year cliff, followed by 437,500 **\$OMNI** unlocked every 6 months for the remaining 2 years.

# Total Supply

<figure>
<img src="/img/circulating-supply.png" alt="Circulating Supply" />
<figcaption>*Circulating supply progression*</figcaption>
</figure>

Locked and/or unvested tokens for the Core Contributors, Investors, and Advisors categories cannot be staked. **\$OMNI** unlocks will be complete across all categories three years after token genesis. The Ecosystem Development and Community Growth allocations will be unlocked at genesis but will enter circulation at the discretion of the Omni Foundation and community governance. Inflation for validator rewards after the third year will be determined by community governance.
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
---
sidebar_position: 2
sidebar_position: 1
---

# Fees
# Fee Model

## Fee Model
Omni implements a Solidity-based fee payment interface that accepts **\$ETH** as the payment currency. In the future, Omni will add support for fees payable in **\$OMNI** and other tokens to streamline the developer experience.

Omni fees start with a basic, Solidity-based fee payment interface and an uncomplicated pricing mechanism, with room for future enhancements. The network only supports **\$ETH** for fee payments presently. In the future, developers will also be able to pay with **\$OMNI** and potentially other tokens if they desire, but **\$ETH** will always be supported.

Fees are paid in **\$ETH** and calculated in real-time during transactions via the payable `xcall` function on the portal contracts, ensuring simplicity for developers and compatibility with existing Ethereum tooling. This setup allows for easy off-chain fee estimations and the possibility for developers to pass the cost on to users, with a straightforward upgrade path to a more dynamic fee structure that can adapt to the network's evolving needs without necessitating changes to developer contracts.
Fees are paid in **\$ETH** and calculated during transactions via the payable `xcall` function on the portal contracts, ensuring simplicity for developers and compatibility with existing Ethereum tooling. This setup allows for easy off-chain fee estimations and the possibility for developers to pass the cost on to users, with a straightforward upgrade path to a more dynamic fee structure that can adapt to the network's evolving needs without necessitating changes to developer contracts.

### Collection

Expand Down
30 changes: 30 additions & 0 deletions docs/site/docs/protocol/xmessages/fees/native.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
sidebar_position: 2
---

# Native Token Roles & Utility

**\$OMNI** is the native token powering the Omni protocol. It serves the following functions within the network:

## Cross-Rollup Gas Fees

**\$OMNI** is used as a payment mechanism to compensate relayers for submitting cross-rollup messages to destination networks. Relayers maintain an inventory of gas assets for all supported rollups and accept payments in the form of **\$OMNI**. This allows Omni to establish a universal gas marketplace that simplifies the process of gas payments across all rollups for end users.

<figure>
<img src="/img/gas-marketplace.png" alt="Global Gas Marketplace" />
<figcaption>*Universal gas marketplace simplifying gas payments across all rollups*</figcaption>
</figure>

## Omni EVM Gas Fees

**\$OMNI** also serves as the native gas asset that powers the Omni EVM. The Omni EVM functions as a global orchestration layer for application instances across multiple rollups, allowing users and developers to initiate transactions and manage applications on any rollup from a single source. **\$OMNI** provides an anti-sybil mechanism for transactions submitted to the Omni EVM, deterring spam and malicious activities such as denial-of-service attacks. **\$OMNI** also serves as compensation for Omni validators investing computational power for transaction processing and network security. Users can choose to pay higher **\$OMNI** fees to validators for priority transactions, thereby establishing a fee market based on **\$OMNI**.

## Network Governance

At launch, the initial Omni protocol will provide basic cross-rollup messaging functionality across a specified set of rollups. As Omni matures, **\$OMNI** stakeholders will be responsible for various governance decisions such as protocol upgrades and additional developer features.

## Reinforced Security

Omni achieves stronger and more stable security guarantees than existing interoperability protocols by deriving its cryptoeconomic security from restaked **\$ETH**. Omni extends its security model further by incorporating staked **\$OMNI** using a dual staking model. Effectively, the total cryptoeconomic security of Omni is determined by the combined value of restaked **\$ETH** and staked **\$OMNI**.

By implementing this dual staking model, Omni’s security scales across two dimensions. Restaked **\$ETH** anchors Omni’s security to Ethereum L1, enabling it to grow in line with Ethereum’s own security budget. The addition of staked **\$OMNI** builds upon this base, expanding Omni’s security alongside its own network activity. Collectively, these two complementary mechanisms provide robust and dynamic security guarantees for Omni, setting a new standard for secure interoperability for the Ethereum ecosystem.
34 changes: 30 additions & 4 deletions docs/site/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,25 @@ const sidebars: SidebarsConfig = {
className: "sidebar-title",
collapsible: false,
items: [
"learn/omni/restaking",
{
type: "autogenerated",
dirName: "learn/omni",
}
type: "category",
label: "Token",
className: "sidebar-title",
collapsible: false,
items: [
{
type: "autogenerated",
dirName: "learn/omni/token",
}
]
},
"learn/omni/interoperability",
"learn/omni/evm",
"learn/omni/gas",
"learn/omni/cometbft",
"learn/omni/architecture",
"learn/omni/consensus",
]
},
{
Expand Down Expand Up @@ -132,7 +147,18 @@ const sidebars: SidebarsConfig = {
"protocol/xmessages/components/relayer",
]
},
"protocol/xmessages/fees",
{
type: "category",
label: "Fees",
className: "sidebar-title",
collapsible: false,
items: [
{
type: "autogenerated",
dirName: "protocol/xmessages/fees",
}
]
},
"protocol/xmessages/finality",
]
},
Expand Down
Binary file added docs/site/static/img/advisors.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/static/img/airdrop.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/static/img/circulating-supply.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/static/img/core-contributors.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/static/img/gas-marketplace.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/static/img/investors.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/static/img/supply-distribution.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3ff85a2

Please sign in to comment.