mirror of
https://github.com/luxfi/erc-3643.git
synced 2026-10-30 16:58:28 +00:00
Mohamad HammoudandGitHub
94182deb9c
* ✨ 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
138 lines
7.0 KiB
Solidity
138 lines
7.0 KiB
Solidity
// SPDX-License-Identifier: CC0-1.0
|
|
//
|
|
// :+#####%%%%%%%%%%%%%%+
|
|
// .-*@@@%+.:+%@@@@@%%#***%@@%=
|
|
// :=*%@@@#=. :#@@% *@@@%=
|
|
// .-+*%@%*-.:+%@@@@@@+. -*+: .=#. :%@@@%-
|
|
// :=*@@@@%%@@@@@@@@@%@@@- .=#@@@%@%= =@@@@#.
|
|
// -=+#%@@%#*=:. :%@@@@%. -*@@#*@@@@@@@#=:- *@@@@+
|
|
// =@@%=:. :=: *@@@@@%#- =%*%@@@@#+-. =+ :%@@@%-
|
|
// -@@%. .+@@@ =+=-. @@#- +@@@%- =@@@@%:
|
|
// :@@@. .+@@#%: : .=*=-::.-%@@@+*@@= +@@@@#.
|
|
// %@@: +@%%* =%@@@@@@@@@@@#. .*@%- +@@@@*.
|
|
// #@@= .+@@@@%:=*@@@@@- :%@%: .*@@@@+
|
|
// *@@* +@@@#-@@%-:%@@* +@@#. :%@@@@-
|
|
// -@@% .:-=++*##%%%@@@@@@@@@@@@*. :@+.@@@%: .#@@+ =@@@@#:
|
|
// .@@@*-+*#%%%@@@@@@@@@@@@@@@@%%#**@@%@@@. *@=*@@# :#@%= .#@@@@#-
|
|
// -%@@@@@@@@@@@@@@@*+==-:-@@@= *@# .#@*-=*@@@@%= -%@@@* =@@@@@%-
|
|
// -+%@@@#. %@%%= -@@:+@: -@@* *@@*-:: -%@@%=. .*@@@@@#
|
|
// *@@@* +@* *@@##@@- #@*@@+ -@@= . :+@@@#: .-+@@@%+-
|
|
// +@@@%*@@:..=@@@@* .@@@* .#@#. .=+- .=%@@@*. :+#@@@@*=:
|
|
// =@@@@%@@@@@@@@@@@@@@@@@@@@@@%- :+#*. :*@@@%=. .=#@@@@%+:
|
|
// .%@@= ..... .=#@@+. .#@@@*: -*%@@@@%+.
|
|
// +@@#+===---:::... .=%@@*- +@@@+. -*@@@@@%+.
|
|
// -@@@@@@@@@@@@@@@@@@@@@@%@@@@= -@@@+ -#@@@@@#=.
|
|
// ..:::---===+++***###%%%@@@#- .#@@+ -*@@@@@#=.
|
|
// @@@@@@+. +@@*. .+@@@@@%=.
|
|
// -@@@@@= =@@%: -#@@@@%+.
|
|
// +@@@@@. =@@@= .+@@@@@*:
|
|
// #@@@@#:%@@#. :*@@@@#-
|
|
// @@@@@%@@@= :#@@@@+.
|
|
// :@@@@@@@#.:#@@@%-
|
|
// +@@@@@@-.*@@@*:
|
|
// #@@@@#.=@@@+.
|
|
// @@@@+-%@%=
|
|
// :@@@#%@%=
|
|
// +@@@@%-
|
|
// :#%%=
|
|
//
|
|
pragma solidity 0.8.30;
|
|
|
|
/// Events
|
|
|
|
/// @dev This event is emitted when a token has been bound to the compliance contract.
|
|
/// @param _token is the address of the token to bind.
|
|
event TokenBound(address _token);
|
|
|
|
/// @dev This event is emitted when a token has been unbound from the compliance contract.
|
|
/// @param _token is the address of the token to unbind.
|
|
event TokenUnbound(address _token);
|
|
|
|
interface IERC3643Compliance {
|
|
|
|
/// Functions
|
|
/// initialization of the compliance contract
|
|
/**
|
|
* @dev binds a token to the compliance contract
|
|
* @param _token address of the token to bind
|
|
* This function can be called ONLY by the owner of the compliance contract
|
|
* Emits a TokenBound event
|
|
*/
|
|
function bindToken(address _token) external;
|
|
|
|
/**
|
|
* @dev unbinds a token from the compliance contract
|
|
* @param _token address of the token to unbind
|
|
* This function can be called ONLY by the owner of the compliance contract
|
|
* Emits a TokenUnbound event
|
|
*/
|
|
function unbindToken(address _token) external;
|
|
|
|
// compliance check and state update
|
|
/**
|
|
* @dev function called whenever tokens are transferred
|
|
* from one wallet to another
|
|
* this function can update state variables in the modules bound to the compliance
|
|
* these state variables being used by the module checks to decide if a transfer
|
|
* is compliant or not depending on the values stored in these state variables and on
|
|
* the parameters of the modules
|
|
* This function can be called ONLY by the token contract bound to the compliance
|
|
* @param _from The address of the sender
|
|
* @param _to The address of the receiver
|
|
* @param _amount The amount of tokens involved in the transfer
|
|
* This function calls moduleTransferAction() on each module bound to the compliance contract
|
|
*/
|
|
function transferred(address _from, address _to, uint256 _amount) external;
|
|
|
|
/**
|
|
* @dev function called whenever tokens are created on a wallet
|
|
* this function can update state variables in the modules bound to the compliance
|
|
* these state variables being used by the module checks to decide if a transfer
|
|
* is compliant or not depending on the values stored in these state variables and on
|
|
* the parameters of the modules
|
|
* This function can be called ONLY by the token contract bound to the compliance
|
|
* @param _to The address of the receiver
|
|
* @param _amount The amount of tokens involved in the minting
|
|
* This function calls moduleMintAction() on each module bound to the compliance contract
|
|
*/
|
|
function created(address _to, uint256 _amount) external;
|
|
|
|
/**
|
|
* @dev function called whenever tokens are destroyed from a wallet
|
|
* this function can update state variables in the modules bound to the compliance
|
|
* these state variables being used by the module checks to decide if a transfer
|
|
* is compliant or not depending on the values stored in these state variables and on
|
|
* the parameters of the modules
|
|
* This function can be called ONLY by the token contract bound to the compliance
|
|
* @param _from The address on which tokens are burnt
|
|
* @param _amount The amount of tokens involved in the burn
|
|
* This function calls moduleBurnAction() on each module bound to the compliance contract
|
|
*/
|
|
function destroyed(address _from, uint256 _amount) external;
|
|
|
|
/**
|
|
* @dev checks that the transfer is compliant.
|
|
* default compliance always returns true
|
|
* READ ONLY FUNCTION, this function cannot be used to increment
|
|
* counters, emit events, ...
|
|
* @param _from The address of the sender
|
|
* @param _to The address of the receiver
|
|
* @param _amount The amount of tokens involved in the transfer
|
|
* This function will call moduleCheck() on every module bound to the compliance
|
|
* If each of the module checks return TRUE, this function will return TRUE as well
|
|
* returns FALSE otherwise
|
|
*/
|
|
function canTransfer(address _from, address _to, uint256 _amount) external view returns (bool);
|
|
|
|
/// check the parameters of the compliance contract
|
|
|
|
function isTokenBound(address _token) external view returns (bool);
|
|
|
|
/**
|
|
* @dev getter for the address of the token bound
|
|
* returns the address of the token
|
|
*/
|
|
function getTokenBound() external view returns (address);
|
|
|
|
}
|