diff --git a/EIPS/eip-777.md b/EIPS/eip-777.md index f2b4c8bf..72f4e821 100644 --- a/EIPS/eip-777.md +++ b/EIPS/eip-777.md @@ -139,6 +139,7 @@ function name() external view returns (string memory) Get the name of the token, e.g., `"MyToken"`. +> **identifier:** `06fdde03` > **returns:** Name of the token. **`symbol` function** @@ -149,6 +150,7 @@ function symbol() external view returns (string memory) Get the symbol of the token, e.g., `"MYT"`. +> **identifier:** `95d89b41` > **returns:** Symbol of the token. **`totalSupply` function** @@ -165,6 +167,7 @@ returned by the `balanceOf` function. *NOTE*: The total supply MUST be equal to the sum of all the minted tokens as defined in all the `Minted` events minus the sum of all the burned tokens as defined in all the `Burned` events. +> **identifier:** `18160ddd` > **returns:** Total supply of tokens currently in circulation. **`balanceOf` function** @@ -177,6 +180,7 @@ Get the balance of the account with address `holder`. The balance MUST be zero (`0`) or higher. +> **identifier:** `70a08231` > **parameters** > `holder`: Address for which the balance is returned. > @@ -210,6 +214,7 @@ The following rules MUST be applied regarding the *granularity*: *NOTE*: Most of the tokens SHOULD be fully partition-able. I.e., this function SHOULD return `1` unless there is a good reason for not allowing any fraction of the token. +> **identifier:** `556f0dc7` > **returns:** The smallest non-divisible part of the token. *NOTE*: [`defaultOperators`][defaultOperators] and [`isOperatorFor`][isOperatorFor] are also `view` functions, @@ -322,6 +327,7 @@ Get the list of *default operators* as defined by the token contract. *NOTE*: If the token contract does not have any *default operators*, this function MUST return an empty list. +> **identifier:** `06e48538` > **returns:** List of addresses of all the *default operators*. **`authorizeOperator` function** @@ -337,6 +343,7 @@ This right SHALL NOT be revoked. Hence this function MUST `revert` if it is called to authorize the holder (`msg.sender`) as an *operator* for itself (i.e. if `operator` is equal to `msg.sender`). +> **identifier:** `959b8c3f` > **parameters** > `operator`: Address to set as an *operator* for `msg.sender`. @@ -354,6 +361,7 @@ This right SHALL NOT be revoked. Hence this function MUST `revert` if it is called to revoke the holder (`msg.sender`) as an *operator* for itself (i.e., if `operator` is equal to `msg.sender`). +> **identifier:** `fad8b32a` > **parameters** > `operator`: Address to rescind as an *operator* for `msg.sender`. @@ -365,6 +373,7 @@ function isOperatorFor(address operator, address holder) external view returns ( Indicate whether the `operator` address is an *operator* of the `holder` address. +> **identifier:** `d95b6371` > **parameters** > `operator`: Address which may be an *operator* of `holder`. > `holder`: Address of a *holder* which may have the `operator` address as an *operator*. @@ -484,6 +493,7 @@ Send the `amount` of tokens from the address `msg.sender` to the address `to`. The *operator* and the *holder* MUST both be the `msg.sender`. +> **identifier:** `9bd9bbc6` > **parameters** > `to`: Recipient of the tokens. > `amount`: Number of tokens to send. @@ -506,6 +516,7 @@ This call MUST be equivalent to `send` with the addition that the *operator* MAY specify an explicit value for `operatorData` (which cannot be done with the `send` function). +> **identifier:** `62ad1b83` > **parameters** > `from`: *Holder* whose tokens are being sent. > `to`: Recipient of the tokens. @@ -675,6 +686,7 @@ Burn the `amount` of tokens from the address `msg.sender`. The *operator* and the *holder* MUST both be the `msg.sender`. +> **identifier:** `fe9d9303` > **parameters** > `amount`: Number of tokens to burn. > `data`: Information provided by the *holder*. @@ -690,6 +702,7 @@ Burn the `amount` of tokens on behalf of the address `from`. *Reminder*: If the *operator* address is not an authorized operator of the `from` address, then the burn process MUST `revert`. +> **identifier:** `fc673c4f` > **parameters** > `from`: *Holder* whose tokens will be burned. > `amount`: Number of tokens to burn. @@ -740,6 +753,7 @@ by the `operator` address. *NOTE*: This function MUST NOT be called outside of a burn, send or [ERC20] transfer process. +> **identifier:** `75ab9782` > **parameters** > `operator`: Address which triggered the balance decrease (through sending or burning). > `from`: *Holder* whose tokens were sent. @@ -825,6 +839,7 @@ by the `operator` address. *NOTE*: This function MUST NOT be called outside of a mint, send or [ERC20] transfer process. +> **identifier:** `0023de29` > **parameters** > `operator`: Address which triggered the balance increase (through sending or minting). > `from`: *Holder* whose tokens were sent (or `0x0` for a mint).