mirror of
https://github.com/luxfi/erc-3643.git
synced 2026-10-30 16:58:28 +00:00
* ✨ integrate foundry alongside hardhat for dual testing framework - Add foundry.toml configuration - Reorganize test structure: test/forge/ and test/hardhat/ - Add Foundry scripts to package.json (build:forge, test:forge, coverage:forge) - Update hardhat.config.ts with evmVersion for compatibility - Add GitHub workflows and coverage scripts from template - Add Husky hooks (pre-commit, post-checkout, post-merge) - Add .vscode/settings.json for better IDE support - Disable coverage checks until tests are migrated (commented with TODO) This migration is based on TokenySolutions/contracts-template and enables gradual migration of tests from Hardhat (TypeScript) to Foundry (Solidity). Related to: BT-1418 * ✅ trex factory tests * ⚰️ remove trex suit * feat(forge): reorganize Foundry test structure and sync GitHub workflows - Move TREXFactorySetup to helpers folder - Rename TREXSuite.t.sol to TREXFactory.t.sol - Update fixture to inherit from Test for proper Foundry pattern - Transfer ownership to deployer address to match Hardhat behavior - Sync GitHub workflows with package.json scripts - Update test.yml to use npm run build and npm run test - Update push_checking.yml to use unified npm run lint - Update forge_coverage.sh to use npm run coverage * fix(ci): install Foundry and skip husky in push_checking workflow - Add Foundry installation step before npm ci - Set HUSKY=0 to skip husky setup in CI environment - Fixes 'forge: not found' error during npm prepare script * 🔧 keep hardhat settings * ✅ create addressess directly * ✅ removed test_StandardAddressesSet * ✅ fix lint * 💡 removed title natspecs * ✅ migrated trex factort tests * ✅ added test module multicall * ✅ migrate agent role test * ✅ migrate claim topics registry * ✅ migrated trusted issuer registry * ✅ migrate identity registry storage * ✅ migrated identity registry tests * ✅ migrated implementation authority test * ✅ migrated token agen restrictions * ✅ migrated token information test * ✅ migrated token recover * ✅ migrated token permit * ✅ migrated token transfer * ✅ migrated utilities upgrade * ✅ migrated freeze check * ✅ migrated compliance check in utilities test * ✅ migrated eligibility check * ✅ migrated transfer check in utilities * ✅ migrated compliance test * ✅ migrated gateway tests * 🔥 removed already defined events * 🗑️ imported Initializable error from openzeppelin * ➕ added already defined events and errors * ✅ added base test token * ✅ used idFactory * ♻️ refactored compliance test * ⚰️ remoced useless vm.prank * 🔧 deleted hardhat configurations * 💚 fixed ci * refactor: remove 100% coverage requirement from forge_coverage.sh - Remove strict 100% coverage checks that were causing workflow failures - Script now only generates and displays coverage report without failing - Aligns with previous behavior where coverage was informational only * ✅ resolve getVerifiedDetails * ✅ applied _getEligibility and remove via-ir from foundry.toml * ✅ cover tokena and token permit * ✅ cover compliance * ✅ cover identity registry * ✅ increased trex gateway coverage * ✅ increase coverage for trex factory * ✅ increased AbstractModuleUpgradeable.sol coverage * ⚰️ removed abstract module * 🔧 updted generate coverage * ✅ coverage 100% identity registry * ✅ coverage 100% trex gate way * ✅ coverage trex factory * ✅ coverage 100% AbstractModuleUpgradeable by test module * ✅ coverage IAFactory.sol * ✅ coverage 100% for implementation authority * ✅ coverage 1005 abstract proxy * ✅ coverage 100% claim topic registry * ✅ coverage 100% identity registry storage * ✅ coverage 100% modular compliance proxy * ✅ coverage trusted issuer registry proxy * ✅ coverage 100% identity registry * ✅ coverage 100% token proxy * 🚨 resolve linter in token information * ✅ coverage 100% roles * 🚨 resolve linter * 🔧 added no coverage for test, _testContracts and utils * ✅ coverage 100% for token.sol * ✅ coverage 100% for modular compliance * ✅ coverage 100% trusted issuer registry * 🔧 restore package.json * ✅ coverage 100% for utlity checker * 🚨 fix linter
193 lines
8.9 KiB
Solidity
193 lines
8.9 KiB
Solidity
// SPDX-License-Identifier: UNLICENSED
|
|
pragma solidity 0.8.30;
|
|
|
|
import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
|
|
import { Initializable } from "@openzeppelin/contracts/proxy/utils/Initializable.sol";
|
|
import { IERC165 } from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
|
|
import { IERC3643ClaimTopicsRegistry } from "contracts/ERC-3643/IERC3643ClaimTopicsRegistry.sol";
|
|
import { ClaimTopicAdded, ClaimTopicRemoved } from "contracts/ERC-3643/IERC3643ClaimTopicsRegistry.sol";
|
|
import { MockContract } from "contracts/_testContracts/MockContract.sol";
|
|
import { InitializationFailed } from "contracts/errors/CommonErrors.sol";
|
|
import { ZeroAddress } from "contracts/errors/InvalidArgumentErrors.sol";
|
|
import { ClaimTopicsRegistryProxy } from "contracts/proxy/ClaimTopicsRegistryProxy.sol";
|
|
import { ITREXImplementationAuthority } from "contracts/proxy/authority/ITREXImplementationAuthority.sol";
|
|
import { TREXImplementationAuthority } from "contracts/proxy/authority/TREXImplementationAuthority.sol";
|
|
import { ClaimTopicsRegistry } from "contracts/registry/implementation/ClaimTopicsRegistry.sol";
|
|
import { ClaimTopicAlreadyExists, MaxTopicsReached } from "contracts/registry/implementation/ClaimTopicsRegistry.sol";
|
|
import { IERC173 } from "contracts/roles/IERC173.sol";
|
|
import { InterfaceIdCalculator } from "contracts/utils/InterfaceIdCalculator.sol";
|
|
import { Test } from "forge-std/Test.sol";
|
|
import { ImplementationAuthorityHelper } from "test/helpers/ImplementationAuthorityHelper.sol";
|
|
|
|
contract ClaimTopicsRegistryTest is Test {
|
|
|
|
// Contracts
|
|
ClaimTopicsRegistry public claimTopicsRegistry;
|
|
TREXImplementationAuthority public implementationAuthority;
|
|
|
|
// Standard test addresses
|
|
address public deployer = makeAddr("deployer");
|
|
address public another = makeAddr("another");
|
|
|
|
/// @notice Sets up ClaimTopicsRegistry via proxy
|
|
function setUp() public {
|
|
// Deploy Implementation Authority with all implementations
|
|
ImplementationAuthorityHelper.ImplementationAuthoritySetup memory iaSetup =
|
|
ImplementationAuthorityHelper.deploy(true);
|
|
implementationAuthority = iaSetup.implementationAuthority;
|
|
|
|
// Transfer ownership to deployer
|
|
Ownable(address(implementationAuthority)).transferOwnership(deployer);
|
|
|
|
// Deploy ClaimTopicsRegistryProxy (which initializes via delegatecall)
|
|
ClaimTopicsRegistryProxy proxy = new ClaimTopicsRegistryProxy(address(implementationAuthority));
|
|
claimTopicsRegistry = ClaimTopicsRegistry(address(proxy));
|
|
|
|
// Transfer ownership to deployer (owner is initially the test contract since it deploys the proxy)
|
|
claimTopicsRegistry.transferOwnership(deployer);
|
|
}
|
|
|
|
// ============ init() Tests ============
|
|
|
|
/// @notice Should revert when contract was already initialized
|
|
function test_init_RevertWhen_AlreadyInitialized() public {
|
|
vm.prank(deployer);
|
|
vm.expectRevert(Initializable.InvalidInitialization.selector);
|
|
claimTopicsRegistry.init();
|
|
}
|
|
|
|
// ============ addClaimTopic() Tests ============
|
|
|
|
/// @notice Should revert when sender is not owner
|
|
function test_addClaimTopic_RevertWhen_NotOwner() public {
|
|
vm.prank(another);
|
|
vm.expectRevert(abi.encodeWithSelector(Ownable.OwnableUnauthorizedAccount.selector, another));
|
|
claimTopicsRegistry.addClaimTopic(1);
|
|
}
|
|
|
|
/// @notice Should revert when topic array contains more than 14 elements
|
|
/// @dev Contract allows up to 15 topics (length < 15). To test the limit, we add 15 topics first.
|
|
function test_addClaimTopic_RevertWhen_MoreThan14Topics() public {
|
|
// Add 14 topics first (0-13)
|
|
for (uint256 i = 0; i < 14; i++) {
|
|
vm.prank(deployer);
|
|
claimTopicsRegistry.addClaimTopic(i);
|
|
}
|
|
|
|
// Add the 15th topic (index 14), this should succeed (length 14 < 15)
|
|
vm.prank(deployer);
|
|
claimTopicsRegistry.addClaimTopic(14);
|
|
|
|
// Now try to add 16th topic, should revert (length 15 is not < 15)
|
|
vm.prank(deployer);
|
|
vm.expectRevert(abi.encodeWithSelector(MaxTopicsReached.selector, 15));
|
|
claimTopicsRegistry.addClaimTopic(15);
|
|
}
|
|
|
|
/// @notice Should revert when adding a topic that is already added
|
|
function test_addClaimTopic_RevertWhen_TopicAlreadyExists() public {
|
|
vm.prank(deployer);
|
|
claimTopicsRegistry.addClaimTopic(1);
|
|
|
|
vm.prank(deployer);
|
|
vm.expectRevert(ClaimTopicAlreadyExists.selector);
|
|
claimTopicsRegistry.addClaimTopic(1);
|
|
}
|
|
|
|
// ============ removeClaimTopic() Tests ============
|
|
|
|
/// @notice Should revert when sender is not owner
|
|
function test_removeClaimTopic_RevertWhen_NotOwner() public {
|
|
vm.prank(another);
|
|
vm.expectRevert(abi.encodeWithSelector(Ownable.OwnableUnauthorizedAccount.selector, another));
|
|
claimTopicsRegistry.removeClaimTopic(1);
|
|
}
|
|
|
|
/// @notice Should remove claim topic successfully
|
|
function test_removeClaimTopic_Success() public {
|
|
// Add topics first
|
|
vm.prank(deployer);
|
|
claimTopicsRegistry.addClaimTopic(1);
|
|
vm.prank(deployer);
|
|
claimTopicsRegistry.addClaimTopic(2);
|
|
vm.prank(deployer);
|
|
claimTopicsRegistry.addClaimTopic(3);
|
|
|
|
// Remove topic 2
|
|
vm.prank(deployer);
|
|
vm.expectEmit(true, false, false, false);
|
|
emit ClaimTopicRemoved(2);
|
|
claimTopicsRegistry.removeClaimTopic(2);
|
|
}
|
|
|
|
// ============ supportsInterface() Tests ============
|
|
|
|
/// @notice Should return false for unsupported interfaces
|
|
function test_supportsInterface_ReturnsFalse_ForUnsupported() public view {
|
|
bytes4 unsupportedInterfaceId = 0x12345678;
|
|
assertFalse(claimTopicsRegistry.supportsInterface(unsupportedInterfaceId));
|
|
}
|
|
|
|
/// @notice Should correctly identify the IERC3643ClaimTopicsRegistry interface ID
|
|
function test_supportsInterface_ReturnsTrue_ForIERC3643ClaimTopicsRegistry() public {
|
|
InterfaceIdCalculator calculator = new InterfaceIdCalculator();
|
|
bytes4 interfaceId = calculator.getIERC3643ClaimTopicsRegistryInterfaceId();
|
|
assertTrue(claimTopicsRegistry.supportsInterface(interfaceId));
|
|
}
|
|
|
|
/// @notice Should correctly identify the IERC173 interface ID
|
|
function test_supportsInterface_ReturnsTrue_ForIERC173() public {
|
|
InterfaceIdCalculator calculator = new InterfaceIdCalculator();
|
|
bytes4 interfaceId = calculator.getIERC173InterfaceId();
|
|
assertTrue(claimTopicsRegistry.supportsInterface(interfaceId));
|
|
}
|
|
|
|
/// @notice Should correctly identify the IERC165 interface ID
|
|
function test_supportsInterface_ReturnsTrue_ForIERC165() public {
|
|
InterfaceIdCalculator calculator = new InterfaceIdCalculator();
|
|
bytes4 interfaceId = calculator.getIERC165InterfaceId();
|
|
assertTrue(claimTopicsRegistry.supportsInterface(interfaceId));
|
|
}
|
|
|
|
// ============ Constructor Tests ============
|
|
|
|
/// @notice Should revert when implementation authority is zero address
|
|
function test_constructor_RevertWhen_ImplementationAuthorityZeroAddress() public {
|
|
vm.expectRevert(ZeroAddress.selector);
|
|
new ClaimTopicsRegistryProxy(address(0));
|
|
}
|
|
|
|
/// @notice Should revert when initialization fails (invalid implementation)
|
|
function test_constructor_RevertWhen_InitializationFails() public {
|
|
// Deploy a mock contract that doesn't have init() function
|
|
MockContract mockImpl = new MockContract();
|
|
|
|
// Deploy an IA and manually set an invalid CTR implementation
|
|
TREXImplementationAuthority incompleteIA = new TREXImplementationAuthority(true, address(0), address(0));
|
|
|
|
// Create a version with invalid CTR implementation (mock contract without init())
|
|
ITREXImplementationAuthority.Version memory version =
|
|
ITREXImplementationAuthority.Version({ major: 4, minor: 0, patch: 0 });
|
|
|
|
ITREXImplementationAuthority.TREXContracts memory contracts = ITREXImplementationAuthority.TREXContracts({
|
|
tokenImplementation: address(mockImpl), // Invalid - doesn't have proper init
|
|
ctrImplementation: address(mockImpl), // Invalid - doesn't have init() function
|
|
irImplementation: address(mockImpl), // Invalid
|
|
irsImplementation: address(mockImpl), // Invalid
|
|
tirImplementation: address(mockImpl), // Invalid
|
|
mcImplementation: address(mockImpl) // Invalid
|
|
});
|
|
|
|
// Add version to IA (need to be owner)
|
|
Ownable(address(incompleteIA)).transferOwnership(deployer);
|
|
vm.prank(deployer);
|
|
incompleteIA.addAndUseTREXVersion(version, contracts);
|
|
|
|
// Now try to deploy proxy - delegatecall to mockImpl.init() will fail
|
|
// because MockContract doesn't have init() function, causing InitializationFailed() revert
|
|
vm.expectRevert(InitializationFailed.selector);
|
|
new ClaimTopicsRegistryProxy(address(incompleteIA));
|
|
}
|
|
|
|
}
|