Merge d806bee into adc64e1

Author: YamenMerhi

CONTRIBUTING.md

@@ -159,7 +159,7 @@ E.g.:
 
 ```solidity
 /**
- * @custom:events {ValueReceived} event when someone tranfers native tokens to the contract.
+ * @custom:events {UniversalReceiver} event when someone tranfers native tokens to the contract.
  */
 ```
 
@@ -168,7 +168,7 @@ E.g.:
 ```solidity
 /**
  * @custom:events
- * - {ValueReceived} event when someone tranfers native tokens to the contract.
+ * - {UniversalReceiver} event when someone tranfers native tokens to the contract.
  * - {Executes} event when the function is executed without any issues.
  */
 ```

constants.ts

@@ -319,6 +319,9 @@ export const PERMISSIONS = {
  * (e.g: token transfer, vault transfer, ownership transfer, etc...)
  */
 export const LSP1_TYPE_IDS = {
+  // keccak256('LSP0ValueReceived')
+  LSP0ValueReceived: '0x9c4705229491d365fb5434052e12a386d6771d976bea61070a8c694e8affea3d',
+
   // keccak256('LSP0OwnershipTransferStarted')
   LSP0OwnershipTransferStarted:
     '0xe17117c9d2665d1dbeb479ed8058bbebde3c50ac50e2e65619f60006caac6926',
@@ -355,6 +358,9 @@ export const LSP1_TYPE_IDS = {
   LSP8Tokens_OperatorNotification:
     '0x8a1c15a8799f71b547e08e2bcb2e85257e81b0a07eee2ce6712549eef1f00970',
 
+  // keccak256('LSP9ValueReceived')
+  LSP9ValueReceived: '0x468cd1581d7bc001c3b685513d2b929b55437be34700410383d58f3aa1ea0abc',
+
   // keccak256('LSP9OwnershipTransferStarted')
   LSP9OwnershipTransferStarted:
     '0xaefd43f45fed1bcd8992f23c803b6f4ec45cf6b62b0d404d565f290a471e763f',

contracts/LSP0ERC725Account/ILSP0ERC725Account.sol

@@ -7,14 +7,6 @@ pragma solidity ^0.8.4;
  * @author Fabian Vogelsteller <[email protected]>, Jean Cavallera (CJ42)
  */
 interface ILSP0ERC725Account {
-    /**
-     * @notice `value` native tokens received from `sender`.
-     * @dev Emitted when receiving native tokens.
-     * @param sender The address that sent some native tokens to this contract.
-     * @param value The amount of native tokens received.
-     */
-    event ValueReceived(address indexed sender, uint256 indexed value);
-
     /**
      * @notice Executing the following batch of abi-encoded function calls on the contract: `data`.
      *

contracts/LSP0ERC725Account/LSP0Constants.sol

@@ -9,6 +9,11 @@ bytes4 constant _INTERFACEID_ERC1271 = 0x1626ba7e;
 bytes4 constant _ERC1271_SUCCESSVALUE = 0x1626ba7e;
 bytes4 constant _ERC1271_FAILVALUE = 0xffffffff;
 
+// --- Native Token Type Id
+
+// keccak256('LSP0ValueReceived')
+bytes32 constant _TYPEID_LSP0_VALUE_RECEIVED = 0x9c4705229491d365fb5434052e12a386d6771d976bea61070a8c694e8affea3d;
+
 // Ownerhsip Transfer Type IDs
 
 // keccak256('LSP0OwnershipTransferStarted')

contracts/LSP0ERC725Account/LSP0ERC725Account.sol

@@ -7,6 +7,10 @@ import {
     OwnableUnset
 } from "@erc725/smart-contracts/contracts/custom/OwnableUnset.sol";
 
+// constants
+
+import {_TYPEID_LSP0_VALUE_RECEIVED} from "./LSP0Constants.sol";
+
 /**
  * @title Deployable Implementation of [LSP-0-ERC725Account] Standard.
  *
@@ -29,12 +33,18 @@ contract LSP0ERC725Account is LSP0ERC725AccountCore {
      * @param initialOwner The owner of the contract.
      *
      * @custom:events
-     * - {ValueReceived} event when funding the contract on deployment.
+     * - {UniversalReceiver} event when funding the contract on deployment.
      * - {OwnershipTransferred} event when `initialOwner` is set as the contract {owner}.
      */
     constructor(address initialOwner) payable {
         if (msg.value != 0) {
-            emit ValueReceived(msg.sender, msg.value);
+            emit UniversalReceiver(
+                msg.sender,
+                msg.value,
+                _TYPEID_LSP0_VALUE_RECEIVED,
+                "",
+                ""
+            );
         }
 
         OwnableUnset._setOwner(initialOwner);

contracts/LSP0ERC725Account/LSP0ERC725AccountCore.sol

@@ -41,6 +41,7 @@ import {
     _INTERFACEID_ERC1271,
     _ERC1271_SUCCESSVALUE,
     _ERC1271_FAILVALUE,
+    _TYPEID_LSP0_VALUE_RECEIVED,
     _TYPEID_LSP0_OwnershipTransferStarted,
     _TYPEID_LSP0_OwnershipTransferred_SenderNotification,
     _TYPEID_LSP0_OwnershipTransferred_RecipientNotification
@@ -94,11 +95,11 @@ abstract contract LSP0ERC725AccountCore is
      * - When receiving some native tokens without any additional data.
      * - On empty calls to the contract.
      *
-     * @custom:events {ValueReceived} event when receiving native tokens.
+     * @custom:events {UniversalReceiver} event when receiving native tokens.
      */
     receive() external payable virtual {
         if (msg.value != 0) {
-            emit ValueReceived(msg.sender, msg.value);
+            universalReceiver(_TYPEID_LSP0_VALUE_RECEIVED, "");
         }
     }
 
@@ -121,17 +122,16 @@ abstract contract LSP0ERC725AccountCore is
      *
      * 2. If the data sent to this function is of length less than 4 bytes (not a function selector), return.
      *
-     * @custom:events {ValueReceived} event when receiving native tokens.
+     * @custom:events {UniversalReceiver} event when receiving native tokens and extension function selector is not found or not payable.
      */
     // solhint-disable-next-line no-complex-fallback
     fallback(
         bytes calldata callData
     ) external payable virtual returns (bytes memory) {
-        if (msg.value != 0) {
-            emit ValueReceived(msg.sender, msg.value);
-        }
-
         if (msg.data.length < 4) {
+            // if value is associated with the extension call, use the universalReceiver
+            if (msg.value != 0)
+                universalReceiver(_TYPEID_LSP0_VALUE_RECEIVED, callData);
             return "";
         }
 
@@ -187,7 +187,7 @@ abstract contract LSP0ERC725AccountCore is
      * @custom:events
      * - {Executed} event for each call that uses under `operationType`: `CALL` (0), `STATICCALL` (3) and `DELEGATECALL` (4).
      * - {ContractCreated} event, when a contract is created under `operationType`: `CREATE` (1) and `CREATE2` (2).
-     * - {ValueReceived} event when receiving native tokens.
+     * - {UniversalReceiver} event when receiving native tokens.
      */
     function execute(
         uint256 operationType,
@@ -196,7 +196,13 @@ abstract contract LSP0ERC725AccountCore is
         bytes memory data
     ) public payable virtual override returns (bytes memory) {
         if (msg.value != 0) {
-            emit ValueReceived(msg.sender, msg.value);
+            emit UniversalReceiver(
+                msg.sender,
+                msg.value,
+                _TYPEID_LSP0_VALUE_RECEIVED,
+                abi.encodePacked(msg.sig),
+                ""
+            );
         }
 
         address accountOwner = owner();
@@ -245,7 +251,7 @@ abstract contract LSP0ERC725AccountCore is
      * @custom:events
      * - {Executed} event for each call that uses under `operationType`: `CALL` (0), `STATICCALL` (3) and `DELEGATECALL` (4). (each iteration)
      * - {ContractCreated} event, when a contract is created under `operationType`: `CREATE` (1) and `CREATE2` (2) (each iteration)
-     * - {ValueReceived} event when receiving native tokens.
+     * - {UniversalReceiver} event when receiving native tokens.
      */
     function executeBatch(
         uint256[] memory operationsType,
@@ -254,7 +260,13 @@ abstract contract LSP0ERC725AccountCore is
         bytes[] memory datas
     ) public payable virtual override returns (bytes[] memory) {
         if (msg.value != 0) {
-            emit ValueReceived(msg.sender, msg.value);
+            emit UniversalReceiver(
+                msg.sender,
+                msg.value,
+                _TYPEID_LSP0_VALUE_RECEIVED,
+                abi.encodePacked(msg.sig),
+                ""
+            );
         }
 
         address accountOwner = owner();
@@ -299,15 +311,21 @@ abstract contract LSP0ERC725AccountCore is
      * @custom:requirements Can be only called by the {owner} or by an authorised address that pass the verification check performed on the owner.
      *
      * @custom:events
-     * - {ValueReceived} event when receiving native tokens.
+     * - {UniversalReceiver} event when receiving native tokens.
      * - {DataChanged} event.
      */
     function setData(
         bytes32 dataKey,
         bytes memory dataValue
     ) public payable virtual override {
         if (msg.value != 0) {
-            emit ValueReceived(msg.sender, msg.value);
+            emit UniversalReceiver(
+                msg.sender,
+                msg.value,
+                _TYPEID_LSP0_VALUE_RECEIVED,
+                abi.encodePacked(msg.sig),
+                ""
+            );
         }
 
         address accountOwner = owner();
@@ -336,15 +354,21 @@ abstract contract LSP0ERC725AccountCore is
      * @custom:requirements Can be only called by the {owner} or by an authorised address that pass the verification check performed on the owner.
      *
      * @custom:events
-     * - {ValueReceived} event when receiving native tokens.
+     * - {UniversalReceiver} event when receiving native tokens.
      * - {DataChanged} event. (on each iteration of setting data)
      */
     function setDataBatch(
         bytes32[] memory dataKeys,
         bytes[] memory dataValues
     ) public payable virtual override {
         if (msg.value != 0) {
-            emit ValueReceived(msg.sender, msg.value);
+            emit UniversalReceiver(
+                msg.sender,
+                msg.value,
+                _TYPEID_LSP0_VALUE_RECEIVED,
+                abi.encodePacked(msg.sig),
+                ""
+            );
         }
 
         if (dataKeys.length != dataValues.length) {
@@ -416,15 +440,15 @@ abstract contract LSP0ERC725AccountCore is
      * @return returnedValues The ABI encoded return value of the LSP1UniversalReceiverDelegate call and the LSP1TypeIdDelegate call.
      *
      * @custom:events
-     * - {ValueReceived} when receiving native tokens.
+     * - {UniversalReceiver} when receiving native tokens.
      * - {UniversalReceiver} event with the function parameters, call options, and the response of the UniversalReceiverDelegates (URD) contract that was called.
      */
     function universalReceiver(
         bytes32 typeId,
-        bytes calldata receivedData
+        bytes memory receivedData
     ) public payable virtual override returns (bytes memory returnedValues) {
-        if (msg.value != 0) {
-            emit ValueReceived(msg.sender, msg.value);
+        if (msg.value != 0 && (typeId != _TYPEID_LSP0_VALUE_RECEIVED)) {
+            universalReceiver(_TYPEID_LSP0_VALUE_RECEIVED, msg.data);
         }
 
         // Query the ERC725Y storage with the data key {_LSP1_UNIVERSAL_RECEIVER_DELEGATE_KEY}
@@ -742,8 +766,9 @@ abstract contract LSP0ERC725AccountCore is
     /**
      * @dev Forwards the call to an extension mapped to a function selector.
      *
-     * Calls {_getExtension} to get the address of the extension mapped to the function selector being
+     * Calls {_getExtensionAndForwardValue} to get the address of the extension mapped to the function selector being
      * called on the account. If there is no extension, the `address(0)` will be returned.
+     * Forwards the value sent with the call to the extension if the function selector is mapped to a payable extension.
      *
      * Reverts if there is no extension for the function being called, except for the `bytes4(0)` function selector, which passes even if there is no extension for it.
      *
@@ -763,7 +788,14 @@ abstract contract LSP0ERC725AccountCore is
         bytes calldata callData
     ) internal virtual override returns (bytes memory) {
         // If there is a function selector
-        address extension = _getExtension(msg.sig);
+        (
+            address extension,
+            bool isForwardingValue
+        ) = _getExtensionAndForwardValue(msg.sig);
+
+        // if value is associated with the extension call and extension function selector is not payable, use the universalReceiver
+        if (msg.value != 0 && !isForwardingValue)
+            universalReceiver(_TYPEID_LSP0_VALUE_RECEIVED, callData);
 
         // if no extension was found for bytes4(0) return don't revert
         if (msg.sig == bytes4(0) && extension == address(0)) return "";
@@ -772,9 +804,9 @@ abstract contract LSP0ERC725AccountCore is
         if (extension == address(0))
             revert NoExtensionFoundForFunctionSelector(msg.sig);
 
-        (bool success, bytes memory result) = extension.call(
-            abi.encodePacked(callData, msg.sender, msg.value)
-        );
+        (bool success, bytes memory result) = extension.call{
+            value: isForwardingValue ? msg.value : 0
+        }(abi.encodePacked(callData, msg.sender, msg.value));
 
         if (success) {
             return result;
@@ -793,21 +825,32 @@ abstract contract LSP0ERC725AccountCore is
      * - {_LSP17_EXTENSION_PREFIX} + `<bytes4>` (Check [LSP2-ERC725YJSONSchema] for encoding the data key).
      * - If no extension is stored, returns the address(0).
      */
-    function _getExtension(
+    function _getExtensionAndForwardValue(
         bytes4 functionSelector
-    ) internal view virtual override returns (address) {
+    ) internal view virtual override returns (address, bool) {
         // Generate the data key relevant for the functionSelector being called
         bytes32 mappedExtensionDataKey = LSP2Utils.generateMappingKey(
             _LSP17_EXTENSION_PREFIX,
             functionSelector
         );
 
-        // Check if there is an extension stored under the generated data key
-        address extension = address(
-            bytes20(ERC725YCore._getData(mappedExtensionDataKey))
+        bytes memory extensionData = ERC725YCore._getData(
+            mappedExtensionDataKey
         );
 
-        return extension;
+        // CHECK if the `extensionData` is 21 bytes long
+        // - 20 bytes = extension's address
+        // - 1 byte `0x01` as a boolean indicating if the contract should forward the value to the extension or not
+        if (extensionData.length == 21) {
+            // If the last byte is set to `0x01` (`true`)
+            // this indicates that the contract should forward the value to the extension
+            if (extensionData[20] == 0x01) {
+                // Return the address of the extension
+                return (address(bytes20(extensionData)), true);
+            }
+        }
+
+        return (address(bytes20(extensionData)), false);
     }
 
     /**

contracts/LSP0ERC725Account/LSP0ERC725AccountInit.sol

@@ -38,7 +38,7 @@ contract LSP0ERC725AccountInit is LSP0ERC725AccountInitAbstract {
      * @param initialOwner The owner of the contract.
      *
      * @custom:events
-     * - {ValueReceived} event when funding the contract on deployment.
+     * - {UniversalReceiver} event when funding the contract on deployment.
      * - {OwnershipTransferred} event when `initialOwner` is set as the contract {owner}.
      */
     function initialize(

contracts/LSP0ERC725Account/LSP0ERC725AccountInitAbstract.sol

@@ -10,6 +10,9 @@ import {
     OwnableUnset
 } from "@erc725/smart-contracts/contracts/custom/OwnableUnset.sol";
 
+// constants
+import {_TYPEID_LSP0_VALUE_RECEIVED} from "./LSP0Constants.sol";
+
 /**
  * @title Inheritable Proxy Implementation of [LSP-0-ERC725Account] Standard.
  *
@@ -27,14 +30,20 @@ abstract contract LSP0ERC725AccountInitAbstract is
      * @custom:warning ERC725X & ERC725Y parent contracts are not initialised as they don't have non-zero initial state. If you decide to add non-zero initial state to any of those contracts, you must initialize them here.
      *
      * @custom:events
-     * - {ValueReceived} event when funding the contract on deployment.
+     * - {UniversalReceiver} event when funding the contract on deployment.
      * - {OwnershipTransferred} event when `initialOwner` is set as the contract {owner}.
      */
     function _initialize(
         address initialOwner
     ) internal virtual onlyInitializing {
         if (msg.value != 0) {
-            emit ValueReceived(msg.sender, msg.value);
+            emit UniversalReceiver(
+                msg.sender,
+                msg.value,
+                _TYPEID_LSP0_VALUE_RECEIVED,
+                "",
+                ""
+            );
         }
         OwnableUnset._setOwner(initialOwner);
     }