Merge branch 'master' into beacon

Author: ItsNickBarry

README.md

@@ -42,10 +42,10 @@ describe('CustomToken', () => {
   });
 
   describeBehaviorOfERC20Base(
+    async () => instance,
     {
-      deploy: () => instance,
-    },
-    [],
+      args: ...,
+    }
   );
 
   // custom tests...
@@ -56,8 +56,9 @@ If parts of the base implementation are changed intentionally, tests can be sele
 
 ```javascript
 describeBehaviorOfERC20Base(
+  async () => instance,
   {
-    deploy: () => instance,
+    args: ...
   },
   ['#balanceOf'],
 );

abi/CloneFactory.json

@@ -1,6 +1,6 @@
 {
   "name": "@solidstate/abi",
-  "version": "0.0.58",
+  "version": "0.0.59",
   "author": "Nick Barry",
   "license": "MIT",
   "description": "ABIs for SolidState contracts",

abi/MetamorphicFactory.json

@@ -8,16 +8,16 @@ import { Factory } from './Factory.sol';
  * @title Factory for contract self-replication
  * @dev derived from https://github.com/ItsNickBarry/solidity-auto-deployer (MIT license)
  */
-abstract contract CloneFactory is Factory {
+library CloneFactory {
     bytes private constant CLONE_INIT_CODE = hex'58333b90818180333cf3';
     bytes32 private constant CLONE_INIT_CODE_HASH = keccak256(CLONE_INIT_CODE);
 
     /**
      * @notice deploy a clone of the calling contract using "CREATE" opcode
      * @return cloneContract address of deployed contract
      */
-    function _deployClone() internal returns (address cloneContract) {
-        return _deploy(CLONE_INIT_CODE);
+    function deployClone() internal returns (address cloneContract) {
+        return Factory.deploy(CLONE_INIT_CODE);
     }
 
     /**
@@ -26,20 +26,20 @@ abstract contract CloneFactory is Factory {
      * @param salt input for deterministic address calculation
      * @return cloneContract address of deployed contract
      */
-    function _deployClone(
+    function deployClone(
         bytes32 salt
     ) internal returns (address cloneContract) {
-        return _deploy(CLONE_INIT_CODE, salt);
+        return Factory.deploy(CLONE_INIT_CODE, salt);
     }
 
     /**
      * @notice calculate the deployment address for a given salt
      * @param salt input for deterministic address calculation
      * @return deployment address
      */
-    function _calculateCloneDeploymentAddress(
+    function calculateCloneDeploymentAddress(
         bytes32 salt
     ) internal view returns (address) {
-        return _calculateDeploymentAddress(CLONE_INIT_CODE_HASH, salt);
+        return Factory.calculateDeploymentAddress(CLONE_INIT_CODE_HASH, salt);
     }
 }

abi/MinimalProxyFactory.json

@@ -4,20 +4,20 @@ pragma solidity ^0.8.18;
 
 import { CloneFactory } from './CloneFactory.sol';
 
-contract CloneFactoryMock is CloneFactory {
-    function __deployClone() external returns (address cloneContract) {
-        return _deployClone();
+contract CloneFactoryMock {
+    function deployClone() external returns (address cloneContract) {
+        return CloneFactory.deployClone();
     }
 
-    function __deployClone(
+    function deployClone(
         bytes32 salt
     ) external returns (address cloneContract) {
-        return _deployClone(salt);
+        return CloneFactory.deployClone(salt);
     }
 
-    function __calculateCloneDeploymentAddress(
+    function calculateCloneDeploymentAddress(
         bytes32 salt
     ) external view returns (address) {
-        return _calculateCloneDeploymentAddress(salt);
+        return CloneFactory.calculateCloneDeploymentAddress(salt);
     }
 }

abi/package.json

@@ -5,15 +5,15 @@ pragma solidity ^0.8.18;
 /**
  * @title Factory for arbitrary code deployment using the "CREATE" and "CREATE2" opcodes
  */
-abstract contract Factory {
+library Factory {
     error Factory__FailedDeployment();
 
     /**
      * @notice deploy contract code using "CREATE" opcode
      * @param initCode contract initialization code
      * @return deployment address of deployed contract
      */
-    function _deploy(
+    function deploy(
         bytes memory initCode
     ) internal returns (address deployment) {
         assembly {
@@ -32,7 +32,7 @@ abstract contract Factory {
      * @param salt input for deterministic address calculation
      * @return deployment address of deployed contract
      */
-    function _deploy(
+    function deploy(
         bytes memory initCode,
         bytes32 salt
     ) internal returns (address deployment) {
@@ -51,7 +51,7 @@ abstract contract Factory {
      * @param salt input for deterministic address calculation
      * @return deployment address
      */
-    function _calculateDeploymentAddress(
+    function calculateDeploymentAddress(
         bytes32 initCodeHash,
         bytes32 salt
     ) internal view returns (address) {

contracts/factory/CloneFactory.sol

@@ -4,24 +4,24 @@ pragma solidity ^0.8.18;
 
 import { Factory } from './Factory.sol';
 
-contract FactoryMock is Factory {
-    function __deploy(
+contract FactoryMock {
+    function deploy(
         bytes memory initCode
     ) external returns (address deployment) {
-        return _deploy(initCode);
+        return Factory.deploy(initCode);
     }
 
-    function __deploy(
+    function deploy(
         bytes memory initCode,
         bytes32 salt
     ) external returns (address deployment) {
-        return _deploy(initCode, salt);
+        return Factory.deploy(initCode, salt);
     }
 
-    function __calculateDeploymentAddress(
+    function calculateDeploymentAddress(
         bytes32 initCodeHash,
         bytes32 salt
     ) external view returns (address) {
-        return _calculateDeploymentAddress(initCodeHash, salt);
+        return Factory.calculateDeploymentAddress(initCodeHash, salt);
     }
 }

contracts/factory/CloneFactoryMock.sol

@@ -8,7 +8,7 @@ import { Factory } from './Factory.sol';
  * @title Factory for the deployment of EIP1167 minimal proxies
  * @dev derived from https://github.com/optionality/clone-factory (MIT license)
  */
-abstract contract MinimalProxyFactory is Factory {
+library MinimalProxyFactory {
     bytes private constant MINIMAL_PROXY_INIT_CODE_PREFIX =
         hex'3d602d80600a3d3981f3_363d3d373d3d3d363d73';
     bytes private constant MINIMAL_PROXY_INIT_CODE_SUFFIX =
@@ -19,10 +19,10 @@ abstract contract MinimalProxyFactory is Factory {
      * @param target implementation contract to proxy
      * @return minimalProxy address of deployed proxy
      */
-    function _deployMinimalProxy(
+    function deployMinimalProxy(
         address target
     ) internal returns (address minimalProxy) {
-        return _deploy(_generateMinimalProxyInitCode(target));
+        return Factory.deploy(generateMinimalProxyInitCode(target));
     }
 
     /**
@@ -32,11 +32,11 @@ abstract contract MinimalProxyFactory is Factory {
      * @param salt input for deterministic address calculation
      * @return minimalProxy address of deployed proxy
      */
-    function _deployMinimalProxy(
+    function deployMinimalProxy(
         address target,
         bytes32 salt
     ) internal returns (address minimalProxy) {
-        return _deploy(_generateMinimalProxyInitCode(target), salt);
+        return Factory.deploy(generateMinimalProxyInitCode(target), salt);
     }
 
     /**
@@ -45,13 +45,13 @@ abstract contract MinimalProxyFactory is Factory {
      * @param salt input for deterministic address calculation
      * @return deployment address
      */
-    function _calculateMinimalProxyDeploymentAddress(
+    function calculateMinimalProxyDeploymentAddress(
         address target,
         bytes32 salt
     ) internal view returns (address) {
         return
-            _calculateDeploymentAddress(
-                keccak256(_generateMinimalProxyInitCode(target)),
+            Factory.calculateDeploymentAddress(
+                keccak256(generateMinimalProxyInitCode(target)),
                 salt
             );
     }
@@ -61,7 +61,7 @@ abstract contract MinimalProxyFactory is Factory {
      * @param target implementation contract to proxy
      * @return bytes memory initialization code
      */
-    function _generateMinimalProxyInitCode(
+    function generateMinimalProxyInitCode(
         address target
     ) internal pure returns (bytes memory) {
         return