renaming of ETH to gas token

Author: eduv09

.github/agents/cnf-token-auditor.agent.md

@@ -94,7 +94,7 @@ Focus: nonce consumption, signature domain separation, validity windows, receive
 Focus: hashing `bytes value` in typed data, nonce consumption before CTX finality, encrypted vs plaintext authorization differences, relayer and payee griefing.
 
 ### Phase 4 — ConfidentialToken external/public surface
-`receive`, `burn`, `onDecrypt`, `encryptedTransfer`, `encryptedTransferFrom`, `requestDecryptHistoricTransfer`, `requestDecryptHistoricTransferFor`, `removeHistoricViewAuth`, `removeHistoricViewTimeRange`, `removeHistoricViewTransferId`, `authorizeHistoricViewTimeRange`, `authorizeHistoricViewTransferId`, `setViewerPublicKey`, `setCallbackFee`, `setSubmitCTXAddress`, `setEncryptECIESAddress`, `setEncryptTEAddress`, `withdraw`, `encryptedBalanceOf`, `ethBalanceOf`, `canDecryptHistoricTransfer`, `deposit`, `transferFrom`, `registerPublicKey`, `setViewerAddress`, `totalSupply`, `balanceOf`
+`receive`, `burn`, `onDecrypt`, `encryptedTransfer`, `encryptedTransferFrom`, `requestDecryptHistoricTransfer`, `requestDecryptHistoricTransferFor`, `removeHistoricViewAuth`, `removeHistoricViewTimeRange`, `removeHistoricViewTransferId`, `authorizeHistoricViewTimeRange`, `authorizeHistoricViewTransferId`, `setViewerPublicKey`, `setCallbackFee`, `setSubmitCTXAddress`, `setEncryptECIESAddress`, `setEncryptTEAddress`, `withdraw`, `encryptedBalanceOf`, `gasTokenBalanceOf`, `canDecryptHistoricTransfer`, `deposit`, `transferFrom`, `registerPublicKey`, `setViewerAddress`, `totalSupply`, `balanceOf`
 
 Also trace inherited entry points: `transfer`, `approve`, `allowance`, `increaseAllowance`/`decreaseAllowance`, `permit`, `nonces`, `DOMAIN_SEPARATOR`, ERC20 metadata.
 
@@ -123,7 +123,7 @@ Focus: 1:1 backing, `requestedMints`, failed mint callback recovery, withdrawal
 
 **Input patterns:** zero address, self-transfer, zero amount, max amount, amount exceeding balance, valid TE ciphertext, malformed ciphertext length, empty decrypted value, malformed plaintext arguments, stale encrypted balances, missing public key, viewer key changed between submission and callback, historic auth revoked between submission and callback, expired/not-yet-valid authorization, reused nonce.
 
-**State patterns:** no ETH deposited for callback fees, exact fee deposited, fee changed before next operation, multiple concurrent CTXs for same account, multiple concurrent CTXs for both accounts involved in transfer, account changed after CTX submission, callback succeeds, callback reverts, callback sender attempts replay, underlying token transfer succeeds, underlying token transfer fails.
+**State patterns:** no gas token deposited for callback fees, exact fee deposited, fee changed before next operation, multiple concurrent CTXs for same account, multiple concurrent CTXs for both accounts involved in transfer, account changed after CTX submission, callback succeeds, callback reverts, callback sender attempts replay, underlying token transfer succeeds, underlying token transfer fails.
 
 **Inheritance patterns:** direct call, call through inherited ERC20, call through ERC20Permit allowance path, call through EIP3009 signed path, call through wrapper override.
 

README.md

@@ -52,7 +52,7 @@ The main contract implementing the confidential token functionality. It extends
 - `encryptedTransfer(to, value)`: Transfer tokens using an encrypted value (bytes)
 - `encryptedTransferFrom(from, to, value)`: Transfer tokens on behalf of another using an encrypted value (bytes)
 - `encryptedBalanceOf(holder)`: Get the encrypted balance representation (must be decrypted off-chain)
-- `ethBalanceOf(holder)`: Get the gas token balance for callback funding
+- `gasTokenBalanceOf(holder)`: Get the gas token balance for callback funding
 
 **Historic Transfer Decryption:**
 
@@ -62,7 +62,7 @@ Additionally, if the recipient has a registered public key at the time of transf
 
 For third-party viewers (auditors, accounting tools, delegated observers), holders can grant selective decryption access to their own transfers:
 
-- `requestDecryptHistoricTransfer(encryptedTransferData)`: Submit a TE-encrypted transfer payload for decryption. Requires the caller to be a registered user and have sufficient ETH balance for the callback fee. On successful callback, emits a `ReEncryptedTransfer` event with the value ECIES-encrypted for the requester's public key. The fee is charged even if the requester turns out not to be authorized — authorization is only checked inside the callback.
+- `requestDecryptHistoricTransfer(encryptedTransferData)`: Submit a TE-encrypted transfer payload for decryption. Requires the caller to be a registered user and have sufficient gas token balance for the callback fee. On successful callback, emits a `ReEncryptedTransfer` event with the value ECIES-encrypted for the requester's public key. The fee is charged even if the requester turns out not to be authorized — authorization is only checked inside the callback.
 - `requestDecryptHistoricTransferFor(encryptedTransferData, historicViewer)`: Submit a TE-encrypted transfer payload for decryption on behalf of another registered viewer. Callback fee is charged from the caller (`msg.sender`), while successful callback emits `ReEncryptedTransfer` encrypted for `historicViewer`.
 - `authorizeHistoricViewTimeRange(viewer, fromTimestamp, toTimestamp)`: Grant a viewer decryption access to all transfers whose timestamp falls within `[fromTimestamp, toTimestamp)` (inclusive of `fromTimestamp`, exclusive of `toTimestamp`). To revoke this time-range access, call `removeHistoricViewTimeRange(viewer)`; to revoke all historic-view permissions for the viewer, call `removeHistoricViewAuth(viewer)`. Emits `HistoricViewTimeRangeAuthorized`.
 - `authorizeHistoricViewTransferId(viewer, transferId)`: Grant a viewer access to one specific transfer by its on-chain ID. The transfer ID must already exist. Emits `HistoricViewTransferIdAuthorized`.

contracts/ConfidentialToken.sol

@@ -59,7 +59,7 @@ contract ConfidentialToken is ConfidentialEIP3009, ERC20Permit, AccessManaged, I
     uint8 private constant _TRANSFER_ACTION = 0;
     uint8 private constant _HISTORIC_VIEW_ACTION = 1;
 
-    /// @notice Specifies number of ETH to be sent to pay for callback execution
+    /// @notice Specifies amount of gas token to be sent to pay for callback execution
     uint256 public callbackFee = 1_000 gwei;
 
     /// @notice Address of the EncryptECIES precompiled contract
@@ -90,7 +90,7 @@ contract ConfidentialToken is ConfidentialEIP3009, ERC20Permit, AccessManaged, I
     /// @notice Encrypted with User's Public Key (U_Key) - Used for local viewing
     mapping(address holder => bytes encryptedBalance) private _userBalances;
 
-    mapping(address holder => uint256 eth) private _ethBalance;
+    mapping(address holder => uint256 gasToken) private _gasTokenBalance;
 
     mapping(address holder => uint256 blockNumber) private _lastChanged;
 
@@ -107,7 +107,7 @@ contract ConfidentialToken is ConfidentialEIP3009, ERC20Permit, AccessManaged, I
     error AccessViolation();
     error ActionNotRecognized();
     error InsufficientBalance();
-    error InsufficientEth(uint256 required, uint256 available);
+    error InsufficientGasToken(uint256 required, uint256 available);
     error InvalidPublicKey();
     error InvalidTransferId(uint256 transferId);
     error NoViewerRegisteredForHolder(address holder);
@@ -290,10 +290,14 @@ contract ConfidentialToken is ConfidentialEIP3009, ERC20Permit, AccessManaged, I
     function withdraw(uint256 value, address receiver) external override {
         // value is not a constant
         // so no ability to save some gas here
-        // solhint-disable-next-line gas-strict-inequalities
-        require(_ethBalance[msg.sender] >= value, InsufficientEth(value, _ethBalance[msg.sender]));
-        _ethBalance[msg.sender] -= value;
-        emit EthWithdrawn(receiver, value);
+        // solhint-disable gas-strict-inequalities
+        require(
+            _gasTokenBalance[msg.sender] >= value,
+            InsufficientGasToken(value, _gasTokenBalance[msg.sender])
+        );
+        // solhint-enable gas-strict-inequalities
+        _gasTokenBalance[msg.sender] -= value;
+        emit GasTokenWithdrawn(receiver, value);
         payable(receiver).sendValue(value);
     }
 
@@ -304,8 +308,8 @@ contract ConfidentialToken is ConfidentialEIP3009, ERC20Permit, AccessManaged, I
     }
 
     /// @inheritdoc IConfidentialToken
-    function ethBalanceOf(address holder) external view override returns (uint256 balance) {
-        return _ethBalance[holder];
+    function gasTokenBalanceOf(address holder) external view override returns (uint256 balance) {
+        return _gasTokenBalance[holder];
     }
 
     ///@inheritdoc IConfidentialToken
@@ -355,8 +359,8 @@ contract ConfidentialToken is ConfidentialEIP3009, ERC20Permit, AccessManaged, I
     function deposit(address receiver) public payable override {
         uint256 value = msg.value;
         if (value > 0) {
-            _ethBalance[receiver] += value;
-            emit EthBalanceToppedUp(msg.sender, receiver, value);
+            _gasTokenBalance[receiver] += value;
+            emit GasTokenBalanceToppedUp(msg.sender, receiver, value);
         }
     }
 
@@ -784,9 +788,13 @@ contract ConfidentialToken is ConfidentialEIP3009, ERC20Permit, AccessManaged, I
     {
         // callbackFee is not a constant
         // so no ability to save some gas here
-        // solhint-disable-next-line gas-strict-inequalities
-        require(_ethBalance[gasPayer] >= callbackFee, InsufficientEth(callbackFee, _ethBalance[gasPayer]));
-        _ethBalance[gasPayer] -= callbackFee;
+        // solhint-disable gas-strict-inequalities
+        require(
+            _gasTokenBalance[gasPayer] >= callbackFee,
+            InsufficientGasToken(callbackFee, _gasTokenBalance[gasPayer])
+        );
+        // solhint-enable gas-strict-inequalities
+        _gasTokenBalance[gasPayer] -= callbackFee;
 
         address payable callback = BITE.submitCTX(
             submitCTXAddress,

contracts/interfaces/IConfidentialToken.sol

@@ -42,16 +42,16 @@ interface IConfidentialToken is IBiteSupplicant {
     /// @param callbackSender Address of the CTX sender that triggered the resubmission
     event CTXResubmitted(address indexed callbackSender);
 
-    /// @notice Emitted when ETH balance is topped up
+    /// @notice Emitted when gas token balance is topped up
     /// @param sender Address of the sender
     /// @param receiver Address of the receiver
-    /// @param value Amount of ETH topped up
-    event EthBalanceToppedUp(address indexed sender, address indexed receiver, uint256 indexed value);
+    /// @param value Amount of gas token topped up
+    event GasTokenBalanceToppedUp(address indexed sender, address indexed receiver, uint256 indexed value);
 
-    /// @notice Emitted when ETH is withdrawn
+    /// @notice Emitted when gas token is withdrawn
     /// @param receiver Address of the receiver
-    /// @param value Amount of ETH withdrawn
-    event EthWithdrawn(address indexed receiver, uint256 indexed value);
+    /// @param value Amount of gas token withdrawn
+    event GasTokenWithdrawn(address indexed receiver, uint256 indexed value);
 
     /// @notice Emitted when tokens (value omitted) are moved from one account (`from`) to another (`to`)
     /// @param from Address tokens are moved from
@@ -161,10 +161,10 @@ interface IConfidentialToken is IBiteSupplicant {
     /// @param newViewer Address of the new viewer
     event ViewerChanged(address indexed holder, address indexed newViewer);
 
-    /// @notice Allows the contract to receive ETH to pay for callback execution
+    /// @notice Allows the contract to receive gas token to pay for callback execution
     receive() external payable;
 
-    /// @notice Deposits ETH to any holder balance
+    /// @notice Deposits gas token to any holder balance
     /// @param receiver The address of the receiver holder
     function deposit(address receiver) external payable;
 
@@ -183,7 +183,7 @@ interface IConfidentialToken is IBiteSupplicant {
     /// @param viewer The address of the viewer
     function setViewerAddress(address viewer) external payable;
 
-    /// @notice Sets number of ETH to be sent to pay for callback execution
+    /// @notice Sets amount of gas token to be sent to pay for callback execution
     /// @param newFee New callback fee
     function setCallbackFee(uint256 newFee) external;
 
@@ -199,9 +199,9 @@ interface IConfidentialToken is IBiteSupplicant {
     /// @param newAddress New address of the SubmitCTX precompiled contract
     function setSubmitCTXAddress(address newAddress) external;
 
-    /// @notice Withdraws ETH from the caller's balance
-    /// @param amount Amount of ETH to withdraw
-    /// @param receiver Address to send the withdrawn ETH to
+    /// @notice Withdraws gas token from the caller's balance
+    /// @param amount Amount of gas token to withdraw
+    /// @param receiver Address to send the withdrawn gas token to
     function withdraw(uint256 amount, address receiver) external;
 
     /// @notice Transfers tokens to another holder
@@ -283,8 +283,8 @@ interface IConfidentialToken is IBiteSupplicant {
     /// @return encryptedBalance The encrypted balance of the holder
     function encryptedBalanceOf(address holder) external view returns (bytes memory encryptedBalance);
 
-    /// @notice Gets the ETH balance of a holder
+    /// @notice Gets the gas token balance of a holder
     /// @param holder The address of the holder
-    /// @return balance The ETH balance of the holder
-    function ethBalanceOf(address holder) external view returns (uint256 balance);
+    /// @return balance The gas token balance of the holder
+    function gasTokenBalanceOf(address holder) external view returns (uint256 balance);
 }

docs/ConfidentialToken.md

@@ -18,7 +18,7 @@ struct TransferInfo {
 
 ### callbackFee
 
-Specifies number of ETH to be sent to pay for callback execution
+Specifies amount of gas token to be sent to pay for callback execution
 
 ```solidity
 uint256 callbackFee
@@ -92,10 +92,10 @@ error ActionNotRecognized()
 error InsufficientBalance()
 ```
 
-### InsufficientEth
+### InsufficientGasToken
 
 ```solidity
-error InsufficientEth(uint256 required, uint256 available)
+error InsufficientGasToken(uint256 required, uint256 available)
 ```
 
 ### InvalidPublicKey
@@ -173,7 +173,7 @@ constructor(string name_, string symbol_, string version_, address initialAuthor
 
 ### receive
 
-Allows the contract to receive ETH to pay for callback execution
+Allows the contract to receive gas token to pay for callback execution
 
 ```solidity
 receive() external payable
@@ -367,7 +367,7 @@ function setViewerPublicKey(struct PublicKey publicKey) external payable
 
 ### setCallbackFee
 
-Sets number of ETH to be sent to pay for callback execution
+Sets amount of gas token to be sent to pay for callback execution
 
 ```solidity
 function setCallbackFee(uint256 newFee) external
@@ -423,7 +423,7 @@ function setEncryptTEAddress(address newAddress) external
 
 ### withdraw
 
-Withdraws ETH from the caller's balance
+Withdraws gas token from the caller's balance
 
 ```solidity
 function withdraw(uint256 value, address receiver) external
@@ -434,7 +434,7 @@ function withdraw(uint256 value, address receiver) external
 | Name | Type | Description |
 | ---- | ---- | ----------- |
 | value | uint256 |  |
-| receiver | address | Address to send the withdrawn ETH to |
+| receiver | address | Address to send the withdrawn gas token to |
 
 ### encryptedBalanceOf
 
@@ -456,12 +456,12 @@ function encryptedBalanceOf(address holder) external view returns (bytes encrypt
 | ---- | ---- | ----------- |
 | encryptedBalance | bytes | The encrypted balance of the holder |
 
-### ethBalanceOf
+### gasTokenBalanceOf
 
-Gets the ETH balance of a holder
+Gets the gas token balance of a holder
 
 ```solidity
-function ethBalanceOf(address holder) external view returns (uint256 balance)
+function gasTokenBalanceOf(address holder) external view returns (uint256 balance)
 ```
 
 #### Parameters
@@ -474,7 +474,7 @@ function ethBalanceOf(address holder) external view returns (uint256 balance)
 
 | Name | Type | Description |
 | ---- | ---- | ----------- |
-| balance | uint256 | The ETH balance of the holder |
+| balance | uint256 | The gas token balance of the holder |
 
 ### canDecryptHistoricTransfer
 
@@ -521,7 +521,7 @@ function requestDecryptHistoricTransferFor(bytes encryptedTransferData, address
 
 ### deposit
 
-Deposits ETH to any holder balance
+Deposits gas token to any holder balance
 
 ```solidity
 function deposit(address receiver) public payable

docs/interfaces/IConfidentialToken.md

@@ -32,12 +32,12 @@ event CTXResubmitted(address callbackSender)
 | ---- | ---- | ----------- |
 | callbackSender | address | Address of the CTX sender that triggered the resubmission |
 
-### EthBalanceToppedUp
+### GasTokenBalanceToppedUp
 
-Emitted when ETH balance is topped up
+Emitted when gas token balance is topped up
 
 ```solidity
-event EthBalanceToppedUp(address sender, address receiver, uint256 value)
+event GasTokenBalanceToppedUp(address sender, address receiver, uint256 value)
 ```
 
 #### Parameters
@@ -46,22 +46,22 @@ event EthBalanceToppedUp(address sender, address receiver, uint256 value)
 | ---- | ---- | ----------- |
 | sender | address | Address of the sender |
 | receiver | address | Address of the receiver |
-| value | uint256 | Amount of ETH topped up |
+| value | uint256 | Amount of gas token topped up |
 
-### EthWithdrawn
+### GasTokenWithdrawn
 
-Emitted when ETH is withdrawn
+Emitted when gas token is withdrawn
 
 ```solidity
-event EthWithdrawn(address receiver, uint256 value)
+event GasTokenWithdrawn(address receiver, uint256 value)
 ```
 
 #### Parameters
 
 | Name | Type | Description |
 | ---- | ---- | ----------- |
 | receiver | address | Address of the receiver |
-| value | uint256 | Amount of ETH withdrawn |
+| value | uint256 | Amount of gas token withdrawn |
 
 ### Transfer
 
@@ -302,15 +302,15 @@ event ViewerChanged(address holder, address newViewer)
 
 ### receive
 
-Allows the contract to receive ETH to pay for callback execution
+Allows the contract to receive gas token to pay for callback execution
 
 ```solidity
 receive() external payable
 ```
 
 ### deposit
 
-Deposits ETH to any holder balance
+Deposits gas token to any holder balance
 
 ```solidity
 function deposit(address receiver) external payable
@@ -372,7 +372,7 @@ function setViewerAddress(address viewer) external payable
 
 ### setCallbackFee
 
-Sets number of ETH to be sent to pay for callback execution
+Sets amount of gas token to be sent to pay for callback execution
 
 ```solidity
 function setCallbackFee(uint256 newFee) external
@@ -428,7 +428,7 @@ function setSubmitCTXAddress(address newAddress) external
 
 ### withdraw
 
-Withdraws ETH from the caller's balance
+Withdraws gas token from the caller's balance
 
 ```solidity
 function withdraw(uint256 amount, address receiver) external
@@ -438,8 +438,8 @@ function withdraw(uint256 amount, address receiver) external
 
 | Name | Type | Description |
 | ---- | ---- | ----------- |
-| amount | uint256 | Amount of ETH to withdraw |
-| receiver | address | Address to send the withdrawn ETH to |
+| amount | uint256 | Amount of gas token to withdraw |
+| receiver | address | Address to send the withdrawn gas token to |
 
 ### encryptedTransfer
 
@@ -659,12 +659,12 @@ function encryptedBalanceOf(address holder) external view returns (bytes encrypt
 | ---- | ---- | ----------- |
 | encryptedBalance | bytes | The encrypted balance of the holder |
 
-### ethBalanceOf
+### gasTokenBalanceOf
 
-Gets the ETH balance of a holder
+Gets the gas token balance of a holder
 
 ```solidity
-function ethBalanceOf(address holder) external view returns (uint256 balance)
+function gasTokenBalanceOf(address holder) external view returns (uint256 balance)
 ```
 
 #### Parameters
@@ -677,5 +677,5 @@ function ethBalanceOf(address holder) external view returns (uint256 balance)
 
 | Name | Type | Description |
 | ---- | ---- | ----------- |
-| balance | uint256 | The ETH balance of the holder |
+| balance | uint256 | The gas token balance of the holder |