feat: create IVersionable interface (#87)

* chore: add version, update packages * chore: remove deployed addresses * chore: remove space * docs: update `README.md` * chore: sync files with all repos * chore: update scripts * chore: update scripts * feat: update `@author` comment * chore: update dependencies * feat: format scripts * feat: update `IVersionable` comments * feat: minor refactoring --------- Co-authored-by: Igor Senych <72256997+igorsenych-cw@users.noreply.github.com> Co-authored-by: Igor Senych <igor.senych@cloudwalk.io> Co-authored-by: Evgenii Zaitsev <evgenii@cloudwalk.io>
cloudwalk · Nov 10, 2024 · c8013ee · c8013ee
1 parent ddb70af
commit c8013ee
Show file tree

Hide file tree

Showing 47 changed files with 481 additions and 342 deletions.
diff --git a/.env.example b/.env.example
@@ -1,13 +1,14 @@
-SOLIDITY_VERSION     = 0.8.24
-OPTIMIZER_ENABLED    = true
-OPTIMIZER_RUNS       = 1000
-GAS_REPORTER_ENABLED = false
-HARDHAT_MNEMONIC     = test test test test test test test test test test test junk
-GANACHE_RPC          = http://127.0.0.1:7545
-GANACHE_MNEMONIC     = test test test test test test test test test test test junk
-CW_TESTNET_RPC       =
-CW_TESTNET_PK        =
-CW_TESTNET_MNEMONIC  =
-CW_MAINNET_RPC       =
-CW_MAINNET_PK        =
-CW_MAINNET_MNEMONIC  =
+SOLIDITY_VERSION        = 0.8.24
+OPTIMIZER_ENABLED       = true
+OPTIMIZER_RUNS          = 1000
+GAS_REPORTER_ENABLED    = false
+CONTRACT_SIZER_ENABLED  = false
+HARDHAT_MNEMONIC        = test test test test test test test test test test test junk
+GANACHE_RPC             = http://127.0.0.1:7545
+GANACHE_MNEMONIC        = test test test test test test test test test test test junk
+CW_TESTNET_RPC          =
+CW_TESTNET_PK           =
+CW_TESTNET_MNEMONIC     =
+CW_MAINNET_RPC          =
+CW_MAINNET_PK           =
+CW_MAINNET_MNEMONIC     =
diff --git a/README.md b/README.md
@@ -8,8 +8,7 @@
 ![example branch parameter](https://github.com/cloudwalk/brlc-token/actions/workflows/build.yml/badge.svg?branch=main)
 ![example branch parameter](https://github.com/cloudwalk/brlc-token/actions/workflows/test.yml/badge.svg?branch=main)
 
-This repository contains [BRLC](https://infinitepay.io/brlc) token smart contracts.</br>
-[BRLC](https://infinitepay.io/brlc) is a stablecoin created and issued by [Infinitepay](https://infinitepay.io).
+This repository contains BRLC token smart contracts.
 
 ## Project Setup
 1. Clone the repo.
@@ -22,7 +21,7 @@ This repository contains [BRLC](https://infinitepay.io/brlc) token smart contrac
     ```sh
     cp .env.example .env
     ```
-3. Update settings in the newly created `.env` file if needed (e.g. another solidity version, number of optimization runs, private keys (PK) for networks, network RPC URLs, etc.).
+3. If necessary, update settings in the newly created `.env` file (e.g., Solidity version, number of optimization runs, network RPC URLs, private keys (PK) for networks, etc.).
 
 ## Build and test
 
@@ -37,10 +36,6 @@ npx hardhat compile
 npx hardhat test
 ```
 
-## Networks and deployments
-
-Information about deployments across all the networks can be found [here](./docs/deployed-contracts.json).
-
 ## Licensing
 
 This project is released under the MIT License, see [LICENSE](./LICENSE).
diff --git a/contracts/BRLCToken.sol b/contracts/BRLCToken.sol
@@ -6,7 +6,7 @@ import { CWToken } from "./base/CWToken.sol";
 
 /**
  * @title BRLCToken contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice The BRLC token implementation
  */
 contract BRLCToken is CWToken {

diff --git a/contracts/BRLCTokenBridgeable.sol b/contracts/BRLCTokenBridgeable.sol
@@ -8,7 +8,7 @@ import { ERC20Freezable } from "./base/ERC20Freezable.sol";
 
 /**
  * @title BRLCTokenBridgeable contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice The BRLC token implementation that supports bridging operations
  */
 contract BRLCTokenBridgeable is ERC20Base, ERC20Bridgeable, ERC20Freezable {

diff --git a/contracts/USJimToken.sol b/contracts/USJimToken.sol
@@ -6,7 +6,7 @@ import { CWToken } from "./base/CWToken.sol";
 
 /**
  * @title USJimToken contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice The USJim token implementation
  */
 contract USJimToken is CWToken {

diff --git a/contracts/base/CWToken.sol b/contracts/base/CWToken.sol
@@ -8,12 +8,13 @@ import { ERC20Freezable } from "./ERC20Freezable.sol";
 import { ERC20Restrictable } from "./ERC20Restrictable.sol";
 import { ERC20Hookable } from "./ERC20Hookable.sol";
 import { ERC20Trustable } from "./ERC20Trustable.sol";
+import { Versionable } from "./Versionable.sol";
 
 import { IERC20ComplexBalance } from "./interfaces/IERC20ComplexBalance.sol";
 
 /**
  * @title CWToken contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice The CloudWalk token that extends the standard ERC20 token implementation with additional functionality
  */
 contract CWToken is
@@ -23,7 +24,8 @@ contract CWToken is
     ERC20Restrictable,
     ERC20Hookable,
     ERC20Trustable,
-    IERC20ComplexBalance
+    IERC20ComplexBalance,
+    Versionable
 {
     /**
      * @notice Constructor that prohibits the initialization of the implementation of the upgradable contract

diff --git a/contracts/base/ERC20Base.sol b/contracts/base/ERC20Base.sol
@@ -10,7 +10,7 @@ import { BlocklistableUpgradeable } from "./common/BlocklistableUpgradeable.sol"
 
 /**
  * @title ERC20Base contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice This contract is base implementation of the BRLC token with inherited Rescuable,
  * Pausable, and Blocklistable functionality.
  */

diff --git a/contracts/base/ERC20Bridgeable.sol b/contracts/base/ERC20Bridgeable.sol
@@ -8,7 +8,7 @@ import { ERC20Base } from "./ERC20Base.sol";
 
 /**
  * @title ERC20Bridgeable contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice The ERC20 token implementation that supports bridging operations
  */
 abstract contract ERC20Bridgeable is ERC20Base, IERC20Bridgeable {

diff --git a/contracts/base/ERC20Freezable.sol b/contracts/base/ERC20Freezable.sol
@@ -7,7 +7,7 @@ import { ERC20Base } from "./ERC20Base.sol";
 
 /**
  * @title ERC20Freezable contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice The ERC20 token implementation that supports the freezing operations
  */
 abstract contract ERC20Freezable is ERC20Base, IERC20Freezable {

diff --git a/contracts/base/ERC20Hookable.sol b/contracts/base/ERC20Hookable.sol
@@ -8,7 +8,7 @@ import { ERC20Base } from "./ERC20Base.sol";
 
 /**
  * @title ERC20Hookable contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice The ERC20 token implementation that supports hooking operations
  */
 abstract contract ERC20Hookable is ERC20Base, IERC20Hookable {

diff --git a/contracts/base/ERC20Mintable.sol b/contracts/base/ERC20Mintable.sol
@@ -7,7 +7,7 @@ import { ERC20Base } from "./ERC20Base.sol";
 
 /**
  * @title ERC20Mintable contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice The ERC20 token implementation that supports the mint, premint, and burn operations
  */
 abstract contract ERC20Mintable is ERC20Base, IERC20Mintable {

diff --git a/contracts/base/ERC20Restrictable.sol b/contracts/base/ERC20Restrictable.sol
@@ -7,7 +7,7 @@ import { ERC20Base } from "./ERC20Base.sol";
 
 /**
  * @title ERC20Restrictable contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice The ERC20 token implementation that supports restriction operations
  */
 abstract contract ERC20Restrictable is ERC20Base, IERC20Restrictable {

diff --git a/contracts/base/ERC20Trustable.sol b/contracts/base/ERC20Trustable.sol
@@ -7,7 +7,7 @@ import { IERC20Trustable } from "./interfaces/IERC20Trustable.sol";
 
 /**
  * @title ERC20Trustable contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice The ERC20 token implementation that supports the `trusted` transfers on behalf
  */
 abstract contract ERC20Trustable is ERC20Base, IERC20Trustable {

diff --git a/contracts/base/Versionable.sol b/contracts/base/Versionable.sol
@@ -0,0 +1,21 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.0;
+
+import "./interfaces/IVersionable.sol";
+
+/**
+ * @title Versionable contract
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
+ * @dev Defines the contract version.
+ */
+abstract contract Versionable is IVersionable {
+    // ------------------ Pure functions -------------------------- //
+
+    /**
+     * @inheritdoc IVersionable
+     */
+    function $__VERSION() external pure returns (Version memory) {
+        return Version(1, 0, 0);
+    }
+}
diff --git a/contracts/base/common/BlocklistableUpgradeable.sol b/contracts/base/common/BlocklistableUpgradeable.sol
@@ -6,7 +6,7 @@ import { OwnableUpgradeable } from "@openzeppelin/contracts-upgradeable/access/O
 
 /**
  * @title BlocklistableUpgradeable base contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice Allows to blocklist and unblocklist accounts using the `blocklister` account
  * @dev This contract is used through inheritance. It makes available the modifier `notBlocklisted`,
  * which can be applied to functions to restrict their usage to not blocklisted accounts only.

diff --git a/contracts/base/common/PausableExtUpgradeable.sol b/contracts/base/common/PausableExtUpgradeable.sol
@@ -7,7 +7,7 @@ import { PausableUpgradeable } from "@openzeppelin/contracts-upgradeable/securit
 
 /**
  * @title PausableExtUpgradeable base contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice Extends the OpenZeppelin's {PausableUpgradeable} contract by adding the `pauser` account
  * @dev This contract is used through inheritance. It introduces the `pauser` role that is allowed to
  * trigger the paused or unpaused state of the contract that is inherited from this one.

diff --git a/contracts/base/common/RescuableUpgradeable.sol b/contracts/base/common/RescuableUpgradeable.sol
@@ -8,7 +8,7 @@ import { OwnableUpgradeable } from "@openzeppelin/contracts-upgradeable/access/O
 
 /**
  * @title RescuableUpgradeable base contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice Allows to rescue ERC20 tokens locked up in the contract using the `rescuer` account
  * @dev This contract is used through inheritance. It introduces the `rescuer` role that is allowed
  * to rescue tokens locked up in the contract that is inherited from this one.

diff --git a/contracts/base/interfaces/IERC20Bridgeable.sol b/contracts/base/interfaces/IERC20Bridgeable.sol
@@ -4,7 +4,7 @@ pragma solidity ^0.8.0;
 
 /**
  * @title IERC20Bridgeable interface
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice The interface of a token that supports bridging operations
  */
 interface IERC20Bridgeable {

diff --git a/contracts/base/interfaces/IERC20ComplexBalance.sol b/contracts/base/interfaces/IERC20ComplexBalance.sol
@@ -4,7 +4,7 @@ pragma solidity ^0.8.0;
 
 /**
  * @title IERC20ComplexBalance interface
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice The interface of a token that supports complex balance tracking
  */
 interface IERC20ComplexBalance {

diff --git a/contracts/base/interfaces/IERC20Freezable.sol b/contracts/base/interfaces/IERC20Freezable.sol
@@ -4,7 +4,7 @@ pragma solidity ^0.8.0;
 
 /**
  * @title IERC20Freezable interface
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice The interface of a token that supports freezing operations
  */
 interface IERC20Freezable {

diff --git a/contracts/base/interfaces/IERC20Hook.sol b/contracts/base/interfaces/IERC20Hook.sol
@@ -4,7 +4,7 @@ pragma solidity ^0.8.0;
 
 /**
  * @title IERC20Hook interface
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice The interface of a contract that supports hookable token operations
  */
 interface IERC20Hook {

diff --git a/contracts/base/interfaces/IERC20Hookable.sol b/contracts/base/interfaces/IERC20Hookable.sol
@@ -4,7 +4,7 @@ pragma solidity ^0.8.0;
 
 /**
  * @title IERC20Hookable interface
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice The interface of a token that supports hooking operations
  */
 interface IERC20Hookable {

diff --git a/contracts/base/interfaces/IERC20Mintable.sol b/contracts/base/interfaces/IERC20Mintable.sol
@@ -4,7 +4,7 @@ pragma solidity ^0.8.0;
 
 /**
  * @title IERC20Mintable interface
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice The interface of a token that supports mint and burn operations
  */
 interface IERC20Mintable {

diff --git a/contracts/base/interfaces/IERC20Restrictable.sol b/contracts/base/interfaces/IERC20Restrictable.sol
@@ -4,7 +4,7 @@ pragma solidity ^0.8.0;
 
 /**
  * @title IERC20Restrictable interface
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice The interface of a token that supports restriction operations
  */
 interface IERC20Restrictable {

diff --git a/contracts/base/interfaces/IERC20Trustable.sol b/contracts/base/interfaces/IERC20Trustable.sol
@@ -4,7 +4,7 @@ pragma solidity ^0.8.0;
 
 /**
  * @title ERC20Trustable contract interface
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice The interface of the token that supports the `trusted` transfers on behalf
  */
 interface IERC20Trustable {

diff --git a/contracts/base/interfaces/IVersionable.sol b/contracts/base/interfaces/IVersionable.sol
@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity ^0.8.0;
+
+/**
+ * @title IVersionable interface
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
+ * @dev Defines the function of getting the contract version.
+ */
+interface IVersionable {
+    /**
+     * @dev The struct for the contract version.
+     */
+    struct Version {
+        uint16 major; // -- The major version of contract
+        uint16 minor; // -- The minor version of contract
+        uint16 patch; // -- The patch version of contract
+    }
+
+    /**
+     * @dev Returns the version of the contract.
+     */
+    function $__VERSION() external pure returns (Version memory);
+}
diff --git a/contracts/mocks/ERC20HookMock.sol b/contracts/mocks/ERC20HookMock.sol
@@ -6,7 +6,7 @@ import { IERC20Hook } from "./../base/interfaces/IERC20Hook.sol";
 
 /**
  * @title ERC20HookMock contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice An implementation of the {IERC20Hook} contract for testing purposes
  */
 contract ERC20HookMock is IERC20Hook {

diff --git a/contracts/mocks/ERC20TokenMock.sol b/contracts/mocks/ERC20TokenMock.sol
@@ -6,7 +6,7 @@ import { ERC20Upgradeable } from "@openzeppelin/contracts-upgradeable/token/ERC2
 
 /**
  * @title ERC20TokenMock contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice An implementation of the {ERC20Upgradeable} contract for testing purposes
  */
 contract ERC20TokenMock is ERC20Upgradeable {

diff --git a/contracts/mocks/base/ERC20BaseMock.sol b/contracts/mocks/base/ERC20BaseMock.sol
@@ -6,7 +6,7 @@ import { ERC20Base } from "../../base/ERC20Base.sol";
 
 /**
  * @title ERC20BaseMock contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice An implementation of the {ERC20Base} contract for testing purposes
  */
 contract ERC20BaseMock is ERC20Base {

diff --git a/contracts/mocks/base/ERC20BridgeableMock.sol b/contracts/mocks/base/ERC20BridgeableMock.sol
@@ -6,7 +6,7 @@ import { ERC20Bridgeable } from "../../base/ERC20Bridgeable.sol";
 
 /**
  * @title ERC20BridgeableMock contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice An implementation of the {ERC20Bridgeable} contract for testing purposes
  */
 contract ERC20BridgeableMock is ERC20Bridgeable {

diff --git a/contracts/mocks/base/ERC20FreezableMock.sol b/contracts/mocks/base/ERC20FreezableMock.sol
@@ -6,7 +6,7 @@ import { ERC20Freezable } from "../../base/ERC20Freezable.sol";
 
 /**
  * @title ERC20FreezableMock contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice An implementation of the {ERC20Freezable} contract for testing purposes
  */
 contract ERC20FreezableMock is ERC20Freezable {

diff --git a/contracts/mocks/base/ERC20HookableMock.sol b/contracts/mocks/base/ERC20HookableMock.sol
@@ -6,7 +6,7 @@ import { ERC20Hookable } from "../../base/ERC20Hookable.sol";
 
 /**
  * @title ERC20HookableMock contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice An implementation of the {ERC20Hookable} contract for testing purposes
  */
 contract ERC20HookableMock is ERC20Hookable {

diff --git a/contracts/mocks/base/ERC20MintableMock.sol b/contracts/mocks/base/ERC20MintableMock.sol
@@ -6,7 +6,7 @@ import { ERC20Mintable } from "../../base/ERC20Mintable.sol";
 
 /**
  * @title ERC20MintableMock contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice An implementation of the {ERC20Mintable} contract for testing purposes
  */
 contract ERC20MintableMock is ERC20Mintable {

diff --git a/contracts/mocks/base/ERC20RestrictableMock.sol b/contracts/mocks/base/ERC20RestrictableMock.sol
@@ -6,7 +6,7 @@ import { ERC20Restrictable } from "../../base/ERC20Restrictable.sol";
 
 /**
  * @title ERC20RestrictableMock contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice An implementation of the {ERC20Restrictable} contract for testing purposes
  */
 contract ERC20RestrictableMock is ERC20Restrictable {

diff --git a/contracts/mocks/base/ERC20TrustableMock.sol b/contracts/mocks/base/ERC20TrustableMock.sol
@@ -6,7 +6,7 @@ import { ERC20Trustable } from "../../base/ERC20Trustable.sol";
 
 /**
  * @title ERC20TrustableMock contract
- * @author CloudWalk Inc.
+ * @author CloudWalk Inc. (See https://www.cloudwalk.io)
  * @notice An implementation of the {ERC20Trustable} contract for testing purposes
  */
 contract ERC20TrustableMock is ERC20Trustable {