feat: title escrow factory (Open-Attestation#84)

* feat: composite factory * refactor: remove TitleEscrowCloner * chore: simplify test commands * refactor: export TitleEscrowFactory in lib * test: add test for TitleEscrowFactory
TradeTrust · Apr 11, 2022 · fb86103 · fb86103
1 parent 6551bf0
commit fb86103
Show file tree

Hide file tree

Showing 27 changed files with 290 additions and 352 deletions.
diff --git a/contracts/TitleEscrowCloneable.sol b/contracts/TitleEscrowCloneable.sol
@@ -8,8 +8,8 @@ import "@openzeppelin/contracts/proxy/utils/Initializable.sol";
 import "@openzeppelin/contracts/security/Pausable.sol";
 import "./access/HasNamedBeneficiaryInitializable.sol";
 import "./access/HasHolderInitializable.sol";
-import "./interfaces/ITitleEscrowCreator.sol";
 import "./interfaces/ITitleEscrow.sol";
+import "./TitleEscrowFactory.sol";
 
 contract TitleEscrowCloneable is
   Context,
@@ -28,7 +28,7 @@ contract TitleEscrowCloneable is
   uint256 public _tokenId;
 
   // Factory to clone this title escrow
-  ITitleEscrowCreator public titleEscrowFactory;
+  ITitleEscrowFactory public titleEscrowFactory;
 
   // For exiting into title escrow contracts
   address public override approvedBeneficiary;
@@ -43,7 +43,7 @@ contract TitleEscrowCloneable is
     __initialize__holder(_holder);
     __initialize__beneficiary(_beneficiary);
     tokenRegistry = ERC721(_tokenRegistry);
-    titleEscrowFactory = ITitleEscrowCreator(_titleEscrowFactoryAddress);
+    titleEscrowFactory = ITitleEscrowFactory(_titleEscrowFactoryAddress);
     status = StatusTypes.Uninitialised;
   }
 
@@ -115,11 +115,7 @@ contract TitleEscrowCloneable is
     onlyHolder
     allowTransferTitleEscrow(newBeneficiary, newHolder)
   {
-    address newTitleEscrowAddress = titleEscrowFactory.deployNewTitleEscrow(
-      address(tokenRegistry),
-      newBeneficiary,
-      newHolder
-    );
+    address newTitleEscrowAddress = titleEscrowFactory.create(address(tokenRegistry), newBeneficiary, newHolder);
     _transferTo(newTitleEscrowAddress);
   }
 

diff --git a/contracts/TitleEscrowCloner.sol b/contracts/TitleEscrowCloner.sol
diff --git a/contracts/TitleEscrowFactory.sol b/contracts/TitleEscrowFactory.sol
@@ -0,0 +1,27 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.0;
+
+import "@openzeppelin/contracts/proxy/Clones.sol";
+import "./TitleEscrowCloneable.sol";
+import "./interfaces/ITitleEscrowFactory.sol";
+
+contract TitleEscrowFactory is ITitleEscrowFactory {
+  address public override implementation;
+
+  constructor() {
+    implementation = address(new TitleEscrowCloneable());
+  }
+
+  function create(
+    address tokenRegistry,
+    address beneficiary,
+    address holder
+  ) external override returns (address) {
+    address clone = Clones.clone(implementation);
+    TitleEscrowCloneable(clone).initialize(tokenRegistry, beneficiary, holder, address(this));
+
+    emit TitleEscrowDeployed(address(clone), tokenRegistry, beneficiary, holder);
+
+    return address(clone);
+  }
+}
diff --git a/contracts/TradeTrustERC721.sol b/contracts/TradeTrustERC721.sol
@@ -2,17 +2,15 @@
 pragma solidity ^0.8.0;
 
 import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
-import "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
 import "@openzeppelin/contracts/utils/Address.sol";
 import "@openzeppelin/contracts/security/Pausable.sol";
-import "./TitleEscrowCloneable.sol";
-import "./TitleEscrowCloner.sol";
+import "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
 import "./access/RegistryAccess.sol";
-import "./interfaces/ITitleEscrowCreator.sol";
 import "./interfaces/ITitleEscrow.sol";
 import "./interfaces/ITradeTrustERC721.sol";
+import "./interfaces/ITitleEscrowFactory.sol";
 
-contract TradeTrustERC721 is ITradeTrustERC721, RegistryAccess, TitleEscrowCloner, Pausable, ERC721 {
+contract TradeTrustERC721 is ITradeTrustERC721, RegistryAccess, Pausable, ERC721 {
   using Address for address;
 
   event TokenBurnt(uint256 indexed tokenId);
@@ -21,11 +19,17 @@ contract TradeTrustERC721 is ITradeTrustERC721, RegistryAccess, TitleEscrowClone
 
   address internal constant BURN_ADDRESS = 0x000000000000000000000000000000000000dEaD;
 
+  ITitleEscrowFactory public override titleEscrowFactory;
+
   // Mapping from token ID to previously surrendered title escrow address
   mapping(uint256 => address) internal _surrenderedOwners;
 
-  constructor(string memory name, string memory symbol) ERC721(name, symbol) {
-    return;
+  constructor(
+    string memory name,
+    string memory symbol,
+    address _titleEscrowFactory
+  ) ERC721(name, symbol) {
+    titleEscrowFactory = ITitleEscrowFactory(_titleEscrowFactory);
   }
 
   function supportsInterface(bytes4 interfaceId)
@@ -36,7 +40,6 @@ contract TradeTrustERC721 is ITradeTrustERC721, RegistryAccess, TitleEscrowClone
     returns (bool)
   {
     return
-      interfaceId == type(ITitleEscrowCreator).interfaceId ||
       interfaceId == type(ITradeTrustERC721).interfaceId ||
       ERC721.supportsInterface(interfaceId) ||
       RegistryAccess.supportsInterface(interfaceId);
@@ -117,7 +120,7 @@ contract TradeTrustERC721 is ITradeTrustERC721, RegistryAccess, TitleEscrowClone
       beneficiary = previousOwner;
       holder = previousOwner;
     }
-    address newTitleEscrow = _deployNewTitleEscrow(address(this), beneficiary, holder);
+    address newTitleEscrow = titleEscrowFactory.create(address(this), beneficiary, holder);
     _registrySafeTransformFrom(address(this), newTitleEscrow, tokenId);
 
     emit TokenRestored(tokenId, newTitleEscrow);
@@ -163,7 +166,7 @@ contract TradeTrustERC721 is ITradeTrustERC721, RegistryAccess, TitleEscrowClone
     address holder,
     uint256 tokenId
   ) internal virtual returns (address) {
-    address newTitleEscrow = _deployNewTitleEscrow(address(this), beneficiary, holder);
+    address newTitleEscrow = titleEscrowFactory.create(address(this), beneficiary, holder);
     _safeMint(newTitleEscrow, tokenId);
 
     return newTitleEscrow;

diff --git a/contracts/access/IMinterRole.sol b/contracts/access/IMinterRole.sol
diff --git a/contracts/interfaces/ITitleEscrowCreator.sol → contracts/interfaces/ITitleEscrowFactory.sol b/contracts/interfaces/ITitleEscrowCreator.sol → contracts/interfaces/ITitleEscrowFactory.sol
@@ -1,17 +1,17 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.0;
 
-/// @title Title Escrow for Transferable Records
-interface ITitleEscrowCreator {
+interface ITitleEscrowFactory {
   event TitleEscrowDeployed(
     address indexed escrowAddress,
     address indexed tokenRegistry,
     address beneficiary,
     address holder
   );
 
-  /// @notice Deploys an instance of a title escrow
-  function deployNewTitleEscrow(
+  function implementation() external view returns (address);
+
+  function create(
     address tokenRegistry,
     address beneficiary,
     address holder

diff --git a/contracts/interfaces/ITradeTrustERC721.sol b/contracts/interfaces/ITradeTrustERC721.sol
@@ -3,8 +3,11 @@ pragma solidity ^0.8.0;
 
 import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
 import "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
+import "../TitleEscrowFactory.sol";
 
 interface ITradeTrustERC721 is IERC721Receiver, IERC721 {
+  function titleEscrowFactory() external view returns (ITitleEscrowFactory);
+
   function destroyToken(uint256 tokenId) external;
 
   function restoreTitle(uint256 tokenId) external returns (address);

diff --git a/contracts/mocks/TitleEscrowClonerMock.sol b/contracts/mocks/TitleEscrowClonerMock.sol
diff --git a/contracts/mocks/TitleEscrowFactoryMock.sol b/contracts/mocks/TitleEscrowFactoryMock.sol
@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.0;
+
+import "./TitleEscrowCloneableMock.sol";
+import "../TitleEscrowFactory.sol";
+
+contract TitleEscrowFactoryMock is TitleEscrowFactory {
+  constructor() {
+    implementation = address(new TitleEscrowCloneableMock());
+  }
+}
diff --git a/contracts/mocks/TradeTrustERC721Mock.sol b/contracts/mocks/TradeTrustERC721Mock.sol
@@ -4,7 +4,11 @@ pragma solidity ^0.8.0;
 import "../TradeTrustERC721.sol";
 
 contract TradeTrustERC721Mock is TradeTrustERC721 {
-  constructor(string memory name, string memory symbol) TradeTrustERC721(name, symbol) {}
+  constructor(
+    string memory name,
+    string memory symbol,
+    address escrowFactory
+  ) TradeTrustERC721(name, symbol, escrowFactory) {}
 
   function surrenderedOwnersInternal(uint256 tokenId) public view returns (address) {
     return _surrenderedOwners[tokenId];

diff --git a/package.json b/package.json
@@ -27,10 +27,8 @@
     "lint:sol:fix": "npm run lint:sol -- --fix",
     "lint": "npm run lint:sol && npm run lint:js",
     "lint:fix": "npm run lint:sol:fix && npm run lint:js:fix",
-    "test:sol": "TS_NODE_TRANSPILE_ONLY=1 hardhat test",
-    "test:sol:watch": "TS_NODE_TRANSPILE_ONLY=1 hardhat watch test",
-    "test:js": "jest --testPathPattern=src",
-    "test": "npm run test:sol && npm run test:js",
+    "test": "TS_NODE_TRANSPILE_ONLY=1 hardhat test",
+    "test:watch": "TS_NODE_TRANSPILE_ONLY=1 hardhat watch test",
     "prepare": "npm run build",
     "semantic-release": "semantic-release",
     "precoverage": "npm run clean:build && npm run build:sol",

diff --git a/src/index.test.ts b/src/index.test.ts
diff --git a/src/index.ts b/src/index.ts
@@ -1,9 +1,9 @@
 /* eslint-disable camelcase */
 export {
   TitleEscrowCloneable__factory as TitleEscrowCloneableFactory,
-  TitleEscrowCloner__factory as TitleEscrowClonerFactory,
+  TitleEscrowFactory__factory as TitleEscrowFactoryFactory,
   TradeTrustERC721__factory as TradeTrustERC721Factory,
   TitleEscrowCloneable,
-  TitleEscrowCloner,
+  TitleEscrowFactory,
   TradeTrustERC721,
 } from "./contracts";