Skip to content

Commit

Permalink
Update EIP number in filename and content
Browse files Browse the repository at this point in the history
  • Loading branch information
socathie committed Feb 29, 2024
1 parent 420a266 commit c920fc2
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions ERCS/erc-intrinsic_revshare_token.md → ERCS/erc-7641.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ Notably, it introduces a use case known as Initial Model Offering (IMO). Many op

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 and RFC 8174.

**Every compliant contract must implement the `IERCXXXX`, and [ERC-20](./eip-20.md) interfaces.**
**Every compliant contract must implement the `IERC7641`, and [ERC-20](./eip-20.md) interfaces.**

The Intrinsic RevShare Token standard includes the following interfaces:

`IERCXXXX`:
`IERC7641`:
- Defines a `claimableRevenue` view function to calculate the amount of ETH claimable by a token holder at a certain snapshot.
- Defines a `claim` function for token holder to claim ETH based on the token balance at certain snapshot.
- Defines a `snapshot` function to snapshot the token balance and the claimable revenue token balance.
Expand All @@ -51,9 +51,9 @@ The Intrinsic RevShare Token standard includes the following interfaces:
pragma solidity ^0.8.24;
/**
* @dev An interface for ERCXXXX, an ERC-20 extension that integrates a revenue-sharing mechanism, ensuring tokens intrinsically represent a share of a communal revenue pool
* @dev An interface for ERC-7641, an ERC-20 extension that integrates a revenue-sharing mechanism, ensuring tokens intrinsically represent a share of a communal revenue pool
*/
interface IERCXXXX is IERC20 {
interface IERC7641 is IERC20 {
/**
* @dev A function to calculate the amount of ETH claimable by a token holder at certain snapshot.
* @param account The address of the token holder
Expand Down Expand Up @@ -102,9 +102,9 @@ The AltRevToken extension
pragma solidity ^0.8.24;
/**
* @dev An optional extension of the ERCXXXX standard that accepts other ERC-20 revenue tokens into the contract with corresponding claim function
* @dev An optional extension of the ERC-7641 standard that accepts other ERC-20 revenue tokens into the contract with corresponding claim function
*/
interface IERCXXXXAltRevToken is IERCXXXX {
interface IERC7641AltRevToken is IERC7641 {
/**
* @dev A function to calculate the amount of ERC-20 claimable by a token holder at certain snapshot.
* @param account The address of the token holder
Expand Down Expand Up @@ -136,7 +136,7 @@ We specify a `snapshot` interface to snapshot the token balance and the claimabl

### `claimableRevenue` interface

We specify a `claimableRevenue` interface to calculate the amount of ETH claimable by a token holder at a certain snapshot. We will share the revenue between two consecutive snapshots. Specifically, assuming that the revenue between two snapshots is `R`, we will specify a revenue sharing ratio `p`, ranging from 0%-100%, and we will share the revenue of `pR` to different token holders according to the token ratio. Specifically, the amount of ETH claimable by a token holder with `amount` tokens at a certain snapshot is `pR * amount / totalAmount` , where `totalAmount` denotes the total amount of ERCXXXX token. Noted that the remaining revenue of `(1-p)R` will be retained in the revenue pool, and we can take out this part of revenue through burning.
We specify a `claimableRevenue` interface to calculate the amount of ETH claimable by a token holder at a certain snapshot. We will share the revenue between two consecutive snapshots. Specifically, assuming that the revenue between two snapshots is `R`, we will specify a revenue sharing ratio `p`, ranging from 0%-100%, and we will share the revenue of `pR` to different token holders according to the token ratio. Specifically, the amount of ETH claimable by a token holder with `amount` tokens at a certain snapshot is `pR * amount / totalAmount` , where `totalAmount` denotes the total amount of ERC-7641 token. Noted that the remaining revenue of `(1-p)R` will be retained in the revenue pool, and we can take out this part of revenue through burning.

Check failure on line 139 in ERCS/erc-7641.md

View workflow job for this annotation

GitHub Actions / EIP Walidator

the first match of the given pattern must be a link

error[markdown-link-first]: the first match of the given pattern must be a link --> ERCS/erc-7641.md | 139 | We specify a `claimableRevenue` interface to calculate the amount of ETH claimable by a token holder at a certain snapshot. We will share the revenue between two consecutive snapshots. Specifically, assuming that the revenue between two snapshots is `R`, we will specify a revenue sharing ratio `p`, ranging from 0%-100%, and we will share the revenue of `pR` to different token holders according to the token ratio. Specifically, the amount of ETH claimable by a token holder with `amount` tokens at a certain snapshot is `pR * amount / totalAmount` , where `totalAmount` denotes the total amount of ERC-7641 token. Noted that the remaining revenue of `(1-p)R` will be retained in the revenue pool, and we can take out this part of revenue through burning. | = info: the pattern in question: `(?i)(?:eip|erc)-[0-9]+` = help: see https://ethereum.github.io/eipw/markdown-link-first/

Check failure on line 139 in ERCS/erc-7641.md

View workflow job for this annotation

GitHub Actions / EIP Walidator

the first match of the given pattern must be a link

error[markdown-link-first]: the first match of the given pattern must be a link --> ERCS/erc-7641.md | 139 | We specify a `claimableRevenue` interface to calculate the amount of ETH claimable by a token holder at a certain snapshot. We will share the revenue between two consecutive snapshots. Specifically, assuming that the revenue between two snapshots is `R`, we will specify a revenue sharing ratio `p`, ranging from 0%-100%, and we will share the revenue of `pR` to different token holders according to the token ratio. Specifically, the amount of ETH claimable by a token holder with `amount` tokens at a certain snapshot is `pR * amount / totalAmount` , where `totalAmount` denotes the total amount of ERC-7641 token. Noted that the remaining revenue of `(1-p)R` will be retained in the revenue pool, and we can take out this part of revenue through burning. | = info: the pattern in question: `(?i)(?:eip|erc)-[0-9]+` = help: see https://ethereum.github.io/eipw/markdown-link-first/

### `claim` interface

Expand All @@ -154,7 +154,7 @@ We specify `redeemableOnBurn` interface to calculate the amount of ETH redeemabl
redeemableETH = amount / totalSupply * totalRedeemableETH
```

where `totalSupply` denotes the total supply of ERCXXXX token, and `totalRedeemableETH` denotes the total amount of ETH in the burning pool.
where `totalSupply` denotes the total supply of ERC-7641 token, and `totalRedeemableETH` denotes the total amount of ETH in the burning pool.

Check failure on line 157 in ERCS/erc-7641.md

View workflow job for this annotation

GitHub Actions / EIP Walidator

the first match of the given pattern must be a link

error[markdown-link-first]: the first match of the given pattern must be a link --> ERCS/erc-7641.md | 157 | where `totalSupply` denotes the total supply of ERC-7641 token, and `totalRedeemableETH` denotes the total amount of ETH in the burning pool. | = info: the pattern in question: `(?i)(?:eip|erc)-[0-9]+`

Check failure on line 157 in ERCS/erc-7641.md

View workflow job for this annotation

GitHub Actions / EIP Walidator

the first match of the given pattern must be a link

error[markdown-link-first]: the first match of the given pattern must be a link --> ERCS/erc-7641.md | 157 | where `totalSupply` denotes the total supply of ERC-7641 token, and `totalRedeemableETH` denotes the total amount of ETH in the burning pool. | = info: the pattern in question: `(?i)(?:eip|erc)-[0-9]+`

### `burn` interface:

Expand All @@ -170,7 +170,7 @@ The reference implementation includes sample implementations of the interfaces i

## Reference Implementation

* [ERC-XXXX](../assets/eip-XXXX/contracts/ERCXXXX.sol)
* [ERC-7641](../assets/eip-7641/contracts/ERC7641.sol)

## Security Considerations

Expand Down

0 comments on commit c920fc2

Please sign in to comment.