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
889 lines
33 KiB
Solidity
889 lines
33 KiB
Solidity
// SPDX-License-Identifier: UNLICENSED
|
|
pragma solidity 0.8.30;
|
|
|
|
import { IIdentity } from "@onchain-id/solidity/contracts/interface/IIdentity.sol";
|
|
import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol";
|
|
import { ERC1967Proxy } from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
|
|
import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
|
|
import { TokensFrozen, TokensUnfrozen } from "contracts/ERC-3643/IERC3643.sol";
|
|
import { IERC3643IdentityRegistry } from "contracts/ERC-3643/IERC3643IdentityRegistry.sol";
|
|
import { TestModule } from "contracts/_testContracts/TestModule.sol";
|
|
import { ModularCompliance } from "contracts/compliance/modular/ModularCompliance.sol";
|
|
import { ModuleProxy } from "contracts/compliance/modular/modules/ModuleProxy.sol";
|
|
import { ERC20InvalidReceiver, ERC20InvalidSender, ERC20InvalidSpender } from "contracts/errors/CommonErrors.sol";
|
|
import { ITREXFactory } from "contracts/factory/ITREXFactory.sol";
|
|
import { IdentityRegistry } from "contracts/registry/implementation/IdentityRegistry.sol";
|
|
import { DefaultAllowance, DefaultAllowanceDisabled, DefaultAllowanceEnabled } from "contracts/token/IToken.sol";
|
|
import {
|
|
AgentNotAuthorized,
|
|
AmountAboveFrozenTokens,
|
|
CallerDoesNotHaveAgentRole,
|
|
ERC20InsufficientBalance,
|
|
EnforcedPause,
|
|
FrozenWallet,
|
|
TransferNotPossible
|
|
} from "contracts/token/Token.sol";
|
|
import { Token } from "contracts/token/Token.sol";
|
|
import { TokenRoles } from "contracts/token/TokenStructs.sol";
|
|
import { TokenTestBase } from "test/token/TokenTestBase.sol";
|
|
|
|
contract TokenTransferTest is TokenTestBase {
|
|
|
|
// Token suite components
|
|
IdentityRegistry public identityRegistry;
|
|
|
|
function setUp() public override {
|
|
super.setUp();
|
|
|
|
// Get IdentityRegistry
|
|
IERC3643IdentityRegistry ir = token.identityRegistry();
|
|
identityRegistry = IdentityRegistry(address(ir));
|
|
|
|
// Add tokenAgent as an agent
|
|
vm.startPrank(deployer);
|
|
token.addAgent(tokenAgent);
|
|
identityRegistry.addAgent(tokenAgent);
|
|
vm.stopPrank();
|
|
|
|
// Register alice and bob in IdentityRegistry and mint tokens
|
|
vm.startPrank(tokenAgent);
|
|
identityRegistry.registerIdentity(alice, aliceIdentity, 42);
|
|
identityRegistry.registerIdentity(bob, bobIdentity, 666);
|
|
token.mint(alice, 1000);
|
|
token.mint(bob, 500);
|
|
token.unpause();
|
|
vm.stopPrank();
|
|
}
|
|
|
|
/// @notice Helper to deploy TestModule + ModularCompliance setup for compliance tests
|
|
function _deployComplianceSetup() internal returns (ModularCompliance, TestModule) {
|
|
// Deploy ModularCompliance
|
|
ModularCompliance complianceImplementation = new ModularCompliance();
|
|
bytes memory complianceInitData = abi.encodeWithSelector(ModularCompliance.init.selector);
|
|
ERC1967Proxy complianceProxy = new ERC1967Proxy(address(complianceImplementation), complianceInitData);
|
|
ModularCompliance compliance = ModularCompliance(address(complianceProxy));
|
|
|
|
// Transfer ownership to deployer
|
|
compliance.transferOwnership(deployer);
|
|
|
|
// Deploy TestModule
|
|
TestModule testModuleImplementation = new TestModule();
|
|
bytes memory moduleInitData = abi.encodeWithSelector(TestModule.initialize.selector);
|
|
ModuleProxy testModuleProxy = new ModuleProxy(address(testModuleImplementation), moduleInitData);
|
|
TestModule testModule = TestModule(address(testModuleProxy));
|
|
|
|
// Add module to compliance
|
|
vm.prank(deployer);
|
|
compliance.addModule(address(testModule));
|
|
|
|
return (compliance, testModule);
|
|
}
|
|
|
|
// ============ approve() Tests ============
|
|
|
|
/// @notice Should approve a contract to spend a certain amount of tokens
|
|
function test_approve_Success() public {
|
|
vm.prank(alice);
|
|
vm.expectEmit(true, true, false, false, address(token));
|
|
emit IERC20.Approval(alice, another, 100);
|
|
token.approve(another, 100);
|
|
|
|
assertEq(token.allowance(alice, another), 100);
|
|
}
|
|
|
|
// ============ increaseAllowance() Tests ============
|
|
|
|
/// @notice Should increase the allowance of a contract to spend a certain amount of tokens
|
|
function test_increaseAllowance_Success() public {
|
|
vm.prank(alice);
|
|
token.approve(another, 100);
|
|
|
|
vm.prank(alice);
|
|
vm.expectEmit(true, true, false, false, address(token));
|
|
emit IERC20.Approval(alice, another, 200);
|
|
token.increaseAllowance(another, 100);
|
|
|
|
assertEq(token.allowance(alice, another), 200);
|
|
}
|
|
|
|
// ============ decreaseAllowance() Tests ============
|
|
|
|
/// @notice Should decrease the allowance of a contract to spend a certain amount of tokens
|
|
function test_decreaseAllowance_Success() public {
|
|
vm.prank(alice);
|
|
token.approve(another, 150);
|
|
|
|
vm.prank(alice);
|
|
vm.expectEmit(true, true, false, false, address(token));
|
|
emit IERC20.Approval(alice, another, 50);
|
|
token.decreaseAllowance(another, 100);
|
|
|
|
assertEq(token.allowance(alice, another), 50);
|
|
}
|
|
|
|
// ============ transfer() Tests ============
|
|
|
|
/// @notice Should revert when token is paused
|
|
function test_transfer_RevertWhen_Paused() public {
|
|
vm.prank(tokenAgent);
|
|
token.pause();
|
|
|
|
vm.prank(alice);
|
|
vm.expectRevert(EnforcedPause.selector);
|
|
token.transfer(bob, 100);
|
|
}
|
|
|
|
/// @notice Should revert when recipient balance is frozen
|
|
function test_transfer_RevertWhen_RecipientFrozen() public {
|
|
vm.prank(tokenAgent);
|
|
token.setAddressFrozen(bob, true);
|
|
|
|
vm.prank(alice);
|
|
vm.expectRevert(FrozenWallet.selector);
|
|
token.transfer(bob, 100);
|
|
}
|
|
|
|
/// @notice Should revert when sender balance is frozen
|
|
function test_transfer_RevertWhen_SenderFrozen() public {
|
|
vm.prank(tokenAgent);
|
|
token.setAddressFrozen(alice, true);
|
|
|
|
vm.prank(alice);
|
|
vm.expectRevert(FrozenWallet.selector);
|
|
token.transfer(bob, 100);
|
|
}
|
|
|
|
/// @notice Should revert when sender has not enough balance
|
|
function test_transfer_RevertWhen_InsufficientBalance() public {
|
|
uint256 balance = token.balanceOf(alice);
|
|
|
|
vm.prank(alice);
|
|
vm.expectRevert(abi.encodeWithSelector(ERC20InsufficientBalance.selector, alice, balance, balance + 1000));
|
|
token.transfer(bob, balance + 1000);
|
|
}
|
|
|
|
/// @notice Should revert when sender has not enough balance unfrozen
|
|
function test_transfer_RevertWhen_InsufficientUnfrozenBalance() public {
|
|
uint256 balance = token.balanceOf(alice);
|
|
vm.prank(tokenAgent);
|
|
token.freezePartialTokens(alice, balance - 100);
|
|
|
|
vm.prank(alice);
|
|
vm.expectRevert(abi.encodeWithSelector(ERC20InsufficientBalance.selector, alice, 100, balance));
|
|
token.transfer(bob, balance);
|
|
}
|
|
|
|
/// @notice Should revert when recipient identity is not verified
|
|
function test_transfer_RevertWhen_RecipientNotVerified() public {
|
|
vm.prank(alice);
|
|
vm.expectRevert(TransferNotPossible.selector);
|
|
token.transfer(another, 100);
|
|
}
|
|
|
|
/// @notice Should revert when transfer breaks compliance rules (covers AND condition: isVerified=true, canTransfer=false)
|
|
function test_transfer_RevertWhen_ComplianceBreaks() public {
|
|
(ModularCompliance compliance, TestModule testModule) = _deployComplianceSetup();
|
|
|
|
vm.prank(deployer);
|
|
token.setCompliance(address(compliance));
|
|
|
|
// Block transfers in module
|
|
bytes memory blockModuleCall = abi.encodeWithSignature("blockModule(bool)", true);
|
|
vm.prank(deployer);
|
|
compliance.callModuleFunction(blockModuleCall, address(testModule));
|
|
|
|
// bob is verified but compliance blocks transfer (covers isVerified=true && canTransfer=false branch)
|
|
vm.prank(alice);
|
|
vm.expectRevert(TransferNotPossible.selector);
|
|
token.transfer(bob, 100);
|
|
}
|
|
|
|
/// @notice Should transfer tokens when transfer is compliant
|
|
function test_transfer_Success() public {
|
|
vm.prank(alice);
|
|
vm.expectEmit(true, true, false, false, address(token));
|
|
emit IERC20.Transfer(alice, bob, 100);
|
|
token.transfer(bob, 100);
|
|
}
|
|
|
|
// ============ batchTransfer() Tests ============
|
|
|
|
/// @notice Should transfer tokens
|
|
function test_batchTransfer_Success() public {
|
|
address[] memory toList = new address[](2);
|
|
toList[0] = bob;
|
|
toList[1] = bob;
|
|
uint256[] memory amounts = new uint256[](2);
|
|
amounts[0] = 100;
|
|
amounts[1] = 200;
|
|
|
|
vm.prank(alice);
|
|
vm.expectEmit(true, true, false, false, address(token));
|
|
emit IERC20.Transfer(alice, bob, 100);
|
|
vm.expectEmit(true, true, false, false, address(token));
|
|
emit IERC20.Transfer(alice, bob, 200);
|
|
token.batchTransfer(toList, amounts);
|
|
}
|
|
|
|
// ============ transferFrom() Tests ============
|
|
|
|
/// @notice Should revert when token is paused
|
|
function test_transferFrom_RevertWhen_Paused() public {
|
|
vm.prank(tokenAgent);
|
|
token.pause();
|
|
|
|
vm.prank(alice);
|
|
vm.expectRevert(EnforcedPause.selector);
|
|
token.transferFrom(alice, bob, 100);
|
|
}
|
|
|
|
/// @notice Should revert when sender address is frozen
|
|
function test_transferFrom_RevertWhen_SenderFrozen() public {
|
|
vm.prank(tokenAgent);
|
|
token.setAddressFrozen(alice, true);
|
|
|
|
vm.prank(alice);
|
|
vm.expectRevert(FrozenWallet.selector);
|
|
token.transferFrom(alice, bob, 100);
|
|
}
|
|
|
|
/// @notice Should revert when recipient address is frozen
|
|
function test_transferFrom_RevertWhen_RecipientFrozen() public {
|
|
vm.prank(tokenAgent);
|
|
token.setAddressFrozen(bob, true);
|
|
|
|
vm.prank(alice);
|
|
vm.expectRevert(FrozenWallet.selector);
|
|
token.transferFrom(alice, bob, 100);
|
|
}
|
|
|
|
/// @notice Should revert when sender has not enough balance
|
|
function test_transferFrom_RevertWhen_InsufficientBalance() public {
|
|
uint256 balance = token.balanceOf(alice);
|
|
|
|
vm.prank(alice);
|
|
vm.expectRevert(abi.encodeWithSelector(ERC20InsufficientBalance.selector, alice, balance, balance + 1000));
|
|
token.transferFrom(alice, bob, balance + 1000);
|
|
}
|
|
|
|
/// @notice Should revert when sender has not enough balance unfrozen
|
|
function test_transferFrom_RevertWhen_InsufficientUnfrozenBalance() public {
|
|
uint256 balance = token.balanceOf(alice);
|
|
vm.prank(tokenAgent);
|
|
token.freezePartialTokens(alice, balance - 100);
|
|
|
|
vm.prank(alice);
|
|
vm.expectRevert(abi.encodeWithSelector(ERC20InsufficientBalance.selector, alice, 100, balance));
|
|
token.transferFrom(alice, bob, balance);
|
|
}
|
|
|
|
/// @notice Should revert when recipient identity is not verified
|
|
function test_transferFrom_RevertWhen_RecipientNotVerified() public {
|
|
vm.prank(alice);
|
|
vm.expectRevert(TransferNotPossible.selector);
|
|
token.transferFrom(alice, another, 100);
|
|
}
|
|
|
|
/// @notice Should revert when transfer breaks compliance rules (covers AND condition: isVerified=true, canTransfer=false)
|
|
function test_transferFrom_RevertWhen_ComplianceBreaks() public {
|
|
(ModularCompliance compliance, TestModule testModule) = _deployComplianceSetup();
|
|
|
|
vm.prank(deployer);
|
|
token.setCompliance(address(compliance));
|
|
|
|
// Block transfers in module
|
|
bytes memory blockModuleCall = abi.encodeWithSignature("blockModule(bool)", true);
|
|
vm.prank(deployer);
|
|
compliance.callModuleFunction(blockModuleCall, address(testModule));
|
|
|
|
// bob is verified but compliance blocks transfer (covers isVerified=true && canTransfer=false branch)
|
|
vm.prank(alice);
|
|
vm.expectRevert(TransferNotPossible.selector);
|
|
token.transferFrom(alice, bob, 100);
|
|
}
|
|
|
|
/// @notice Should transfer tokens and reduce allowance of transferred value
|
|
function test_transferFrom_Success() public {
|
|
vm.prank(alice);
|
|
token.approve(another, 100);
|
|
|
|
vm.prank(another);
|
|
vm.expectEmit(true, true, false, false, address(token));
|
|
emit IERC20.Transfer(alice, bob, 100);
|
|
token.transferFrom(alice, bob, 100);
|
|
|
|
assertEq(token.allowance(alice, another), 0);
|
|
}
|
|
|
|
/// @notice Should decrease allowance when default allowance is NOT enabled (first part of OR condition)
|
|
function test_transferFrom_DecreasesAllowance_WhenDefaultAllowanceNotEnabled() public {
|
|
// Ensure default allowance is NOT enabled for another
|
|
vm.prank(alice);
|
|
token.approve(another, 200);
|
|
|
|
vm.prank(another);
|
|
token.transferFrom(alice, bob, 100);
|
|
|
|
// Allowance should be decreased
|
|
assertEq(token.allowance(alice, another), 100);
|
|
}
|
|
|
|
/// @notice Should decrease allowance when default allowance enabled but user opted out (second part of OR condition)
|
|
function test_transferFrom_DecreasesAllowance_WhenUserOptedOut() public {
|
|
address[] memory targets = new address[](1);
|
|
targets[0] = another;
|
|
|
|
// Enable default allowance for another
|
|
vm.prank(deployer);
|
|
token.setAllowanceForAll(true, targets);
|
|
|
|
// User opts out
|
|
vm.prank(alice);
|
|
token.disableDefaultAllowance();
|
|
|
|
// Approve a specific amount
|
|
vm.prank(alice);
|
|
token.approve(another, 200);
|
|
|
|
// Transfer should decrease allowance because user opted out
|
|
vm.prank(another);
|
|
token.transferFrom(alice, bob, 100);
|
|
|
|
// Allowance should be decreased (not max)
|
|
assertEq(token.allowance(alice, another), 100);
|
|
}
|
|
|
|
/// @notice Should NOT decrease allowance when default allowance enabled AND user NOT opted out (covers OR condition: both false)
|
|
function test_transferFrom_DoesNotDecreaseAllowance_WhenDefaultAllowanceEnabledAndNotOptedOut() public {
|
|
address[] memory targets = new address[](1);
|
|
targets[0] = another;
|
|
|
|
// Enable default allowance for another
|
|
vm.prank(deployer);
|
|
token.setAllowanceForAll(true, targets);
|
|
|
|
// User has NOT opted out, so default allowance applies
|
|
// Approve a specific amount (this is stored but allowance() returns max)
|
|
vm.prank(alice);
|
|
token.approve(another, 200);
|
|
|
|
// Transfer should NOT decrease allowance because default allowance is enabled and user hasn't opted out
|
|
vm.prank(another);
|
|
token.transferFrom(alice, bob, 100);
|
|
|
|
// Allowance should return max (default allowance enabled, user not opted out)
|
|
assertEq(token.allowance(alice, another), type(uint256).max);
|
|
}
|
|
|
|
// ============ forcedTransfer() Tests ============
|
|
|
|
/// @notice Should revert when sender is not an agent
|
|
function test_forcedTransfer_RevertWhen_NotAgent() public {
|
|
vm.prank(alice);
|
|
vm.expectRevert(CallerDoesNotHaveAgentRole.selector);
|
|
token.forcedTransfer(alice, bob, 100);
|
|
}
|
|
|
|
/// @notice Should revert when agent permission is restricted
|
|
function test_forcedTransfer_RevertWhen_AgentRestricted() public {
|
|
TokenRoles memory restrictions = TokenRoles({
|
|
disableMint: false,
|
|
disableBurn: false,
|
|
disablePartialFreeze: false,
|
|
disableAddressFreeze: false,
|
|
disableRecovery: false,
|
|
disableForceTransfer: true,
|
|
disablePause: false
|
|
});
|
|
|
|
vm.prank(deployer);
|
|
token.setAgentRestrictions(tokenAgent, restrictions);
|
|
|
|
vm.prank(tokenAgent);
|
|
vm.expectRevert(abi.encodeWithSelector(AgentNotAuthorized.selector, tokenAgent, "forceTransfer disabled"));
|
|
token.forcedTransfer(alice, bob, 100);
|
|
}
|
|
|
|
/// @notice Should revert when source wallet has not enough balance
|
|
function test_forcedTransfer_RevertWhen_InsufficientBalance() public {
|
|
uint256 balance = token.balanceOf(alice);
|
|
|
|
vm.prank(tokenAgent);
|
|
vm.expectRevert(abi.encodeWithSelector(ERC20InsufficientBalance.selector, alice, balance, balance + 1000));
|
|
token.forcedTransfer(alice, bob, balance + 1000);
|
|
}
|
|
|
|
/// @notice Should revert when recipient identity is not verified
|
|
function test_forcedTransfer_RevertWhen_RecipientNotVerified() public {
|
|
vm.prank(tokenAgent);
|
|
vm.expectRevert(TransferNotPossible.selector);
|
|
token.forcedTransfer(alice, another, 100);
|
|
}
|
|
|
|
/// @notice Should still transfer tokens when transfer breaks compliance rules
|
|
function test_forcedTransfer_Success_WhenComplianceBreaks() public {
|
|
(ModularCompliance compliance, TestModule testModule) = _deployComplianceSetup();
|
|
|
|
vm.prank(deployer);
|
|
token.setCompliance(address(compliance));
|
|
|
|
// Block transfers in module
|
|
bytes memory blockModuleCall = abi.encodeWithSignature("blockModule(bool)", true);
|
|
vm.prank(deployer);
|
|
compliance.callModuleFunction(blockModuleCall, address(testModule));
|
|
|
|
vm.prank(tokenAgent);
|
|
vm.expectEmit(true, true, false, false, address(token));
|
|
emit IERC20.Transfer(alice, bob, 100);
|
|
token.forcedTransfer(alice, bob, 100);
|
|
}
|
|
|
|
/// @notice Should unfreeze tokens when amount is greater than unfrozen balance
|
|
function test_forcedTransfer_Success_UnfreezesTokens() public {
|
|
uint256 balance = token.balanceOf(alice);
|
|
vm.prank(tokenAgent);
|
|
token.freezePartialTokens(alice, balance - 100);
|
|
|
|
uint256 transferAmount = balance - 50;
|
|
uint256 unfreezeAmount = balance - 150;
|
|
vm.prank(tokenAgent);
|
|
vm.expectEmit(true, true, false, false, address(token));
|
|
emit IERC20.Transfer(alice, bob, transferAmount);
|
|
token.forcedTransfer(alice, bob, transferAmount);
|
|
|
|
// Check unfrozen tokens separately (event order may vary)
|
|
assertEq(token.getFrozenTokens(alice), 50);
|
|
}
|
|
|
|
/// @notice Should transfer without unfreezing when amount is less than or equal to free balance
|
|
function test_forcedTransfer_Success_NoUnfreezing() public {
|
|
uint256 balance = token.balanceOf(alice);
|
|
vm.prank(tokenAgent);
|
|
token.freezePartialTokens(alice, 200);
|
|
|
|
// Transfer amount less than free balance (no unfreezing needed)
|
|
uint256 transferAmount = balance - 300;
|
|
vm.prank(tokenAgent);
|
|
vm.expectEmit(true, true, false, false, address(token));
|
|
emit IERC20.Transfer(alice, bob, transferAmount);
|
|
token.forcedTransfer(alice, bob, transferAmount);
|
|
|
|
// Frozen tokens should remain unchanged
|
|
assertEq(token.getFrozenTokens(alice), 200);
|
|
}
|
|
|
|
// ============ mint() Tests ============
|
|
|
|
/// @notice Should revert when sender is not an agent
|
|
function test_mint_RevertWhen_NotAgent() public {
|
|
vm.prank(alice);
|
|
vm.expectRevert(CallerDoesNotHaveAgentRole.selector);
|
|
token.mint(alice, 100);
|
|
}
|
|
|
|
/// @notice Should revert when agent permission is restricted
|
|
function test_mint_RevertWhen_AgentRestricted() public {
|
|
TokenRoles memory restrictions = TokenRoles({
|
|
disableMint: true,
|
|
disableBurn: false,
|
|
disablePartialFreeze: false,
|
|
disableAddressFreeze: false,
|
|
disableRecovery: false,
|
|
disableForceTransfer: false,
|
|
disablePause: false
|
|
});
|
|
|
|
vm.prank(deployer);
|
|
token.setAgentRestrictions(tokenAgent, restrictions);
|
|
|
|
vm.prank(tokenAgent);
|
|
vm.expectRevert(abi.encodeWithSelector(AgentNotAuthorized.selector, tokenAgent, "mint disabled"));
|
|
token.mint(alice, 100);
|
|
}
|
|
|
|
/// @notice Should revert when recipient identity is not verified
|
|
function test_mint_RevertWhen_RecipientNotVerified() public {
|
|
vm.prank(tokenAgent);
|
|
vm.expectRevert();
|
|
token.mint(another, 100);
|
|
}
|
|
|
|
/// @notice Should revert when the mint breaks compliance rules
|
|
function test_mint_RevertWhen_ComplianceBreaks() public {
|
|
(ModularCompliance compliance, TestModule testModule) = _deployComplianceSetup();
|
|
|
|
vm.prank(deployer);
|
|
token.setCompliance(address(compliance));
|
|
|
|
// Block transfers in module
|
|
bytes memory blockModuleCall = abi.encodeWithSignature("blockModule(bool)", true);
|
|
vm.prank(deployer);
|
|
compliance.callModuleFunction(blockModuleCall, address(testModule));
|
|
|
|
vm.prank(tokenAgent);
|
|
vm.expectRevert();
|
|
token.mint(alice, 100);
|
|
}
|
|
|
|
// ============ burn() Tests ============
|
|
|
|
/// @notice Should revert when sender is not an agent
|
|
function test_burn_RevertWhen_NotAgent() public {
|
|
vm.prank(alice);
|
|
vm.expectRevert(CallerDoesNotHaveAgentRole.selector);
|
|
token.burn(alice, 100);
|
|
}
|
|
|
|
/// @notice Should revert when agent permission is restricted
|
|
function test_burn_RevertWhen_AgentRestricted() public {
|
|
TokenRoles memory restrictions = TokenRoles({
|
|
disableMint: false,
|
|
disableBurn: true,
|
|
disablePartialFreeze: false,
|
|
disableAddressFreeze: false,
|
|
disableRecovery: false,
|
|
disableForceTransfer: false,
|
|
disablePause: false
|
|
});
|
|
|
|
vm.prank(deployer);
|
|
token.setAgentRestrictions(tokenAgent, restrictions);
|
|
|
|
vm.prank(tokenAgent);
|
|
vm.expectRevert(abi.encodeWithSelector(AgentNotAuthorized.selector, tokenAgent, "burn disabled"));
|
|
token.burn(alice, 100);
|
|
}
|
|
|
|
/// @notice Should revert when source wallet has not enough balance
|
|
function test_burn_RevertWhen_InsufficientBalance() public {
|
|
uint256 balance = token.balanceOf(alice);
|
|
|
|
vm.prank(tokenAgent);
|
|
vm.expectRevert(abi.encodeWithSelector(ERC20InsufficientBalance.selector, alice, balance, balance + 1000));
|
|
token.burn(alice, balance + 1000);
|
|
}
|
|
|
|
/// @notice Should burn and decrease frozen balance when amount to burn is greater than unfrozen balance
|
|
function test_burn_Success_DecreasesFrozenBalance() public {
|
|
uint256 balance = token.balanceOf(alice);
|
|
vm.prank(tokenAgent);
|
|
token.freezePartialTokens(alice, balance - 100);
|
|
|
|
uint256 burnAmount = balance - 50;
|
|
vm.prank(tokenAgent);
|
|
vm.expectEmit(true, true, false, false, address(token));
|
|
emit IERC20.Transfer(alice, address(0), burnAmount);
|
|
token.burn(alice, burnAmount);
|
|
|
|
// Check frozen tokens (event order may vary)
|
|
assertEq(token.getFrozenTokens(alice), 50);
|
|
}
|
|
|
|
// ============ freezePartialTokens() Tests ============
|
|
|
|
/// @notice Should revert when sender is not an agent
|
|
function test_freezePartialTokens_RevertWhen_NotAgent() public {
|
|
vm.prank(alice);
|
|
vm.expectRevert(CallerDoesNotHaveAgentRole.selector);
|
|
token.freezePartialTokens(alice, 100);
|
|
}
|
|
|
|
/// @notice Should revert when agent permission is restricted
|
|
function test_freezePartialTokens_RevertWhen_AgentRestricted() public {
|
|
TokenRoles memory restrictions = TokenRoles({
|
|
disableMint: false,
|
|
disableBurn: false,
|
|
disablePartialFreeze: true,
|
|
disableAddressFreeze: false,
|
|
disableRecovery: false,
|
|
disableForceTransfer: false,
|
|
disablePause: false
|
|
});
|
|
|
|
vm.prank(deployer);
|
|
token.setAgentRestrictions(tokenAgent, restrictions);
|
|
|
|
vm.prank(tokenAgent);
|
|
vm.expectRevert(abi.encodeWithSelector(AgentNotAuthorized.selector, tokenAgent, "partial freeze disabled"));
|
|
token.freezePartialTokens(alice, 100);
|
|
}
|
|
|
|
// ============ unfreezePartialTokens() Tests ============
|
|
|
|
/// @notice Should revert when sender is not an agent
|
|
function test_unfreezePartialTokens_RevertWhen_NotAgent() public {
|
|
vm.prank(alice);
|
|
vm.expectRevert(CallerDoesNotHaveAgentRole.selector);
|
|
token.unfreezePartialTokens(alice, 100);
|
|
}
|
|
|
|
/// @notice Should revert when agent permission is restricted
|
|
function test_unfreezePartialTokens_RevertWhen_AgentRestricted() public {
|
|
// Freeze some tokens first (before restrictions are set)
|
|
vm.prank(tokenAgent);
|
|
token.freezePartialTokens(alice, 200);
|
|
|
|
// Now set restrictions to disable partial freeze
|
|
TokenRoles memory restrictions = TokenRoles({
|
|
disableMint: false,
|
|
disableBurn: false,
|
|
disablePartialFreeze: true,
|
|
disableAddressFreeze: false,
|
|
disableRecovery: false,
|
|
disableForceTransfer: false,
|
|
disablePause: false
|
|
});
|
|
|
|
vm.prank(deployer);
|
|
token.setAgentRestrictions(tokenAgent, restrictions);
|
|
|
|
// Now try to unfreeze, should revert because partial freeze is disabled
|
|
vm.prank(tokenAgent);
|
|
vm.expectRevert(abi.encodeWithSelector(AgentNotAuthorized.selector, tokenAgent, "partial freeze disabled"));
|
|
token.unfreezePartialTokens(alice, 100);
|
|
}
|
|
|
|
/// @notice Should revert when amount exceeds frozen tokens
|
|
function test_unfreezePartialTokens_RevertWhen_AmountExceedsFrozen() public {
|
|
vm.prank(tokenAgent);
|
|
token.freezePartialTokens(alice, 200);
|
|
|
|
vm.prank(tokenAgent);
|
|
vm.expectRevert(abi.encodeWithSelector(AmountAboveFrozenTokens.selector, 5000, 200));
|
|
token.unfreezePartialTokens(alice, 5000);
|
|
}
|
|
|
|
/// @notice Should unfreeze when freeze amount does not exceed the balance
|
|
function test_unfreezePartialTokens_Success() public {
|
|
vm.prank(tokenAgent);
|
|
token.freezePartialTokens(alice, 200);
|
|
|
|
vm.prank(tokenAgent);
|
|
vm.expectEmit(true, false, false, false, address(token));
|
|
emit TokensUnfrozen(alice, 100);
|
|
token.unfreezePartialTokens(alice, 100);
|
|
}
|
|
|
|
// ============ setAllowanceForAll() / Default Allowance Tests ============
|
|
|
|
/// @notice Should only allow the owner to set default allowances
|
|
function test_setAllowanceForAll_OnlyOwner() public {
|
|
address[] memory targets = new address[](1);
|
|
targets[0] = bob;
|
|
|
|
vm.prank(alice);
|
|
vm.expectRevert(abi.encodeWithSelector(Ownable.OwnableUnauthorizedAccount.selector, alice));
|
|
token.setAllowanceForAll(true, targets);
|
|
|
|
vm.prank(deployer);
|
|
token.setAllowanceForAll(true, targets);
|
|
|
|
// Verify default allowance is set
|
|
assertEq(token.allowance(alice, bob), type(uint256).max);
|
|
}
|
|
|
|
/// @notice Should revert if default allowance is already set for a target
|
|
function test_setAllowanceForAll_RevertWhen_AlreadySet() public {
|
|
address[] memory targets = new address[](1);
|
|
targets[0] = bob;
|
|
|
|
vm.prank(deployer);
|
|
token.setAllowanceForAll(true, targets);
|
|
|
|
vm.prank(deployer);
|
|
vm.expectRevert(abi.encodeWithSelector(bytes4(keccak256("DefaultAllowanceAlreadySet(address)")), bob));
|
|
token.setAllowanceForAll(true, targets);
|
|
}
|
|
|
|
/// @notice Should allow transfer without explicit allowance for addresses with default allowance
|
|
function test_setAllowanceForAll_AllowsTransferWithoutAllowance() public {
|
|
address[] memory targets = new address[](1);
|
|
targets[0] = bob;
|
|
|
|
vm.prank(alice);
|
|
vm.expectRevert();
|
|
token.transferFrom(alice, bob, 100);
|
|
|
|
vm.prank(deployer);
|
|
token.setAllowanceForAll(true, targets);
|
|
|
|
vm.prank(bob);
|
|
vm.expectEmit(true, true, false, false, address(token));
|
|
emit IERC20.Transfer(alice, bob, 100);
|
|
token.transferFrom(alice, bob, 100);
|
|
}
|
|
|
|
/// @notice Should allow users to opt out of default allowance
|
|
function test_setAllowanceForAll_OptOut() public {
|
|
address[] memory targets = new address[](1);
|
|
targets[0] = bob;
|
|
|
|
vm.prank(deployer);
|
|
token.setAllowanceForAll(true, targets);
|
|
|
|
vm.prank(bob);
|
|
token.transferFrom(alice, bob, 100);
|
|
|
|
vm.prank(alice);
|
|
token.disableDefaultAllowance();
|
|
|
|
// Verify default allowance is disabled
|
|
vm.prank(bob);
|
|
vm.expectRevert();
|
|
token.transferFrom(alice, bob, 100);
|
|
|
|
vm.prank(alice);
|
|
token.enableDefaultAllowance();
|
|
|
|
// Verify default allowance is re-enabled
|
|
vm.prank(bob);
|
|
vm.expectEmit(true, true, false, false, address(token));
|
|
emit IERC20.Transfer(alice, bob, 100);
|
|
token.transferFrom(alice, bob, 100);
|
|
}
|
|
|
|
/// @notice Should revert if a user tries to disable an already disabled default allowance
|
|
function test_disableDefaultAllowance_RevertWhen_AlreadyDisabled() public {
|
|
vm.prank(alice);
|
|
token.disableDefaultAllowance();
|
|
|
|
vm.prank(alice);
|
|
vm.expectRevert(abi.encodeWithSelector(bytes4(keccak256("DefaultAllowanceAlreadyDisabled(address)")), alice));
|
|
token.disableDefaultAllowance();
|
|
}
|
|
|
|
/// @notice Should revert if a user tries to enable an already enabled default allowance
|
|
function test_enableDefaultAllowance_RevertWhen_AlreadyEnabled() public {
|
|
vm.prank(alice);
|
|
token.disableDefaultAllowance();
|
|
vm.prank(alice);
|
|
token.enableDefaultAllowance();
|
|
|
|
vm.prank(alice);
|
|
vm.expectRevert(abi.encodeWithSelector(bytes4(keccak256("DefaultAllowanceAlreadyEnabled(address)")), alice));
|
|
token.enableDefaultAllowance();
|
|
}
|
|
|
|
/// @notice Should return max uint256 as allowance for addresses with default allowance when user has not opted out
|
|
function test_allowance_ReturnsMaxUint256_WhenDefaultAllowanceSet() public {
|
|
address[] memory targets = new address[](1);
|
|
targets[0] = bob;
|
|
|
|
vm.prank(deployer);
|
|
token.setAllowanceForAll(true, targets);
|
|
|
|
assertEq(token.allowance(alice, bob), type(uint256).max);
|
|
}
|
|
|
|
/// @notice Should return actual allowance when user has opted out of default allowance
|
|
function test_allowance_ReturnsActual_WhenOptedOut() public {
|
|
address[] memory targets = new address[](1);
|
|
targets[0] = bob;
|
|
|
|
vm.prank(deployer);
|
|
token.setAllowanceForAll(true, targets);
|
|
vm.prank(alice);
|
|
token.disableDefaultAllowance();
|
|
|
|
assertEq(token.allowance(alice, bob), 0);
|
|
}
|
|
|
|
/// @notice Should return actual allowance when default allowance is not enabled (covers branch: !_defaultAllowances[_spender])
|
|
function test_allowance_ReturnsActual_WhenDefaultAllowanceNotEnabled() public {
|
|
// No default allowance set, should return actual allowance
|
|
vm.prank(alice);
|
|
token.approve(bob, 100);
|
|
assertEq(token.allowance(alice, bob), 100);
|
|
}
|
|
|
|
/// @notice Should revert when array size exceeds 100
|
|
function test_setAllowanceForAll_RevertWhen_ArraySizeExceeds100() public {
|
|
address[] memory targets = new address[](101);
|
|
for (uint256 i = 0; i < 101; i++) {
|
|
targets[i] = makeAddr(string(abi.encodePacked("target", i)));
|
|
}
|
|
|
|
vm.prank(deployer);
|
|
vm.expectRevert(abi.encodeWithSelector(bytes4(keccak256("ArraySizeLimited(uint256)")), 100));
|
|
token.setAllowanceForAll(true, targets);
|
|
}
|
|
|
|
// ============ batchForcedTransfer() Tests ============
|
|
|
|
/// @notice Should perform batch forced transfers
|
|
function test_batchForcedTransfer_Success() public {
|
|
address[] memory fromList = new address[](2);
|
|
fromList[0] = alice;
|
|
fromList[1] = alice;
|
|
address[] memory toList = new address[](2);
|
|
toList[0] = bob;
|
|
toList[1] = bob;
|
|
uint256[] memory amounts = new uint256[](2);
|
|
amounts[0] = 100;
|
|
amounts[1] = 200;
|
|
|
|
vm.prank(tokenAgent);
|
|
vm.expectEmit(true, true, false, false, address(token));
|
|
emit IERC20.Transfer(alice, bob, 100);
|
|
vm.expectEmit(true, true, false, false, address(token));
|
|
emit IERC20.Transfer(alice, bob, 200);
|
|
token.batchForcedTransfer(fromList, toList, amounts);
|
|
|
|
assertEq(token.balanceOf(bob), 500 + 300);
|
|
}
|
|
|
|
// ============ batchMint() Tests ============
|
|
|
|
/// @notice Should perform batch minting
|
|
function test_batchMint_Success() public {
|
|
address[] memory toList = new address[](2);
|
|
toList[0] = alice;
|
|
toList[1] = bob;
|
|
uint256[] memory amounts = new uint256[](2);
|
|
amounts[0] = 100;
|
|
amounts[1] = 200;
|
|
|
|
vm.prank(tokenAgent);
|
|
vm.expectEmit(true, true, false, false, address(token));
|
|
emit IERC20.Transfer(address(0), alice, 100);
|
|
vm.expectEmit(true, true, false, false, address(token));
|
|
emit IERC20.Transfer(address(0), bob, 200);
|
|
token.batchMint(toList, amounts);
|
|
|
|
assertEq(token.balanceOf(alice), 1000 + 100);
|
|
assertEq(token.balanceOf(bob), 500 + 200);
|
|
}
|
|
|
|
// ============ batchBurn() Tests ============
|
|
|
|
/// @notice Should perform batch burning
|
|
function test_batchBurn_Success() public {
|
|
address[] memory userAddresses = new address[](2);
|
|
userAddresses[0] = alice;
|
|
userAddresses[1] = bob;
|
|
uint256[] memory amounts = new uint256[](2);
|
|
amounts[0] = 100;
|
|
amounts[1] = 200;
|
|
|
|
vm.prank(tokenAgent);
|
|
vm.expectEmit(true, true, false, false, address(token));
|
|
emit IERC20.Transfer(alice, address(0), 100);
|
|
vm.expectEmit(true, true, false, false, address(token));
|
|
emit IERC20.Transfer(bob, address(0), 200);
|
|
token.batchBurn(userAddresses, amounts);
|
|
|
|
assertEq(token.balanceOf(alice), 1000 - 100);
|
|
assertEq(token.balanceOf(bob), 500 - 200);
|
|
}
|
|
|
|
// ============ Zero Address Checks (via internal functions) ============
|
|
|
|
/// @notice Should revert when trying to approve zero address (tests _approve internal)
|
|
function test_approve_RevertWhen_ZeroSpender() public {
|
|
vm.prank(alice);
|
|
vm.expectRevert(abi.encodeWithSelector(ERC20InvalidSpender.selector, address(0)));
|
|
token.approve(address(0), 100);
|
|
}
|
|
|
|
}
|