@tradetrust-yl/token-registry 5.1.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,446 @@
+License
+This project is based on Token Registry software originally licensed under the Apache License, Version 2.0.
+
+Modifications
+This distribution contains modifications made by yl, including but not limited to:
+ 
+All such modifications are © [yl-2025].
+
+Original License
+The original work is licensed under the Apache License, Version 2.0.
+A copy of the license is included in the LICENSE file.
+<h1 align="center"> 
+
+  <p align="center">Token Registry</p>
+  <a href="https://tradetrust.io"><img src="docs/images/tt-logo.png" alt="TradeTrust Token Registry" /></a>
+</h1>
+
+<p align="center">
+    <a href="https://tradetrust.io">TradeTrust</a> Electronic Bill of Lading (eBL)
+</p>
+
+<p align="center"> 
+  <a href="https://github.com/tradetrust/token-registry/tree/master" alt="Release"><img src="https://github.com/tradetrust/token-registry/actions/workflows/release.yml/badge.svg?event=push" /></a>
+  <a href="https://codecov.io/gh/Open-Attestation/token-registry" alt="Code Coverage"><img src="https://codecov.io/gh/Open-Attestation/token-registry/branch/master/graph/badge.svg?token=Y4R9SWXATG" /></a>
+  <a href="https://www.npmjs.com/package/@tradetrust-tt/token-registry" alt="NPM"><img src="https://img.shields.io/npm/dw/@tradetrust-tt/token-registry" /></a>
+  <img src="https://img.shields.io/github/license/open-attestation/token-registry" />
+</p>
+
+The Electronic Bill of Lading (eBL) is a digital document that can be used to prove the ownership of goods. It is a standardised document that is accepted by all major shipping lines and customs authorities. The [Token Registry](https://github.com/TradeTrust/token-registry) repository contains both the smart contract
+code for token registry (in `/contracts`) as well as the node package for using this library (in `/src`).
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [TradeTrustToken](#tradetrusttoken)
+    - [Connect to existing token registry](#connect-to-existing-token-registry)
+    - [Issuing a Document](#issuing-a-document)
+    - [Restoring a Document](#restoring-a-document)
+    - [Accept/Burn a Document](#acceptburn-a-document)
+  - [Title Escrow](#title-escrow)
+    - [Connect to Title Escrow](#connect-to-title-escrow)
+    - [Transfer of Beneficiary/Holder](#transfer-of-beneficiaryholder)
+    - [Reject Transfers of Beneficiary/Holder](#reject-transfers-of-beneficiaryholder)
+    - [Return ETR Document to Issuer](#return-etr-document-to-issuer)
+    - [Accessing the Current Owners](#accessing-the-current-owners)
+  - [Provider \& Signer](#provider--signer)
+  - [Roles and Access](#roles-and-access)
+    - [Grant a role to a user](#grant-a-role-to-a-user)
+    - [Revoke a role from a user](#revoke-a-role-from-a-user)
+    - [Setting a role admin (Advanced Usage)](#setting-a-role-admin-advanced-usage)
+- [Deployment](#deployment)
+  - [Quick Start](#quick-start)
+  - [Advanced Usage](#advanced-usage)
+    - [Token Contract](#token-contract)
+      - [Using an existing Title Escrow Factory](#using-an-existing-title-escrow-factory)
+    - [Title Escrow Factory](#title-escrow-factory)
+      - [Deploy a new Title Escrow Factory](#deploy-a-new-title-escrow-factory)
+  - [Verification](#verification)
+  - [Network Configuration](#network-configuration)
+- [Configuration](#configuration)
+- [Development](#development)
+  - [Scripts](#scripts)
+- [Subgraph](#subgraph)
+- [Notes](#notes)
+
+# Installation
+
+```sh
+npm install --save @tradetrust-tt/token-registry
+```
+
+---
+
+# Usage
+
+To use the package, you will need to provide your own
+Web3 [provider](https://docs.ethers.io/v5/api/providers/api-providers/)
+or [signer](https://docs.ethers.io/v5/api/signer/#Wallet) (if you are writing to the blockchain).
+This package exposes the [Typechain (Ethers)](https://github.com/dethcrypto/TypeChain/tree/master/packages/target-ethers-v6) bindings for the contracts.
+
+## TradeTrustToken
+
+The `TradeTrustToken` is a Soulbound Token (SBT) tied to the Title Escrow. The SBT implementation is loosely based on OpenZeppelin's implementation of the [ERC721](http://erc721.org/) standard.
+An SBT is used in this case because the token, while can be transferred to the registry, is largely restricted to its designated Title Escrow contracts.
+See issue [#108](https://github.com/Open-Attestation/token-registry/issues/108) for more details.
+
+### Connect to existing token registry
+
+```ts
+import { TradeTrustToken__factory } from "@tradetrust-tt/token-registry/contracts";
+
+const connectedRegistry = TradeTrustToken__factory.connect(tokenRegistryAddress, signer);
+```
+
+### Issuing a Document
+
+```ts
+await connectedRegistry.mint(beneficiaryAddress, holderAddress, tokenId, remarks);
+```
+
+### Restoring a Document
+
+```ts
+await connectedRegistry.restore(tokenId, remarks);
+```
+
+### Accept/Burn a Document
+
+```ts
+await connectedRegistry.burn(tokenId, remarks);
+```
+
+## Title Escrow
+
+The Title Escrow contract is used to manage and represent the ownership of a token between a **`beneficiary`** and **`holder`**.
+During minting, the Token Registry will create and assign a Title Escrow as the owner of that token.
+The actual owners will use the Title Escrow contract to perform their ownership operations.
+
+> [!IMPORTANT]
+> A new `remark` field has been **introduced** for all contract operations.
+> 
+> The `remark` field is optional and can be left empty by providing an empty string `"0x"`.
+> Please note that any value in the `remark` field is limited to **120** characters, and encryption is **recommended**.
+>
+> Please refer to the sample encryption implementation [here]().
+
+### Connect to Title Escrow
+
+```ts
+import { TitleEscrow__factory } from "@tradetrust-tt/token-registry/contracts";
+
+const connectedEscrow = TitleEscrow__factory.connect(existingTitleEscrowAddress, signer);
+```
+
+### Transfer of Beneficiary/Holder
+
+Transferring of **`beneficiary`** and **`holder`** within the Title Escrow relies on the following methods:
+
+```solidity
+function transferBeneficiary(address nominee, bytes calldata remark) external;
+
+function transferHolder(address newHolder, bytes calldata remark) external;
+
+function transferOwners(address nominee, address newHolder, bytes calldata remark) external;
+
+function nominate(address nominee, bytes calldata remark) external;
+```
+
+> [!NOTE]
+> The `transferBeneficiary` transfers only the beneficiary and `transferHolder` transfers only the holder.
+> To transfer both beneficiary and holder in a single transaction, use `transferOwners`.
+>
+> In the event where the **`holder`** is different from the **`beneficiary`**, the transfer of beneficiary will require a nomination done through the `nominate` method.
+
+### Reject Transfers of Beneficiary/Holder
+
+Rejection of transfers for any wrongful transactions.
+
+```solidity
+function rejectTransferBeneficiary(bytes calldata _remark) external;
+
+function rejectTransferHolder(bytes calldata _remark) external;
+
+function rejectTransferOwners(bytes calldata _remark) external;
+```
+
+> [!IMPORTANT]
+> Rejection must occur as the very next action after being appointed as **`beneficiary`** and/or **`holder`**. If any transactions occur by the new appointee, it will be considered as an implicit acceptance of appointment.
+>
+> There are separate methods to reject a **`beneficiary`** (`rejectTransferBeneficiary`) and a **`holder`** (`rejectTransferHolder`). However, if you are both, you must use `rejectTransferOwners`, as the other two methods will not work in this case.
+
+### Return ETR Document to Issuer
+
+Use the `returnToIssuer` method in the Title Escrow.
+
+```solidity
+function returnToIssuer(bytes calldata remark) external;
+```
+
+### Accessing the Current Owners
+
+The addresses of the current owners can be retrieved from the `beneficiary`, `holder` and `nominee` methods.
+
+Example:
+
+```ts
+const currentBeneficiary = await connectedEscrow.beneficiary();
+
+const currentHolder = await connectedEscrow.holder();
+
+const nominatedBeneficiary = await connectedEscrow.nominee();
+```
+
+## Provider & Signer
+
+Different ways to get provider or signer:
+
+```ts
+import { Wallet, providers, getDefaultProvider } from "ethers";
+
+// Providers
+const mainnetProvider = getDefaultProvider();
+const metamaskProvider = new providers.Web3Provider(web3.currentProvider); // Will change network automatically
+
+// Signer
+const signerFromPrivateKey = new Wallet("YOUR-PRIVATE-KEY-HERE", provider);
+const signerFromEncryptedJson = Wallet.fromEncryptedJson(json, password);
+signerFromEncryptedJson.connect(provider);
+
+const signerFromMnemonic = Wallet.fromMnemonic("MNEMONIC-HERE");
+signerFromMnemonic.connect(provider);
+```
+
+## Roles and Access
+
+Roles are useful for granting users to access certain functions only. Currently, here are the designated roles meant for the different key operations.
+
+| Role           | Access                                     |
+| -------------- | ------------------------------------------ |
+| `DefaultAdmin` | Able to perform all operations             |
+| `MinterRole`   | Able to mint new tokens                    |
+| `AccepterRole` | Able to accept a token returned to issuer  |
+| `RestorerRole` | Able to restore a token returned to issuer |
+
+A trusted user can be granted multiple roles by the admin user to perform different operations.
+The following functions can be called on the token contract by the admin user to grant and revoke roles to and from users.
+
+### Grant a role to a user
+
+```ts
+import { constants } from "@tradetrust-tt/token-registry";
+
+await connectedRegistry.grantRole(constants.roleHash.MinterRole, accountAddress);
+```
+
+> [!IMPORTANT]
+> Can only be called by **default admin** or **role admin**.
+
+### Revoke a role from a user
+
+```ts
+import { constants } from "@tradetrust-tt/token-registry";
+
+await connectedRegistry.revokeRole(constants.roleHash.AccepterRole, accountAddress);
+```
+
+> [!IMPORTANT]
+> Can only be called by **default admin** or **role admin**.
+
+### Setting a role admin (Advanced Usage)
+
+The standard setup does not add the role-admin roles so that users don't deploy (and, hence, pay the gas for) more than what they need.
+If you need a more complex setup, you can add the admin roles to the designated roles.
+
+```ts
+import { constants } from "@tradetrust-tt/token-registry";
+const { roleHash } = constants;
+
+await connectedRegistry.setRoleAdmin(roleHash.MinterRole, roleHash.MinterAdminRole);
+await connectedRegistry.setRoleAdmin(roleHash.RestorerRole, roleHash.RestorerAdminRole);
+await connectedRegistry.setRoleAdmin(roleHash.AccepterRole, roleHash.AccepterAdminRole);
+```
+
+> [!IMPORTANT]
+> Can only be called by **default admin**.
+
+# Deployment
+
+Hardhat is used to manage the contract development environment and deployment. This repository provides a couple of
+Hardhat tasks to simplify the deployment process.
+
+Starting from v4, we have included an easy and cost-effective way to deploy the contracts while also keeping options available for advanced users to setup the contracts their preferred way.
+
+> [!TIP]
+> 💡 Please ensure that you have setup your configuration file before deployment.
+>
+> See [Configuration](#configuration) section for more details. The deployer (configured in your `.env` file) will be made the default admin.
+
+## Quick Start
+
+For users who want to quickly deploy their contracts without too much hassle, you’ll only have to supply the name and symbol of your token to the command, and you’re ready to roll!
+
+```
+npx hardhat deploy:token --network stability --name "The Great Shipping Co." --symbol GSC
+```
+
+👆 This is the easiest and most cost-effective method to deploy. The deployed contract will inherit all the standard functionality from our on-chain contracts. This helps to save deployment costs and make the process more convenient for users and integrators.
+
+> [!TIP]
+> 💡 Remember to supply the `--network` argument with the name of the network you wish to deploy on.
+>
+> See [Network Configuration](#network-configuration) section for more info on the list of network names.
+
+## Advanced Usage
+
+For experienced users who would like to have more control over their setup (or have extra 💰 to spend 💸), we have provided a few other options and commands.
+However, you should be aware that, depending on what you’re doing, the gas costs could be higher than the method described in [Quick Start](#quick-start).
+You should already know what you are doing when using any of these options.
+
+### Token Contract
+
+Deploys the token contract.
+
+```
+user@NMacBook-Pro token-registry % npx hardhat deploy:token --help
+
+Usage: hardhat [GLOBAL OPTIONS] deploy:token --factory <STRING> --name <STRING> [--standalone] --symbol <STRING> [--verify]
+
+OPTIONS:
+
+  --factory   	Address of Title Escrow factory (Optional)
+  --name      	Name of the token
+  --standalone	Deploy as standalone token contract
+  --symbol    	Symbol of token
+  --verify    	Verify on Etherscan
+
+deploy:token: Deploys the TradeTrust token
+```
+
+> [!TIP]
+> 💡 Note that the `--factory` argument is optional. When not provided, the task will use the default Title Escrow Factory.
+> You can also reuse a Title Escrow factory that you have previously deployed by passing its address to the `--factory` argument.
+
+#### Using an existing Title Escrow Factory
+
+- To use an existing version of Title Escrow factory, you can supply its address to the `—-factory` argument.
+
+- To use your own version of Title Escrow factory, you need to supply its address to the `--factory` with the `--standalone` flag.
+
+```
+npx hardhat deploy:token --network polygon --name "The Great Shipping Co." --symbol GSC --factory 0xfac70
+```
+
+👆 This will deploy a "cheap" token contract with the name _The Great Shipping Co._ under the symbol _GSC_ on the _Polygon Mainnet_
+network using an existing Title Escrow factory at `0xfac70`.
+
+### Title Escrow Factory
+
+Deploys the Title Escrow factory.
+
+```
+user@NMacBook-Pro token-registry % npx hardhat deploy:token --help
+
+Usage: hardhat [GLOBAL OPTIONS] deploy:factory [--verify]
+
+OPTIONS:
+
+  --verify	Verify on Etherscan
+
+deploy:factory: Deploys a new Title Escrow factory
+```
+
+#### Deploy a new Title Escrow Factory
+
+If you want to deploy your own modified version or simply want to have your own copy of the Title Escrow factory, you can use this command:
+
+```
+npx hardhat deploy:factory --network amoy
+```
+
+👆 This will deploy a new Title Escrow factory on the _Amoyy_ network without verifying the contract.
+To verify the contract, pass in the `--verify` flag.
+
+## Verification
+
+When verifying the contracts through either the Hardhat's verify plugin or passing the `--verify` flag to the deployment
+tasks (which internally uses the same plugin), you will need to include your correct API key, depending on the network, in your `.env` configuration. See [Configuration](#configuration) section for more info.
+
+- For Ethereum, set `ETHERSCAN_API_KEY`.
+- For Polygon, set `POLYGONSCAN_API_KEY`.
+- For Astron, set `ASTRON_API_KEY`.
+- For Astrontestnet, set `ASTRON_TESTNET_API_KEY`.
+
+## Network Configuration
+
+Here's a list of network names currently pre-configured:
+
+- `mainnet` (Ethereum)
+- `sepolia`
+- `polygon` (Polygon Mainnet)
+- `amoy` (Polygon Amoy)
+- `xdc` (XDC Network Mainnet)
+- `xdcapothem` (XDC Apothem TestNet)
+- `stabilitytestnet` (Stability TestNet)
+- `stability` (Stability Global Trust Network)
+- `astron` (astron Network MainNet)
+- `astrontestnet` (astron Network TestNet)
+
+> [!TIP]
+> 💡 You can configure existing and add other networks you wish to deploy to in the `hardhat.config.ts` file.
+
+# Configuration
+
+Create a `.env` file and add your own keys into it. You can rename from the sample file `.env.sample` or copy the
+following into a new file:
+
+```
+# Infura
+INFURA_APP_ID=
+
+# API Keys
+ETHERSCAN_API_KEY=
+POLYGONSCAN_API_KEY=
+COINMARKETCAP_API_KEY=
+STABILITY_API_KEY=
+ASTRONSCAN_API_KEY=
+ASTRON_TESTNET_API_KEY=
+
+# Deployer Private Key
+DEPLOYER_PK=
+
+# Mnemonic words
+MNEMONIC=
+```
+
+Only either the `DEPLOYER_PK` or `MNEMONIC` is needed.
+
+# Development
+
+This repository's development framework uses [HardHat](https://hardhat.org/getting-started/).
+
+Tests are run using `npm run test`, more development tasks can be found in the package.json scripts.
+
+## Scripts
+
+```sh
+npm install
+npm test
+npm run lint
+npm run build
+
+# See Deployment section for more info
+npx hardhat deploy:token
+npx hardhat deploy:factory
+npx hardhat deploy:token:impl
+```
+
+# Subgraph
+
+Check out our [Token Registry Subgraph](https://github.com/tradetrust/token-registry-subgraph) Github repository
+for more information on using and deploying your own subgraphs for the Token Registry contracts.
+
+# Notes
+
+- The contracts have not gone through formal audits yet. Please use them at your own discretion.