feat: update networks (#183)

* feat: add polygon amoy * feat: remove mumbai * feat: remove xdc * ci: update cov
Open-Attestation · Jun 21, 2024 · 1c1f94b · 1c1f94b
1 parent 3668fa6
commit 1c1f94b
Show file tree

Hide file tree

Showing 6 changed files with 56 additions and 60 deletions.
diff --git a/.github/workflows/pull_requests.yml b/.github/workflows/pull_requests.yml
@@ -11,6 +11,8 @@ jobs:
   tests:
     name: Tests
     uses: ./.github/workflows/tests.yml
+    secrets:
+      codecov_token: ${{ secrets.CODECOV_TOKEN }}
 
   linters:
     name: Linters

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -14,6 +14,8 @@ jobs:
   tests:
     name: Tests
     uses: ./.github/workflows/tests.yml
+    secrets:
+      codecov_token: ${{ secrets.CODECOV_TOKEN }}
 
   linters:
     name: Linters

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -1,5 +1,8 @@
 on:
   workflow_call:
+    secrets:
+      codecov_token:
+        required: true
 
 env:
   NODE_ENV: ci
@@ -47,3 +50,4 @@ jobs:
         with:
           fail_ci_if_error: true
           verbose: true
+          token: ${{ secrets.codecov_token }}
diff --git a/README.md b/README.md
@@ -14,17 +14,15 @@
   <img src="https://img.shields.io/github/license/open-attestation/token-registry" />
 </p>
 
-The Electronic Bill of Lading (eBL) is a digital document which you can use to prove the ownership of goods. It is a standardized document accepted by all major shipping lines and customs authorities. 
+The Electronic Bill of Lading (eBL) is a digital document which you can use to prove the ownership of goods. It is a standardized document accepted by all major shipping lines and customs authorities.
 
 The [Token Registry](https://github.com/Open-Attestation/token-registry) repository contains the following:
 
-* The smart contract code for token registry in the `/contracts` folder
-* The node package for using this library in the `/src` folder
+- The smart contract code for token registry in the `/contracts` folder
+- The node package for using this library in the `/src` folder
 
 ## Table of Contents
 
-
-
 - [Installation](#installation)
 - [Usage](#usage)
   - [TradeTrustToken](#tradetrusttoken)
@@ -60,12 +58,12 @@ npm install --save @govtechsg/token-registry
 
 ## Usage
 
-Provide one of the following depending on your purpose: 
+Provide one of the following depending on your purpose:
 
-* To use the package, provide your own
-Web3 [provider](https://docs.ethers.io/v5/api/providers/api-providers/)
+- To use the package, provide your own
+  Web3 [provider](https://docs.ethers.io/v5/api/providers/api-providers/)
 
-* To write to the blockchain, provide the [signer](https://docs.ethers.io/v5/api/signer/#Wallet) that exposes the [Typechain (Ethers)](https://github.com/dethcrypto/TypeChain/tree/master/packages/target-ethers-v5) bindings for the contracts
+- To write to the blockchain, provide the [signer](https://docs.ethers.io/v5/api/signer/#Wallet) that exposes the [Typechain (Ethers)](https://github.com/dethcrypto/TypeChain/tree/master/packages/target-ethers-v5) bindings for the contracts
 
 ### TradeTrustToken
 
@@ -76,6 +74,7 @@ In this case, an SBT is used because the token is largely restricted to its desi
 See issue [#108](https://github.com/Open-Attestation/token-registry/issues/108) for more details.
 
 #### Connecting to an existing token registry
+
 The following is a code example that connects to a token registry:
 
 ```ts
@@ -114,6 +113,7 @@ Using the Title Escrow contract, you can manage and represent the ownership of a
 The actual owners will use the Title Escrow contract to perform their ownership operations.
 
 #### Connecting to a Title Escrow
+
 The following is a code example that connects to a Title Escrow:
 
 ```ts
@@ -137,11 +137,11 @@ function nominate(address beneficiaryNominee) external;
 
 ```
 
-* The `transferBeneficiary` transfers only the beneficiary and `transferHolder` transfers only the holder.
+- The `transferBeneficiary` transfers only the beneficiary and `transferHolder` transfers only the holder.
 
-* To transfer both the beneficiary and holder in a single transaction, use `transferOwners`. 
+- To transfer both the beneficiary and holder in a single transaction, use `transferOwners`.
 
-* Transfer of the beneficiary will require a nomination through the `nominate` method.
+- Transfer of the beneficiary will require a nomination through the `nominate` method.
 
 #### Surrendering or burning a document
 
@@ -174,9 +174,10 @@ const nominatedBeneficiary = await connectedEscrow.nominee();
 
 ### Title Escrow signable (experimental)
 
-This is similar to the [Title Escrow](#title-escrow) with the additional support for off-chain nomination and the endorsement of beneficiary nominees: 
-* The on-chain nominee will take precedence. 
-* The current beneficiary will initiate the transfer transaction with the endorsement.
+This is similar to the [Title Escrow](#title-escrow) with the additional support for off-chain nomination and the endorsement of beneficiary nominees:
+
+- The on-chain nominee will take precedence.
+- The current beneficiary will initiate the transfer transaction with the endorsement.
 
 With this feature, you can save on gas fees for cases where frequent nominations and endorsements occur between the owners.
 
@@ -205,7 +206,7 @@ contract TitleEscrowFactory is ITitleEscrowFactory {
 
 ```
 
->**Note:** This is currently an experimental feature. Implementers need to set up a "book-keeping" backend for the signed data.
+> **Note:** This is currently an experimental feature. Implementers need to set up a "book-keeping" backend for the signed data.
 
 ### Provider & signer
 
@@ -237,14 +238,14 @@ Using roles, you can grant the users to access only certain functions. Currently
 | `AccepterRole` | Able to accept a surrendered token  |
 | `RestorerRole` | Able to restore a surrendered token |
 
-
 The admin user can grant a trusted user multiple roles to perform different operations.
 
 To grant roles to the users or revoke roles from them, the admin user can call the following functions:
 
 #### Granting a role to a user
 
 Only the default admin or the role admin will be able to call this function:
+
 <!--Flag: according to the table above, there is no "role admin".-->
 
 ```ts
@@ -286,25 +287,25 @@ With Hardhat, you can manage the contract development environment and deployment
 
 Starting from V4, the token registry includes an easy and cost-effective way to deploy the contracts and meanwhile keep the options available for advanced users to set up the contracts in a preferable way.
 
->**Note:** Before deployment, ensure that you have set up your configuration file. See the [Configuration](#configuration) section for more details. The deployer (configured in your `.env` file) will be the default admin.
+> **Note:** Before deployment, ensure that you have set up your configuration file. See the [Configuration](#configuration) section for more details. The deployer (configured in your `.env` file) will be the default admin.
 
 ## Quick start
 
 To quickly deploy contracts with ease, you need to supply your token name and symbol to the command:
 
 ```
-npx hardhat deploy:token --network mumbai --name "The Great Shipping Co." --symbol GSC
+npx hardhat deploy:token --network amoy --name "The Great Shipping Co." --symbol GSC
 ```
 
-The above is the easiest and most cost-effective method to deploy. Currently, this is supported on Ethereum, Sepolia, Polygon, and Polygon Mumbai. The deployed contract will inherit all the standard functionalities from the Token Registry's on-chain contracts. This saves deployment costs and makes the process more convenient for users and integrators.
+The above is the easiest and most cost-effective method to deploy. Currently, this is supported on Ethereum, Sepolia, Polygon, and Polygon Amoy. The deployed contract will inherit all the standard functionalities from the Token Registry's on-chain contracts. This saves deployment costs and makes the process more convenient for users and integrators.
 
->**Note:** Remember to supply the`--network` argument with the name of the network on which you want to deploy. See the [Network configuration](#network-configuration) section for more information on the list of network names.
+> **Note:** Remember to supply the`--network` argument with the name of the network on which you want to deploy. See the [Network configuration](#network-configuration) section for more information on the list of network names.
 
 ## Advanced usage
 
 For experienced users who want more control over their setup (or have extra fund to spend), a few other options and commands are provided.
 
->**Important:** Depending on your use case, the gas costs might be higher than the method described in [Quick start](#quick-start).
+> **Important:** Depending on your use case, the gas costs might be higher than the method described in [Quick start](#quick-start).
 
 ### Token contract
 
@@ -324,19 +325,20 @@ OPTIONS:
 deploy:token: Deploys the TradeTrust token
 ```
 
->**Note:** 
-> * The `--factory` argument is optional. If not provided, the task will use the default Title Escrow Factory. 
-> * You can also reuse a  previously deployed Title Escrow factory by passing its address to the `--factory` argument.
+> **Note:**
+>
+> - The `--factory` argument is optional. If not provided, the task will use the default Title Escrow Factory.
+> - You can also reuse a previously deployed Title Escrow factory by passing its address to the `--factory` argument.
 
 #### Standalone contract
 
 To deploy your own modified version or your own copy of the token contract, use the `--standalone` flag:
 
 ```
-npx hardhat deploy:token --network mumbai --name "The Great Shipping Co." --symbol GSC --verify --standalone
+npx hardhat deploy:token --network amoy --name "The Great Shipping Co." --symbol GSC --verify --standalone
 ```
 
-The above command will deploy a _full token contract_ with the name _The Great Shipping Co._ under the symbol _GSC_ on the Polygon _mumbai_ network using the default Title Escrow factory. The contract will also be _verified_ on Etherscan.
+The above command will deploy a _full token contract_ with the name _The Great Shipping Co._ under the symbol _GSC_ on the Polygon _amoy_ network using the default Title Escrow factory. The contract will also be _verified_ on Etherscan.
 
 #### Using an existing Title Escrow factory
 
@@ -384,17 +386,14 @@ When verifying the contracts through either the Hardhat's verify plugin or passi
 
 The table below shows the network names that are currently pre-configured:
 
-| Network ID | Name                     | Network      | Type       |
-| ---------- | ------------------------ | ------------ | ---------- |
-| `1`        | Ethereum Mainnet         | `mainnet`    | Production |
-| `11155111` | Ethereum Testnet Sepolia | `sepolia`    | Test       |
-| `137`      | Polygon Mainnet          | `polygon`    | Production |
-| `80001`    | Polygon Testnet Mumbai   | `mumbai`     | Test       |
-| `50`       | XDC Network              | `xdc`        | Production |
-| `51`       | XDC Apothem Network      | `xdcapothem` | Test       |
-
+| Network ID | Name                     | Network   | Type       |
+| ---------- | ------------------------ | --------- | ---------- |
+| `1`        | Ethereum Mainnet         | `mainnet` | Production |
+| `11155111` | Ethereum Testnet Sepolia | `sepolia` | Test       |
+| `137`      | Polygon Mainnet          | `polygon` | Production |
+| `80002`    | Polygon Testnet Amoy     | `amoy`    | Test       |
 
->**Note:** You can configure the existing networks and add others to which you want to deploy in the `hardhat.config.ts` file.
+> **Note:** You can configure the existing networks and add others to which you want to deploy in the `hardhat.config.ts` file.
 
 ## Configuration
 
@@ -417,9 +416,10 @@ DEPLOYER_PK=
 MNEMONIC=
 ```
 
-Only one of the following is needed: 
-* `DEPLOYER_PK` 
-* `MNEMONIC`
+Only one of the following is needed:
+
+- `DEPLOYER_PK`
+- `MNEMONIC`
 
 ## Development
 
@@ -439,6 +439,7 @@ npm run build
 ```
 
 For more information on the commands below, see the [Deployment](#deployment) section:
+
 ```sh
 npx hardhat deploy:token
 npx hardhat deploy:factory

diff --git a/hardhat.config.ts b/hardhat.config.ts
@@ -74,7 +74,6 @@ const config: HardhatUserConfig = {
        * Polygon
        */
       polygon: POLYGONSCAN_API_KEY!,
-      polygonMumbai: POLYGONSCAN_API_KEY!,
     },
   },
   networks: {
@@ -89,14 +88,6 @@ const config: HardhatUserConfig = {
       ...networkConfig,
       url: "https://rpc.sepolia.org",
     },
-    xdc: {
-      ...networkConfig,
-      url: "https://erpc.xinfin.network",
-    },
-    xdcapothem: {
-      ...networkConfig,
-      url: "https://erpc.apothem.network",
-    },
     /**
      * Polygon
      */
@@ -106,11 +97,11 @@ const config: HardhatUserConfig = {
       // Uncomment line below if using Infura
       // url: `https://polygon-mainnet.infura.io/v3/${INFURA_APP_ID}`,
     },
-    mumbai: {
+    amoy: {
       ...networkConfig,
-      url: "https://matic-mumbai.chainstacklabs.com",
+      url: `https://rpc-amoy.polygon.technology`,
       // Uncomment line below if using Infura
-      // url: `https://polygon-mumbai.infura.io/v3/${INFURA_APP_ID}`,
+      // url: `https://polygon-amoy.infura.io/v3/${INFURA_APP_ID}`,
     },
     /**
      * Development

diff --git a/src/constants/contract-address.ts b/src/constants/contract-address.ts
@@ -2,30 +2,26 @@ const ChainId = {
   Ethereum: 1,
   Sepolia: 11155111,
   Polygon: 137,
-  PolygonMumbai: 80001,
-  XDC: 50,
-  XDCApothem: 51,
+  PolygonAmoy: 80002,
 };
 
 export const contractAddress = {
   TitleEscrowFactory: {
     [ChainId.Ethereum]: "0xA38CC56c9291B9C1f52F862dd92326d352e710b8",
     [ChainId.Sepolia]: "0x5aA71Cc9559bC5e54E9504a81496d9F8454721F5",
     [ChainId.Polygon]: "0x5B5F8d94782be18E22420f3276D5ef5a1bc65C53",
-    [ChainId.PolygonMumbai]: "0x5aA71Cc9559bC5e54E9504a81496d9F8454721F5",
-    [ChainId.XDC]: "0x50BfCc1b699fD2308B978B7a6A26e3C3Bbad16DC",
-    [ChainId.XDCApothem]: "0xce28778bE6cF32ef3Ccbc09910258DF592F3b6F1",
+    [ChainId.PolygonAmoy]: "0x0B0E0DA7Db10dB96f673dBe3796f7A509c68B472",
   },
   Deployer: {
     [ChainId.Ethereum]: "0x92470d0Fc33Cbf2f04B39696733806a15eD7eef3",
     [ChainId.Sepolia]: "0x9eBC30E7506E6Ce36eAc5507FCF0121BaF7AeA57",
     [ChainId.Polygon]: "0x92470d0Fc33Cbf2f04B39696733806a15eD7eef3",
-    [ChainId.PolygonMumbai]: "0x9eBC30E7506E6Ce36eAc5507FCF0121BaF7AeA57",
+    [ChainId.PolygonAmoy]: "0x7a46A1eA20E260987a28b192efbfBb266C097C42",
   },
   TokenImplementation: {
     [ChainId.Ethereum]: "0xd3F09dD800525Ecf7e452C3c167C7c716632d016",
     [ChainId.Sepolia]: "0xC78BA1a49663Ef8b920F36B036E91Ab40D8F26D6",
     [ChainId.Polygon]: "0xd3F09dD800525Ecf7e452C3c167C7c716632d016",
-    [ChainId.PolygonMumbai]: "0x83A533397eFE1d90baA26dEc7743626d7598656F",
+    [ChainId.PolygonAmoy]: "0x718355AE8c625C3A84F734fCC1D59aAd1700f819",
   },
 };