Solidity 0.8.27

CHANGELOG.md

@@ -42,6 +42,20 @@ All notable changes to this project will be documented in this file.
     - The `AgentRestrictionsSet` event is emitted whenever restrictions are updated for an agent.
   - All agent-scoped functions (e.g., mint, burn) now check the agent’s permissions before executing the transaction, ensuring proper enforcement of these restrictions.
 
+- **Ethers.js Version Upgrade**:
+  - The project was upgraded from **Ethers v5** to **Ethers v6**, introducing several changes to the API and syntax.
+  - **Key Changes**:
+    - Adjusted syntax for contract deployments, interactions, and function calls to comply with Ethers v6.
+    - Replaced deprecated features from v5 with the new Ethers v6 equivalents, ensuring compatibility and future-proofing the project.
+    - Updated test suites and helper functions to use the Ethers v6 `Interface` and `Contract` classes, ensuring smooth testing of the updated code.
+  - This upgrade ensures better performance, enhanced security, and improved developer experience moving forward.
+
+- **Solidity Version Upgrade to 0.8.27**:
+  - Upgraded Solidity version from **0.8.17** to **0.8.27** across all contracts, bringing in multiple new features and improvements:
+    - **File-Level Event Declaration**: Events are now declared at the file level, simplifying code structure and improving readability.
+    - **Custom Errors for Require Statements**: All `require` clauses that previously returned a string reason for failure have been updated to use **custom errors**, making debugging easier and more efficient.
+  - This upgrade provides a cleaner, more efficient error handling process and improves overall code structure without affecting backward compatibility.
+
 ### Updated
 
 - **Token Recovery Function**:

contracts/DVA/DVATransferManager.sol

@@ -66,7 +66,7 @@
  *     Tokeny sàrl for licensing options.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../roles/AgentRole.sol";
 import "../token/IToken.sol";

contracts/DVA/DVATransferManagerProxy.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
 

contracts/DVA/IDVATransferManager.sol

@@ -66,7 +66,7 @@
  *     Tokeny sàrl for licensing options.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../roles/AgentRole.sol";
 import "../token/IToken.sol";

contracts/DVD/DVDTransferManager.sol

@@ -66,7 +66,7 @@
  *     Tokeny sàrl for licensing options.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../roles/AgentRole.sol";
 import "../token/IToken.sol";

contracts/ERC-3643/IERC3643.sol

@@ -37,7 +37,7 @@
 //                                        :#%%=
 //
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";

contracts/ERC-3643/IERC3643ClaimTopicsRegistry.sol

@@ -36,7 +36,7 @@
 //                                        +@@@@%-
 //                                        :#%%=
 //
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 /// Events
 

contracts/ERC-3643/IERC3643Compliance.sol

@@ -36,7 +36,7 @@
 //                                        +@@@@%-
 //                                        :#%%=
 //
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 /// Events
 

contracts/ERC-3643/IERC3643IdentityRegistry.sol

@@ -36,7 +36,7 @@
 //                                        +@@@@%-
 //                                        :#%%=
 //
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "@onchain-id/solidity/contracts/interface/IIdentity.sol";
 import "./IERC3643IdentityRegistryStorage.sol";

contracts/ERC-3643/IERC3643IdentityRegistryStorage.sol

@@ -36,7 +36,7 @@
 //                                        +@@@@%-
 //                                        :#%%=
 //
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 import "@onchain-id/solidity/contracts/interface/IIdentity.sol";
 
 /// events

contracts/ERC-3643/IERC3643TrustedIssuersRegistry.sol

@@ -36,7 +36,7 @@
 //                                        +@@@@%-
 //                                        :#%%=
 //
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 import "@onchain-id/solidity/contracts/interface/IClaimIssuer.sol";
 
 /// Events

contracts/_testContracts/MockContract.sol

@@ -1,4 +1,4 @@
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 contract MockContract {
     address _irRegistry;

contracts/_testContracts/TestERC20.sol

@@ -58,7 +58,7 @@
  *     You should have received a copy of the GNU General Public License
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "@openzeppelin/contracts/token/ERC20/extensions/ERC20Pausable.sol";
 import "@openzeppelin/contracts/access/Ownable.sol";

contracts/_testContracts/TestUpgradedCountryAllowModule.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../compliance/modular/modules/CountryAllowModule.sol";
 

contracts/_testContracts/v_3_5_2/LegacyIA.sol

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-3.0
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 abstract contract ContextLegacy {
     function _msgSender() internal view virtual returns (address) {

contracts/_testContracts/v_3_5_2/LegacyProxy.sol

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: GPL-3.0
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 interface IImplementationAuthorityLegacy {
     function getImplementation() external view returns (address);

contracts/_testContracts/v_3_5_2/LegacyToken_3_5_2.sol

@@ -5,7 +5,7 @@
 // File: @onchain-id/solidity/contracts/interface/IERC734Legacy.sol
 
 // SPDX-License-Identifier: GPL-3.0
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 /**
  * @dev interface of the ERC734 (Key Holder) standard as defined in the EIP.

contracts/compliance/legacy/BasicCompliance.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../../roles/AgentRole.sol";
 import "./ICompliance.sol";

contracts/compliance/legacy/DefaultCompliance.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "./BasicCompliance.sol";
 

contracts/compliance/legacy/ICompliance.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 interface ICompliance {
     /**

contracts/compliance/legacy/features/ApproveTransfer.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../BasicCompliance.sol";
 
@@ -82,7 +82,7 @@
      *  note that the approved transfer has to be exactly of the approved amount `_amount`
      *  `_token` is the address of the token that is allowed to be transferred
      */
     event TransferApproved(address _from, address _to, uint _amount, address _token);
 
     /**
      *  this event is emitted when a transfer approval is removed
@@ -92,7 +92,7 @@
      *  `_amount` is the amount of tokens that `_from` was allowed to send to `_to`
      *  `_token` is the address of the token that was allowed to be transferred
      */
     event ApprovalRemoved(address _from, address _to, uint _amount, address _token);
 
     /**
     *  @dev removes approval on a transfer previously approved
@@ -104,7 +104,7 @@
     *  Only Admin can call this function, i.e. owner of compliance contract OR token agent
     *  emits an `ApprovalRemoved` event
     */
     function removeApproval(address _from, address _to, uint _amount) external onlyAdmin {
         bytes32 transferId = _calculateTransferID (_from, _to, _amount, address(tokenBound));
         require(_transfersApproved[transferId], "transfer not approved yet");
         _transfersApproved[transferId] = false;
@@ -122,7 +122,7 @@
     *  Only Admin can call this function, i.e. owner of compliance contract OR token agent
     *  emits a `TransferApproved` event, an `ApprovalRemoved` event and a `Transfer` event
     */
     function approveAndTransfer(address _from, address _to, uint _amount) external {
         approveTransfer(_from, _to, _amount);
         tokenBound.transferFrom(_from, _to, _amount);
     }
@@ -136,7 +136,7 @@
     *  Only Admin can call this function, i.e. owner of compliance contract OR token agent
     *  emits a `TransferApproved` event
     */
     function approveTransfer(address _from, address _to, uint _amount) public onlyAdmin {
         bytes32 transferId = _calculateTransferID (_from, _to, _amount, address(tokenBound));
         require(!_transfersApproved[transferId], "transfer already approved");
         _transfersApproved[transferId] = true;
@@ -207,7 +207,7 @@
     *  emits an `ApprovalRemoved` event if transfer was pre-approved, i.e. if function call was done by a regular
     *  token holder, token agents bypassing the approval requirements
     */
     function _transferProcessed(address _from, address _to, uint _amount) internal {
         bytes32 transferId = _calculateTransferID (_from, _to, _amount, address(tokenBound));
         if (_transfersApproved[transferId]) {
             _transfersApproved[transferId] = false;
@@ -227,7 +227,7 @@
     function _calculateTransferID (
         address _from,
         address _to,
         uint _amount,
         address _token
     ) internal pure returns (bytes32){
         bytes32 transferId = keccak256(abi.encode(_from, _to, _amount, _token));

contracts/compliance/legacy/features/CountryRestrictions.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../BasicCompliance.sol";
 
@@ -95,7 +95,7 @@
     *  emits _countries.length `AddedRestrictedCountry` events
     */
     function batchRestrictCountries(uint16[] calldata _countries) external {
         for (uint i = 0; i < _countries.length; i++) {
             addCountryRestriction(_countries[i]);
         }
     }
@@ -108,7 +108,7 @@
      *  emits _countries.length `RemovedRestrictedCountry` events
      */
     function batchUnrestrictCountries(uint16[] calldata _countries) external {
         for (uint i = 0; i < _countries.length; i++) {
             removeCountryRestriction(_countries[i]);
         }
     }

contracts/compliance/legacy/features/CountryWhitelisting.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../BasicCompliance.sol";
 
@@ -95,7 +95,7 @@
     *  emits an `WhitelistedCountry` event
     */
     function batchWhitelistCountries(uint16[] memory _countries) external {
         for (uint i = 0; i < _countries.length; i++) {
             whitelistCountry(_countries[i]);
         }
     }

contracts/compliance/legacy/features/DayMonthLimits.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../BasicCompliance.sol";
 

contracts/compliance/legacy/features/ExchangeMonthlyLimits.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../BasicCompliance.sol";
 

contracts/compliance/legacy/features/MaxBalance.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../BasicCompliance.sol";
 

contracts/compliance/legacy/features/SupplyLimit.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../BasicCompliance.sol";
 

contracts/compliance/legacy/test/ApproveTransferTest.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../features/ApproveTransfer.sol";
 

contracts/compliance/legacy/test/CountryRestrictionsTest.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../features/CountryRestrictions.sol";
 

contracts/compliance/legacy/test/CountryWhitelistingTest.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../features/CountryWhitelisting.sol";
 

contracts/compliance/legacy/test/DayMonthLimitsTest.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../features/DayMonthLimits.sol";
 

contracts/compliance/legacy/test/ExchangeMonthlyLimitsTest.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../features/ExchangeMonthlyLimits.sol";
 

contracts/compliance/legacy/test/MaxBalanceTest.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../features/MaxBalance.sol";
 

contracts/compliance/legacy/test/SupplyLimitTest.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../features/SupplyLimit.sol";
 

contracts/compliance/modular/IModularCompliance.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../../ERC-3643/IERC3643Compliance.sol";
 

contracts/compliance/modular/MCStorage.sol

@@ -61,7 +61,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 contract MCStorage {
     /// token linked to the compliance contract

contracts/compliance/modular/ModularCompliance.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";
 import "../../token/IToken.sol";

contracts/compliance/modular/modules/AbstractModule.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "./IModule.sol";
 import "../../../errors/InvalidArgumentErrors.sol";

contracts/compliance/modular/modules/AbstractModuleUpgradeable.sol

@@ -60,7 +60,7 @@
  *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
 import "@openzeppelin/contracts-upgradeable/access/OwnableUpgradeable.sol";

contracts/compliance/modular/modules/ConditionalTransferModule.sol

@@ -66,7 +66,7 @@
  *     Tokeny sàrl for licensing options.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../IModularCompliance.sol";
 import "../../../token/IToken.sol";

contracts/compliance/modular/modules/CountryAllowModule.sol

@@ -66,7 +66,7 @@
  *     Tokeny sàrl for licensing options.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../IModularCompliance.sol";
 import "../../../token/IToken.sol";

contracts/compliance/modular/modules/CountryRestrictModule.sol

@@ -66,7 +66,7 @@
  *     Tokeny sàrl for licensing options.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../IModularCompliance.sol";
 import "../../../token/IToken.sol";

contracts/compliance/modular/modules/ExchangeMonthlyLimitsModule.sol

@@ -66,7 +66,7 @@
  *     Tokeny sàrl for licensing options.
  */
 
-pragma solidity 0.8.26;
+pragma solidity 0.8.27;
 
 import "../IModularCompliance.sol";
 import "../../../token/IToken.sol";