Merge pull request #287 from solidstate-network/receive

Add `receive` function to `Proxy`

Author: ItsNickBarry

contracts/proxy/IProxy.sol

@@ -6,4 +6,6 @@ import { _IProxy } from './_IProxy.sol';
 
 interface IProxy is _IProxy {
     fallback() external payable;
+
+    receive() external payable;
 }

contracts/proxy/Proxy.sol

@@ -16,4 +16,8 @@ abstract contract Proxy is IProxy, _Proxy {
     fallback() external payable {
         _fallback();
     }
+
+    receive() external payable {
+        _receive();
+    }
 }

contracts/proxy/_Proxy.sol

@@ -68,4 +68,11 @@ abstract contract _Proxy is _IProxy {
 
         revert Proxy__ImplementationIsNotContract();
     }
+
+    /**
+     * @notice received ether is forwarded to the fallback function
+     */
+    function _receive() internal virtual {
+        _fallback();
+    }
 }

contracts/proxy/diamond/ISolidstateDiamondProxy.sol

@@ -16,6 +16,4 @@ interface ISolidstateDiamondProxy is
     IDiamondProxyReadable,
     IDiamondProxyWritable,
     ISafeOwnable
-{
-    receive() external payable;
-}
+{}

contracts/proxy/diamond/SolidstateDiamondProxy.sol

@@ -99,8 +99,6 @@ abstract contract SolidstateDiamondProxy is
         _setOwner(msg.sender);
     }
 
-    receive() external payable {}
-
     function _transferOwnership(
         address account
     )

spec/proxy/Proxy.behavior.ts

@@ -37,5 +37,19 @@ export function describeBehaviorOfProxy(
         ).not.to.be.reverted;
       });
     });
+
+    describe('receive()', () => {
+      it('forwards value to implementation via delegatecall', async () => {
+        // TODO: receive tests pass because hardhat-exposed functions used as implementations are payable
+        const [signer] = await ethers.getSigners();
+
+        await expect(
+          signer.sendTransaction({
+            to: await instance.getAddress(),
+            value: 1n,
+          }),
+        ).not.to.be.reverted;
+      });
+    });
   });
 }

spec/proxy/diamond/DiamondProxy.behavior.ts

@@ -1,5 +1,5 @@
 import { describeFilter } from '@solidstate/library';
-import { ProxyBehaviorArgs } from '@solidstate/spec';
+import { describeBehaviorOfProxy, ProxyBehaviorArgs } from '@solidstate/spec';
 import { IDiamondProxy } from '@solidstate/typechain-types';
 import { expect } from 'chai';
 import { ethers } from 'hardhat';
@@ -20,6 +20,8 @@ export function describeBehaviorOfDiamondProxy(
       instance = await deploy();
     });
 
+    describeBehaviorOfProxy(deploy, args, skips);
+
     describe('fallback()', () => {
       it('forwards data with matching selector call to facet', async () => {
         expect(instance.interface.hasFunction(args.implementationFunction)).to
@@ -55,5 +57,9 @@ export function describeBehaviorOfDiamondProxy(
         });
       });
     });
+
+    describe('receive()', () => {
+      it('todo');
+    });
   });
 }

spec/proxy/diamond/SolidstateDiamondProxy.behavior.ts

@@ -78,18 +78,6 @@ export function describeBehaviorOfSolidstateDiamondProxy(
 
     describeBehaviorOfSafeOwnable(deploy, args, skips);
 
-    describe('receive()', () => {
-      it('accepts ether transfer', async () => {
-        const [signer] = await ethers.getSigners();
-        const value = 1;
-        const to = await instance.getAddress();
-
-        await expect(() =>
-          signer.sendTransaction({ to, value }),
-        ).to.changeEtherBalance(instance, value);
-      });
-    });
-
     describe('#diamondCut((address,enum,bytes4[])[],address,bytes)', () => {
       const selectors: string[] = [];
       const abi: string[] = [];

spec/proxy/diamond/fallback/DiamondProxyFallback.behavior.ts

@@ -31,10 +31,36 @@ export function describeBehaviorOfDiamondProxyFallback(
       nonOwner = await args.getNonOwner();
     });
 
-    describeBehaviorOfDiamondProxy(async () => instance, args, skips);
+    describeBehaviorOfDiamondProxy(async () => instance, args, [
+      'receive()',
+      ...(skips ?? []),
+    ]);
 
     describe('fallback()', () => {
-      it('forwards data without matching selector to fallback contract');
+      it('forwards data without matching selector to fallback contract', async () => {
+        await expect(
+          owner.sendTransaction({
+            to: await instance.getAddress(),
+          }),
+        ).to.be.revertedWithCustomError(
+          instance,
+          'Proxy__ImplementationIsNotContract',
+        );
+      });
+    });
+
+    describe('receive()', () => {
+      it('forwards value to fallback contract', async () => {
+        await expect(
+          owner.sendTransaction({
+            to: await instance.getAddress(),
+            value: 1n,
+          }),
+        ).to.be.revertedWithCustomError(
+          instance,
+          'Proxy__ImplementationIsNotContract',
+        );
+      });
     });
 
     describe('#getFallbackAddress()', () => {

test/proxy/diamond/SolidstateDiamondProxy.ts

@@ -54,6 +54,6 @@ describe('SolidstateDiamondProxy', () => {
       fallbackAddress: ethers.ZeroAddress,
       immutableSelectors,
     },
-    ['fallback()'],
+    ['fallback()', 'receive()'],
   );
 });

test/proxy/upgradeable/UpgradeableProxy.ts

@@ -1,7 +1,7 @@
 import { SignerWithAddress } from '@nomicfoundation/hardhat-ethers/signers';
 import { describeBehaviorOfUpgradeableProxy } from '@solidstate/spec';
 import {
-  $Ownable__factory,
+  $SafeOwnable__factory,
   $UpgradeableProxy,
   $UpgradeableProxy__factory,
 } from '@solidstate/typechain-types';
@@ -20,7 +20,7 @@ describe('UpgradeableProxy', () => {
   beforeEach(async () => {
     const [deployer] = await ethers.getSigners();
 
-    const implementationInstance = await new $Ownable__factory(
+    const implementationInstance = await new $SafeOwnable__factory(
       deployer,
     ).deploy();
 
@@ -35,7 +35,7 @@ describe('UpgradeableProxy', () => {
   describeBehaviorOfUpgradeableProxy(async () => instance, {
     getOwner: async () => owner,
     getNonOwner: async () => nonOwner,
-    implementationFunction: 'owner()',
+    implementationFunction: 'nomineeOwner()',
     implementationFunctionArgs: [],
   });