Central Bank Digital Coin (CBDC)

Overview

This smart contract implements a Central Bank Digital Coin (CBDC) with the following key features:

• ERC20 Token Standard: The token follows the ERC20 standard, with additional burn and pause functionalities.
• Role-based Access Control: Administrators and governance entities can control actions such as interest rate adjustments, money supply inflation, and blacklisting of accounts.
• Staking of Treasury Bonds: Users can stake their tokens in exchange for treasury bonds, which accumulate interest over time.
• Blacklist Functionality: Certain addresses can be blacklisted from staking or claiming rewards, managed by the administrator.
• Interest Rate on Staked Bonds: Interest is calculated on the staked bonds based on a basis point system, allowing flexible interest rate changes by governance.

Features

• Interest Rate Control: Adjust the interest rate for staked treasury bonds.
• Money Supply Control: Increase the money supply (minting new tokens) by the governance role.
• Blacklist Addresses: Admins can blacklist specific addresses, preventing them from participating in staking.
• Staking and Rewards: Users can stake their tokens as treasury bonds and claim rewards based on the time staked.
• Pause/Unpause Functionality: Admins can pause or unpause the contract, freezing token transfers when paused.
• Burnable Token: Tokens can be burned to reduce the total supply.

Getting Started

Prerequisites

Make sure you have the following installed on your machine:

• Node.js (>=16.0.0)
• npm (Node Package Manager)
• Hardhat (for smart contract development and testing)
• Openzeppelin Contract Libraries
• Ethers or Web3 (for interacting with smart contract)

Installation

Clone this repository:

git clone https://github.com/TotalingArc/cbdc-smart-contract.git
cd cbdc-smart-contract

Install dependencies:

npm install

OpenZeppelin Contracts

Your contract uses several OpenZeppelin libraries for token standards, access control, and security mechanisms like pausing and burnability. These need to be installed in your project.

Install OpenZeppelin Contracts:

npm install @openzeppelin/contracts

Specific OpenZeppelin contracts used:

• ERC20: For the standard ERC-20 token implementation.
• ERC20Burnable: Adds burn functionality to the token.
• Pausable: Allows the contract to be paused by an admin.
• AccessControl: Provides role-based access control functionality.
• ReentrancyGuard: Prevents reentrancy attacks.

Ethers.js or Web3.js (for Interacting with Contracts)

If you need to interact with the smart contract through JavaScript, you can use either Ethers.js or Web3.js.

Ethers.js (works well with Hardhat):

npm install ethers

Web3.js (if you prefer it):

npm install web3

Compile the smart contract:

npx hardhat compile

Deploying the Contract

To deploy the smart contract on your chosen network, use the following command:

Update the network configuration and deployment script in scripts/deploy.js.

Deploy the contract:

npx hardhat run scripts/deploy.js --network <network_name>

Make sure to replace <network_name> with the actual network you're deploying to (e.g., sepolia, mainnet, localhost).

Testing

The project comes with a set of unit tests to ensure the contract behaves as expected.

Install Testing Libraries

Before running the tests, ensure that you have installed the necessary testing libraries:

npm install --save-dev chai @nomiclabs/hardhat-ethers ethers

Run test

npx hardhat test