add initial implementation

gorgos · gorgos · commit 69aec99638d5 · 2022-03-07T11:19:20.000+13:00
diff --git a/.env.example b/.env.example
@@ -0,0 +1,3 @@
+ETHERSCAN_API_KEY=ABC123ABC123ABC123ABC123ABC123ABC1
+ROPSTEN_URL=https://eth-ropsten.alchemyapi.io/v2/<YOUR ALCHEMY KEY>
+PRIVATE_KEY=0xabc123abc123abc123abc123abc123abc123abc123abc123abc123abc123abc1
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,4 @@
+node_modules
+artifacts
+cache
+coverage
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,24 @@
+module.exports = {
+  env: {
+    browser: false,
+    es2021: true,
+    mocha: true,
+    node: true,
+  },
+  plugins: ["@typescript-eslint"],
+  extends: [
+    "standard",
+    "plugin:prettier/recommended",
+    "plugin:node/recommended",
+  ],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: 12,
+  },
+  rules: {
+    "node/no-unsupported-features/es-syntax": [
+      "error",
+      { ignores: ["modules"] },
+    ],
+  },
+};
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,9 @@
+node_modules
+.env
+coverage
+coverage.json
+typechain
+
+#Hardhat files
+cache
+artifacts
diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,3 @@
+hardhat.config.ts
+scripts
+test
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,5 @@
+node_modules
+artifacts
+cache
+coverage*
+gasReporterOutput.json
diff --git a/.solhint.json b/.solhint.json
@@ -0,0 +1,7 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "compiler-version": ["error", "^0.8.0"],
+    "func-visibility": ["warn", { "ignoreConstructors": true }]
+  }
+}
diff --git a/.solhintignore b/.solhintignore
@@ -0,0 +1 @@
+node_modules
diff --git a/README.md b/README.md
@@ -1 +1,46 @@
-# ERC721-Permit
+# Advanced Sample Hardhat Project
+
+This project demonstrates an advanced Hardhat use case, integrating other tools commonly used alongside Hardhat in the ecosystem.
+
+The project comes with a sample contract, a test for that contract, a sample script that deploys that contract, and an example of a task implementation, which simply lists the available accounts. It also comes with a variety of other tools, preconfigured to work with the project code.
+
+Try running some of the following tasks:
+
+```shell
+npx hardhat accounts
+npx hardhat compile
+npx hardhat clean
+npx hardhat test
+npx hardhat node
+npx hardhat help
+REPORT_GAS=true npx hardhat test
+npx hardhat coverage
+npx hardhat run scripts/deploy.ts
+TS_NODE_FILES=true npx ts-node scripts/deploy.ts
+npx eslint '**/*.{js,ts}'
+npx eslint '**/*.{js,ts}' --fix
+npx prettier '**/*.{json,sol,md}' --check
+npx prettier '**/*.{json,sol,md}' --write
+npx solhint 'contracts/**/*.sol'
+npx solhint 'contracts/**/*.sol' --fix
+```
+
+# Etherscan verification
+
+To try out Etherscan verification, you first need to deploy a contract to an Ethereum network that's supported by Etherscan, such as Ropsten.
+
+In this project, copy the .env.example file to a file named .env, and then edit it to fill in the details. Enter your Etherscan API key, your Ropsten node URL (eg from Alchemy), and the private key of the account which will send the deployment transaction. With a valid .env file in place, first deploy your contract:
+
+```shell
+hardhat run --network ropsten scripts/sample-script.ts
+```
+
+Then, copy the deployment address and paste it in to replace `DEPLOYED_CONTRACT_ADDRESS` in this command:
+
+```shell
+npx hardhat verify --network ropsten DEPLOYED_CONTRACT_ADDRESS "Hello, Hardhat!"
+```
+
+# Performance optimizations
+
+For faster runs of your tests and scripts, consider skipping ts-node's type checking by setting the environment variable `TS_NODE_TRANSPILE_ONLY` to `1` in hardhat's environment. For more details see [the documentation](https://hardhat.org/guides/typescript.html#performance-optimizations).
diff --git a/contracts/ERC721Permit.sol b/contracts/ERC721Permit.sol
@@ -0,0 +1,125 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
+import "@openzeppelin/contracts/utils/cryptography/draft-EIP712.sol";
+import "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
+import "@openzeppelin/contracts/interfaces/IERC1271.sol";
+import "@openzeppelin/contracts/utils/Counters.sol";
+
+import "./interfaces/IERC721Permit.sol";
+
+contract ERC721Permit is IERC721Permit, ERC721, EIP712 {
+  using Counters for Counters.Counter;
+
+  mapping(uint256 => Counters.Counter) private _nonces;
+
+  // solhint-disable-next-line var-name-mixedcase
+  bytes32 private immutable _PERMIT_TYPEHASH =
+    keccak256(
+      "Permit(address spender,uint256 tokenId,uint256 nonce,uint256 deadline)"
+    );
+
+  constructor(string memory name, string memory symbol)
+    ERC721(name, symbol)
+    EIP712(name, "1")
+  {
+    this;
+  }
+
+  function nonces(uint256 tokenId)
+    external
+    view
+    virtual
+    override
+    returns (uint256)
+  {
+    return _nonces[tokenId].current();
+  }
+
+  // solhint-disable-next-line func-name-mixedcase
+  function DOMAIN_SEPARATOR() external view override returns (bytes32) {
+    return _domainSeparatorV4();
+  }
+
+  function supportsInterface(bytes4 interfaceId)
+    public
+    view
+    virtual
+    override(IERC165, ERC721)
+    returns (bool)
+  {
+    return
+      interfaceId == type(IERC721Permit).interfaceId || // 0x5604e225
+      super.supportsInterface(interfaceId);
+  }
+
+  function permit(
+    address spender,
+    uint256 tokenId,
+    uint256 deadline,
+    bytes memory signature
+  ) external override {
+    _permit(spender, tokenId, deadline, signature);
+  }
+
+  function _transfer(
+    address from,
+    address to,
+    uint256 tokenId
+  ) internal virtual override {
+    _nonces[tokenId].increment();
+    super._transfer(from, to, tokenId);
+  }
+
+  function _permit(
+    address spender,
+    uint256 tokenId,
+    uint256 deadline,
+    bytes memory signature
+  ) internal virtual {
+    // solhint-disable-next-line not-rely-on-time
+    require(block.timestamp <= deadline, "ERC721Permit: expired deadline");
+
+    bytes32 structHash = keccak256(
+      abi.encode(
+        _PERMIT_TYPEHASH,
+        spender,
+        tokenId,
+        _nonces[tokenId].current(),
+        deadline
+      )
+    );
+    bytes32 hash = _hashTypedDataV4(structHash);
+
+    (address signer, ) = ECDSA.tryRecover(hash, signature);
+    bool isValidEOASignature = signer != address(0) &&
+      _isApprovedOrOwner(signer, tokenId);
+
+    require(
+      isValidEOASignature ||
+        _isValidContractERC1271Signature(ownerOf(tokenId), hash, signature) ||
+        _isValidContractERC1271Signature(getApproved(tokenId), hash, signature),
+      "ERC721Permit: invalid signature"
+    );
+
+    _approve(spender, tokenId);
+  }
+
+  function _isValidContractERC1271Signature(
+    address signer,
+    bytes32 hash,
+    bytes memory signature
+  ) private view returns (bool) {
+    (bool success, bytes memory result) = signer.staticcall(
+      abi.encodeWithSelector(
+        IERC1271.isValidSignature.selector,
+        hash,
+        signature
+      )
+    );
+    return (success &&
+      result.length == 32 &&
+      abi.decode(result, (bytes4)) == IERC1271.isValidSignature.selector);
+  }
+}
diff --git a/contracts/interfaces/IERC721Permit.sol b/contracts/interfaces/IERC721Permit.sol
@@ -0,0 +1,35 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import "@openzeppelin/contracts/interfaces/IERC165.sol";
+
+///
+/// @dev Interface for token permits for ERC-721
+///
+interface IERC721Permit is IERC165 {
+  /// ERC165 bytes to add to interface array - set in parent contract
+  ///
+  /// _INTERFACE_ID_ERC4494 = 0x5604e225
+
+  /// @notice Function to approve by way of owner signature
+  /// @param spender the address to approve
+  /// @param tokenId the index of the NFT to approve the spender on
+  /// @param deadline a timestamp expiry for the permit
+  /// @param sig a traditional or EIP-2098 signature
+  function permit(
+    address spender,
+    uint256 tokenId,
+    uint256 deadline,
+    bytes memory sig
+  ) external;
+
+  /// @notice Returns the nonce of an NFT - useful for creating permits
+  /// @param tokenId the index of the NFT to get the nonce of
+  /// @return the uint256 representation of the nonce
+  function nonces(uint256 tokenId) external view returns (uint256);
+
+  /// @notice Returns the domain separator used in the encoding of the signature for permits, as defined by EIP-712
+  /// @return the bytes32 domain separator
+  // solhint-disable-next-line func-name-mixedcase
+  function DOMAIN_SEPARATOR() external view returns (bytes32);
+}
diff --git a/contracts/mocks/NFTMock.sol b/contracts/mocks/NFTMock.sol
@@ -0,0 +1,25 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
+import "../ERC721Permit.sol";
+
+contract NFTMock is ERC721Permit("Mock721", "MOCK") {
+  uint256 private _lastTokenId;
+
+  function mint() public {
+    _mint(msg.sender, ++_lastTokenId);
+  }
+
+  function safeTransferFromWithPermit(
+    address from,
+    address to,
+    uint256 tokenId,
+    bytes memory _data,
+    uint256 deadline,
+    bytes memory signature
+  ) external {
+    _permit(msg.sender, tokenId, deadline, signature);
+    safeTransferFrom(from, to, tokenId, _data);
+  }
+}
diff --git a/hardhat.config.ts b/hardhat.config.ts
@@ -0,0 +1,43 @@
+import * as dotenv from "dotenv";
+
+import { HardhatUserConfig, task } from "hardhat/config";
+import "@nomiclabs/hardhat-etherscan";
+import "@nomiclabs/hardhat-waffle";
+import "@typechain/hardhat";
+import "hardhat-gas-reporter";
+import "solidity-coverage";
+
+dotenv.config();
+
+// This is a sample Hardhat task. To learn how to create your own go to
+// https://hardhat.org/guides/create-task.html
+task("accounts", "Prints the list of accounts", async (taskArgs, hre) => {
+  const accounts = await hre.ethers.getSigners();
+
+  for (const account of accounts) {
+    console.log(account.address);
+  }
+});
+
+// You need to export an object to set up your config
+// Go to https://hardhat.org/config/ to learn more
+
+const config: HardhatUserConfig = {
+  solidity: "0.8.4",
+  networks: {
+    ropsten: {
+      url: process.env.ROPSTEN_URL || "",
+      accounts:
+        process.env.PRIVATE_KEY !== undefined ? [process.env.PRIVATE_KEY] : [],
+    },
+  },
+  gasReporter: {
+    enabled: process.env.REPORT_GAS !== undefined,
+    currency: "USD",
+  },
+  etherscan: {
+    apiKey: process.env.ETHERSCAN_API_KEY,
+  },
+};
+
+export default config;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/scripts/deploy.ts b/scripts/deploy.ts
diff --git a/test/index.ts b/test/index.ts
diff --git a/tsconfig.json b/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+ETHERSCAN_API_KEY=ABC123ABC123ABC123ABC123ABC123ABC1`
	`2`	`+ROPSTEN_URL=https://eth-ropsten.alchemyapi.io/v2/<YOUR ALCHEMY KEY>`
	`3`	`+PRIVATE_KEY=0xabc123abc123abc123abc123abc123abc123abc123abc123abc123abc123abc1`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+hardhat.config.ts`
	`2`	`+scripts`
	`3`	`+test`