add contract package

Author: alanchchen

package.json

@@ -69,6 +69,7 @@
     "lerna": "4.0.0",
     "lint-staged": "^10.2.11",
     "prettier": "^2.0.5",
+    "ts-node": "^10.2.1",
     "typescript": "~3.9.5"
   },
   "private": true

packages/contracts/.gitignore

@@ -0,0 +1,107 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# Next.js build output
+.next
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and *not* Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+artifacts/
+cache/

packages/contracts/.prettierrc

@@ -0,0 +1,10 @@
+{
+  "printWidth": 120,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "bracketSpacing": true,
+  "arrowParens": "avoid",
+  "semi": true,
+  "useTabs": false,
+  "tabWidth": 2
+}

packages/contracts/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 AMIS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/contracts/README.md

@@ -0,0 +1,16 @@
+//SPDX-License-Identifier: MIT
+pragma solidity 0.8.13;
+
+import '@openzeppelin/contracts/interfaces/IERC165.sol';
+
+interface INativeMetaTransactionV1 is IERC165 {
+  function executeMetaTransaction(
+    address authorizer,
+    bytes memory callData,
+    uint8 v,
+    bytes32 r,
+    bytes32 s
+  ) external payable returns (bytes memory);
+
+  function getNonce(address authorizer) external view returns (uint256);
+}

packages/contracts/contracts/metatx/INativeMetaTransactionV1.sol

@@ -0,0 +1,19 @@
+//SPDX-License-Identifier: MIT
+pragma solidity 0.8.13;
+
+import '@openzeppelin/contracts/interfaces/IERC165.sol';
+
+interface INativeMetaTransactionV2 is IERC165 {
+  function executeMetaTransaction(
+    address relayer,
+    address authorizer,
+    bytes32 nonce,
+    bytes memory callData,
+    uint256 deadline,
+    uint8 v,
+    bytes32 r,
+    bytes32 s
+  ) external payable returns (bytes memory);
+
+  function authorizationState(address authorizer, bytes32 nonce) external view returns (bool);
+}

packages/contracts/contracts/metatx/INativeMetaTransactionV2.sol

@@ -0,0 +1,20 @@
+//SPDX-License-Identifier: MIT
+pragma solidity 0.8.13;
+
+import '@openzeppelin/contracts/interfaces/IERC165.sol';
+
+interface INativeMetaTransactionV3 is IERC165 {
+  function executeMetaTransaction(
+    address relayer,
+    address authorizer,
+    bytes32 nonce,
+    bytes memory callData,
+    uint256 validAfter,
+    uint256 validBefore,
+    uint8 v,
+    bytes32 r,
+    bytes32 s
+  ) external payable returns (bytes memory);
+
+  function authorizationState(address authorizer, bytes32 nonce) external view returns (bool);
+}

packages/contracts/contracts/metatx/INativeMetaTransactionV3.sol

@@ -0,0 +1,53 @@
+//SPDX-License-Identifier: MIT
+pragma solidity 0.8.13;
+
+import '@openzeppelin/contracts/utils/Context.sol';
+
+import '../utils/EIP712.sol';
+import '../utils/EIP712Domain.sol';
+
+abstract contract NativeMetaTransaction is Context, EIP712Domain {
+  constructor(string memory name, string memory version) {
+    domainData = DomainData(name, version, block.chainid, address(this));
+    DOMAIN_SEPARATOR = EIP712.makeDomainSeparator(name, version);
+  }
+
+  /**
+   * @notice Check that function call is valid
+   * @param callData      The authorized function call
+   */
+  function _requireValidFuntionCall(bytes memory callData) internal pure {
+    if (callData.length == 0) {
+      return;
+    }
+
+    bytes4 sigHash;
+    assembly {
+      sigHash := mload(add(callData, 32))
+    }
+
+    require(sigHash != msg.sig, 'NativeMetaTransaction: calling executeMetaTransaction is forbidden');
+  }
+
+  function _msgSender() internal view virtual override returns (address sender) {
+    if (msg.sender == address(this)) {
+      bytes memory array = msg.data;
+      uint256 index = msg.data.length;
+      assembly {
+        // Load the 32 bytes word from memory with the address on the lower 20 bytes, and mask those.
+        sender := and(mload(add(array, index)), 0xffffffffffffffffffffffffffffffffffffffff)
+      }
+    } else {
+      sender = msg.sender;
+    }
+    return sender;
+  }
+
+  function _msgData() internal view virtual override returns (bytes calldata) {
+    if (msg.sender == address(this)) {
+      return msg.data[:msg.data.length - 20];
+    } else {
+      return msg.data;
+    }
+  }
+}

packages/contracts/contracts/metatx/NativeMetaTransaction.sol

@@ -0,0 +1,99 @@
+//SPDX-License-Identifier: MIT
+pragma solidity 0.8.13;
+
+import '@openzeppelin/contracts/utils/math/SafeMath.sol';
+
+import './NativeMetaTransaction.sol';
+import './INativeMetaTransactionV1.sol';
+
+// Example typed data
+//
+//     {
+//       types: {
+//         EIP712Domain: [
+//           { name: "name", type: "string" },
+//           { name: "version", type: "string" },
+//           { name: "chainId", type: "uint256" },
+//           { name: "verifyingContract", type: "address" },
+//         ],
+//         MetaTransaction: [
+//           { name: "authorizer", type: "address" },
+//           { name: "nonce", type: "uint256" },
+//           { name: "callData", type: "bytes" },
+//         ],
+//       },
+//       domain: {
+//         name: "MetaTransaction",
+//         version: "1",
+//         chainId: 1,
+//         verifyingContract: "0x1111111111111111111111111111111111111111",
+//       },
+//       primaryType: "MetaTransaction",
+//       message: {
+//         authorizer: authorizer.address,
+//         nonce: 1
+//         callData: "0x....",
+//       },
+//     }
+//
+contract NativeMetaTransactionV1 is NativeMetaTransaction, INativeMetaTransactionV1 {
+  using SafeMath for uint256;
+
+  bytes32 private constant META_TRANSACTION_TYPEHASH =
+    keccak256(bytes('MetaTransaction(address authorizer,uint256 nonce,bytes callData)'));
+
+  event MetaTransactionExecuted(address authorizer, address relayer, bytes callData);
+  mapping(address => uint256) private nonces;
+
+  constructor(string memory name, string memory version) NativeMetaTransaction(name, version) {}
+
+  function executeMetaTransaction(
+    address authorizer,
+    bytes memory callData,
+    uint8 v,
+    bytes32 r,
+    bytes32 s
+  ) public payable returns (bytes memory) {
+    _requireValidAuthorization(authorizer, callData, v, r, s);
+
+    nonces[authorizer] = nonces[authorizer].add(1);
+
+    // Append authorizer at the end to extract it from calling context
+    (bool success, bytes memory returnData) = address(this).call(abi.encodePacked(callData, authorizer));
+
+    require(success, 'NativeMetaTransaction: function call not successful');
+    emit MetaTransactionExecuted(authorizer, msg.sender, callData);
+
+    return returnData;
+  }
+
+  function getNonce(address authorizer) external view returns (uint256 nonce) {
+    nonce = nonces[authorizer];
+  }
+
+  /**
+   * @notice Check that authorization is valid
+   * @param authorizer   User's address
+   * @param callData      The authorized function call
+   * @param v             v of the signature
+   * @param r             r of the signature
+   * @param s             s of the signature
+   */
+  function _requireValidAuthorization(
+    address authorizer,
+    bytes memory callData,
+    uint8 v,
+    bytes32 r,
+    bytes32 s
+  ) internal view {
+    _requireValidFuntionCall(callData);
+
+    bytes memory data = abi.encode(META_TRANSACTION_TYPEHASH, authorizer, nonces[authorizer], keccak256(callData));
+
+    require(EIP712.recover(DOMAIN_SEPARATOR, v, r, s, data) == authorizer, 'NativeMetaTransaction: invalid signature');
+  }
+
+  function supportsInterface(bytes4 interfaceId) external view virtual returns (bool) {
+    return interfaceId == type(INativeMetaTransactionV1).interfaceId;
+  }
+}