Merge pull request #1 from dl-tokene/feature/hardhat-ts

Rewrite the project to utilize the Hardhat framework with TS

.editorconfig

@@ -3,9 +3,9 @@ charset = utf-8
 end_of_line = lf
 indent_style = space
 insert_final_newline = true
-[*.js]
+[*.ts]
 indent_size = 2
 max_line_length = 120
 [*.sol]
 indent_size = 4
-max_line_length = 99
+max_line_length = 99

.env.example

@@ -1,12 +1,15 @@
+# Deployer private key
 PRIVATE_KEY = "YOUR PRIVATE KEY"
+
+# RPC Endpoints
 INFURA_KEY = "INFURA PROJECT ID"
+
+# Additional keys
 ETHERSCAN_KEY = "ETHERSCAN API KEY"
 BSCSCAN_KEY = "BSCSCAN API KEY"
 COINMARKETCAP_KEY = "COINMARKETCAP API KEY"
+
+# Bridge configuration
 BRIDGE_OWNER = "bridge contract owner"
 BRIDGE_VALIDATORS = "addresses separated by ',' that can sign withdrawals to bridge contract"
 BRIDGE_THRESHHOLD = int, number of signatures needed to check withdraw by bridge contract, example: 1
-
-# Available targets: 'ethers-v5', 'truffle-v5' and 'web3-v1'
-# By default 'ethers-v5'
-TYPECHAIN_TARGET = "TYPECHAIN TARGET"

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,30 @@
+name: Bug Report
+description: File a bug report
+labels: ['bug']
+assignees:
+  - Arvolear
+body:
+  - type: markdown
+    attributes:
+      value: Thanks for taking the time to fill out this bug report!
+  - type: input
+    id: version
+    attributes:
+      label: "Project version"
+      placeholder: "1.2.3"
+    validations:
+      required: true
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: A brief description of what happened and what you expected to happen
+    validations:
+      required: true
+  - type: textarea
+    id: reproduction-steps
+    attributes:
+      label: "Minimal reproduction steps"
+      description: "The minimal steps needed to reproduce the bug"
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,13 @@
+name: Feature request
+description: Suggest a new feature
+labels: ['feature']
+assignees:
+  - Arvolear
+body:
+  - type: textarea
+    id: feature-description
+    attributes:
+      label: "Describe the feature"
+      description: "A description of what you would like to see in the project"
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/other-issue.md

@@ -0,0 +1,4 @@
+---
+name: Other issue
+about: Other kind of issue
+---

.github/actions/setup/action.yml

@@ -0,0 +1,15 @@
+name: setup
+
+description: setup
+
+runs:
+  using: composite
+  steps:
+    - name: Setup node
+      uses: actions/setup-node@v3
+      with:
+        node-version: "16.18.x"
+        cache: npm
+    - name: Install packages
+      run: npm install
+      shell: bash

.github/workflows/checks.yml

@@ -0,0 +1,21 @@
+name: "checks"
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+      - dev
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+      - name: Setup
+        uses: ./.github/actions/setup
+      - name: Run tests
+        run: npm run test

.prettierrc.json

@@ -1,4 +1,5 @@
 {
+  "plugins": ["prettier-plugin-solidity"],
   "overrides": [
     {
       "files": "*.sol",

contracts/bridge/Bridge.sol

@@ -23,10 +23,10 @@ contract Bridge is
     ERC1155Handler,
     NativeHandler
 {
-    function __Bridge_init(address[] calldata signers_, uint256 signaturesThreshold_)
-        external
-        initializer
-    {
+    function __Bridge_init(
+        address[] calldata signers_,
+        uint256 signaturesThreshold_
+    ) external initializer {
         __Signers_init(signers_, signaturesThreshold_);
     }
 

contracts/handlers/NativeHandler.sol

@@ -4,11 +4,10 @@ pragma solidity ^0.8.9;
 import "../interfaces/handlers/INativeHandler.sol";
 
 abstract contract NativeHandler is INativeHandler {
-    function depositNative(string calldata receiver_, string calldata network_)
-        external
-        payable
-        override
-    {
+    function depositNative(
+        string calldata receiver_,
+        string calldata network_
+    ) external payable override {
         require(msg.value > 0, "NativeHandler: zero value");
 
         emit DepositedNative(msg.value, receiver_, network_);

contracts/interfaces/tokens/IERC1155MintableBurnable.sol

@@ -11,9 +11,5 @@ interface IERC1155MintableBurnable is IERC1155 {
         string calldata tokenURI_
     ) external;
 
-    function burnFrom(
-        address payer_,
-        uint256 tokenId_,
-        uint256 amount_
-    ) external;
+    function burnFrom(address payer_, uint256 tokenId_, uint256 amount_) external;
 }

contracts/interfaces/tokens/IERC721MintableBurnable.sol

@@ -4,11 +4,7 @@ pragma solidity ^0.8.9;
 import "@openzeppelin/contracts/token/ERC721/IERC721.sol";
 
 interface IERC721MintableBurnable is IERC721 {
-    function mintTo(
-        address receiver_,
-        uint256 tokenId_,
-        string calldata tokenURI_
-    ) external;
+    function mintTo(address receiver_, uint256 tokenId_, string calldata tokenURI_) external;
 
     function burnFrom(address payer_, uint256 tokenId_) external;
 }

contracts/mocks/utils/SignersMock.sol

@@ -4,10 +4,10 @@ pragma solidity ^0.8.9;
 import "../../utils/Signers.sol";
 
 contract SignersMock is Signers {
-    function __SignersMock_init(address[] calldata signers_, uint256 signaturesThreshold_)
-        public
-        initializer
-    {
+    function __SignersMock_init(
+        address[] calldata signers_,
+        uint256 signaturesThreshold_
+    ) public initializer {
         __Signers_init(signers_, signaturesThreshold_);
     }
 

contracts/tokens/ERC1155MintableBurnable.sol

@@ -52,12 +52,9 @@ contract ERC1155MintableBurnable is
         _burn(payer_, tokenId_, amount_);
     }
 
-    function uri(uint256 tokenId)
-        public
-        view
-        override(ERC1155URIStorage, ERC1155)
-        returns (string memory)
-    {
+    function uri(
+        uint256 tokenId
+    ) public view override(ERC1155URIStorage, ERC1155) returns (string memory) {
         return super.uri(tokenId);
     }
 

contracts/tokens/ERC20MintableBurnable.sol

@@ -7,11 +7,7 @@ import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 import "../interfaces/tokens/IERC20MintableBurnable.sol";
 
 contract ERC20MintableBurnable is IERC20MintableBurnable, Ownable, ERC20 {
-    constructor(
-        string memory name_,
-        string memory symbol_,
-        address owner_
-    ) ERC20(name_, symbol_) {
+    constructor(string memory name_, string memory symbol_, address owner_) ERC20(name_, symbol_) {
         transferOwnership(owner_);
     }
 

contracts/tokens/ERC721MintableBurnable.sol

@@ -48,21 +48,15 @@ contract ERC721MintableBurnable is
         _burn(tokenId_);
     }
 
-    function tokenURI(uint256 tokenId)
-        public
-        view
-        override(ERC721URIStorage, ERC721)
-        returns (string memory)
-    {
+    function tokenURI(
+        uint256 tokenId
+    ) public view override(ERC721URIStorage, ERC721) returns (string memory) {
         return super.tokenURI(tokenId);
     }
 
-    function supportsInterface(bytes4 interfaceId)
-        public
-        view
-        override(ERC721Enumerable, ERC721, IERC165)
-        returns (bool)
-    {
+    function supportsInterface(
+        bytes4 interfaceId
+    ) public view override(ERC721Enumerable, ERC721, IERC165) returns (bool) {
         return super.supportsInterface(interfaceId);
     }
 

contracts/utils/Signers.sol

@@ -13,10 +13,10 @@ abstract contract Signers is OwnableUpgradeable {
 
     EnumerableSet.AddressSet internal _signers;
 
-    function __Signers_init(address[] calldata signers_, uint256 signaturesThreshold_)
-        public
-        onlyInitializing
-    {
+    function __Signers_init(
+        address[] calldata signers_,
+        uint256 signaturesThreshold_
+    ) public onlyInitializing {
         __Ownable_init();
 
         addSigners(signers_);
@@ -29,7 +29,7 @@ abstract contract Signers is OwnableUpgradeable {
         for (uint256 i = 0; i < signers_.length; i++) {
             require(_signers.contains(signers_[i]), "Signers: invalid signer");
 
-            uint256 bitKey = 2**(uint256(uint160(signers_[i])) >> 152);
+            uint256 bitKey = 2 ** (uint256(uint160(signers_[i])) >> 152);
 
             require(bitMap & bitKey == 0, "Signers: duplicate signers");
 

deploy/1_bridge.migration.ts

@@ -0,0 +1,24 @@
+import { Deployer, Reporter } from "@solarity/hardhat-migrate";
+
+import { Bridge__factory, ERC1967Proxy__factory } from "@ethers-v6";
+
+const OWNER = process.env.BRIDGE_OWNER!;
+const validators = process.env.BRIDGE_VALIDATORS!.split(",");
+const threshold = parseInt(process.env.BRIDGE_THRESHHOLD!, 10);
+
+export = async (deployer: Deployer) => {
+  const bridgeImplementation = await deployer.deploy(Bridge__factory);
+  const proxy = await deployer.deploy(ERC1967Proxy__factory, [
+    await bridgeImplementation.getAddress(),
+    bridgeImplementation.interface.encodeFunctionData("__Bridge_init", [validators, threshold]),
+  ]);
+
+  const bridge = await deployer.deployed(Bridge__factory, await proxy.getAddress());
+
+  await bridge.transferOwnership(OWNER);
+
+  Reporter.reportContracts(
+    ["Bridge Implementation", await bridgeImplementation.getAddress()],
+    ["Bridge Proxy", await proxy.getAddress()],
+  );
+};