Skip to content

Commit

Permalink
chore: IO to ARIO
Browse files Browse the repository at this point in the history
  • Loading branch information
Bobinstein committed Dec 9, 2024
1 parent 39f268c commit 700258d
Show file tree
Hide file tree
Showing 13 changed files with 62 additions and 62 deletions.
10 changes: 5 additions & 5 deletions docs/src/arns.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ Users can easily reference these friendly names in their browsers, and other app

## Name Registry

The ArNS Registry is a list of all the registered names and their associated ANT AO process Ids. Registering a name requires spending IO tokens based upon the name length and purchase type. The system shall allow users to either lease a name on a yearly basis (maximum up to 5 years) or purchase that name permanently.
The ArNS Registry is a list of all the registered names and their associated ANT AO process Ids. Registering a name requires spending ARIO tokens based upon the name length and purchase type. The system shall allow users to either lease a name on a yearly basis (maximum up to 5 years) or purchase that name permanently.

The registry uses the following key rules, embedded within the AR.IO AO process:

- The genesis prices of names are set within the contract itself; these are the starting conditions.
- Name prices vary based on name length, purchase type (lease vs buy), lease duration, and the current Demand Factor. See the Dynamic Pricing section for more details.
- Name records in the registry each include a pointer to its Arweave Name Token Smart Contract process address, its lease end time, and undername allocation.
- Anyone with available IO Tokens can extend any name’s active lease.
- Anyone with available IO Tokens can purchase undername space for any name.
- Anyone with available ARIO Tokens can extend any name’s active lease.
- Anyone with available ARIO Tokens can purchase undername space for any name.
- When a lease expires, there is a grace period where it can still be extended before anyone else can repurchase the name with a new ANT.

Once added, name records cannot be removed from the registry. A leased name’s associated ANT smart contract address cannot be changed until the lease has expired and a new one is purchased. Care must be taken by the owners of permanent name purchases to ensure that their ANT supports an `evolve` ability should it be desired to add or modify functionality in the future as these name purchases are permanently tied to the associated ANT. Owners of permanently purchased names must understand the consequences of private key loss, which results in not being able to update any data pointers for this name.
Expand Down Expand Up @@ -69,7 +69,7 @@ The table below indicates some of the possible interactions with an ANT and who
<th>Type</th>
<th>ANT Owner</th>
<th>ANT Controller</th>
<th>Any IO Token Holder</th>
<th>Any ARIO Token Holder</th>
</tr>
<tr>
<td>Transfer ANT</td>
Expand Down Expand Up @@ -142,7 +142,7 @@ ArNS is designed to ensure that name valuations are always in sync with their tr

The Arweave Name System (ArNS) introduces an adaptive pricing model for registering names within the AR.IO Network. The core objective is to strike a balance between market demand and pricing fairness, leveraging both static and dynamic pricing elements. The system differentiates prices based on character lengths of names and offers varied purchasing options such as leasing, permanent acquisition, and undernames.

A unique feature of the ArNS pricing mechanism is the integration of a Demand Factor (DF), a dynamic multiplier that adjusts name prices in response to market demand. The DF is determined by comparing the total revenue in IO tokens from the current period to a moving average of revenues from the preceding period window. Depending on whether revenue is above, below, or equal to this average, the DF can increase or decrease. These adjustments are contained within boundaries to prevent extreme pricing variations.
A unique feature of the ArNS pricing mechanism is the integration of a Demand Factor (DF), a dynamic multiplier that adjusts name prices in response to market demand. The DF is determined by comparing the total revenue in ARIO tokens from the current period to a moving average of revenues from the preceding period window. Depending on whether revenue is above, below, or equal to this average, the DF can increase or decrease. These adjustments are contained within boundaries to prevent extreme pricing variations.

This comprehensive approach ensures that ArNS names are accessible and reasonably priced, adapting to market trends while maintaining an equitable and maintenance-free registration environment.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/arweave.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ AO is a global supercomputer built on Arweave. This actor-oriented machine is a

<div class="caption">Diagram 4: AO - The Supercomputer and Smart Contract Protocol</div>

With AO, developers can create processes that act as smart contracts with token-like properties which can then be used to incorporate incentive structures into applications and infrastructure. The AR.IO Network leverages this technology for development of its network protocol and IO token.
With AO, developers can create processes that act as smart contracts with token-like properties which can then be used to incorporate incentive structures into applications and infrastructure. The AR.IO Network leverages this technology for development of its network protocol and ARIO token.

## The Permaweb

Expand Down
14 changes: 7 additions & 7 deletions docs/src/gateway-network.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Being part of the network grants AR.IO Gateways an array of advantages, such as:

## Gateway Address Registry (GAR)

Any Gateway operator that whishes to join the AR.IO Network must register their node in the AR.IO smart contract's "Gateway Address Registry", known as the GAR. Registration involves staking a minimum amount of IO tokens and providing additional metadata describing the Gateway service offered.
Any Gateway operator that whishes to join the AR.IO Network must register their node in the AR.IO smart contract's "Gateway Address Registry", known as the GAR. Registration involves staking a minimum amount of ARIO tokens and providing additional metadata describing the Gateway service offered.

<!-- This metadata includes details such as:
Expand Down Expand Up @@ -78,10 +78,10 @@ Staking tokens serves a dual purpose in the AR.IO Network:

- It qualifies participants for reward distribution.

In the AR.IO Network, "staking" designates the act of locking a specified amount of IO tokens into a protocol-controlled vault. These tokens act as a form of collateral and public commitment, encouraging network participants to act in the network's best interests. Once tokens are deposited in the vault, they remain locked until either the participant triggers the "unstake" function or the vault's predetermined lock period expires.
In the AR.IO Network, "staking" designates the act of locking a specified amount of ARIO tokens into a protocol-controlled vault. These tokens act as a form of collateral and public commitment, encouraging network participants to act in the network's best interests. Once tokens are deposited in the vault, they remain locked until either the participant triggers the "unstake" function or the vault's predetermined lock period expires.


It is important to note that unlike other protocols, the IO token is non-inflationary. Therefore, the staking mechanism in the AR.IO Network is not designed to function as a yield-generation tool. By staking their tokens, participants become eligible for potential rewards, fostering an atmosphere of mutual trust within the network. Specifically, Gateway operators stake tokens to facilitate their Gateway integration and establish public trust. Once connected, they become eligible for rewards driven by the protocol and gain access to the network's shared resources.
It is important to note that unlike other protocols, the ARIO token is non-inflationary. Therefore, the staking mechanism in the AR.IO Network is not designed to function as a yield-generation tool. By staking their tokens, participants become eligible for potential rewards, fostering an atmosphere of mutual trust within the network. Specifically, Gateway operators stake tokens to facilitate their Gateway integration and establish public trust. Once connected, they become eligible for rewards driven by the protocol and gain access to the network's shared resources.

## Schema

Expand Down Expand Up @@ -130,12 +130,12 @@ It is important to note that unlike other protocols, the IO token is non-inflati
<tr>
<th>delegates</th>
<td>object</td>
<td class="align-left">Wallets that have delegated a stake of IO tokens to the Gateway.</td>
<td class="align-left">Wallets that have delegated a stake of ARIO tokens to the Gateway.</td>
</tr>
<tr>
<th>totalDelegatedStake</th>
<td>number</td>
<td class="align-left">The total number of IO tokens delegated to the Gateway</td>
<td class="align-left">The total number of ARIO tokens delegated to the Gateway</td>
</tr>
<tr>
<th>observerWallet</th>
Expand Down Expand Up @@ -165,7 +165,7 @@ It is important to note that unlike other protocols, the IO token is non-inflati
<tr>
<th>balance</th>
<td>number</td>
<td class="align-left">Positive integer, the number of IO tokens locked.</td>
<td class="align-left">Positive integer, the number of ARIO tokens locked.</td>
</tr>
<tr>
<th>start</th>
Expand Down Expand Up @@ -233,7 +233,7 @@ It is important to note that unlike other protocols, the IO token is non-inflati
<th>allowDelegatedStaking</th>
<td>boolean</td>
<td>no</td>
<td class="align-left">The Gateway Operator can allow or disallow other wallets to stake IO tokens on the Gateway.</td>
<td class="align-left">The Gateway Operator can allow or disallow other wallets to stake ARIO tokens on the Gateway.</td>
</tr>
<tr>
<th>delegatedRewardShareRatio</th>
Expand Down
8 changes: 4 additions & 4 deletions docs/src/gateways/ar-io-node/arnsoip/observer.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ In this protocol, observers evaluate their gateway peers' performance to resolve

A key component of the protocol is its reward mechanism. This system is predicated on gateway performance and compliance with observation duties. Gateways that excel are tagged as "Functional Gateways" and earn rewards, while those that do not meet the criteria, “Deficient Gateways” risk facing penalties – namely, the lack of rewards.

Funds for incentive rewards are derived from the protocol balance, which consists of IO tokens collected from ArNS asset purchases. Every epoch, this balance is utilized to distribute rewards to qualifying gateways and observers based on certain performance metrics.
Funds for incentive rewards are derived from the protocol balance, which consists of ARIO tokens collected from ArNS asset purchases. Every epoch, this balance is utilized to distribute rewards to qualifying gateways and observers based on certain performance metrics.

## Observation Protocol

Expand All @@ -22,7 +22,7 @@ The Observation protocol is organized around epochs, periods of time that are br
<img class="amazingdiagram" :src="$withBase('/images/observer-1.png')">
<div class="caption">Observation and Incentive Protocol</div>

- To participate in the epoch, a gateway must have already staked IO tokens and joined the network before it starts.
- To participate in the epoch, a gateway must have already staked ARIO tokens and joined the network before it starts.
- Each epoch (approximately 7 block-days), a random pool of active gateways will be selected (prescribed) to perform observation duties.
- Within the epoch, observers are tasked with evaluating a subset of ArNS names for each gateway in the network.
- By the end of the epoch’s observation reporting period, the observer must upload its standardized health observation report to Arweave.
Expand Down Expand Up @@ -59,7 +59,7 @@ Up to 50 gateways can be chosen as observers per epoch. If the GAR contains 50 o

The weighted selection criteria will consider the following for each gateway:

- Stake Weight (SW): This factor considers how financially committed a gateway is to the network. It is the ratio of the amount of IO tokens staked by the gateway relative to the network minimum and is expressed as SW = Gateway Stake / Minimum Stake.
- Stake Weight (SW): This factor considers how financially committed a gateway is to the network. It is the ratio of the amount of ARIO tokens staked by the gateway relative to the network minimum and is expressed as SW = Gateway Stake / Minimum Stake.

- Tenure Weight (TW): This factor considers how long a gateway has been part of the network, with a maximum value capped at 4. It is calculated as TW = Gateway Network Tenure / 6 block-months. This means that the maximum value is achieved after 2 block-years of participation in the network.

Expand Down Expand Up @@ -131,7 +131,7 @@ In cases where rewards are not distributed, either due to the inactivity or defi

## Handling Inactive Gateways

To maintain network efficiency and reduce contract state bloat, gateways that are consistently offline, specifically for thirty (30) consecutive epochs, and thus fail to receive rewards, will be automatically removed from the Gateway Active Registry (GAR) as well as have their staked IO tokens unlocked and returned to the gateway operator.
To maintain network efficiency and reduce contract state bloat, gateways that are consistently offline, specifically for thirty (30) consecutive epochs, and thus fail to receive rewards, will be automatically removed from the Gateway Active Registry (GAR) as well as have their staked ARIO tokens unlocked and returned to the gateway operator.

## Observer Report Details

Expand Down
2 changes: 1 addition & 1 deletion docs/src/gateways/ar-io-node/testnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ tags: [testnet, join, application, jwk, qty, fqdn, label, note, properties]

## Submit an Application

Joining the ar.io Testnet requires staking a minimum of 50,000 Test IO Tokens. You must have Test IO Tokens before you are able to join. Test IO Tokens are currently not being distributed.
Joining the ar.io Testnet requires staking a minimum of 10,000 Test ARIO Tokens. You must have Test ARIO Tokens before you are able to join. Test ARIO Tokens are currently not being distributed.

New applications for joining the Testnet are not currently being accepted. Be sure to join the [ar.io Discord](https://discord.com/invite/7zUPfN4D6g) to stay up to date on Testnet status and possible future availability prior to the launch of the Mainnet. -->

Expand Down
4 changes: 2 additions & 2 deletions docs/src/gateways/gateways.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,11 +105,11 @@ For example, small scale operators might want to use low-overhead relational dat

## ARNS Indexing and Routing

The Arweave Name System’s (ArNS) state is managed by the IO token’s smart contract. AR.IO gateways shall perform the following minimum functions relative to ArNS:
The Arweave Name System’s (ArNS) state is managed by the ARIO token’s smart contract. AR.IO gateways shall perform the following minimum functions relative to ArNS:

- Actively track state changes in the contract.

- Maintain up-to-date indexes for routing configurations based on the state of the IO contract as well as the states of the Arweave Name Token (ANT) contracts to which each name is affiliated.
- Maintain up-to-date indexes for routing configurations based on the state of the ARIO contract as well as the states of the Arweave Name Token (ANT) contracts to which each name is affiliated.

- Manage the expiration of stale records.

Expand Down
6 changes: 3 additions & 3 deletions docs/src/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,11 +117,11 @@ The permaweb is the permanent and decentralized web of files and applications bu

## **Protocol Balance**:

The primary sink and source of IO tokens circulating through the AR.IO Network. This balance is akin to a central vault or wallet programmatically encoded into the network’s smart contract from which ArNS revenue is accumulated and incentive rewards are distributed.
The primary sink and source of ARIO tokens circulating through the AR.IO Network. This balance is akin to a central vault or wallet programmatically encoded into the network’s smart contract from which ArNS revenue is accumulated and incentive rewards are distributed.

## **Protocol Rewards**:

IO Token incentive rewards distributed by the protocol to the network’s eligible users and gateway operators.
ARIO Token incentive rewards distributed by the protocol to the network’s eligible users and gateway operators.

## **Public Key**:

Expand All @@ -133,7 +133,7 @@ Refers to the act of propagating new data throughout the network. Miner nodes se

## **Staking (of tokens)**:

Refers to the process of locking IO tokens into a protocol-facilitated vault, temporarily removing them from circulation until unlocked. This action represents an opportunity cost for the gateway operator and serves as a motivator to prioritize the network's collective interests.
Refers to the process of locking ARIO tokens into a protocol-facilitated vault, temporarily removing them from circulation until unlocked. This action represents an opportunity cost for the gateway operator and serves as a motivator to prioritize the network's collective interests.

## **Transaction ID (txID)**:

Expand Down
4 changes: 2 additions & 2 deletions docs/src/guides/arns/registering.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ You can also use this page to assign the name to an existing [Arweave Name Token

<img class="amazingdiagram" :src="$withBase('/images/arns-name-configure.jpeg')">

Towards the bottom of the page, you can also see the cost of your currently configured purchase in [IO tokens](../../token.md), and the AR required to pay for gas for the transaction.
Towards the bottom of the page, you can also see the cost of your currently configured purchase in [ARIO tokens](../../token.md), and the AR required to pay for gas for the transaction.

## Confirm Your Purchase

Expand All @@ -65,6 +65,6 @@ No additional steps are necessary to initiate a purchase that requires an auctio

<img class="amazingdiagram" :src="$withBase('/images/arns-auction-started.jpeg')">

The IO cost displayed on the confirmation page will be frozen by the aoComputer contract, and used to finalize the purchase once the the auction drops to the floor price. You, or anyone else, may purchase the name at any time for the current auction price. You can click on the "View Auction" button from your confirmation page, or find your auction in the "Live Auctions" tab at the top of the screen to view the current auction price, and how it will change over time. If someone else purchases the name prior to the auction reaching the floor price, your frozen tokens will be released to you.
The ARIO cost displayed on the confirmation page will be frozen by the aoComputer contract, and used to finalize the purchase once the the auction drops to the floor price. You, or anyone else, may purchase the name at any time for the current auction price. You can click on the "View Auction" button from your confirmation page, or find your auction in the "Live Auctions" tab at the top of the screen to view the current auction price, and how it will change over time. If someone else purchases the name prior to the auction reaching the floor price, your frozen tokens will be released to you.

<img class="amazingdiagram" :src="$withBase('/images/arns-auction-chart.jpeg')">
2 changes: 1 addition & 1 deletion docs/src/guides/delegated-staking.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ permalink: "/delegated-staking"

## Overview

Delegated staking is a process by which a person can stake their own IO tokens on someone elses ar.io gateway. The additional staked tokens increase that gateway's chance to be selected as an observer, and so they have the potential to earn more rewards.
Delegated staking is a process by which a person can stake their own ARIO tokens on someone elses ar.io gateway. The additional staked tokens increase that gateway's chance to be selected as an observer, and so they have the potential to earn more rewards.
In exchange, the person who delegates the tokens will receive a share of the gateway's rewards. Gateway operators can set the percentage of rewards are available for delegating wallets.

You can find more specific information about delegated staking and how rewards are distributed in the [ar.io whitepaper](https://whitepaper_ar-io.arweave.dev/).
Expand Down
Loading

0 comments on commit 700258d

Please sign in to comment.