Add a transferAllowed boolean to PBMToken to control whether transfer of token between wallets is allowed. Allows for optional transfer stage as described in PBM Whitepaper (page 10).
This repository contains the smart contracts used for OGP PBM Tokens, a purpose bound money approach for the government usecase. This serves as part of a wider trial under Project Orchid. Read more about the project via the Project Orchid Whitepaper.
For more specific engineering and technical decisions, refer to the wiki page in this repository
This project requires the NodeJS environment > 14.0, along with either yarn/npm as package manager. Instructions provided will be for npm.
- Clone the repo
git clone https://github.com/datagovsg/cbdc-smart-contracts.git
- Install the required NPM packages for development
npm install
An .env.example file has been added to provide a template for the environment variables required to get you up to speed. Refer to the table below for the purposes of these variables. Create a .env file in the root directory and populate with the required environment variables.
| Name | Description | Required |
|---|---|---|
| PBM_DEPLOYER_PRIVATE_KEY | Private key to be used for deploying the PBM Contract | Y |
| DSGD_DEPLOYER_PRIVATE_KEY | Private key to be used for deploying the DSGD Contract | Y |
| POLYGON_RPC_URL | RPC url used for the Polygon testnet/mainnet networks. It is recommended to create a dedicated RPC | Y |
| POLYGONSCAN_API_KEY | Polygonscan key used for verifying contracts on the polygonscan explorer (only for Polygon Mainnet/Mumbai Testnet) | N |
| COIN_MARKET_API_KEY | API key for the CoinMarket API. This is used for calculating gas fees in FIAT currency specified (SGD) | N |
PBM Contracts have been developed with the hardhat development framework. Hardhat provides a series of built-in plugins, which include gas reporting, chai test helpers and network helpers as part of the hardhat-toolbox.
Tests in hardhat utilises the mocha + chai framework, along with waffle matchers specific to ethereum contract development and testing. Fixtures have been setted up to bring the test runner to the correct chain state.
Gas reporting is automatically configured to analyse gas usages in tests. A gas report will be generated per each successful test run in /gas-report.txt
To run tests:
npm run testDeployments should only be run after the necessary required environment variables above are populated. We have also provided a helper-hardhat-config.ts to adjust the various deployment configurations for deployment.
npm run deploy:pbm
# For running a custom deployment:
# npm run deploy --{tags}For local deployments and tests, default hardhat node accounts are used.
npm hardhat node # for local onlyAdditional Information
Deployments are managed by hardhat-deploy. These scripts have been written in a sequential manner with all scripts containing tags and dependencies.
tagsare used for setting an identifier to a particular deploymentdependenciesare an array of tags that a particular deployment will rely on. Running a deployment with a dependency array will also automatically create deployments for its dependencies (if depolyments dont already exits).
Successful deployments are cached and stored in the ./deployments file. Hardhat deploy will automatically re-use already existing deployments wherever possible
The following hardhat plugins have also been utilised for a better development experience. The respective depedencies/packages have already been included in this package.
hardhat-deploy- for managing contract deploymentshardhat-upgrades- an OpenZeppelin plugin for managing upgradeable OpenZepellin contracts.hardhat-dodoc- documentation generator based on solidity's NatSpec comments. Usenpm run gen:docsto generate your documentation in the docs folder.
These will already be made available to you on running npm install. Configurations can be overriden from hardhat.config.ts