```
-### Help
+#### Help
```shell
$ forge --help
$ anvil --help
$ cast --help
```
+
+
+
+## API
+
+### IRuleEngine
+
+> Each rule implements the IRuleEngine interface
+
+#### transferred
+
+```
+function transferred(address spender, address from, address to, uint256 value)
+ external;
+```
+
+Called during an ERC-20 token transfer
+ Used by rules to update internal state or enforce operation-based restrictions.
+
+##### Parameters
+
+| Name | Type | Description |
+| --------- | --------- | ------------------------------------------------------------ |
+| `spender` | `address` | Address executing the transfer (owner, operator, or approved). |
+| `from` | `address` | Current token holder. |
+| `to` | `address` | Recipient address. |
+| `value` | `uint256` | Amount transferred. |
+
+------
+
+### IERC1404
+
+#### detectTransferRestriction
+
+```
+function detectTransferRestriction(address from, address to, uint256 value)
+ external
+ view
+ returns (uint8);
+```
+
+Returns a restriction code describing why a transfer is blocked.
+
+##### Parameters
+
+| Name | Type | Description |
+| ------- | --------- | ------------------------- |
+| `from` | `address` | Sender address. |
+| `to` | `address` | Recipient address. |
+| `value` | `uint256` | Amount being transferred. |
+
+##### Returns
+
+| Name | Type | Description |
+| ----- | ------- | ---------------------------------------- |
+| `0` | `uint8` | Transfer allowed. |
+| other | `uint8` | Implementation-defined restriction code. |
+
+------
+
+#### messageForTransferRestriction
+
+```
+function messageForTransferRestriction(uint8 restrictionCode)
+ external
+ view
+ returns (string memory);
+```
+
+Returns a human-readable message associated with a restriction code.
+
+##### Parameters
+
+| Name | Type | Description |
+| ----------------- | ------- | --------------------------------------------------------- |
+| `restrictionCode` | `uint8` | Restriction code returned by `detectTransferRestriction`. |
+
+##### Returns
+
+| Name | Type | Description |
+| --------- | -------- | ------------------------------------- |
+| `message` | `string` | Explanation for the restriction code. |
+
+------
+
+### IERC1404Extend
+
+#### REJECTED_CODE_BASE
+
+```
+enum REJECTED_CODE_BASE {
+ TRANSFER_OK,
+ TRANSFER_REJECTED_DEACTIVATED,
+ TRANSFER_REJECTED_PAUSED,
+ TRANSFER_REJECTED_FROM_FROZEN,
+ TRANSFER_REJECTED_TO_FROZEN,
+ TRANSFER_REJECTED_SPENDER_FROZEN,
+ TRANSFER_REJECTED_FROM_INSUFFICIENT_ACTIVE_BALANCE
+}
+```
+
+Base transfer restriction codes used by ERC-1404 extensions.
+
+------
+
+#### detectTransferRestrictionFrom
+
+```
+function detectTransferRestrictionFrom(
+ address spender,
+ address from,
+ address to,
+ uint256 value
+)
+ external
+ view
+ returns (uint8);
+```
+
+Restriction code for transfers performed by a spender (approved operator).
+
+##### Parameters
+
+| Name | Type | Description |
+| --------- | --------- | -------------------------------- |
+| `spender` | `address` | Address performing the transfer. |
+| `from` | `address` | Current token owner. |
+| `to` | `address` | Recipient address. |
+| `value` | `uint256` | Transfer amount. |
+
+##### Returns
+
+| Name | Type | Description |
+| ------ | ------- | ---------------------------------------------------- |
+| `code` | `uint8` | 0 if transfer allowed, otherwise a restriction code. |
+
+------
+
+### IERC7551Compliance
+
+#### canTransferFrom
+
+```
+function canTransferFrom(address spender, address from, address to, uint256 value)
+ external
+ view
+ returns (bool);
+```
+
+Determines if a spender-initiated transfer is permitted.
+
+##### Parameters
+
+| Name | Type | Description |
+| --------- | --------- | -------------------------- |
+| `spender` | `address` | Caller executing transfer. |
+| `from` | `address` | Token owner. |
+| `to` | `address` | Recipient. |
+| `value` | `uint256` | Amount. |
+
+##### Returns
+
+| Name | Type | Description |
+| --------- | ------ | ----------------------------- |
+| `allowed` | `bool` | `true` if transfer permitted. |
+
+------
+
+### IERC3643ComplianceRead
+
+#### canTransfer
+
+```
+function canTransfer(address from, address to, uint256 value)
+ external
+ view
+ returns (bool isValid);
+```
+
+Returns whether a transfer is compliant.
+
+##### Parameters
+
+| Name | Type | Description |
+| ------- | --------- | ---------------- |
+| `from` | `address` | Sender. |
+| `to` | `address` | Receiver. |
+| `value` | `uint256` | Transfer amount. |
+
+##### Returns
+
+| Name | Type | Description |
+| --------- | ------ | -------------------- |
+| `isValid` | `bool` | `true` if compliant. |
+
+------
+
+### IERC3643IComplianceContract
+
+#### transferred
+
+```
+function transferred(address from, address to, uint256 value)
+ external;
+```
+
+Hook invoked during an ERC-20 token transfer.
+
+##### Parameters
+
+| Name | Type | Description |
+| ------- | --------- | ------------------- |
+| `from` | `address` | Previous owner. |
+| `to` | `address` | New owner. |
+| `value` | `uint256` | Amount transferred. |
+
+### Address List Management
+
+> This API is common to whitelist and blacklist rules
+
+#### addAddresses
+
+```
+function addAddresses(address[] calldata targetAddresses)
+ public
+ onlyRole(ADDRESS_LIST_ADD_ROLE)
+```
+
+##### Description
+
+Adds multiple addresses to the internal address set.
+
+##### Details
+
+- Does **not** revert if one or more addresses are already listed.
+- Restricted to callers holding the `ADDRESS_LIST_ADD_ROLE`.
+- Emits an `AddAddresses` event.
+
+##### Parameters
+
+| Name | Type | Description |
+| ----------------- | ----------- | ------------------------------------------ |
+| `targetAddresses` | `address[]` | Array of addresses to be added to the set. |
+
+------
+
+#### removeAddresses
+
+```
+function removeAddresses(address[] calldata targetAddresses)
+ public
+ onlyRole(ADDRESS_LIST_REMOVE_ROLE)
+```
+
+##### Description
+
+Removes multiple addresses from the internal set.
+
+##### Details
+
+- Does **not** revert if an address is not currently listed.
+- Restricted to callers holding the `ADDRESS_LIST_REMOVE_ROLE`.
+- Emits a `RemoveAddresses` event.
+
+##### Parameters
+
+| Name | Type | Description |
+| ----------------- | ----------- | --------------------------------- |
+| `targetAddresses` | `address[]` | Array of addresses to be removed. |
+
+------
+
+#### addAddress
+
+```
+function addAddress(address targetAddress)
+ public
+ onlyRole(ADDRESS_LIST_ADD_ROLE)
+```
+
+##### Description
+
+Adds a **single** address to the set.
+
+##### Details
+
+- **Reverts** if the address is already listed.
+- Restricted to callers holding the `ADDRESS_LIST_ADD_ROLE`.
+- Emits an `AddAddress` event.
+
+##### Parameters
+
+| Name | Type | Description |
+| --------------- | --------- | --------------- |
+| `targetAddress` | `address` | Address to add. |
+
+------
+
+#### removeAddress
+
+```
+function removeAddress(address targetAddress)
+ public
+ onlyRole(ADDRESS_LIST_REMOVE_ROLE)
+```
+
+##### Description
+
+Removes a **single** address from the set.
+
+##### Details
+
+- **Reverts** if the address is not listed.
+- Restricted to callers holding the `ADDRESS_LIST_REMOVE_ROLE`.
+- Emits a `RemoveAddress` event.
+
+##### Parameters
+
+| Name | Type | Description |
+| --------------- | --------- | ------------------ |
+| `targetAddress` | `address` | Address to remove. |
+
+------
+
+#### listedAddressCount
+
+```
+function listedAddressCount() public view returns (uint256 count)
+```
+
+##### Description
+
+Returns the total number of addresses currently listed in the internal set.
+
+##### Returns
+
+| Name | Type | Description |
+| ------- | --------- | --------------------------------- |
+| `count` | `uint256` | Total number of listed addresses. |
+
+------
+
+##### contains
+
+```
+function contains(address targetAddress)
+ public
+ view
+ override(IIdentityRegistryContains)
+ returns (bool isListed)
+```
+
+##### Description
+
+Checks whether a specific address is listed.
+ Implements `IIdentityRegistryContains`.
+
+##### Parameters
+
+| Name | Type | Description |
+| --------------- | --------- | ----------------- |
+| `targetAddress` | `address` | Address to check. |
+
+##### Returns
+
+| Name | Type | Description |
+| ---------- | ------ | --------------------------------------------------- |
+| `isListed` | `bool` | `true` if the address is listed, otherwise `false`. |
+
+------
+
+#### isAddressListed
+
+```
+function isAddressListed(address targetAddress)
+ public
+ view
+ returns (bool isListed)
+```
+
+##### Description
+
+Returns whether a given address is included in the internal set.
+
+##### Parameters
+
+| Name | Type | Description |
+| --------------- | --------- | ----------------- |
+| `targetAddress` | `address` | Address to check. |
+
+##### Returns
+
+| Name | Type | Description |
+| ---------- | ------ | --------------- |
+| `isListed` | `bool` | Listing status. |
+
+------
+
+#### areAddressesListed
+
+```
+function areAddressesListed(address[] memory targetAddresses)
+ public
+ view
+ returns (bool[] memory results)
+```
+
+##### Description
+
+Checks the listing status of multiple addresses in a single call.
+
+##### Parameters
+
+| Name | Type | Description |
+| ----------------- | ----------- | ---------------------------- |
+| `targetAddresses` | `address[]` | Array of addresses to check. |
+
+##### Returns
+
+| Name | Type | Description |
+| --------- | -------- | --------------------------------------------------- |
+| `results` | `bool[]` | Array of boolean listing results, aligned by index. |
+
+#### Details
+
+##### Null address
+
+It is possible to add the null address (0x0) to the blacklist. If it is the case, it will not be possible to mint and burn tokens.
+
+##### Duplicate address
+
+**addAddress**
+If the address already exists, the transaction is reverted to save gas.
+**addAddresses**
+If one of addresses already exist, there is no change for this address. The transaction remains valid (no revert).
+
+##### NonExistent Address
+
+**removeAddress**
+If the address does not exist in the whitelist, the transaction is reverted to save gas.
+**removeAddresses**
+If the address does not exist in the whitelist, there is no change for this address. The transaction remains valid (no revert).
+
+
+
+### IERC7943NonFungibleCompliance
+
+Compliance interface for ERC-721 / ERC-1155–style non-fungible assets.
+ For ERC-721, `amount` must always be `1`.
+
+------
+
+#### Functions
+
+| Name | Description |
+| --------------- | ------------------------------------------------------------ |
+| **canTransfer** | Verifies whether a transfer is permitted according to the token’s compliance rules. |
+
+------
+
+#### canTransfer
+
+```
+function canTransfer(
+ address from,
+ address to,
+ uint256 tokenId,
+ uint256 amount
+) external view returns (bool allowed)
+```
+
+##### Description
+
+Verifies whether a token transfer is permitted according to the rule-based compliance logic.
+
+##### Details
+
+- Must not modify state.
+- May enforce checks such as allowlists, blocklists, freezing, transfer limits, regulatory rules.
+- Must return `false` if the transfer is not permitted.
+
+##### Parameters
+
+| Name | Type | Description |
+| --------- | --------- | ----------------------------------------- |
+| `from` | `address` | Current token owner. |
+| `to` | `address` | Receiving address. |
+| `tokenId` | `uint256` | Token ID. |
+| `amount` | `uint256` | Transfer amount (always `1` for ERC-721). |
+
+##### Returns
+
+| Name | Type | Description |
+| --------- | ------ | ------------------------------------------------- |
+| `allowed` | `bool` | `true` if transfer is allowed; otherwise `false`. |
+
+------
+
+### IERC7943NonFungibleComplianceExtend
+
+Extended compliance interface for ERC-721 / ERC-1155 non-fungible assets.
+ Adds restriction-code reporting, spender-aware checks, and a post-transfer hook.
+
+For ERC-721, `amount` / `value` must always be `1`.
+
+------
+
+#### Functions
+
+| Name | Description |
+| --------------------------------- | ------------------------------------------------------------ |
+| **detectTransferRestriction** | Returns a restriction code indicating why a transfer is blocked. |
+| **detectTransferRestrictionFrom** | Returns a restriction code for a spender-initiated transfer. |
+| **canTransferFrom** | Checks whether a spender-initiated transfer is allowed. |
+| **transferred** | Notifies the compliance engine that a transfer has occurred. |
+
+------
+
+#### detectTransferRestriction
+
+```
+function detectTransferRestriction(
+ address from,
+ address to,
+ uint256 tokenId,
+ uint256 amount
+) external view returns (uint8 code)
+```
+
+##### Description
+
+Returns a restriction code describing whether and why a transfer is blocked.
+
+##### Details
+
+- Must not modify state.
+- Must return `0` when the transfer is allowed.
+- Non-zero codes should follow ERC-1404 or similar standards.
+
+##### Parameters
+
+| Name | Type | Description |
+| --------- | --------- | ---------------------------------- |
+| `from` | `address` | Current token holder. |
+| `to` | `address` | Receiving address. |
+| `tokenId` | `uint256` | Token ID. |
+| `amount` | `uint256` | Transfer amount (`1` for ERC-721). |
+
+##### Returns
+
+| Name | Type | Description |
+| ------ | ------- | --------------------------------------------- |
+| `code` | `uint8` | `0` if allowed; otherwise a restriction code. |
+
+------
+
+#### detectTransferRestrictionFrom
+
+```
+function detectTransferRestrictionFrom(
+ address spender,
+ address from,
+ address to,
+ uint256 tokenId,
+ uint256 value
+) external view returns (uint8 code)
+```
+
+##### Description
+
+Returns a restriction code for a transfer initiated by a spender (approved operator or owner).
+
+##### Details
+
+- Must not modify state.
+- Must return `0` when the transfer is permitted.
+
+##### Parameters
+
+| Name | Type | Description |
+| --------- | --------- | ---------------------------------- |
+| `spender` | `address` | Address performing the transfer. |
+| `from` | `address` | Current owner. |
+| `to` | `address` | Recipient address. |
+| `tokenId` | `uint256` | Token ID being checked. |
+| `value` | `uint256` | Transfer amount (`1` for ERC-721). |
+
+##### Returns
+
+| Name | Type | Description |
+| ------ | ------- | ------------------------------------------- |
+| `code` | `uint8` | `0` if allowed; otherwise restriction code. |
+
+------
+
+#### canTransferFrom
+
+```
+function canTransferFrom(
+ address spender,
+ address from,
+ address to,
+ uint256 tokenId,
+ uint256 value
+) external view returns (bool allowed)
+```
+
+##### Description
+
+Checks whether a spender-initiated transfer is allowed under the compliance rules.
+
+##### Details
+
+- Must not modify state.
+- Should internally use `detectTransferRestrictionFrom`.
+
+##### Parameters
+
+| Name | Type | Description |
+| --------- | --------- | ---------------------------------------- |
+| `spender` | `address` | Address executing the transfer. |
+| `from` | `address` | Current owner. |
+| `to` | `address` | Recipient. |
+| `tokenId` | `uint256` | Token ID. |
+| `value` | `uint256` | Transfer amount (`1` for ERC-721 token). |
+
+##### Returns
+
+| Name | Type | Description |
+| --------- | ------ | ------------------------------ |
+| `allowed` | `bool` | `true` if transfer is allowed. |
+
+------
+
+#### transferred
+
+```
+function transferred(
+ address spender,
+ address from,
+ address to,
+ uint256 tokenId,
+ uint256 value
+) external
+```
+
+##### Description
+
+Signals to the compliance engine that a transfer has successfully occurred.
+
+##### Details
+
+- May modify compliance state.
+- Must be called by the token contract after a successful transfer.
+- Must revert if invoked by unauthorized callers.
+
+##### Parameters
+
+| Name | Type | Description |
+| --------- | --------- | ---------------------------------------- |
+| `spender` | `address` | Address executing the transfer. |
+| `from` | `address` | Previous owner. |
+| `to` | `address` | New owner. |
+| `tokenId` | `uint256` | Token transferred. |
+| `value` | `uint256` | Transfer amount (`1` for ERC-721 token). |
+
+### RuleSanctionsList
+
+Compliance rule enforcing sanctions-screening for token transfers.
+ Integrates a sanctions-oracle (e.g., Chainalysis) to block transfers when the sender, recipient, or spender is sanctioned.
+
+------
+
+#### Constructor
+
+```solidity
+constructor(address admin, address forwarderIrrevocable, ISanctionsList sanctionContractOracle_)
+```
+
+Initializes access control, meta-transaction forwarder, and optionally the sanctions oracle.
+
+#### setSanctionListOracle
+
+```solidity
+function setSanctionListOracle(ISanctionsList sanctionContractOracle_)
+ public
+ virtual
+ onlyRole(SANCTIONLIST_ROLE)
+```
+
+Set the sanctions-oracle contract used for transfer-restriction checks.
+
+##### Parameters
+
+| Name | Type | Description |
+| ------------------------- | ---------------- | ------------------------------------------------------------ |
+| `sanctionContractOracle_` | `ISanctionsList` | Address of the sanctions-oracle. Passing the zero address disables sanctions checks. |
+
+##### Description
+
+Updates the sanctions-oracle contract reference.
+ This function may only be called by accounts granted the `SANCTIONLIST_ROLE`.
+
+Setting the oracle to the zero address is permitted and effectively disables all sanctions-based transfer restrictions.
+
+##### Emits
+
+| Event | Description |
+| -------------------------------- | ----------------------------------------------------- |
+| `SetSanctionListOracle(address)` | Emitted when the sanctions-oracle address is updated. |
+
+
+
+## Intellectual property
+
+The code is copyright (c) Capital Market and Technology Association, 2022-2025, and is released under [Mozilla Public License 2.0](https://github.com/CMTA/CMTAT/blob/master/LICENSE.md).
diff --git a/doc/TOOLCHAIN.md b/doc/TOOLCHAIN.md
index f5d9cc1..64b6246 100644
--- a/doc/TOOLCHAIN.md
+++ b/doc/TOOLCHAIN.md
@@ -53,14 +53,6 @@ Warning:
## Generate documentation
-### [docgen](https://github.com/OpenZeppelin/solidity-docgen)
-
->Solidity-docgen is a program that extracts documentation for a Solidity project.
-
-```
-npx hardhat docgen
-```
-
### [sol2uml](https://github.com/naddison36/sol2uml)
>Generate UML for smart contracts
@@ -131,21 +123,9 @@ slither . --checklist --filter-paths "openzeppelin-contracts|test|CMTAT|forge-s
## Code style guidelines
-We use the following tools to ensure consistent coding style:
-
-[Prettier](https://github.com/prettier-solidity/prettier-plugin-solidity)
+We use `Foundry` to perform code style guidelines
-```
-npm run-script lint:sol:prettier
-```
-
-[Ethlint / Solium](https://github.com/duaraghav8/Ethlint)
-
-```
-npm run-script lint:sol
-npm run-script lint:sol:fix
-npm run-script lint:sol:test
-npm run-script lint:sol:test:fix
+```bash
+forge fmt
```
-The related components can be installed with `npm install` (see [package.json](./package.json)).
diff --git a/doc/codelist.md b/doc/codelist.md
deleted file mode 100644
index 2ad6da6..0000000
--- a/doc/codelist.md
+++ /dev/null
@@ -1,20 +0,0 @@
-# Rule - Code list
-
-> It is very important that each rule uses an unique code
-
-Here the list of codes used by the different rules
-
-| Contract | Constant name | Value |
-| ----------------------- | ---------------------------------- | ----- |
-| All | TRANSFER_OK (from CMTAT) | 0 |
-| RuleWhitelist | CODE_ADDRESS_FROM_NOT_WHITELISTED | 21 |
-| RuleWhitelist | CODE_ADDRESS_TO_NOT_WHITELISTED | 22 |
-| RuleSanctionList | CODE_ADDRESS_FROM_IS_SANCTIONED | 31 |
-| RuleSanctionList | CODE_ADDRESS_TO_IS_SANCTIONED | 32 |
-| RuleBlacklist | CODE_ADDRESS_FROM_IS_BLACKLISTED | 41 |
-| RuleBlacklist | CODE_ADDRESS_TO_IS_BLACKLISTED | 42 |
-| RuleConditionalTransfer | CODE_TRANSFER_REQUEST_NOT_APPROVED | 51 |
-
-
-
-Warning: the CMTAT already uses the code 0-4 and the code 5-9 should be left free to allow further additions in the CMTAT
diff --git a/doc/coverage/coverage/src/rules/validation/abstract/RuleWhitelistCommon.sol.func.html b/doc/coverage/coverage/home/ryan/Pictures/dev/Rules/src/modules/AccessControlModuleStandalone.sol.func-sort-c.html
similarity index 58%
rename from doc/coverage/coverage/src/rules/validation/abstract/RuleWhitelistCommon.sol.func.html
rename to doc/coverage/coverage/home/ryan/Pictures/dev/Rules/src/modules/AccessControlModuleStandalone.sol.func-sort-c.html
index b899bc1..5ee975a 100644
--- a/doc/coverage/coverage/src/rules/validation/abstract/RuleWhitelistCommon.sol.func.html
+++ b/doc/coverage/coverage/home/ryan/Pictures/dev/Rules/src/modules/AccessControlModuleStandalone.sol.func-sort-c.html
@@ -4,22 +4,22 @@
LCOV - lcov.info - src/rules/validation/abstract/RuleWhitelistCommon.sol - functions
- LCOV - lcov.info - /home/ryan/Pictures/dev/Rules/src/modules/AccessControlModuleStandalone.sol - functions
+
LCOV - code coverage report
-
+
-
+
-
-
LCOV - lcov.info - src/rules/validation/abstract/RuleWhitelistCommon.sol - functions
- LCOV - lcov.info - /home/ryan/Pictures/dev/Rules/src/modules/AccessControlModuleStandalone.sol - functions
+
LCOV - code coverage report
-
+
-
+
-
-
LCOV - lcov.info - src/rules/validation/abstract/RuleWhitelistCommon.sol
- LCOV - lcov.info - /home/ryan/Pictures/dev/Rules/src/modules/AccessControlModuleStandalone.sol
+
LCOV - code coverage report
-
+
-
+
-
-
@@ -69,47 +69,52 @@
Branch data Line data Source code
- 1 : : // SPDX-License-Identifier: MPL-2.0 1 : : //SPDX-License-Identifier: MPL-2.0 2 : : 3 : : pragma solidity ^0.8.20; 4 : : 5 : : import "./RuleAddressList/invariantStorage/RuleWhitelistInvariantStorage.sol"; 6 : : import "./RuleValidateTransfer.sol"; 5 : : /* ==== OpenZeppelin === */ 6 : : import {AccessControl} from "OZ/access/AccessControl.sol"; 7 : : 8 : : abstract contract RuleWhitelistCommon is 9 : : RuleValidateTransfer, 10 : : RuleWhitelistInvariantStorage 11 : : { 12 : : /** 13 : : * @notice To know if the restriction code is valid for this rule or not 14 : : * @param _restrictionCode The target restriction code 15 : : * @return true if the restriction code is known, false otherwise 16 : : **/ 17 : : function canReturnTransferRestrictionCode( 18 : : uint8 _restrictionCode 19 : : ) external pure override returns (bool) { 20 : 12 : return 21 : 12 : _restrictionCode == CODE_ADDRESS_FROM_NOT_WHITELISTED || 22 : 6 : _restrictionCode == CODE_ADDRESS_TO_NOT_WHITELISTED; 23 : : } 24 : : 25 : : /** 26 : : * @notice Return the corresponding message 27 : : * @param _restrictionCode The target restriction code 28 : : * @return true if the transfer is valid, false otherwise 29 : : **/ 30 : : function messageForTransferRestriction( 31 : : uint8 _restrictionCode 32 : : ) external pure override returns (string memory) { 33 [ + + ]: 10 : if (_restrictionCode == CODE_ADDRESS_FROM_NOT_WHITELISTED) { 34 : 6 : return TEXT_ADDRESS_FROM_NOT_WHITELISTED; 35 [ + + ]: 4 : } else if (_restrictionCode == CODE_ADDRESS_TO_NOT_WHITELISTED) { 36 : 3 : return TEXT_ADDRESS_TO_NOT_WHITELISTED; 37 : : } else { 38 : 1 : return TEXT_CODE_NOT_FOUND; 39 : : } 40 : : } 41 : : } 8 : : abstract contract AccessControlModuleStandalone is AccessControl { 9 : : error AccessControlModuleStandalone_AddressZeroNotAllowed(); 10 : : /* ============ Constructor ============ */ 11 : : /** 12 : : * @notice Assigns the provided address as the default admin. 13 : : * @dev 14 : : * - Reverts if `admin` is the zero address. 15 : : * - Grants `DEFAULT_ADMIN_ROLE` to `admin`. 16 : : * The return value of `_grantRole` is intentionally ignored, as it returns `false` 17 : : * only when the role was already granted. 18 : : * 19 : : * @param admin The address that will receive the `DEFAULT_ADMIN_ROLE`. 20 : : */ 21 : : 22 : 161 : constructor(address admin) { 23 [ + ]: 161 : if (admin == address(0)) { 24 : 4 : revert AccessControlModuleStandalone_AddressZeroNotAllowed(); 25 : : } 26 : : // we don't check the return value 27 : : // _grantRole attempts to grant `role` to `account` and returns a boolean indicating if `role` was granted. 28 : : // return false only if the admin has already the role 29 : 157 : _grantRole(DEFAULT_ADMIN_ROLE, admin); 30 : : } 31 : : 32 : : /*////////////////////////////////////////////////////////////// 33 : : PUBLIC/EXTERNAL FUNCTIONS 34 : : //////////////////////////////////////////////////////////////*/ 35 : : /** 36 : : * @dev Returns `true` if `account` has been granted `role`. 37 : : */ 38 : 228 : function hasRole(bytes32 role, address account) public view virtual override(AccessControl) returns (bool) { 39 : : // The Default Admin has all roles 40 [ + + ]: 328 : if (AccessControl.hasRole(DEFAULT_ADMIN_ROLE, account)) { 41 : 152 : return true; 42 : : } else { 43 : 176 : return AccessControl.hasRole(role, account); 44 : : } 45 : : } 46 : : }
@@ -117,7 +122,7 @@
LCOV - lcov.info - src/rules/operation/abstract
- LCOV - lcov.info - /home/ryan/Pictures/dev/Rules/src/modules
+
LCOV - code coverage report
-
+
-
+
@@ -49,16 +49,16 @@
-
-
@@ -76,29 +76,29 @@
- Filename
- Line Coverage
- Functions
- Branches
+ Filename
+ Line Coverage
+ Functions
+ Branches
- RuleConditionalTransferOperator.sol AccessControlModuleStandalone.sol
-
+
100.0 %
- 113 / 113
+ 8 / 8
100.0 %
- 20 / 20
+ 2 / 2
100.0 %
- 31 / 31
+ 3 / 3
LCOV - lcov.info - src/rules/operation/abstract
- LCOV - lcov.info - /home/ryan/Pictures/dev/Rules/src/modules
+
LCOV - code coverage report
-
+
-
+
@@ -49,16 +49,16 @@
-
-
@@ -76,29 +76,29 @@
- Filename
- Line Coverage
- Functions
- Branches
+ Filename
+ Line Coverage
+ Functions
+ Branches
- RuleConditionalTransferOperator.sol AccessControlModuleStandalone.sol
-
+
100.0 %
- 113 / 113
+ 8 / 8
100.0 %
- 20 / 20
+ 2 / 2
100.0 %
- 31 / 31
+ 3 / 3
LCOV - lcov.info - src/rules/operation/abstract
- LCOV - lcov.info - /home/ryan/Pictures/dev/Rules/src/modules
+
LCOV - code coverage report
-
+
-
+
@@ -49,16 +49,16 @@
-
-
@@ -76,29 +76,29 @@
- Filename
- Line Coverage
- Functions
- Branches
+ Filename
+ Line Coverage
+ Functions
+ Branches
- RuleConditionalTransferOperator.sol AccessControlModuleStandalone.sol
-
+
100.0 %
- 113 / 113
+ 8 / 8
100.0 %
- 20 / 20
+ 2 / 2
100.0 %
- 31 / 31
+ 3 / 3
LCOV - lcov.info - src/rules/operation/abstract
- LCOV - lcov.info - /home/ryan/Pictures/dev/Rules/src/modules
+
LCOV - code coverage report
-
+
-
+
@@ -49,16 +49,16 @@
-
-
@@ -76,29 +76,29 @@
- Filename
- Line Coverage
- Functions
- Branches
+ Filename
+ Line Coverage
+ Functions
+ Branches
- RuleConditionalTransferOperator.sol AccessControlModuleStandalone.sol
-
+
100.0 %
- 113 / 113
+ 8 / 8
100.0 %
- 20 / 20
+ 2 / 2
100.0 %
- 31 / 31
+ 3 / 3
-
+
Branches
- script validation
-
+
- 0.0 %
- 0 / 26
- 0.0 %
- 0 / 2
- 0.0 %
- 0 / 2
+ 89.9 %
+ 151 / 168
+ 84.8 %
+ 39 / 46
+ 94.3 %
+ 50 / 53
- test/RuleConditionalTransfer/utils validation/abstract/RuleAddressSet
-
+
+ 91.3 %
+ 42 / 46
+ 88.2 %
+ 15 / 17
100.0 %
- 10 / 10
- 100.0 %
- 1 / 1
- -
- 0 / 0
+ 2 / 2
- test/utils
-
-
- 85.7 %
- 6 / 7
- 80.0 %
- 4 / 5
- -
- 0 / 0
-
-
- src/rules/validation/abstract /home/ryan/Pictures/dev/Rules/src/modules
100.0 %
- 10 / 10
- 100.0 %
- 3 / 3
- 100.0 %
- 4 / 4
-
-
- src/rules/validation/abstract/RuleAddressList
-
-
- 97.8 %
- 44 / 45
- 94.4 %
- 17 / 18
- 100.0 %
- 6 / 6
-
-
- src
-
-
- 97.4 %
- 38 / 39
- 88.9 %
- 8 / 9
- 100.0 %
8 / 8
-
-
- src/modules
-
-
- 100.0 %
- 81 / 81
100.0 %
- 27 / 27
+ 2 / 2
100.0 %
- 12 / 12
-
-
- src/rules/operation/abstract
-
-
- 100.0 %
- 113 / 113
- 100.0 %
- 20 / 20
- 100.0 %
- 31 / 31
+ 3 / 3
- src/rules/validation validation/abstract
-
+
- 97.3 %
- 72 / 74
+ 93.5 %
+ 29 / 31
90.9 %
- 20 / 22
- 100.0 %
- 32 / 32
-
-
- src/rules/operation
-
-
- 99.1 %
- 105 / 106
- 94.4 %
- 17 / 18
+ 10 / 11
100.0 %
- 33 / 33
+ 10 / 10
diff --git a/doc/coverage/coverage/index-sort-f.html b/doc/coverage/coverage/index-sort-f.html
index 4c104bd..ddafc17 100644
--- a/doc/coverage/coverage/index-sort-f.html
+++ b/doc/coverage/coverage/index-sort-f.html
@@ -31,27 +31,27 @@
-
+
Branches
- script validation
-
+
- 0.0 %
- 0 / 26
- 0.0 %
- 0 / 2
- 0.0 %
- 0 / 2
+ 89.9 %
+ 151 / 168
+ 84.8 %
+ 39 / 46
+ 94.3 %
+ 50 / 53
- test/utils validation/abstract/RuleAddressSet
-
+
- 85.7 %
- 6 / 7
- 80.0 %
- 4 / 5
- -
- 0 / 0
-
-
- src
-
-
- 97.4 %
- 38 / 39
- 88.9 %
- 8 / 9
+ 91.3 %
+ 42 / 46
+ 88.2 %
+ 15 / 17
100.0 %
- 8 / 8
+ 2 / 2
- src/rules/validation validation/abstract
-
+
- 97.3 %
- 72 / 74
+ 93.5 %
+ 29 / 31
90.9 %
- 20 / 22
- 100.0 %
- 32 / 32
-
-
- src/rules/validation/abstract/RuleAddressList
-
-
- 97.8 %
- 44 / 45
- 94.4 %
- 17 / 18
- 100.0 %
- 6 / 6
-
-
- src/rules/operation
-
-
- 99.1 %
- 105 / 106
- 94.4 %
- 17 / 18
- 100.0 %
- 33 / 33
-
-
- test/RuleConditionalTransfer/utils
-
-
+ 10 / 11
100.0 %
10 / 10
- 100.0 %
- 1 / 1
- -
- 0 / 0
-
-
- src/rules/validation/abstract
-
-
- 100.0 %
- 10 / 10
- 100.0 %
- 3 / 3
- 100.0 %
- 4 / 4
- src/rules/operation/abstract /home/ryan/Pictures/dev/Rules/src/modules
100.0 %
- 113 / 113
- 100.0 %
- 20 / 20
- 100.0 %
- 31 / 31
-
-
- src/modules
-
-
- 100.0 %
- 81 / 81
+ 8 / 8
100.0 %
- 27 / 27
+ 2 / 2
100.0 %
- 12 / 12
+ 3 / 3
diff --git a/doc/coverage/coverage/index-sort-l.html b/doc/coverage/coverage/index-sort-l.html
index f352c82..53eb3c2 100644
--- a/doc/coverage/coverage/index-sort-l.html
+++ b/doc/coverage/coverage/index-sort-l.html
@@ -31,27 +31,27 @@
-
+
Branches
- script validation
-
+
- 0.0 %
- 0 / 26
- 0.0 %
- 0 / 2
- 0.0 %
- 0 / 2
+ 89.9 %
+ 151 / 168
+ 84.8 %
+ 39 / 46
+ 94.3 %
+ 50 / 53
- test/utils validation/abstract/RuleAddressSet
-
-
- 85.7 %
- 6 / 7
- 80.0 %
- 4 / 5
- -
- 0 / 0
-
-
- src/rules/validation
-
-
- 97.3 %
- 72 / 74
- 90.9 %
- 20 / 22
- 100.0 %
- 32 / 32
-
-
- src
-
-
- 97.4 %
- 38 / 39
- 88.9 %
- 8 / 9
- 100.0 %
- 8 / 8
-
-
- src/rules/validation/abstract/RuleAddressList
-
-
- 97.8 %
- 44 / 45
- 94.4 %
- 17 / 18
- 100.0 %
- 6 / 6
-
-
- src/rules/operation
-
-
- 99.1 %
- 105 / 106
- 94.4 %
- 17 / 18
- 100.0 %
- 33 / 33
-
-
- src/rules/validation/abstract
-
+
+ 91.3 %
+ 42 / 46
+ 88.2 %
+ 15 / 17
100.0 %
- 10 / 10
- 100.0 %
- 3 / 3
- 100.0 %
- 4 / 4
+ 2 / 2
- test/RuleConditionalTransfer/utils validation/abstract
-
+
+ 93.5 %
+ 29 / 31
+ 90.9 %
+ 10 / 11
100.0 %
10 / 10
- 100.0 %
- 1 / 1
- -
- 0 / 0
- src/modules /home/ryan/Pictures/dev/Rules/src/modules
100.0 %
- 81 / 81
- 100.0 %
- 27 / 27
- 100.0 %
- 12 / 12
-
-
- src/rules/operation/abstract
-
-
- 100.0 %
- 113 / 113
+ 8 / 8
100.0 %
- 20 / 20
+ 2 / 2
100.0 %
- 31 / 31
+ 3 / 3
diff --git a/doc/coverage/coverage/index.html b/doc/coverage/coverage/index.html
index 92f429f..d70aabb 100644
--- a/doc/coverage/coverage/index.html
+++ b/doc/coverage/coverage/index.html
@@ -31,27 +31,27 @@
-
+
Branches
- script
-
-
- 0.0 %
- 0 / 26
- 0.0 %
- 0 / 2
- 0.0 %
- 0 / 2
-
-
- src
-
-
- 97.4 %
- 38 / 39
- 88.9 %
- 8 / 9
- 100.0 %
- 8 / 8
-
-
- src/modules /home/ryan/Pictures/dev/Rules/src/modules
100.0 %
- 81 / 81
- 100.0 %
- 27 / 27
+ 8 / 8
100.0 %
- 12 / 12
-
-
- src/rules/operation
-
-
- 99.1 %
- 105 / 106
- 94.4 %
- 17 / 18
+ 2 / 2
100.0 %
- 33 / 33
+ 3 / 3
- src/rules/operation/abstract validation
-
+
- 100.0 %
- 113 / 113
- 100.0 %
- 20 / 20
- 100.0 %
- 31 / 31
+ 89.9 %
+ 151 / 168
+ 84.8 %
+ 39 / 46
+ 94.3 %
+ 50 / 53
- src/rules/validation validation/abstract
-
+
- 97.3 %
- 72 / 74
+ 93.5 %
+ 29 / 31
90.9 %
- 20 / 22
- 100.0 %
- 32 / 32
-
-
- src/rules/validation/abstract
-
-
+ 10 / 11
100.0 %
10 / 10
- 100.0 %
- 3 / 3
- 100.0 %
- 4 / 4
- src/rules/validation/abstract/RuleAddressList validation/abstract/RuleAddressSet
-
+
- 97.8 %
- 44 / 45
- 94.4 %
- 17 / 18
+ 91.3 %
+ 42 / 46
+ 88.2 %
+ 15 / 17
100.0 %
- 6 / 6
-
-
- test/RuleConditionalTransfer/utils
-
-
- 100.0 %
- 10 / 10
- 100.0 %
- 1 / 1
- -
- 0 / 0
-
-
- test/utils
-
-
- 85.7 %
- 6 / 7
- 80.0 %
- 4 / 5
- -
- 0 / 0
+ 2 / 2
diff --git a/doc/coverage/coverage/script/CMTATWithRuleEngineScript.s.sol.func-sort-c.html b/doc/coverage/coverage/script/CMTATWithRuleEngineScript.s.sol.func-sort-c.html
deleted file mode 100644
index 9ab57f2..0000000
--- a/doc/coverage/coverage/script/CMTATWithRuleEngineScript.s.sol.func-sort-c.html
+++ /dev/null
@@ -1,85 +0,0 @@
-
-
-
-
-
- LCOV - lcov.info - script/CMTATWithRuleEngineScript.s.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - script/CMTATWithRuleEngineScript.s.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - script/CMTATWithRuleEngineScript.s.sol
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - script/RuleEngineScript.s.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - script/RuleEngineScript.s.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - script/RuleEngineScript.s.sol
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - script
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - script
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - script
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - script
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/modules/RuleEngineOperation.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/modules/RuleEngineOperation.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/modules/RuleEngineOperation.sol
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Branch data Line data Source code
-
- 1 : : // SPDX-License-Identifier: MPL-2.0 2 : : 3 : : pragma solidity ^0.8.20; 4 : : 5 : : import "./RuleInternal.sol"; 6 : : import "../interfaces/IRuleEngineOperation.sol"; 7 : : import "../interfaces/IRuleOperation.sol"; 8 : : import "OZ/access/AccessControl.sol"; 9 : : 10 : : /** 11 : : * @title Implementation of a ruleEngine defined by the CMTAT 12 : : */ 13 : : abstract contract RuleEngineOperation is 14 : : AccessControl, 15 : : RuleInternal, 16 : : IRuleEngineOperation 17 : : { 18 : : /// @dev Array of rules 19 : : address[] internal _rulesOperation; 20 : : 21 : : /** 22 : : * @notice Set all the rules, will overwrite all the previous rules. \n 23 : : * Revert if one rule is a zero address or if the rule is already present 24 : : * 25 : : */ 26 : : function setRulesOperation( 27 : : address[] calldata rules_ 28 : : ) public onlyRole(RULE_ENGINE_OPERATOR_ROLE) { 29 [ + ]: 11 : if (_rulesOperation.length > 0) { 30 : 10 : _clearRulesOperation(); 31 : : } 32 : 11 : _setRules(rules_); 33 : 8 : _rulesOperation = rules_; 34 : : } 35 : : 36 : : /** 37 : : * @notice Clear all the rules of the array of rules 38 : : * 39 : : */ 40 : : function clearRulesOperation() public onlyRole(RULE_ENGINE_OPERATOR_ROLE) { 41 : 4 : _clearRulesOperation(); 42 : : } 43 : : 44 : : /** 45 : : * @notice Clear all the rules of the array of rules 46 : : * 47 : : */ 48 : : function _clearRulesOperation() internal { 49 : 14 : uint256 index; 50 : : // we remove the last element first since it is more optimized. 51 : 14 : for (uint256 i = _rulesOperation.length; i > 0; --i) { 52 : : unchecked { 53 : : // don't underflow since i > 0 54 : 17 : index = i - 1; 55 : : } 56 : 17 : _removeRuleOperation(_rulesOperation[index], index); 57 : : } 58 : 14 : emit ClearRules(_rulesOperation); 59 : : } 60 : : 61 : : /** 62 : : * @notice Add a rule to the array of rules 63 : : * Revert if one rule is a zero address or if the rule is already present 64 : : * 65 : : */ 66 : : function addRuleOperation( 67 : : IRuleOperation rule_ 68 : : ) public onlyRole(RULE_ENGINE_OPERATOR_ROLE) { 69 : 85 : RuleInternal._addRule(_rulesOperation, address(rule_)); 70 : 83 : emit AddRule(address(rule_)); 71 : : } 72 : : 73 : : /** 74 : : * @notice Remove a rule from the array of rules 75 : : * Revert if the rule found at the specified index does not match the rule in argument 76 : : * @param rule_ address of the target rule 77 : : * @param index the position inside the array of rule 78 : : * @dev To reduce the array size, the last rule is moved to the location occupied 79 : : * by the rule to remove 80 : : * 81 : : * 82 : : */ 83 : : function removeRuleOperation( 84 : : IRuleOperation rule_, 85 : : uint256 index 86 : : ) public onlyRole(RULE_ENGINE_OPERATOR_ROLE) { 87 : 5 : _removeRuleOperation(address(rule_), index); 88 : : } 89 : : 90 : : /** 91 : : * @notice Remove a rule from the array of rules 92 : : * Revert if the rule found at the specified index does not match the rule in argument 93 : : * @param rule_ address of the target rule 94 : : * @param index the position inside the array of rule 95 : : * @dev To reduce the array size, the last rule is moved to the location occupied 96 : : * by the rule to remove 97 : : * 98 : : * 99 : : */ 100 : : function _removeRuleOperation(address rule_, uint256 index) internal { 101 : 22 : RuleInternal._removeRule(_rulesOperation, rule_, index); 102 : 21 : emit RemoveRule(address(rule_)); 103 : : } 104 : : 105 : : /** 106 : : * @return The number of rules inside the array 107 : : */ 108 : : function rulesCountOperation() external view override returns (uint256) { 109 : 41 : return _rulesOperation.length; 110 : : } 111 : : 112 : : /** 113 : : * @notice Get the index of a rule inside the list 114 : : * @return index if the rule is found, _rulesOperation.length otherwise 115 : : */ 116 : : function getRuleIndexOperation( 117 : : IRuleOperation rule_ 118 : : ) external view returns (uint256 index) { 119 : 3 : return RuleInternal._getRuleIndex(_rulesOperation, address(rule_)); 120 : : } 121 : : 122 : : /** 123 : : * @notice Get the rule at the position specified by ruleId 124 : : * @param ruleId index of the rule 125 : : * @return a rule address 126 : : */ 127 : : function ruleOperation( 128 : : uint256 ruleId 129 : : ) external view override returns (address) { 130 : 1 : return _rulesOperation[ruleId]; 131 : : } 132 : : 133 : : /** 134 : : * @notice Get all the rules 135 : : * @return An array of rules 136 : : */ 137 : : function rulesOperation() 138 : : external 139 : : view 140 : : override 141 : : returns (address[] memory) 142 : : { 143 : 5 : return _rulesOperation; 144 : : } 145 : : 146 : : /** 147 : : * @notice Go through all the rule to know if a restriction exists on the transfer 148 : : * @param _from the origin address 149 : : * @param _to the destination address 150 : : * @param _amount to transfer 151 : : **/ 152 : : function _operateOnTransfer( 153 : : address _from, 154 : : address _to, 155 : : uint256 _amount 156 : : ) internal returns (bool isValid) { 157 : 58 : uint256 rulesLength = _rulesOperation.length; 158 : 58 : for (uint256 i = 0; i < rulesLength; ++i) { 159 : 50 : bool result = IRuleOperation(_rulesOperation[i]).operateOnTransfer( 160 : : _from, 161 : : _to, 162 : : _amount 163 : : ); 164 [ + ]: 50 : if (!result) { 165 : 24 : return false; 166 : : } 167 : : } 168 : 34 : return true; 169 : : } 170 : : }
-
-
-
- LCOV - lcov.info - src/modules/RuleEngineValidation.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/modules/RuleEngineValidation.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/modules/RuleEngineValidation.sol
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Branch data Line data Source code
-
- 1 : : // SPDX-License-Identifier: MPL-2.0 2 : : 3 : : pragma solidity ^0.8.20; 4 : : 5 : : import "OZ/access/AccessControl.sol"; 6 : : import "./RuleInternal.sol"; 7 : : import "./RuleEngineValidationCommon.sol"; 8 : : import "../interfaces/IRuleEngineValidation.sol"; 9 : : import "../interfaces/IRuleValidation.sol"; 10 : : import "CMTAT/interfaces/draft-IERC1404/draft-IERC1404EnumCode.sol"; 11 : : 12 : : /** 13 : : * @title Implementation of a ruleEngine defined by the CMTAT 14 : : */ 15 : : abstract contract RuleEngineValidation is 16 : : AccessControl, 17 : : RuleInternal, 18 : : RuleEngineValidationCommon, 19 : : IRuleEngineValidation, 20 : : IERC1404EnumCode 21 : : { 22 : : /** 23 : : * @notice Go through all the rule to know if a restriction exists on the transfer 24 : : * @param _from the origin address 25 : : * @param _to the destination address 26 : : * @param _amount to transfer 27 : : * @return The restricion code or REJECTED_CODE_BASE.TRANSFER_OK 28 : : **/ 29 : : function detectTransferRestrictionValidation( 30 : : address _from, 31 : : address _to, 32 : : uint256 _amount 33 : : ) public view override returns (uint8) { 34 : 105 : uint256 rulesLength = _rulesValidation.length; 35 : 105 : for (uint256 i = 0; i < rulesLength; ++i) { 36 : 43 : uint8 restriction = IRuleValidation(_rulesValidation[i]) 37 : : .detectTransferRestriction(_from, _to, _amount); 38 [ + ]: 43 : if (restriction > 0) { 39 : 28 : return restriction; 40 : : } 41 : : } 42 : : 43 : 77 : return uint8(REJECTED_CODE_BASE.TRANSFER_OK); 44 : : } 45 : : 46 : : /** 47 : : * @notice Validate a transfer 48 : : * @param _from the origin address 49 : : * @param _to the destination address 50 : : * @param _amount to transfer 51 : : * @return True if the transfer is valid, false otherwise 52 : : **/ 53 : : function validateTransferValidation( 54 : : address _from, 55 : : address _to, 56 : : uint256 _amount 57 : : ) public view override returns (bool) { 58 : 70 : return 59 : 70 : detectTransferRestrictionValidation(_from, _to, _amount) == 60 : : uint8(REJECTED_CODE_BASE.TRANSFER_OK); 61 : : } 62 : : }
-
-
-
- LCOV - lcov.info - src/modules/RuleEngineValidationCommon.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/modules/RuleEngineValidationCommon.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/modules
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/modules
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/modules
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/modules
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/operation/RuleConditionalTransfer.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/operation/RuleConditionalTransfer.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/operation/RuleConditionalTransfer.sol
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Branch data Line data Source code
-
- 1 : : // SPDX-License-Identifier: MPL-2.0 2 : : 3 : : pragma solidity ^0.8.20; 4 : : 5 : : import "OZ/access/AccessControl.sol"; 6 : : import "../../interfaces/IRuleOperation.sol"; 7 : : import "./../../modules/MetaTxModuleStandalone.sol"; 8 : : import "./abstract/RuleConditionalTransferInvariantStorage.sol"; 9 : : import "./abstract/RuleConditionalTransferOperator.sol"; 10 : : import "../validation/abstract/RuleValidateTransfer.sol"; 11 : : import "CMTAT/interfaces/engine/IRuleEngine.sol"; 12 : : 13 : : /** 14 : : * @title RuleConditionalTransfer 15 : : */ 16 : : 17 : : contract RuleConditionalTransfer is 18 : : RuleValidateTransfer, 19 : : IRuleOperation, 20 : : RuleConditionalTransferOperator, 21 : : MetaTxModuleStandalone 22 : : { 23 : : /** 24 : : * @param admin Address of the contract (Access Control) 25 : : * @param forwarderIrrevocable Address of the forwarder, required for the gasless support 26 : : */ 27 : : constructor( 28 : : address admin, 29 : : address forwarderIrrevocable, 30 : : IRuleEngine ruleEngineContract, 31 : : OPTION memory options_ 32 : : ) MetaTxModuleStandalone(forwarderIrrevocable) { 33 [ + ]: 158 : if (admin == address(0)) { 34 : 1 : revert RuleConditionalTransfer_AdminWithAddressZeroNotAllowed(); 35 : : } 36 : 157 : _grantRole(DEFAULT_ADMIN_ROLE, admin); 37 [ + ]: 157 : if (address(ruleEngineContract) != address(0x0)) { 38 : 153 : _grantRole(RULE_ENGINE_CONTRACT_ROLE, address(ruleEngineContract)); 39 : : } 40 : 157 : options = options_; 41 : : } 42 : : 43 : : /*////////////////////////////////////////////////////////////// 44 : : PUBLIC/EXTERNAL FUNCTIONS 45 : : //////////////////////////////////////////////////////////////*/ 46 : : /** 47 : : * @notice function called by the RuleEngine 48 : : * @dev Returns true if the transfer is valid, and false otherwise. 49 : : * Add access control with the RuleEngine 50 : : */ 51 : : function operateOnTransfer( 52 : : address _from, 53 : : address _to, 54 : : uint256 _amount 55 : : ) 56 : : public 57 : : override 58 : : onlyRole(RULE_ENGINE_CONTRACT_ROLE) 59 : : returns (bool isValid) 60 : : { 61 [ + + ]: 50 : if (_validateTransfer(_from, _to)) { 62 : 8 : return true; 63 : : } else { 64 : 42 : bytes32 key = keccak256(abi.encode(_from, _to, _amount)); 65 [ + + ]: 42 : if (_validateApproval(key)) { 66 : 18 : _updateProcessedTransfer(key); 67 : 18 : return true; 68 : : } else { 69 : 24 : return false; 70 : : } 71 : : } 72 : : } 73 : : 74 : : /** 75 : : * @notice Create a request of transfer for yourselves 76 : : * @param to recipient of tokens 77 : : * @param value amount of tokens to transfer 78 : : */ 79 : : function createTransferRequest(address to, uint256 value) public { 80 : : // WAIT => Will set a new delay to approve 81 : : // APPROVED => will overwrite previous status 82 : : // DENIED => reject 83 : 117 : address from = _msgSender(); 84 : 117 : bytes32 key = keccak256(abi.encode(from, to, value)); 85 [ + ]: 117 : if (transferRequests[key].status == STATUS.DENIED) { 86 : 1 : revert RuleConditionalTransfer_TransferDenied(); 87 : : } 88 [ + + ]: 116 : if (_checkRequestStatus(key)) { 89 : 113 : uint256 requestIdLocal = requestId; 90 : 113 : TransferRequest memory newTransferApproval = TransferRequest({ 91 : : key: key, 92 : : id: requestIdLocal, 93 : : keyElement: TransferRequestKeyElement({ 94 : : from: from, 95 : : to: to, 96 : : value: value 97 : : }), 98 : : askTime: block.timestamp, 99 : : maxTime: 0, 100 : : status: STATUS.WAIT 101 : : }); 102 : 113 : transferRequests[key] = newTransferApproval; 103 : 113 : IdToKey[requestIdLocal] = key; 104 : 113 : emit transferWaiting(key, from, to, value, requestId); 105 : 113 : ++requestId; 106 : : } else { 107 : : // Overwrite previous approval 108 : 3 : transferRequests[key].askTime = block.timestamp; 109 : 3 : transferRequests[key].status = STATUS.WAIT; 110 : 3 : emit transferWaiting( 111 : : key, 112 : : from, 113 : : to, 114 : : value, 115 : : transferRequests[key].id 116 : : ); 117 : : } 118 : : } 119 : : 120 : : /** 121 : : * @notice Batch version of {createTransferRequest} 122 : : */ 123 : : function createTransferRequestBatch( 124 : : address[] memory tos, 125 : : uint256[] memory values 126 : : ) public { 127 [ + ]: 3 : if (tos.length == 0) { 128 : 1 : revert RuleConditionalTransfer_EmptyArray(); 129 : : } 130 [ + ]: 2 : if (tos.length != values.length) { 131 : 1 : revert RuleConditionalTransfer_InvalidLengthArray(); 132 : : } 133 : 1 : for (uint256 i = 0; i < tos.length; ++i) { 134 : 3 : createTransferRequest(tos[i], values[i]); 135 : : } 136 : : } 137 : : 138 : : /** 139 : : * @notice allow a token holder to cancel/reset his own request 140 : : */ 141 : : function cancelTransferRequest(uint256 requestId_) public { 142 : 6 : _cancelTransferRequest(requestId_); 143 : : } 144 : : 145 : : /** 146 : : * @notice allow a token holder to cancel/reset his own request 147 : : */ 148 : : function cancelTransferRequestBatch(uint256[] memory requestIds) public { 149 [ + ]: 3 : if (requestIds.length == 0) { 150 : 1 : revert RuleConditionalTransfer_EmptyArray(); 151 : : } 152 : : // Check id validity before performing actions 153 : 2 : for (uint256 i = 0; i < requestIds.length; ++i) { 154 [ + ]: 5 : if (requestIds[i] + 1 > requestId) { 155 : 1 : revert RuleConditionalTransfer_InvalidId(); 156 : : } 157 : : } 158 : 1 : for (uint256 i = 0; i < requestIds.length; ++i) { 159 : 3 : _cancelTransferRequest(requestIds[i]); 160 : : } 161 : : } 162 : : 163 : : function getRequestTrade( 164 : : address from, 165 : : address to, 166 : : uint256 value 167 : : ) public view returns (TransferRequest memory) { 168 : 57 : bytes32 key = keccak256(abi.encode(from, to, value)); 169 : 57 : return transferRequests[key]; 170 : : } 171 : : 172 : : /** 173 : : * @notice get Trade by status 174 : : * @param _targetStatus The status of the transactions you want to retrieve 175 : : * @return array with corresponding transactions 176 : : */ 177 : : function getRequestByStatus( 178 : : STATUS _targetStatus 179 : : ) public view returns (TransferRequest[] memory) { 180 : 35 : uint totalRequestCount = requestId; 181 : 35 : uint requestCount = 0; 182 : 35 : uint currentIndex = 0; 183 : : 184 : : // We count the number of requests matching the criteria 185 : 35 : for (uint i = 0; i < totalRequestCount; ++i) { 186 [ + ]: 38 : if (transferRequests[IdToKey[i]].status == _targetStatus) { 187 : 36 : requestCount += 1; 188 : : } 189 : : } 190 : : 191 : : // We reserve the memory to store the trade 192 : 35 : TransferRequest[] memory requests = new TransferRequest[](requestCount); 193 : : 194 : : // We create an array with the list of trade 195 : 35 : for (uint i = 0; i < totalRequestCount; ++i) { 196 [ + ]: 38 : if (transferRequests[IdToKey[i]].status == _targetStatus) { 197 : : //uint currentId = i + 1; 198 : 36 : TransferRequest memory currentRequest = transferRequests[ 199 : : IdToKey[i] 200 : : ]; 201 : 36 : requests[currentIndex] = currentRequest; 202 : 36 : currentIndex += 1; 203 : : } 204 : : } 205 : 35 : return requests; 206 : : } 207 : : 208 : : /** 209 : : * @notice Check if the transfer is valid 210 : : * @param _from the origin address 211 : : * @param _to the destination address 212 : : * @return The restricion code or REJECTED_CODE_BASE.TRANSFER_OK 213 : : **/ 214 : : function detectTransferRestriction( 215 : : address _from, 216 : : address _to, 217 : : uint256 _amount 218 : : ) public view override returns (uint8) { 219 : : // No need of approval if from and to are in the whitelist 220 [ + ]: 56 : if (_validateTransfer(_from, _to)) { 221 : 1 : return uint8(REJECTED_CODE_BASE.TRANSFER_OK); 222 : : } 223 : 55 : bytes32 key = keccak256(abi.encode(_from, _to, _amount)); 224 [ + + ]: 55 : if (_validateApproval(key)) { 225 : 8 : return uint8(REJECTED_CODE_BASE.TRANSFER_OK); 226 : : } else { 227 : 47 : return CODE_TRANSFER_REQUEST_NOT_APPROVED; 228 : : } 229 : : } 230 : : 231 : : /** 232 : : * @notice To know if the restriction code is valid for this rule or not. 233 : : * @param _restrictionCode The target restriction code 234 : : * @return true if the restriction code is known, false otherwise 235 : : **/ 236 : : function canReturnTransferRestrictionCode( 237 : : uint8 _restrictionCode 238 : : ) external pure override returns (bool) { 239 : 2 : return _restrictionCode == CODE_TRANSFER_REQUEST_NOT_APPROVED; 240 : : } 241 : : 242 : : /** 243 : : * @notice Return the corresponding message 244 : : * @param _restrictionCode The target restriction code 245 : : * @return true if the transfer is valid, false otherwise 246 : : **/ 247 : : function messageForTransferRestriction( 248 : : uint8 _restrictionCode 249 : : ) external pure override returns (string memory) { 250 [ + + ]: 3 : if (_restrictionCode == CODE_TRANSFER_REQUEST_NOT_APPROVED) { 251 : 2 : return TEXT_TRANSFER_REQUEST_NOT_APPROVED; 252 : : } else { 253 : 1 : return TEXT_CODE_NOT_FOUND; 254 : : } 255 : : } 256 : : 257 : : /*////////////////////////////////////////////////////////////// 258 : : INTERNAL FUNCTIONS 259 : : //////////////////////////////////////////////////////////////*/ 260 : : function _validateTransfer( 261 : : address _from, 262 : : address _to 263 : : ) internal view returns (bool) { 264 : : // No need of approval if from and to are in the whitelist 265 [ + ]: 106 : if (address(whitelistConditionalTransfer) != address(0)) { 266 : : if ( 267 : 36 : whitelistConditionalTransfer.addressIsListed(_from) && 268 : 5 : whitelistConditionalTransfer.addressIsListed(_to) 269 [ + ]: 3 : ) { 270 : 3 : return true; 271 : : } 272 : : } 273 : : 274 : : // Mint & Burn 275 [ + ]: 103 : if (_validateBurnMint(_from, _to)) { 276 : 6 : return true; 277 : : } 278 : 97 : return false; 279 : : } 280 : : 281 : : function _cancelTransferRequest(uint256 requestId_) internal { 282 [ + ]: 9 : if (requestId_ + 1 > requestId) { 283 : 1 : revert RuleConditionalTransfer_InvalidId(); 284 : : } 285 : 8 : bytes32 key = IdToKey[requestId_]; 286 : : // Check Sender 287 [ + ]: 8 : if (transferRequests[key].keyElement.from != _msgSender()) { 288 : 1 : revert RuleConditionalTransfer_InvalidSender(); 289 : : } 290 : : // Check status 291 : : if ( 292 : 7 : transferRequests[key].status != STATUS.WAIT && 293 : 2 : transferRequests[key].status != STATUS.APPROVED 294 [ + ]: 1 : ) { 295 : 1 : revert RuleConditionalTransfer_Wrong_Status(); 296 : : } 297 : 6 : _resetRequestStatus(key); 298 : : } 299 : : 300 : : /** 301 : : * 302 : : * @dev 303 : : * Test burn and mint condition 304 : : * Returns true if the transfer is valid, and false otherwise. 305 : : * 306 : : */ 307 : : function _validateBurnMint( 308 : : address _from, 309 : : address _to 310 : : ) internal view returns (bool isValid) { 311 : : // Mint & Burn 312 : : if ( 313 : 103 : (_from == address(0) && 314 : : options.issuance.authorizedMintWithoutApproval) || 315 : : (_to == address(0) && 316 : : options.issuance.authorizedBurnWithoutApproval) 317 [ + ]: 6 : ) { 318 : 6 : return true; 319 : : } 320 : 97 : return false; 321 : : } 322 : : 323 : : /** 324 : : * 325 : : * @dev 326 : : * Test transfer approval condition 327 : : * Returns true if the transfer is valid, and false otherwise. 328 : : */ 329 : : function _validateApproval( 330 : : bytes32 key 331 : : ) internal view returns (bool isValid) { 332 : : // If automatic approval is activate and time to approve the request has passed 333 : 97 : if(transferRequests[key].status == STATUS.NONE 334 : : || 335 : 50 : transferRequests[key].status == STATUS.DENIED 336 : : || 337 : 47 : transferRequests[key].status == STATUS.EXECUTED) 338 [ + ]: 50 : { 339 : 50 : return false; 340 : : } 341 : 47 : bool isTransferApproved; 342 : 47 : bool automaticApprovalCondition; 343 [ + ]: 47 : if(transferRequests[key].status == 344 [ + ]: 20 : STATUS.APPROVED){ 345 : 20 : isTransferApproved = (transferRequests[key].maxTime >= block.timestamp); 346 : : } else if(options 347 : : .automaticApproval 348 [ + ]: 27 : .isActivate){ 349 : : // Warning: overflow possible if timeLimitBeforeAutomaticApproval == max(uint256) 350 : 27 : automaticApprovalCondition= block.timestamp >= 351 : : (transferRequests[key].askTime + 352 : : options.automaticApproval.timeLimitBeforeAutomaticApproval); 353 : : } 354 : : // If the transfer is approved and delay to perform the transfer is respected 355 [ + + ]: 47 : if (automaticApprovalCondition || isTransferApproved) { 356 : 26 : return true; 357 : : } else { 358 : 21 : return false; 359 : : } 360 : : } 361 : : 362 : : /*////////////////////////////////////////////////////////////// 363 : : ERC-2771 364 : : //////////////////////////////////////////////////////////////*/ 365 : : 366 : : /** 367 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 368 : : */ 369 : : function _msgSender() 370 : : internal 371 : : view 372 : : override(ERC2771Context, Context) 373 : : returns (address sender) 374 : : { 375 : 829 : return ERC2771Context._msgSender(); 376 : : } 377 : : 378 : : /** 379 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 380 : : */ 381 : : function _msgData() 382 : : internal 383 : : view 384 : : override(ERC2771Context, Context) 385 : : returns (bytes calldata) 386 : : { 387 : 0 : return ERC2771Context._msgData(); 388 : : } 389 : : 390 : : /** 391 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 392 : : */ 393 : : function _contextSuffixLength() 394 : : internal 395 : : view 396 : : override(ERC2771Context, Context) 397 : : returns (uint256) 398 : : { 399 : 829 : return ERC2771Context._contextSuffixLength(); 400 : : } 401 : : }
-
-
-
- LCOV - lcov.info - src/rules/operation/abstract/RuleConditionalTransferOperator.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/operation/abstract/RuleConditionalTransferOperator.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/operation/abstract/RuleConditionalTransferOperator.sol
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Branch data Line data Source code
-
- 1 : : // SPDX-License-Identifier: MPL-2.0 2 : : 3 : : pragma solidity ^0.8.20; 4 : : 5 : : import "OZ/access/AccessControl.sol"; 6 : : import "./RuleConditionalTransferInvariantStorage.sol"; 7 : : import "OZ/token/ERC20/utils/SafeERC20.sol"; 8 : : 9 : : /** 10 : : * @title Restricted functions 11 : : */ 12 : : abstract contract RuleConditionalTransferOperator is 13 : : AccessControl, 14 : : RuleConditionalTransferInvariantStorage 15 : : { 16 : : // Security 17 : : using SafeERC20 for IERC20; 18 : : /* ============ State Variables ============ */ 19 : : OPTION public options; 20 : : uint256 public requestId; 21 : : mapping(uint256 => bytes32) public IdToKey; 22 : : mapping(bytes32 => TransferRequest) public transferRequests; 23 : : RuleWhitelist public whitelistConditionalTransfer; 24 : : 25 : : /*////////////////////////////////////////////////////////////// 26 : : PUBLIC/EXTERNAL FUNCTIONS 27 : : //////////////////////////////////////////////////////////////*/ 28 : : 29 : : /** 30 : : * @notice set a whitelist. A transfer does not need of an approved request if from and to are in the whitelist 31 : : */ 32 : : function setConditionalWhitelist( 33 : : RuleWhitelist newWhitelistConditionalTransfer 34 : : ) public onlyRole(RULE_CONDITIONAL_TRANSFER_OPERATOR_ROLE) { 35 : 26 : whitelistConditionalTransfer = newWhitelistConditionalTransfer; 36 : 26 : emit WhitelistConditionalTransfer(newWhitelistConditionalTransfer); 37 : : } 38 : : 39 : : /** 40 : : * @notice set/unset the issuance options (mint & burn) 41 : : */ 42 : : function setIssuanceOptions( 43 : : ISSUANCE calldata issuance_ 44 : : ) public onlyRole(RULE_CONDITIONAL_TRANSFER_OPERATOR_ROLE) { 45 : : if ( 46 : 6 : options.issuance.authorizedMintWithoutApproval != 47 : : issuance_.authorizedMintWithoutApproval 48 [ + ]: 3 : ) { 49 : 3 : options.issuance.authorizedMintWithoutApproval = issuance_ 50 : : .authorizedMintWithoutApproval; 51 : : } 52 : : if ( 53 : 6 : options.issuance.authorizedBurnWithoutApproval != 54 : : issuance_.authorizedBurnWithoutApproval 55 [ + ]: 3 : ) { 56 : 3 : options.issuance.authorizedBurnWithoutApproval = issuance_ 57 : : .authorizedBurnWithoutApproval; 58 : : } 59 : : } 60 : : 61 : : /** 62 : : * @notice set/unset the option to perform the transfer if the request is approved by the rule operator. 63 : : * To perform the transfer, the token holder has to approve the rule to spend tokens on his behalf (standard ERC-20 approval). 64 : : * If the allowance is not sufficient, the request will be approved, but without performing the transfer. 65 : : */ 66 : : function setAutomaticTransfer( 67 : : AUTOMATIC_TRANSFER calldata automaticTransfer_ 68 : : ) public onlyRole(RULE_CONDITIONAL_TRANSFER_OPERATOR_ROLE) { 69 : : if ( 70 : 3 : automaticTransfer_.isActivate != 71 : : options.automaticTransfer.isActivate 72 [ + ]: 2 : ) { 73 : 2 : options.automaticTransfer.isActivate = automaticTransfer_ 74 : : .isActivate; 75 : : } 76 : : // No need to put the cmtat to zero to deactivate automaticTransfer 77 : : if ( 78 : 3 : address(automaticTransfer_.cmtat) != 79 : : address(options.automaticTransfer.cmtat) 80 [ + ]: 2 : ) { 81 : 2 : options.automaticTransfer.cmtat = automaticTransfer_.cmtat; 82 : : } 83 : : } 84 : : 85 : : /** 86 : : * @notice set time limit for new requests (Approval and transfer) 87 : : * timeLimitToApprove: time limit for an operator to approve a request 88 : : * timeLimitToTransfer: once a request is approved, time limit for the token holder to perform the transfer 89 : : */ 90 : : function setTimeLimit( 91 : : TIME_LIMIT memory timeLimit_ 92 : : ) public onlyRole(RULE_CONDITIONAL_TRANSFER_OPERATOR_ROLE) { 93 : : if ( 94 : 4 : options.timeLimit.timeLimitToApprove != 95 : : timeLimit_.timeLimitToApprove 96 [ + ]: 4 : ) { 97 : 4 : options.timeLimit.timeLimitToApprove = timeLimit_ 98 : : .timeLimitToApprove; 99 : : } 100 : : if ( 101 : 4 : options.timeLimit.timeLimitToTransfer != 102 : : timeLimit_.timeLimitToTransfer 103 [ + ]: 4 : ) { 104 : 4 : options.timeLimit.timeLimitToTransfer = timeLimit_ 105 : : .timeLimitToTransfer; 106 : : } 107 : : } 108 : : 109 : : /** 110 : : * @notice If the transfer is not approved or denied within {timeLimitBeforeAutomaticApproval}, 111 : : * the request is considered as approved during a transfer. 112 : : * 113 : : */ 114 : : function setAutomaticApproval( 115 : : AUTOMATIC_APPROVAL memory automaticApproval_ 116 : : ) public onlyRole(RULE_CONDITIONAL_TRANSFER_OPERATOR_ROLE) { 117 : : if ( 118 : 9 : options.automaticApproval.isActivate != 119 : : automaticApproval_.isActivate 120 [ + ]: 6 : ) { 121 : 6 : options.automaticApproval.isActivate = automaticApproval_ 122 : : .isActivate; 123 : : } 124 : : if ( 125 : 9 : options.automaticApproval.timeLimitBeforeAutomaticApproval != 126 : : automaticApproval_.timeLimitBeforeAutomaticApproval 127 [ + ]: 9 : ) { 128 : 9 : options 129 : : .automaticApproval 130 : : .timeLimitBeforeAutomaticApproval = automaticApproval_ 131 : : .timeLimitBeforeAutomaticApproval; 132 : : } 133 : : } 134 : : 135 : : /** 136 : : * @notice create a transfer request directly approved 137 : : */ 138 : : function createTransferRequestWithApproval( 139 : : TransferRequestKeyElement calldata keyElement 140 : : ) public onlyRole(RULE_CONDITIONAL_TRANSFER_OPERATOR_ROLE) { 141 : 5 : _createTransferRequestWithApproval(keyElement); 142 : : } 143 : : 144 : : /** 145 : : * @notice approve a transferRequest 146 : : * @param keyElement contains from, to, value 147 : : * @param partialValue amount approved. Put 0 if all the amount specified by value is approved. 148 : : * @param isApproved approved (true) or refused (false). Put true if you use partialApproval 149 : : */ 150 : : function approveTransferRequest( 151 : : TransferRequestKeyElement calldata keyElement, 152 : : uint256 partialValue, 153 : : bool isApproved 154 : : ) public onlyRole(RULE_CONDITIONAL_TRANSFER_OPERATOR_ROLE) { 155 : 39 : _approveTransferRequestKeyElement(keyElement, partialValue, isApproved); 156 : : } 157 : : 158 : : /** 159 : : * @notice approve a transferRequestby using its id 160 : : */ 161 : : function approveTransferRequestWithId( 162 : : uint256 requestId_, 163 : : bool isApproved 164 : : ) public onlyRole(RULE_CONDITIONAL_TRANSFER_OPERATOR_ROLE) { 165 [ + ]: 4 : if (requestId_ + 1 > requestId) { 166 : 2 : revert RuleConditionalTransfer_InvalidId(); 167 : : } 168 : 2 : TransferRequest memory transferRequest = transferRequests[ 169 : : IdToKey[requestId_] 170 : : ]; 171 : 2 : _approveRequest(transferRequest, isApproved); 172 : : } 173 : : 174 : : /** 175 : : * @notice reset to None the status of a request 176 : : */ 177 : : function resetRequestStatus( 178 : : uint256 requestId_ 179 : : ) public onlyRole(RULE_CONDITIONAL_TRANSFER_OPERATOR_ROLE) { 180 [ + ]: 2 : if (requestId_ + 1 > requestId) { 181 : 1 : revert RuleConditionalTransfer_InvalidId(); 182 : : } 183 : 1 : bytes32 key = IdToKey[requestId_]; 184 : 1 : _resetRequestStatus(key); 185 : : } 186 : : 187 : : /* ============ Batch function ============ */ 188 : : /** 189 : : * @notice Batch version of {approveTransferRequestWithId} 190 : : */ 191 : : function approveTransferRequestBatchWithId( 192 : : uint256[] calldata requestId_, 193 : : bool[] calldata isApproved 194 : : ) public onlyRole(RULE_CONDITIONAL_TRANSFER_OPERATOR_ROLE) { 195 [ + ]: 5 : if (requestId_.length == 0) { 196 : 1 : revert RuleConditionalTransfer_EmptyArray(); 197 : : } 198 [ + ]: 4 : if (requestId_.length != isApproved.length) { 199 : 1 : revert RuleConditionalTransfer_InvalidLengthArray(); 200 : : } 201 : : // Check id validity before performing actions 202 : 3 : for (uint256 i = 0; i < requestId_.length; ++i) { 203 [ + ]: 11 : if (requestId_[i] + 1 > requestId) { 204 : 1 : revert RuleConditionalTransfer_InvalidId(); 205 : : } 206 : : } 207 : 2 : for (uint256 i = 0; i < requestId_.length; ++i) { 208 : 5 : TransferRequest memory transferRequest = transferRequests[ 209 : : IdToKey[requestId_[i]] 210 : : ]; 211 : 5 : _approveRequest(transferRequest, isApproved[i]); 212 : : } 213 : : } 214 : : 215 : : /** 216 : : * @notice Batch version of {approveTransferRequest} 217 : : */ 218 : : function approveTransferRequestBatch( 219 : : TransferRequestKeyElement[] calldata keyElements, 220 : : uint256[] calldata partialValues, 221 : : bool[] calldata isApproved 222 : : ) public onlyRole(RULE_CONDITIONAL_TRANSFER_OPERATOR_ROLE) { 223 [ + ]: 6 : if (keyElements.length == 0) { 224 : 1 : revert RuleConditionalTransfer_EmptyArray(); 225 : : } 226 : : if ( 227 : 5 : (keyElements.length != partialValues.length) || 228 : : (partialValues.length != isApproved.length) 229 [ + ]: 3 : ) { 230 : 3 : revert RuleConditionalTransfer_InvalidLengthArray(); 231 : : } 232 : 2 : for (uint256 i = 0; i < keyElements.length; ++i) { 233 : 9 : _approveTransferRequestKeyElement( 234 : : keyElements[i], 235 : : partialValues[i], 236 : : isApproved[i] 237 : : ); 238 : : } 239 : : } 240 : : 241 : : /** 242 : : * @notice Batch version of {createTransferRequestWithApproval} 243 : : */ 244 : : function createTransferRequestWithApprovalBatch( 245 : : TransferRequestKeyElement[] calldata keyElements 246 : : ) public onlyRole(RULE_CONDITIONAL_TRANSFER_OPERATOR_ROLE) { 247 [ + ]: 2 : if (keyElements.length == 0) { 248 : 1 : revert RuleConditionalTransfer_EmptyArray(); 249 : : } 250 : 1 : for (uint256 i = 0; i < keyElements.length; ++i) { 251 : 4 : _createTransferRequestWithApproval(keyElements[i]); 252 : : } 253 : : } 254 : : 255 : : /** 256 : : * @notice Batch version of {resetRequestStatus} 257 : : */ 258 : : function resetRequestStatusBatch( 259 : : uint256[] memory requestIds 260 : : ) public onlyRole(RULE_CONDITIONAL_TRANSFER_OPERATOR_ROLE) { 261 [ + ]: 3 : if (requestIds.length == 0) { 262 : 1 : revert RuleConditionalTransfer_EmptyArray(); 263 : : } 264 : : // Check id validity before performing actions 265 : 2 : for (uint256 i = 0; i < requestIds.length; ++i) { 266 [ + ]: 4 : if (requestIds[i] + 1 > requestId) { 267 : 1 : revert RuleConditionalTransfer_InvalidId(); 268 : : } 269 : : } 270 : 1 : for (uint256 i = 0; i < requestIds.length; ++i) { 271 : 3 : bytes32 key = IdToKey[requestIds[i]]; 272 : 3 : _resetRequestStatus(key); 273 : : } 274 : : } 275 : : 276 : : /* ============ ACCESS CONTROL ============ */ 277 : : /** 278 : : * @dev Returns `true` if `account` has been granted `role`. 279 : : */ 280 : : function hasRole( 281 : : bytes32 role, 282 : : address account 283 : : ) public view virtual override(AccessControl) returns (bool) { 284 : : // The Default Admin has all roles 285 [ + ]: 704 : if (AccessControl.hasRole(DEFAULT_ADMIN_ROLE, account)) { 286 : 137 : return true; 287 : : } 288 : 567 : return AccessControl.hasRole(role, account); 289 : : } 290 : : 291 : : /*////////////////////////////////////////////////////////////// 292 : : INTERNAL FUNCTIONS 293 : : //////////////////////////////////////////////////////////////*/ 294 : : function _approveTransferRequestKeyElement( 295 : : TransferRequestKeyElement calldata keyElement, 296 : : uint256 partialValue, 297 : : bool isApproved 298 : : ) internal { 299 [ + ]: 48 : if (partialValue > keyElement.value) { 300 : 1 : revert RuleConditionalTransfer_InvalidValueApproved(); 301 : : } 302 : 47 : bytes32 key = keccak256( 303 : : abi.encode(keyElement.from, keyElement.to, keyElement.value) 304 : : ); 305 : 47 : TransferRequest memory transferRequest = transferRequests[key]; 306 [ + + ]: 47 : if (partialValue > 0) { 307 [ + ]: 9 : if (!isApproved) { 308 : 1 : revert RuleConditionalTransfer_CannotDeniedPartially(); 309 : : } 310 : : // Denied the first request 311 : 8 : _approveRequest(transferRequest, false); 312 : : // Create new request 313 : 8 : _createTransferRequestWithApproval( 314 : : TransferRequestKeyElement({ 315 : : from: keyElement.from, 316 : : to: keyElement.to, 317 : : value: partialValue 318 : : }) 319 : : ); 320 : : } else { 321 : 38 : _approveRequest(transferRequest, isApproved); 322 : : } 323 : : } 324 : : 325 : : function _createTransferRequestWithApproval( 326 : : TransferRequestKeyElement memory keyElement_ 327 : : ) internal { 328 : : // WAIT => Will overwrite 329 : : // APPROVED => will overwrite previous status with a new delay 330 : : // DENIED => will overwrite 331 : 17 : bytes32 key = keccak256( 332 : : abi.encode(keyElement_.from, keyElement_.to, keyElement_.value) 333 : : ); 334 [ + + ]: 17 : if (_checkRequestStatus(key)) { 335 : : // Only if it is a new request 336 : 16 : TransferRequest memory newTransferApproval = TransferRequest({ 337 : : key: key, 338 : : id: requestId, 339 : : keyElement: keyElement_, 340 : : askTime: 0, 341 : : // Warning: overflow possible if timeLimitToTransfer == max(uint256) 342 : : maxTime: block.timestamp + 343 : : options.timeLimit.timeLimitToTransfer, 344 : : status: STATUS.APPROVED 345 : : }); 346 : 16 : transferRequests[key] = newTransferApproval; 347 : 16 : IdToKey[requestId] = key; 348 : 16 : emit transferApproved( 349 : : key, 350 : : keyElement_.from, 351 : : keyElement_.to, 352 : : keyElement_.value, 353 : : requestId 354 : : ); 355 : 16 : ++requestId; 356 : : } else { 357 : : // Overwrite previous approval 358 : : // Warning: overflow possible if timeLimitToTransfer == max(uint256) 359 : 1 : transferRequests[key].maxTime = 360 : : block.timestamp + 361 : : options.timeLimit.timeLimitToTransfer; 362 : 1 : transferRequests[key].status = STATUS.APPROVED; 363 : 1 : emit transferApproved( 364 : : key, 365 : : keyElement_.from, 366 : : keyElement_.to, 367 : : keyElement_.value, 368 : : transferRequests[key].id 369 : : ); 370 : : } 371 : : } 372 : : 373 : : function _resetRequestStatus(bytes32 key) internal { 374 : 10 : transferRequests[key].status = STATUS.NONE; 375 : 10 : emit transferReset( 376 : : key, 377 : : transferRequests[key].keyElement.from, 378 : : transferRequests[key].keyElement.to, 379 : : transferRequests[key].keyElement.value, 380 : : transferRequests[key].id 381 : : ); 382 : : } 383 : : 384 : : /** 385 : : * @dev check if it is a new request or not 386 : : */ 387 : : function _checkRequestStatus(bytes32 key) internal view returns (bool) { 388 : : // Status NONE not enough because reset is possible 389 : 133 : return 390 : 133 : (transferRequests[key].status == STATUS.NONE) && 391 : : (transferRequests[key].key == 0x0); 392 : : } 393 : : 394 : : function _approveRequest( 395 : : TransferRequest memory transferRequest, 396 : : bool isApproved 397 : : ) internal { 398 : : // status 399 [ + ]: 53 : if (transferRequest.status != STATUS.WAIT) { 400 : 1 : revert RuleConditionalTransfer_Wrong_Status(); 401 : : } 402 [ + + ]: 32 : if (isApproved) { 403 : : // Time 404 : : if ( 405 : 32 : block.timestamp > 406 : : (transferRequest.askTime + options.timeLimit.timeLimitToApprove) 407 [ + ]: 3 : ) { 408 : 3 : revert RuleConditionalTransfer_timeExceeded(); 409 : : } 410 : : // Set status 411 : 29 : transferRequests[transferRequest.key].status = STATUS.APPROVED; 412 : : // Set max time 413 : 29 : transferRequests[transferRequest.key].maxTime = 414 : : block.timestamp + 415 : : options.timeLimit.timeLimitToTransfer; 416 : 29 : emit transferApproved( 417 : : transferRequest.key, 418 : : transferRequest.keyElement.from, 419 : : transferRequest.keyElement.to, 420 : : transferRequest.keyElement.value, 421 : : transferRequests[transferRequest.key].id 422 : : ); 423 : : if ( 424 : 29 : options.automaticTransfer.isActivate && 425 : 7 : address(options.automaticTransfer.cmtat) != address(0) 426 [ + ]: 7 : ) { 427 : : // Transfer with approval 428 : : // External call 429 : : if ( 430 : 7 : options.automaticTransfer.cmtat.allowance( 431 : : transferRequest.keyElement.from, 432 : : address(this) 433 : : ) >= transferRequest.keyElement.value 434 [ + ]: 3 : ) { 435 : : // Will call the ruleEngine and the rule again... 436 : 3 : options.automaticTransfer.cmtat.safeTransferFrom( 437 : : transferRequest.keyElement.from, 438 : : transferRequest.keyElement.to, 439 : : transferRequest.keyElement.value 440 : : ); 441 : : } 442 : : } 443 : : } else { 444 : 20 : transferRequests[transferRequest.key].status = STATUS.DENIED; 445 : 20 : emit transferDenied( 446 : : transferRequest.key, 447 : : transferRequest.keyElement.from, 448 : : transferRequest.keyElement.to, 449 : : transferRequest.keyElement.value, 450 : : transferRequests[transferRequest.key].id 451 : : ); 452 : : } 453 : : } 454 : : 455 : : /** 456 : : * @notice update the request during a transfer 457 : : */ 458 : : function _updateProcessedTransfer(bytes32 key) internal { 459 : : // Reset to zero 460 : 18 : transferRequests[key].maxTime = 0; 461 : 18 : transferRequests[key].askTime = 0; 462 : : // Change status 463 : 18 : transferRequests[key].status = STATUS.EXECUTED; 464 : : // Emit event 465 : 18 : emit transferProcessed( 466 : : key, 467 : : transferRequests[key].keyElement.from, 468 : : transferRequests[key].keyElement.to, 469 : : transferRequests[key].keyElement.value, 470 : : transferRequests[key].id 471 : : ); 472 : : } 473 : : }
-
-
-
- LCOV - lcov.info - src/rules/operation
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Filename
- Line Coverage
- Functions
- Branches
-
-
- RuleConditionalTransfer.sol
-
-
- 99.1 %
- 105 / 106
- 94.4 %
- 17 / 18
- 100.0 %
- 33 / 33
-
-
-
- LCOV - lcov.info - src/rules/operation
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Filename
- Line Coverage
- Functions
- Branches
-
-
- RuleConditionalTransfer.sol
-
-
- 99.1 %
- 105 / 106
- 94.4 %
- 17 / 18
- 100.0 %
- 33 / 33
-
-
-
- LCOV - lcov.info - src/rules/operation
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Filename
- Line Coverage
- Functions
- Branches
-
-
- RuleConditionalTransfer.sol
-
-
- 99.1 %
- 105 / 106
- 94.4 %
- 17 / 18
- 100.0 %
- 33 / 33
-
-
-
- LCOV - lcov.info - src/rules/operation
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Filename
- Line Coverage
- Functions
- Branches
-
-
- RuleConditionalTransfer.sol
-
-
- 99.1 %
- 105 / 106
- 94.4 %
- 17 / 18
- 100.0 %
- 33 / 33
-
-
-
- LCOV - lcov.info - src/rules/validation/RuleBlacklist.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/validation/RuleBlacklist.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/validation/RuleSanctionList.sol
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Branch data Line data Source code
-
- 1 : : // SPDX-License-Identifier: MPL-2.0 2 : : 3 : : pragma solidity ^0.8.20; 4 : : 5 : : import "OZ/access/AccessControl.sol"; 6 : : import "../../modules/MetaTxModuleStandalone.sol"; 7 : : import "./abstract/RuleSanctionListInvariantStorage.sol"; 8 : : import "./abstract/RuleValidateTransfer.sol"; 9 : : 10 : : interface SanctionsList { 11 : : function isSanctioned(address addr) external view returns (bool); 12 : : } 13 : : 14 : : contract RuleSanctionList is 15 : : AccessControl, 16 : : MetaTxModuleStandalone, 17 : : RuleValidateTransfer, 18 : : RuleSanctionlistInvariantStorage 19 : : { 20 : : SanctionsList public sanctionsList; 21 : : 22 : : /** 23 : : * @param admin Address of the contract (Access Control) 24 : : * @param forwarderIrrevocable Address of the forwarder, required for the gasless support 25 : : */ 26 : : constructor( 27 : : address admin, 28 : : address forwarderIrrevocable, 29 : : address sanctionContractOracle_ 30 : : ) MetaTxModuleStandalone(forwarderIrrevocable) { 31 [ + ]: 13 : if (admin == address(0)) { 32 : 1 : revert RuleSanctionList_AdminWithAddressZeroNotAllowed(); 33 : : } 34 [ + ]: 12 : if (sanctionContractOracle_ != address(0)) { 35 : 1 : _setSanctionListOracle(sanctionContractOracle_); 36 : : } 37 : 12 : _grantRole(DEFAULT_ADMIN_ROLE, admin); 38 : : } 39 : : 40 : : /** 41 : : * @notice Set the oracle contract 42 : : * @param sanctionContractOracle_ address of your oracle contract 43 : : * @dev zero address is authorized to authorize all transfers 44 : : */ 45 : : function setSanctionListOracle( 46 : : address sanctionContractOracle_ 47 : : ) public onlyRole(SANCTIONLIST_ROLE) { 48 : 10 : _setSanctionListOracle(sanctionContractOracle_); 49 : : } 50 : : 51 : : /** 52 : : * @notice Check if an addres is in the whitelist or not 53 : : * @param _from the origin address 54 : : * @param _to the destination address 55 : : * @return The restricion code or REJECTED_CODE_BASE.TRANSFER_OK 56 : : **/ 57 : : function detectTransferRestriction( 58 : : address _from, 59 : : address _to, 60 : : uint256 /*_amount */ 61 : : ) public view override returns (uint8) { 62 [ + ]: 7 : if (address(sanctionsList) != address(0)) { 63 [ + + ]: 7 : if (sanctionsList.isSanctioned(_from)) { 64 : 2 : return CODE_ADDRESS_FROM_IS_SANCTIONED; 65 [ + ]: 5 : } else if (sanctionsList.isSanctioned(_to)) { 66 : 2 : return CODE_ADDRESS_TO_IS_SANCTIONED; 67 : : } 68 : : } 69 : 3 : return uint8(REJECTED_CODE_BASE.TRANSFER_OK); 70 : : } 71 : : 72 : : /** 73 : : * @notice To know if the restriction code is valid for this rule or not. 74 : : * @param _restrictionCode The target restriction code 75 : : * @return true if the restriction code is known, false otherwise 76 : : **/ 77 : : function canReturnTransferRestrictionCode( 78 : : uint8 _restrictionCode 79 : : ) external pure override returns (bool) { 80 : 3 : return 81 : 3 : _restrictionCode == CODE_ADDRESS_FROM_IS_SANCTIONED || 82 : 2 : _restrictionCode == CODE_ADDRESS_TO_IS_SANCTIONED; 83 : : } 84 : : 85 : : /** 86 : : * @notice Return the corresponding message 87 : : * @param _restrictionCode The target restriction code 88 : : * @return true if the transfer is valid, false otherwise 89 : : **/ 90 : : function messageForTransferRestriction( 91 : : uint8 _restrictionCode 92 : : ) external pure override returns (string memory) { 93 [ + + ]: 3 : if (_restrictionCode == CODE_ADDRESS_FROM_IS_SANCTIONED) { 94 : 1 : return TEXT_ADDRESS_FROM_IS_SANCTIONED; 95 [ + + ]: 2 : } else if (_restrictionCode == CODE_ADDRESS_TO_IS_SANCTIONED) { 96 : 1 : return TEXT_ADDRESS_TO_IS_SANCTIONED; 97 : : } else { 98 : 1 : return TEXT_CODE_NOT_FOUND; 99 : : } 100 : : } 101 : : 102 : : /* ============ ACCESS CONTROL ============ */ 103 : : /** 104 : : * @dev Returns `true` if `account` has been granted `role`. 105 : : */ 106 : : function hasRole( 107 : : bytes32 role, 108 : : address account 109 : : ) public view virtual override(AccessControl) returns (bool) { 110 : : // The Default Admin has all roles 111 [ + ]: 24 : if (AccessControl.hasRole(DEFAULT_ADMIN_ROLE, account)) { 112 : 11 : return true; 113 : : } 114 : 13 : return AccessControl.hasRole(role, account); 115 : : } 116 : : 117 : : /*////////////////////////////////////////////////////////////// 118 : : INTERNAL FUNCTIONS 119 : : //////////////////////////////////////////////////////////////*/ 120 : : 121 : : function _setSanctionListOracle(address sanctionContractOracle_) internal { 122 : 11 : sanctionsList = SanctionsList(sanctionContractOracle_); 123 : 11 : emit SetSanctionListOracle(address(sanctionContractOracle_)); 124 : : } 125 : : 126 : : /*////////////////////////////////////////////////////////////// 127 : : ERC-2771 128 : : //////////////////////////////////////////////////////////////*/ 129 : : 130 : : /** 131 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 132 : : */ 133 : : function _msgSender() 134 : : internal 135 : : view 136 : : override(ERC2771Context, Context) 137 : : returns (address sender) 138 : : { 139 : 23 : return ERC2771Context._msgSender(); 140 : : } 141 : : 142 : : /** 143 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 144 : : */ 145 : : function _msgData() 146 : : internal 147 : : view 148 : : override(ERC2771Context, Context) 149 : : returns (bytes calldata) 150 : : { 151 : 0 : return ERC2771Context._msgData(); 152 : : } 153 : : 154 : : /** 155 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 156 : : */ 157 : : function _contextSuffixLength() 158 : : internal 159 : : view 160 : : override(ERC2771Context, Context) 161 : : returns (uint256) 162 : : { 163 : 23 : return ERC2771Context._contextSuffixLength(); 164 : : } 165 : : }
-
-
-
- LCOV - lcov.info - src/rules/validation/RuleWhitelist.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/validation/RuleWhitelist.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/validation/RuleWhitelist.sol
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/validation/RuleWhitelistWrapper.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/validation/RuleWhitelistWrapper.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/validation/abstract/RuleAddressList/RuleAddressList.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/validation/abstract/RuleAddressList/RuleAddressList.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/validation/abstract/RuleAddressList/RuleAddressListInternal.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/validation/abstract/RuleAddressList/RuleAddressListInternal.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/validation/abstract/RuleAddressList/RuleAddressListInternal.sol
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/validation/abstract/RuleAddressList
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Filename
- Line Coverage
- Functions
- Branches
-
-
- RuleAddressList.sol
-
-
- 95.7 %
- 22 / 23
- 91.7 %
- 11 / 12
- 100.0 %
- 2 / 2
-
-
- RuleAddressListInternal.sol
-
-
- 100.0 %
- 22 / 22
- 100.0 %
- 6 / 6
- 100.0 %
- 4 / 4
-
-
-
- LCOV - lcov.info - src/rules/validation/abstract/RuleAddressList
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Filename
- Line Coverage
- Functions
- Branches
-
-
- RuleAddressList.sol
-
-
- 95.7 %
- 22 / 23
- 91.7 %
- 11 / 12
- 100.0 %
- 2 / 2
-
-
- RuleAddressListInternal.sol
-
-
- 100.0 %
- 22 / 22
- 100.0 %
- 6 / 6
- 100.0 %
- 4 / 4
-
-
-
- LCOV - lcov.info - src/rules/validation/abstract/RuleAddressList
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Filename
- Line Coverage
- Functions
- Branches
-
-
- RuleAddressList.sol
-
-
- 95.7 %
- 22 / 23
- 91.7 %
- 11 / 12
- 100.0 %
- 2 / 2
-
-
- RuleAddressListInternal.sol
-
-
- 100.0 %
- 22 / 22
- 100.0 %
- 6 / 6
- 100.0 %
- 4 / 4
-
-
-
- LCOV - lcov.info - src/rules/validation/abstract/RuleAddressList
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Filename
- Line Coverage
- Functions
- Branches
-
-
- RuleAddressList.sol
-
-
- 95.7 %
- 22 / 23
- 91.7 %
- 11 / 12
- 100.0 %
- 2 / 2
-
-
- RuleAddressListInternal.sol
-
-
- 100.0 %
- 22 / 22
- 100.0 %
- 6 / 6
- 100.0 %
- 4 / 4
-
-
-
- LCOV - lcov.info - src/rules/validation/abstract/RuleValidateTransfer.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/validation/abstract/RuleValidateTransfer.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/validation/abstract/RuleValidateTransfer.sol
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - src/rules/validation/abstract
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Filename
- Line Coverage
- Functions
- Branches
-
-
- RuleValidateTransfer.sol
-
-
- 100.0 %
- 2 / 2
- 100.0 %
- 1 / 1
- -
- 0 / 0
-
-
- RuleWhitelistCommon.sol
-
-
- 100.0 %
- 8 / 8
- 100.0 %
- 2 / 2
- 100.0 %
- 4 / 4
-
-
-
- LCOV - lcov.info - src/rules/validation/abstract
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Filename
- Line Coverage
- Functions
- Branches
-
-
- RuleValidateTransfer.sol
-
-
- 100.0 %
- 2 / 2
- 100.0 %
- 1 / 1
- -
- 0 / 0
-
-
- RuleWhitelistCommon.sol
-
-
- 100.0 %
- 8 / 8
- 100.0 %
- 2 / 2
- 100.0 %
- 4 / 4
-
-
-
- LCOV - lcov.info - src/rules/validation/abstract
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Filename
- Line Coverage
- Functions
- Branches
-
-
- RuleValidateTransfer.sol
-
-
- 100.0 %
- 2 / 2
- 100.0 %
- 1 / 1
- -
- 0 / 0
-
-
- RuleWhitelistCommon.sol
-
-
- 100.0 %
- 8 / 8
- 100.0 %
- 2 / 2
- 100.0 %
- 4 / 4
-
-
-
- LCOV - lcov.info - src/rules/validation/abstract
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Filename
- Line Coverage
- Functions
- Branches
-
-
- RuleValidateTransfer.sol
-
-
- 100.0 %
- 2 / 2
- 100.0 %
- 1 / 1
- -
- 0 / 0
-
-
- RuleWhitelistCommon.sol
-
-
- 100.0 %
- 8 / 8
- 100.0 %
- 2 / 2
- 100.0 %
- 4 / 4
-
-
-
- LCOV - lcov.info - src/rules/validation
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Filename
- Line Coverage
- Functions
- Branches
-
-
- RuleWhitelist.sol
-
-
- 100.0 %
- 5 / 5
- 100.0 %
- 2 / 2
- 100.0 %
- 4 / 4
-
-
- RuleBlacklist.sol
-
-
- 100.0 %
- 13 / 13
- 100.0 %
- 4 / 4
- 100.0 %
- 8 / 8
-
-
- RuleWhitelistWrapper.sol
-
-
- 96.4 %
- 27 / 28
- 83.3 %
- 5 / 6
- 100.0 %
- 9 / 9
-
-
- RuleSanctionList.sol
-
-
- 96.4 %
- 27 / 28
- 90.0 %
- 9 / 10
- 100.0 %
- 11 / 11
-
-
-
- LCOV - lcov.info - src/rules/validation
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Filename
- Line Coverage
- Functions
- Branches
-
-
- RuleWhitelistWrapper.sol
-
-
- 96.4 %
- 27 / 28
- 83.3 %
- 5 / 6
- 100.0 %
- 9 / 9
-
-
- RuleSanctionList.sol
-
-
- 96.4 %
- 27 / 28
- 90.0 %
- 9 / 10
- 100.0 %
- 11 / 11
-
-
- RuleWhitelist.sol
-
-
- 100.0 %
- 5 / 5
- 100.0 %
- 2 / 2
- 100.0 %
- 4 / 4
-
-
- RuleBlacklist.sol
-
-
- 100.0 %
- 13 / 13
- 100.0 %
- 4 / 4
- 100.0 %
- 8 / 8
-
-
-
- LCOV - lcov.info - src/rules/validation
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Filename
- Line Coverage
- Functions
- Branches
-
-
- RuleSanctionList.sol
-
-
- 96.4 %
- 27 / 28
- 90.0 %
- 9 / 10
- 100.0 %
- 11 / 11
-
-
- RuleWhitelistWrapper.sol
-
-
- 96.4 %
- 27 / 28
- 83.3 %
- 5 / 6
- 100.0 %
- 9 / 9
-
-
- RuleWhitelist.sol
-
-
- 100.0 %
- 5 / 5
- 100.0 %
- 2 / 2
- 100.0 %
- 4 / 4
-
-
- RuleBlacklist.sol
-
-
- 100.0 %
- 13 / 13
- 100.0 %
- 4 / 4
- 100.0 %
- 8 / 8
-
-
-
- LCOV - lcov.info - src/rules/validation
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Filename
- Line Coverage
- Functions
- Branches
-
-
- RuleBlacklist.sol
-
-
- 100.0 %
- 13 / 13
- 100.0 %
- 4 / 4
- 100.0 %
- 8 / 8
-
-
- RuleSanctionList.sol
-
-
- 96.4 %
- 27 / 28
- 90.0 %
- 9 / 10
- 100.0 %
- 11 / 11
-
-
- RuleWhitelist.sol
-
-
- 100.0 %
- 5 / 5
- 100.0 %
- 2 / 2
- 100.0 %
- 4 / 4
-
-
- RuleWhitelistWrapper.sol
-
-
- 96.4 %
- 27 / 28
- 83.3 %
- 5 / 6
- 100.0 %
- 9 / 9
-
-
-
- LCOV - lcov.info - test/RuleConditionalTransfer/utils/RuleCTDeployment.sol
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Branch data Line data Source code
-
- 1 : : // SPDX-License-Identifier: MPL-2.0 2 : : pragma solidity ^0.8.20; 3 : : 4 : : import "forge-std/Test.sol"; 5 : : import "../../HelperContract.sol"; 6 : : import "src/RuleEngine.sol"; 7 : : 8 : : /** 9 : : * @title Tests on the Access Control 10 : : */ 11 : : contract RuleCTDeployment is Test, HelperContract { 12 : : // Arrange 13 : : constructor() { 14 : 13 : TIME_LIMIT memory timeLimit_ = TIME_LIMIT({ 15 : : timeLimitToApprove: 7 days, 16 : : timeLimitToTransfer: 30 days 17 : : }); 18 : : 19 : 13 : AUTOMATIC_APPROVAL memory automaticApproval_ = AUTOMATIC_APPROVAL({ 20 : : isActivate: false, 21 : : timeLimitBeforeAutomaticApproval: 0 22 : : }); 23 : : 24 : 13 : ISSUANCE memory issuanceOption_ = ISSUANCE({ 25 : : authorizedMintWithoutApproval: false, 26 : : authorizedBurnWithoutApproval: false 27 : : }); 28 : 13 : AUTOMATIC_TRANSFER memory automaticTransfer_ = AUTOMATIC_TRANSFER({ 29 : : isActivate: false, 30 : : cmtat: IERC20(address(0)) 31 : : }); 32 : : 33 : 13 : OPTION memory options = OPTION({ 34 : : issuance: issuanceOption_, 35 : : timeLimit: timeLimit_, 36 : : automaticApproval: automaticApproval_, 37 : : automaticTransfer: automaticTransfer_ 38 : : }); 39 : 13 : ruleEngineMock = new RuleEngine( 40 : : RULE_ENGINE_OPERATOR_ADDRESS, 41 : : ZERO_ADDRESS, 42 : : ZERO_ADDRESS 43 : : ); 44 : 13 : vm.prank(DEFAULT_ADMIN_ADDRESS); 45 : 13 : ruleConditionalTransfer = new RuleConditionalTransfer( 46 : : DEFAULT_ADMIN_ADDRESS, 47 : : ZERO_ADDRESS, 48 : : ruleEngineMock, 49 : : options 50 : : ); 51 : 13 : vm.prank(DEFAULT_ADMIN_ADDRESS); 52 : 13 : ruleConditionalTransfer.grantRole( 53 : : RULE_CONDITIONAL_TRANSFER_OPERATOR_ROLE, 54 : : CONDITIONAL_TRANSFER_OPERATOR_ADDRESS 55 : : ); 56 : : } 57 : : }
-
-
-
- LCOV - lcov.info - test/utils/CMTATDeployment.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - test/utils/CMTATDeployment.sol - functions
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - test/utils/CMTATDeployment.sol
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Branch data Line data Source code
-
- 1 : : //SPDX-License-Identifier: MPL-2.0 2 : : pragma solidity ^0.8.20; 3 : : 4 : : import "forge-std/Test.sol"; 5 : : import "OZ/access/AccessControl.sol"; 6 : : import "CMTAT/CMTAT_STANDALONE.sol"; 7 : : 8 : : contract CMTATDeployment { 9 : : // Share with helper contract 10 : : address constant ZERO_ADDRESS = address(0); 11 : : address constant DEFAULT_ADMIN_ADDRESS = address(1); 12 : : 13 : : CMTAT_STANDALONE public cmtat; 14 : : 15 : : constructor() { 16 : : // CMTAT 17 : 86 : ICMTATConstructor.ERC20Attributes 18 : : memory erc20Attributes = ICMTATConstructor.ERC20Attributes( 19 : : "CMTA Token", 20 : : "CMTAT", 21 : : 0 22 : : ); 23 : 86 : ICMTATConstructor.BaseModuleAttributes 24 : : memory baseModuleAttributes = ICMTATConstructor 25 : : .BaseModuleAttributes( 26 : : "CMTAT_ISIN", 27 : : "https://cmta.ch", 28 : : "CMTAT_info" 29 : : ); 30 : 86 : ICMTATConstructor.Engine memory engines = ICMTATConstructor.Engine( 31 : : IRuleEngine(ZERO_ADDRESS), 32 : : IDebtEngine(ZERO_ADDRESS), 33 : : IAuthorizationEngine(ZERO_ADDRESS), 34 : : IERC1643(ZERO_ADDRESS) 35 : : ); 36 : 86 : cmtat = new CMTAT_STANDALONE( 37 : : ZERO_ADDRESS, 38 : : DEFAULT_ADMIN_ADDRESS, 39 : : erc20Attributes, 40 : : baseModuleAttributes, 41 : : engines 42 : : ); 43 : : } 44 : : }
-
-
-
- LCOV - lcov.info - test/utils/SanctionListOracle.sol
-
- LCOV - code coverage report
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- LCOV - lcov.info - validation/RuleBlacklist.sol - functions
+
+ LCOV - code coverage report
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LCOV - lcov.info - validation/RuleBlacklist.sol - functions
+
+ LCOV - code coverage report
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LCOV - lcov.info - validation/RuleBlacklist.sol
+
+ LCOV - code coverage report
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Branch data Line data Source code
+
+ 1 : : // SPDX-License-Identifier: MPL-2.0 2 : : 3 : : pragma solidity ^0.8.20; 4 : : 5 : : import {AccessControl} from "OZ/access/AccessControl.sol"; 6 : : /* ==== Abtract contracts === */ 7 : : import {RuleBlacklistInvariantStorage} from 8 : : "./abstract/RuleAddressSet/invariantStorage/RuleBlacklistInvariantStorage.sol"; 9 : : import {RuleAddressSet} from "./abstract/RuleAddressSet/RuleAddressSet.sol"; 10 : : import {RuleValidateTransfer, RuleValidateTransfer} from "./abstract/RuleValidateTransfer.sol"; 11 : : /* ==== Interfaces === */ 12 : : import {IERC7943NonFungibleComplianceExtend} from "../interfaces/IERC7943NonFungibleCompliance.sol"; 13 : : /* ==== CMTAT === */ 14 : : import {IERC1404, IERC1404Extend} from "CMTAT/interfaces/tokenization/draft-IERC1404.sol"; 15 : : import {IERC3643IComplianceContract} from "CMTAT/interfaces/tokenization/IERC3643Partial.sol"; 16 : : import {IRuleEngine} from "CMTAT/interfaces/engine/IRuleEngine.sol"; 17 : : /* ==== IRuleEngine === */ 18 : : import {IRule} from "RuleEngine/interfaces/IRule.sol"; 19 : : 20 : : /** 21 : : * @title a blacklist manager 22 : : */ 23 : : contract RuleBlacklist is RuleValidateTransfer, RuleAddressSet, RuleBlacklistInvariantStorage { 24 : : /*////////////////////////////////////////////////////////////// 25 : : CONSTRUCTOR 26 : : //////////////////////////////////////////////////////////////*/ 27 : : /** 28 : : * @param admin Address of the contract (Access Control) 29 : : * @param forwarderIrrevocable Address of the forwarder, required for the gasless support 30 : : */ 31 : : constructor(address admin, address forwarderIrrevocable) RuleAddressSet(admin, forwarderIrrevocable) {} 32 : : 33 : : /* ============ View Functions ============ */ 34 : : /** 35 : : * @notice Check if an addres is in the whitelist or not 36 : : * @param from the origin address 37 : : * @param to the destination address 38 : : * @return The restricion code or REJECTED_CODE_BASE.TRANSFER_OK 39 : : * 40 : : */ 41 : 22 : function detectTransferRestriction(address from, address to, uint256 /* value */ ) 42 : : public 43 : : view 44 : : override(IERC1404) 45 : : returns (uint8) 46 : : { 47 [ + + ]: 43 : if (isAddressListed(from)) { 48 : 14 : return CODE_ADDRESS_FROM_IS_BLACKLISTED; 49 [ + + ]: 29 : } else if (isAddressListed(to)) { 50 : 13 : return CODE_ADDRESS_TO_IS_BLACKLISTED; 51 : : } else { 52 : 16 : return uint8(IERC1404Extend.REJECTED_CODE_BASE.TRANSFER_OK); 53 : : } 54 : : } 55 : : 56 : : /* 57 : : * @inheritdoc IERC7943NonFungibleComplianceExtend 58 : : */ 59 : 7 : function detectTransferRestriction(address from, address to, uint256, /* tokenId */ uint256 value) 60 : : public 61 : : view 62 : : override(IERC7943NonFungibleComplianceExtend) 63 : : returns (uint8) 64 : : { 65 : 7 : return detectTransferRestriction(from, to, value); 66 : : } 67 : : 68 : : /* 69 : : * @inheritdoc IERC1404Extend 70 : : */ 71 : 16 : function detectTransferRestrictionFrom(address spender, address from, address to, uint256 value) 72 : : public 73 : : view 74 : : override(IERC1404Extend) 75 : : returns (uint8) 76 : : { 77 [ + + ]: 20 : if (isAddressListed(spender)) { 78 : 6 : return CODE_ADDRESS_SPENDER_IS_BLACKLISTED; 79 : : } else { 80 : 14 : return detectTransferRestriction(from, to, value); 81 : : } 82 : : } 83 : : 84 : : /** 85 : : * @inheritdoc IERC7943NonFungibleComplianceExtend 86 : : */ 87 : 4 : function detectTransferRestrictionFrom( 88 : : address spender, 89 : : address from, 90 : : address to, 91 : : uint256, /* tokenId */ 92 : : uint256 value 93 : : ) public view override(IERC7943NonFungibleComplianceExtend) returns (uint8) { 94 : 4 : return detectTransferRestrictionFrom(spender, from, to, value); 95 : : } 96 : : 97 : : /** 98 : : * @notice To know if the restriction code is valid for this rule or not. 99 : : * @param _restrictionCode The target restriction code 100 : : * @return true if the restriction code is known, false otherwise 101 : : * 102 : : */ 103 : 4 : function canReturnTransferRestrictionCode(uint8 _restrictionCode) 104 : : public 105 : : pure 106 : : virtual 107 : : override(IRule) 108 : : returns (bool) 109 : : { 110 : 4 : return _restrictionCode == CODE_ADDRESS_FROM_IS_BLACKLISTED 111 : 2 : || _restrictionCode == CODE_ADDRESS_TO_IS_BLACKLISTED || _restrictionCode == CODE_ADDRESS_SPENDER_IS_BLACKLISTED; 112 : : } 113 : : 114 : : /** 115 : : * @notice Return the corresponding message 116 : : * @param _restrictionCode The target restriction code 117 : : * @return true if the transfer is valid, false otherwise 118 : : * 119 : : */ 120 : 8 : function messageForTransferRestriction(uint8 _restrictionCode) 121 : : public 122 : : pure 123 : : virtual 124 : : override(IERC1404) 125 : : returns (string memory) 126 : : { 127 [ + + ]: 8 : if (_restrictionCode == CODE_ADDRESS_FROM_IS_BLACKLISTED) { 128 : 3 : return TEXT_ADDRESS_FROM_IS_BLACKLISTED; 129 [ + + ]: 5 : } else if (_restrictionCode == CODE_ADDRESS_TO_IS_BLACKLISTED) { 130 : 2 : return TEXT_ADDRESS_TO_IS_BLACKLISTED; 131 [ + + ]: 3 : } else if (_restrictionCode == CODE_ADDRESS_SPENDER_IS_BLACKLISTED) { 132 : 1 : return TEXT_ADDRESS_SPENDER_IS_BLACKLISTED; 133 : : } else { 134 : 2 : return TEXT_CODE_NOT_FOUND; 135 : : } 136 : : } 137 : : 138 : 0 : function supportsInterface(bytes4 interfaceId) public view virtual override(AccessControl, RuleValidateTransfer) returns (bool) { 139 : 0 : return AccessControl.supportsInterface(interfaceId) || RuleValidateTransfer.supportsInterface(interfaceId); 140 : : } 141 : : 142 : : /* ============ State Functions ============ */ 143 : : 144 : 9 : function transferred(address from, address to, uint256 value) 145 : : public 146 : : view 147 : : virtual 148 : : override(IERC3643IComplianceContract) 149 : : { 150 : 12 : uint8 code = this.detectTransferRestriction(from, to, value); 151 [ + + ]: 12 : require( 152 : : code == uint8(REJECTED_CODE_BASE.TRANSFER_OK), 153 : : RuleBlacklist_InvalidTransfer(address(this), from, to, value, code) 154 : : ); 155 : : } 156 : : 157 : 2 : function transferred(address spender, address from, address to, uint256 value) 158 : : public 159 : : view 160 : : virtual 161 : : override(IRuleEngine) 162 : : { 163 : 4 : uint8 code = this.detectTransferRestrictionFrom(spender, from, to, value); 164 [ + + ]: 4 : require( 165 : : code == uint8(REJECTED_CODE_BASE.TRANSFER_OK), 166 : : RuleBlacklist_InvalidTransferFrom(address(this), spender, from, to, value, code) 167 : : ); 168 : : } 169 : : 170 : 2 : function transferred(address spender, address from, address to, uint256 /* tokenId */,uint256 value) 171 : : public 172 : : view 173 : : virtual 174 : : override(IERC7943NonFungibleComplianceExtend) 175 : : { 176 : 2 : transferred(spender, from, to, value); 177 : : } 178 : : 179 : 3 : function transferred(address from, address to, uint256 /* tokenId */,uint256 value) 180 : : public 181 : : view 182 : : virtual 183 : : override(IERC7943NonFungibleComplianceExtend) 184 : : { 185 : 3 : transferred(from, to, value); 186 : : } 187 : : }
+
+
+
+ LCOV - lcov.info - validation/RuleSanctionsList.sol - functions
+
+ LCOV - code coverage report
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LCOV - lcov.info - validation/RuleSanctionsList.sol - functions
+
+ LCOV - code coverage report
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LCOV - lcov.info - validation/RuleSanctionsList.sol
+
+ LCOV - code coverage report
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Branch data Line data Source code
+
+ 1 : : // SPDX-License-Identifier: MPL-2.0 2 : : 3 : : pragma solidity ^0.8.20; 4 : : 5 : : import {AccessControl} from "OZ/access/AccessControl.sol"; 6 : : /* ==== Abtract contracts === */ 7 : : import {MetaTxModuleStandalone, ERC2771Context, Context} from "../../modules/MetaTxModuleStandalone.sol"; 8 : : import {AccessControlModuleStandalone} from "../../modules/AccessControlModuleStandalone.sol"; 9 : : import {RuleSanctionsListInvariantStorage} from "./abstract/RuleSanctionsListInvariantStorage.sol"; 10 : : import {RuleValidateTransfer, RuleValidateTransfer} from "./abstract/RuleValidateTransfer.sol"; 11 : : /* ==== Interfaces === */ 12 : : import {ISanctionsList} from "../interfaces/ISanctionsList.sol"; 13 : : import {IERC7943NonFungibleComplianceExtend} from "../interfaces/IERC7943NonFungibleCompliance.sol"; 14 : : /* ==== CMTAT === */ 15 : : import {IERC1404, IERC1404Extend} from "CMTAT/interfaces/tokenization/draft-IERC1404.sol"; 16 : : import {IERC3643IComplianceContract} from "CMTAT/interfaces/tokenization/IERC3643Partial.sol"; 17 : : import {IRuleEngine} from "CMTAT/interfaces/engine/IRuleEngine.sol"; 18 : : /* ==== IRuleEngine === */ 19 : : import {IRule} from "RuleEngine/interfaces/IRule.sol"; 20 : : 21 : : 22 : : /** 23 : : * @title RuleSanctionsList 24 : : * @notice Compliance rule enforcing sanctions-screening for token transfers. 25 : : * @dev 26 : : * This rule integrates a sanctions-oracle (e.g., Chainalysis) and blocks 27 : : * transfers when: 28 : : * - the sender is sanctioned, 29 : : * - the recipient is sanctioned, 30 : : * - or the spender/operator is sanctioned. 31 : : * 32 : : * Features: 33 : : * - Supports ERC-1404, ERC-3643 (transferred) and ERC-7943 non-fungible compliance flows. 34 : : * - Oracle address can be updated by accounts holding `SANCTIONLIST_ROLE`. 35 : : * - Zero oracle address disables sanctions checks (all transfers allowed). 36 : : * 37 : : * The rule is designed for RuleEngine or for direct integration with 38 : : * CMTAT / ERC-3643 compliant tokens. 39 : : */ 40 : : contract RuleSanctionsList is 41 : : AccessControlModuleStandalone, 42 : : MetaTxModuleStandalone, 43 : : RuleValidateTransfer, 44 : : RuleSanctionsListInvariantStorage 45 : : { 46 : : ISanctionsList public sanctionsList; 47 : : 48 : : /*////////////////////////////////////////////////////////////// 49 : : CONSTRUCTOR 50 : : //////////////////////////////////////////////////////////////*/ 51 : : /** 52 : : * @param admin Address of the contract (Access Control) 53 : : * @param forwarderIrrevocable Address of the forwarder, required for the gasless support 54 : : */ 55 : 17 : constructor(address admin, address forwarderIrrevocable, ISanctionsList sanctionContractOracle_) 56 : : MetaTxModuleStandalone(forwarderIrrevocable) 57 : : AccessControlModuleStandalone(admin) 58 : : { 59 [ + ]: 16 : if (address(sanctionContractOracle_) != address(0)) { 60 : 1 : _setSanctionListOracle(sanctionContractOracle_); 61 : : } 62 : : } 63 : : 64 : : /* ============ View Functions ============ */ 65 : : 66 : : /** 67 : : * @notice Check if an addres is in the SanctionsList or not 68 : : * @param from the origin address 69 : : * @param to the destination address 70 : : * @return The restricion code or REJECTED_CODE_BASE.TRANSFER_OK 71 : : * 72 : : */ 73 : 17 : function detectTransferRestriction(address from, address to, uint256 /*value */ ) 74 : : public 75 : : view 76 : : override(IERC1404) 77 : : returns (uint8) 78 : : { 79 [ + ]: 35 : if (address(sanctionsList) != address(0)) { 80 [ + + ]: 30 : if (sanctionsList.isSanctioned(from)) { 81 : 6 : return CODE_ADDRESS_FROM_IS_SANCTIONED; 82 [ + ]: 24 : } else if (sanctionsList.isSanctioned(to)) { 83 : 10 : return CODE_ADDRESS_TO_IS_SANCTIONED; 84 : : } 85 : : } 86 : 19 : return uint8(REJECTED_CODE_BASE.TRANSFER_OK); 87 : : } 88 : : 89 : : /** 90 : : * @inheritdoc IERC7943NonFungibleComplianceExtend 91 : : */ 92 : 9 : function detectTransferRestriction(address from, address to, uint256, /* tokenId */ uint256 value) 93 : : public 94 : : view 95 : : virtual 96 : : override(IERC7943NonFungibleComplianceExtend) 97 : : returns (uint8) 98 : : { 99 : 9 : return detectTransferRestriction(from, to, value); 100 : : } 101 : : 102 : : /** 103 : : * @inheritdoc IERC1404Extend 104 : : */ 105 : 11 : function detectTransferRestrictionFrom(address spender, address from, address to, uint256 value) 106 : : public 107 : : view 108 : : virtual 109 : : override(IERC1404Extend) 110 : : returns (uint8) 111 : : { 112 [ + ]: 14 : if (address(sanctionsList) != address(0)) { 113 [ + + ]: 13 : if (sanctionsList.isSanctioned(spender)) { 114 : 4 : return CODE_ADDRESS_SPENDER_IS_SANCTIONED; 115 : : } else { 116 : 9 : return detectTransferRestriction(from, to, value); 117 : : } 118 : : } 119 : 1 : return uint8(REJECTED_CODE_BASE.TRANSFER_OK); 120 : : } 121 : : 122 : 3 : function detectTransferRestrictionFrom( 123 : : address spender, 124 : : address from, 125 : : address to, 126 : : uint256, /* tokenId */ 127 : : uint256 value 128 : : ) public view virtual override(IERC7943NonFungibleComplianceExtend) returns (uint8) { 129 : 3 : return detectTransferRestrictionFrom(spender, from, to, value); 130 : : } 131 : : 132 : : /** 133 : : * @notice To know if the restriction code is valid for this rule or not. 134 : : * @param restrictionCode The target restriction code 135 : : * @return true if the restriction code is known, false otherwise 136 : : * 137 : : */ 138 : 3 : function canReturnTransferRestrictionCode(uint8 restrictionCode) external pure override(IRule) returns (bool) { 139 : 3 : return restrictionCode == CODE_ADDRESS_FROM_IS_SANCTIONED || restrictionCode == CODE_ADDRESS_TO_IS_SANCTIONED 140 : 1 : || restrictionCode == CODE_ADDRESS_SPENDER_IS_SANCTIONED; 141 : : } 142 : : 143 : : /** 144 : : * @notice Return the corresponding message 145 : : * @param restrictionCode The target restriction code 146 : : * @return true if the transfer is valid, false otherwise 147 : : * 148 : : */ 149 : 4 : function messageForTransferRestriction(uint8 restrictionCode) 150 : : public 151 : : pure 152 : : virtual 153 : : override(IERC1404) 154 : : returns (string memory) 155 : : { 156 [ + + ]: 4 : if (restrictionCode == CODE_ADDRESS_FROM_IS_SANCTIONED) { 157 : 1 : return TEXT_ADDRESS_FROM_IS_SANCTIONED; 158 [ + + ]: 3 : } else if (restrictionCode == CODE_ADDRESS_TO_IS_SANCTIONED) { 159 : 1 : return TEXT_ADDRESS_TO_IS_SANCTIONED; 160 [ + + ]: 2 : } else if (restrictionCode == CODE_ADDRESS_SPENDER_IS_SANCTIONED) { 161 : 1 : return TEXT_ADDRESS_SPENDER_IS_SANCTIONED; 162 : : } else { 163 : 1 : return TEXT_CODE_NOT_FOUND; 164 : : } 165 : : } 166 : : 167 : 0 : function supportsInterface(bytes4 interfaceId) public view virtual override(AccessControl, RuleValidateTransfer) returns (bool) { 168 : 0 : return AccessControl.supportsInterface(interfaceId) || RuleValidateTransfer.supportsInterface(interfaceId); 169 : : } 170 : : 171 : : /* ============ State Functions ============ */ 172 : : /** 173 : : * @notice Set the oracle contract 174 : : * @param sanctionContractOracle_ address of your oracle contract 175 : : * @dev zero address is authorized to authorize all transfers 176 : : */ 177 : 14 : function setSanctionListOracle(ISanctionsList sanctionContractOracle_) public virtual onlyRole(SANCTIONLIST_ROLE) { 178 : 13 : _setSanctionListOracle(sanctionContractOracle_); 179 : : } 180 : : 181 : : /** 182 : : * @inheritdoc IERC3643IComplianceContract 183 : : */ 184 : 3 : function transferred(address from, address to, uint256 value) 185 : : public 186 : : view 187 : : virtual 188 : : override(IERC3643IComplianceContract) 189 : : { 190 : 7 : uint8 code = this.detectTransferRestriction(from, to, value); 191 [ + + ]: 7 : require( 192 : : code == uint8(REJECTED_CODE_BASE.TRANSFER_OK), 193 : : RuleSanctionsList_InvalidTransfer(address(this), from, to, value, code) 194 : : ); 195 : : } 196 : : 197 : : 198 : : /** 199 : : * @inheritdoc IRuleEngine 200 : : */ 201 : 2 : function transferred(address spender, address from, address to, uint256 value) 202 : : public 203 : : view 204 : : virtual 205 : : override(IRuleEngine) 206 : : { 207 : 3 : uint8 code = this.detectTransferRestrictionFrom(spender, from, to, value); 208 [ + + ]: 3 : require( 209 : : code == uint8(REJECTED_CODE_BASE.TRANSFER_OK), 210 : : RuleSanctionsList_InvalidTransferFrom(address(this), spender, from, to, value, code) 211 : : ); 212 : : } 213 : : 214 : 1 : function transferred(address spender, address from, address to, uint256 /* tokenId */,uint256 value) 215 : : public 216 : : view 217 : : virtual 218 : : override(IERC7943NonFungibleComplianceExtend) 219 : : { 220 : 1 : transferred(spender, from, to, value); 221 : : } 222 : : 223 : 4 : function transferred(address from, address to, uint256 /* tokenId */,uint256 value) 224 : : public 225 : : view 226 : : virtual 227 : : override(IERC7943NonFungibleComplianceExtend) 228 : : { 229 : 4 : transferred(from, to, value); 230 : : } 231 : : /*////////////////////////////////////////////////////////////// 232 : : INTERNAL FUNCTIONS 233 : : //////////////////////////////////////////////////////////////*/ 234 : : 235 : 14 : function _setSanctionListOracle(ISanctionsList sanctionContractOracle_) internal { 236 : 14 : sanctionsList = sanctionContractOracle_; 237 : 14 : emit SetSanctionListOracle(sanctionContractOracle_); 238 : : } 239 : : 240 : : /*////////////////////////////////////////////////////////////// 241 : : ERC-2771 242 : : //////////////////////////////////////////////////////////////*/ 243 : : 244 : : /** 245 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 246 : : */ 247 : 30 : function _msgSender() internal view override(ERC2771Context, Context) returns (address sender) { 248 : 30 : return ERC2771Context._msgSender(); 249 : : } 250 : : 251 : : /** 252 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 253 : : */ 254 : 0 : function _msgData() internal view override(ERC2771Context, Context) returns (bytes calldata) { 255 : 0 : return ERC2771Context._msgData(); 256 : : } 257 : : 258 : : /** 259 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 260 : : */ 261 : 30 : function _contextSuffixLength() internal view override(ERC2771Context, Context) returns (uint256) { 262 : 30 : return ERC2771Context._contextSuffixLength(); 263 : : } 264 : : }
+
+
+
+ LCOV - lcov.info - src/RuleEngine.sol - functions
+ LCOV - lcov.info - validation/RuleWhitelist.sol - functions
-
+
-
+
LCOV - lcov.info - src/RuleEngine.sol - functions
+ LCOV - lcov.info - validation/RuleWhitelist.sol - functions
LCOV - lcov.info - src/modules/RuleEngineValidationCommon.sol
- LCOV - lcov.info - validation/RuleWhitelist.sol
+
LCOV - code coverage report
-
+
-
+
-
-
@@ -70,157 +70,151 @@
Branch data Line data Source code
1 : : // SPDX-License-Identifier: MPL-2.0 2 : : 3 : : pragma solidity ^0.8.20; 4 : : 5 : : import "OZ/access/AccessControl.sol"; 6 : : import "./RuleInternal.sol"; 7 : : import "../interfaces/IRuleEngineValidation.sol"; 8 : : import "../interfaces/IRuleValidation.sol"; 9 : : 10 : : /** 11 : : * @title Implementation of a ruleEngine defined by the CMTAT 12 : : */ 13 : : abstract contract RuleEngineValidationCommon is 14 : : AccessControl, 15 : : RuleInternal, 16 : : IRuleEngineValidationCommon 17 : : { 18 : : /// @dev Array of rules 19 : : address[] internal _rulesValidation; 20 : : 21 : : /*////////////////////////////////////////////////////////////// 22 : : PUBLIC/EXTERNAL FUNCTIONS 23 : : //////////////////////////////////////////////////////////////*/ 24 : : /** 25 : : * @notice Set all the rules, will overwrite all the previous rules. \n 26 : : * Revert if one rule is a zero address or if the rule is already present 27 : : * @dev take address[] instead of IRuleEngineValidation[] since it is not possible to cast IRuleEngineValidation[] -> address[] 28 : : * 29 : : */ 30 : : function setRulesValidation( 31 : : address[] calldata rules_ 32 : : ) public override onlyRole(RULE_ENGINE_OPERATOR_ROLE) { 33 [ + ]: 21 : if (_rulesValidation.length > 0) { 34 : 20 : _clearRulesValidation(); 35 : : } 36 : 21 : _setRules(rules_); 37 : 18 : _rulesValidation = rules_; 38 : : } 39 : : 40 : : /** 41 : : * @notice Clear all the rules of the array of rules 42 : : * 43 : : */ 44 : : function clearRulesValidation() public onlyRole(RULE_ENGINE_OPERATOR_ROLE) { 45 : 5 : _clearRulesValidation(); 46 : : } 47 : : 48 : : /** 49 : : * @notice Add a rule to the array of rules 50 : : * Revert if one rule is a zero address or if the rule is already present 51 : : * 52 : : */ 53 : : function addRuleValidation( 54 : : IRuleValidation rule_ 55 : : ) public onlyRole(RULE_ENGINE_OPERATOR_ROLE) { 56 : 118 : RuleInternal._addRule(_rulesValidation, address(rule_)); 57 : 116 : emit AddRule(address(rule_)); 58 : : } 59 : : 60 : : /** 61 : : * @notice Remove a rule from the array of rules 62 : : * Revert if the rule found at the specified index does not match the rule in argument 63 : : * @param rule_ address of the target rule 64 : : * @param index the position inside the array of rule 65 : : * @dev To reduce the array size, the last rule is moved to the location occupied 66 : : * by the rule to remove 67 : : * 68 : : * 69 : : */ 70 : : function removeRuleValidation( 71 : : IRuleValidation rule_, 72 : : uint256 index 73 : : ) public onlyRole(RULE_ENGINE_OPERATOR_ROLE) { 74 : 5 : _removeRuleValidation(address(rule_), index); 75 : : } 76 : : 77 : : /** 78 : : * @return The number of rules inside the array 79 : : */ 80 : : function rulesCountValidation() external view override returns (uint256) { 81 : 69 : return _rulesValidation.length; 82 : : } 83 : : 84 : : /** 85 : : * @notice Get the index of a rule inside the list 86 : : * @return index if the rule is found, _rulesValidation.length otherwise 87 : : */ 88 : : function getRuleIndexValidation( 89 : : IRuleValidation rule_ 90 : : ) external view returns (uint256 index) { 91 : 3 : return RuleInternal._getRuleIndex(_rulesValidation, address(rule_)); 92 : : } 93 : : 94 : : /** 95 : : * @notice Get the rule at the position specified by ruleId 96 : : * @param ruleId index of the rule 97 : : * @return a rule address 98 : : */ 99 : : function ruleValidation( 100 : : uint256 ruleId 101 : : ) external view override returns (address) { 102 : 1 : return _rulesValidation[ruleId]; 103 : : } 104 : : 105 : : /** 106 : : * @notice Get all the rules 107 : : * @return An array of rules 108 : : */ 109 : : function rulesValidation() 110 : : external 111 : : view 112 : : override 113 : : returns (address[] memory) 114 : : { 115 : 5 : return _rulesValidation; 116 : : } 117 : : 118 : : /*////////////////////////////////////////////////////////////// 119 : : INTERNAL FUNCTIONS 120 : : //////////////////////////////////////////////////////////////*/ 121 : : /** 122 : : * @notice Clear all the rules of the array of rules 123 : : * 124 : : */ 125 : : function _clearRulesValidation() internal { 126 : 25 : uint256 index; 127 : : // we remove the last element first since it is more optimized. 128 : 25 : for (uint256 i = _rulesValidation.length; i > 0; --i) { 129 : : unchecked { 130 : : // don't underflow since i > 0 131 : 28 : index = i - 1; 132 : : } 133 : 28 : _removeRuleValidation(_rulesValidation[index], index); 134 : : } 135 : 25 : emit ClearRules(_rulesValidation); 136 : : } 137 : : 138 : : /** 139 : : * @notice Remove a rule from the array of rules 140 : : * Revert if the rule found at the specified index does not match the rule in argument 141 : : * @param rule_ address of the target rule 142 : : * @param index the position inside the array of rule 143 : : * @dev To reduce the array size, the last rule is moved to the location occupied 144 : : * by the rule to remove 145 : : * 146 : : * 147 : : */ 148 : : function _removeRuleValidation(address rule_, uint256 index) internal { 149 : 33 : RuleInternal._removeRule(_rulesValidation, rule_, index); 150 : 32 : emit RemoveRule(address(rule_)); 151 : : } 152 : : } 2 : : pragma solidity ^0.8.20; 3 : : 4 : : import {AccessControl} from "OZ/access/AccessControl.sol"; 5 : : /* ==== Abtract contracts === */ 6 : : import {RuleAddressSet} from "./abstract/RuleAddressSet/RuleAddressSet.sol"; 7 : : import {RuleWhitelistCommon, RuleValidateTransfer} from "./abstract/RuleWhitelistCommon.sol"; 8 : : /* ==== CMTAT === */ 9 : : import {IERC1404, IERC1404Extend} from "CMTAT/interfaces/tokenization/draft-IERC1404.sol"; 10 : : /* ==== Interfaces === */ 11 : : import {IIdentityRegistryVerified} from "../interfaces/IIdentityRegistry.sol"; 12 : : import { 13 : : IERC7943NonFungibleCompliance, 14 : : IERC7943NonFungibleComplianceExtend 15 : : } from "../interfaces/IERC7943NonFungibleCompliance.sol"; 16 : : 17 : : /** 18 : : * @title Rule Whitelist 19 : : * @notice Manages a whitelist of authorized addresses and enforces whitelist-based transfer restrictions. 20 : : * @dev 21 : : * - Inherits core address management logic from {RuleAddressSet}. 22 : : * - Integrates restriction code logic from {RuleWhitelistCommon}. 23 : : * - Implements {IERC1404} to return specific restriction codes for non-whitelisted transfers. 24 : : */ 25 : : contract RuleWhitelist is RuleAddressSet, RuleWhitelistCommon, IIdentityRegistryVerified { 26 : : /*////////////////////////////////////////////////////////////// 27 : : CONSTRUCTOR 28 : : //////////////////////////////////////////////////////////////*/ 29 : : /** 30 : : * @param admin Address of the contract (Access Control) 31 : : * @param forwarderIrrevocable Address of the forwarder, required for the gasless support 32 : : */ 33 : 102 : constructor(address admin, address forwarderIrrevocable, bool checkSpender_) 34 : : RuleAddressSet(admin, forwarderIrrevocable) 35 : : { 36 : 101 : checkSpender = checkSpender_; 37 : : } 38 : : 39 : : /* ============ View Functions ============ */ 40 : : 41 : : /** 42 : : * @notice Detects whether a transfer between two addresses is allowed under the whitelist rule. 43 : : * @dev 44 : : * - Returns a restriction code indicating why a transfer is blocked. 45 : : * - Implements the `IERC1404.detectTransferRestriction` interface. 46 : : * @param from The address sending tokens. 47 : : * @param to The address receiving tokens. 48 : : * @return code Restriction code (e.g., `TRANSFER_OK` or specific whitelist rejection). 49 : : * 50 : : * | Condition | Returned Code | 51 : : * |------------|---------------| 52 : : * | `from` not whitelisted | `CODE_ADDRESS_FROM_NOT_WHITELISTED` | 53 : : * | `to` not whitelisted | `CODE_ADDRESS_TO_NOT_WHITELISTED` | 54 : : * | Both whitelisted | `TRANSFER_OK` | 55 : : */ 56 : 20 : function detectTransferRestriction(address from, address to, uint256 /* value */ ) 57 : : public 58 : : view 59 : : virtual 60 : : override(IERC1404) 61 : : returns (uint8 code) 62 : : { 63 [ + + ]: 33 : if (!isAddressListed(from)) { 64 : 11 : return CODE_ADDRESS_FROM_NOT_WHITELISTED; 65 [ + + ]: 22 : } else if (!isAddressListed(to)) { 66 : 6 : return CODE_ADDRESS_TO_NOT_WHITELISTED; 67 : : } else { 68 : 16 : return uint8(REJECTED_CODE_BASE.TRANSFER_OK); 69 : : } 70 : : } 71 : : 72 : : /** 73 : : * @inheritdoc IERC7943NonFungibleComplianceExtend 74 : : */ 75 : 7 : function detectTransferRestriction(address from, address to, uint256, /* tokenId */ uint256 value) 76 : : public 77 : : view 78 : : virtual 79 : : override(IERC7943NonFungibleComplianceExtend) 80 : : returns (uint8) 81 : : { 82 : 7 : return detectTransferRestriction(from, to, value); 83 : : } 84 : : 85 : : /** 86 : : * @notice Detects transfer restriction for delegated transfers (`transferFrom`). 87 : : * @dev 88 : : * - Checks the `spender`, `from`, and `to` addresses for whitelist compliance. 89 : : * - Implements `IERC1404Extend.detectTransferRestrictionFrom`. 90 : : * @param spender The address initiating the transfer on behalf of another. 91 : : * @param from The address from which tokens are transferred. 92 : : * @param to The address receiving the tokens. 93 : : * @param value The amount being transferred (unused in this check). 94 : : * @return code Restriction code, or `TRANSFER_OK` if all parties are whitelisted. 95 : : * 96 : : * | Condition | Returned Code | 97 : : * |------------|---------------| 98 : : * | `spender` not whitelisted | `CODE_ADDRESS_SPENDER_NOT_WHITELISTED` | 99 : : * | `from` or `to` not whitelisted | respective restriction code from `detectTransferRestriction` | 100 : : * | All whitelisted | `TRANSFER_OK` | 101 : : */ 102 : 10 : function detectTransferRestrictionFrom(address spender, address from, address to, uint256 value) 103 : : public 104 : : view 105 : : virtual 106 : : override(IERC1404Extend) 107 : : returns (uint8 code) 108 : : { 109 [ + ]: 12 : if (checkSpender && !isAddressListed(spender)) { 110 : 6 : return CODE_ADDRESS_SPENDER_NOT_WHITELISTED; 111 : : } 112 : 6 : return detectTransferRestriction(from, to, value); 113 : : } 114 : : 115 : : /** 116 : : * @inheritdoc IERC7943NonFungibleComplianceExtend 117 : : */ 118 : 2 : function detectTransferRestrictionFrom( 119 : : address spender, 120 : : address from, 121 : : address to, 122 : : uint256, /* tokenId */ 123 : : uint256 value 124 : : ) public view override(IERC7943NonFungibleComplianceExtend) returns (uint8) { 125 : 2 : return detectTransferRestrictionFrom(spender, from, to, value); 126 : : } 127 : : 128 : : /** 129 : : * @notice Checks whether a specific address is currently listed. 130 : : * @param targetAddress The address to check. 131 : : * @return isListed True if listed, false otherwise. 132 : : */ 133 : 0 : function isVerified(address targetAddress) 134 : : public 135 : : view 136 : : virtual 137 : : override(IIdentityRegistryVerified) 138 : : returns (bool isListed) 139 : : { 140 : 0 : isListed = _isAddressListed(targetAddress); 141 : : } 142 : : 143 : 0 : function supportsInterface(bytes4 interfaceId) public view virtual override(AccessControl, RuleValidateTransfer) returns (bool) { 144 : 0 : return AccessControl.supportsInterface(interfaceId) || RuleValidateTransfer.supportsInterface(interfaceId); 145 : : } 146 : : }
@@ -228,7 +222,7 @@
LCOV - lcov.info - validation/RuleWhitelistWrapper.sol - functions
+
+ LCOV - code coverage report
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LCOV - lcov.info - validation/RuleWhitelistWrapper.sol - functions
+
+ LCOV - code coverage report
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ LCOV - lcov.info - src/RuleEngine.sol
+ LCOV - lcov.info - validation/RuleWhitelistWrapper.sol
-
+
-
+
@@ -73,204 +73,202 @@
2 : : 3 : : pragma solidity ^0.8.20; 4 : : 5 : : import "CMTAT/interfaces/engine/IRuleEngine.sol"; 6 : : import "./modules/MetaTxModuleStandalone.sol"; 7 : : import "./modules/RuleEngineOperation.sol"; 8 : : import "./modules/RuleEngineValidation.sol"; 9 : : 10 : : /** 11 : : * @title Implementation of a ruleEngine as defined by the CMTAT 12 : : */ 13 : : contract RuleEngine is 14 : : IRuleEngine, 15 : : RuleEngineOperation, 16 : : RuleEngineValidation, 17 : : MetaTxModuleStandalone 18 : : { 19 : : /** 20 : : * @notice 21 : : * Get the current version of the smart contract 22 : : */ 23 : : string public constant VERSION = "2.0.4"; 24 : : 25 : : /** 26 : : * @param admin Address of the contract (Access Control) 27 : : * @param forwarderIrrevocable Address of the forwarder, required for the gasless support 28 : : */ 29 : : constructor( 30 : : address admin, 31 : : address forwarderIrrevocable, 32 : : address tokenContract 33 : : ) MetaTxModuleStandalone(forwarderIrrevocable) { 34 [ + ]: 205 : if (admin == address(0)) { 35 : 1 : revert RuleEngine_AdminWithAddressZeroNotAllowed(); 36 : : } 37 [ + ]: 204 : if (tokenContract != address(0)) { 38 : 86 : _grantRole(TOKEN_CONTRACT_ROLE, tokenContract); 39 : : } 40 : 204 : _grantRole(DEFAULT_ADMIN_ROLE, admin); 41 : : } 42 : : 43 : : /** 44 : : * @notice Go through all the rule to know if a restriction exists on the transfer 45 : : * @param _from the origin address 46 : : * @param _to the destination address 47 : : * @param _amount to transfer 48 : : * @return The restricion code or REJECTED_CODE_BASE.TRANSFER_OK 49 : : **/ 50 : : function detectTransferRestriction( 51 : : address _from, 52 : : address _to, 53 : : uint256 _amount 54 : : ) public view override returns (uint8) { 55 : : // Validation 56 : 32 : uint8 code = RuleEngineValidation.detectTransferRestrictionValidation( 57 : : _from, 58 : : _to, 59 : : _amount 60 : : ); 61 [ + ]: 32 : if (code != uint8(REJECTED_CODE_BASE.TRANSFER_OK)) { 62 : 15 : return code; 63 : : } 64 : : 65 : : // Operation 66 : 17 : uint256 rulesLength = _rulesOperation.length; 67 : 17 : for (uint256 i = 0; i < rulesLength; ++i) { 68 : 12 : uint8 restriction = IRuleValidation(_rulesOperation[i]) 69 : : .detectTransferRestriction(_from, _to, _amount); 70 [ + ]: 12 : if (restriction > 0) { 71 : 11 : return restriction; 72 : : } 73 : : } 74 : : 75 : 6 : return uint8(REJECTED_CODE_BASE.TRANSFER_OK); 76 : : } 77 : : 78 : : /** 79 : : * @notice Validate a transfer 80 : : * @param _from the origin address 81 : : * @param _to the destination address 82 : : * @param _amount to transfer 83 : : * @return True if the transfer is valid, false otherwise 84 : : **/ 85 : : function validateTransfer( 86 : : address _from, 87 : : address _to, 88 : : uint256 _amount 89 : : ) public view override returns (bool) { 90 : 12 : return 91 : 12 : detectTransferRestriction(_from, _to, _amount) == 92 : : uint8(REJECTED_CODE_BASE.TRANSFER_OK); 93 : : } 5 : : /* ==== OpenZeppelin === */ 6 : : import {AccessControl} from "OZ/access/AccessControl.sol"; 7 : : /* ==== Abtract contracts === */ 8 : : import {AccessControlModuleStandalone} from "../../modules/AccessControlModuleStandalone.sol"; 9 : : import {MetaTxModuleStandalone, ERC2771Context, Context} from "../../modules/MetaTxModuleStandalone.sol"; 10 : : import {RuleAddressSet} from "./abstract/RuleAddressSet/RuleAddressSet.sol"; 11 : : import {RuleWhitelistCommon, RuleValidateTransfer} from "./abstract/RuleWhitelistCommon.sol"; 12 : : /* ==== RuleEngine === */ 13 : : import {RulesManagementModule} from "RuleEngine/modules/RulesManagementModule.sol"; 14 : : /* ==== CMTAT === */ 15 : : import {IERC1404, IERC1404Extend} from "CMTAT/interfaces/tokenization/draft-IERC1404.sol"; 16 : : /* ==== Interfaces === */ 17 : : import { 18 : : IERC7943NonFungibleCompliance, 19 : : IERC7943NonFungibleComplianceExtend 20 : : } from "../interfaces/IERC7943NonFungibleCompliance.sol"; 21 : : 22 : : /** 23 : : * @title Wrapper to call several different whitelist rules 24 : : */ 25 : : contract RuleWhitelistWrapper is 26 : : RulesManagementModule, 27 : : AccessControlModuleStandalone, 28 : : MetaTxModuleStandalone, 29 : : RuleWhitelistCommon 30 : : { 31 : : /*////////////////////////////////////////////////////////////// 32 : : CONSTRUCTOR 33 : : //////////////////////////////////////////////////////////////*/ 34 : : /** 35 : : * @param admin Address of the contract (Access Control) 36 : : * @param forwarderIrrevocable Address of the forwarder, required for the gasless support 37 : : */ 38 : 22 : constructor(address admin, address forwarderIrrevocable, bool checkSpender_) 39 : : MetaTxModuleStandalone(forwarderIrrevocable) 40 : : AccessControlModuleStandalone(admin) 41 : : { 42 : 20 : checkSpender = checkSpender_; 43 : : } 44 : : 45 : : /* ============ View Functions ============ */ 46 : : /** 47 : : * @notice Go through all the whitelist rules to know if a restriction exists on the transfer 48 : : * @param from the origin address 49 : : * @param to the destination address 50 : : * @return The restricion code or REJECTED_CODE_BASE.TRANSFER_OK 51 : : * 52 : : */ 53 : 21 : function detectTransferRestriction(address from, address to, uint256 /*value*/ ) 54 : : public 55 : : view 56 : : virtual 57 : : override(IERC1404) 58 : : returns (uint8) 59 : : { 60 : 25 : address[] memory targetAddress = new address[](2); 61 : 25 : targetAddress[0] = from; 62 : 25 : targetAddress[1] = to; 63 : : 64 : 25 : bool[] memory result = _detectTransferRestriction(targetAddress); 65 [ + + ]: 25 : if (!result[0]) { 66 : 9 : return CODE_ADDRESS_FROM_NOT_WHITELISTED; 67 [ + + ]: 16 : } else if (!result[1]) { 68 : 6 : return CODE_ADDRESS_TO_NOT_WHITELISTED; 69 : : } else { 70 : 10 : return uint8(REJECTED_CODE_BASE.TRANSFER_OK); 71 : : } 72 : : } 73 : : 74 : 4 : function detectTransferRestriction(address from, address to, uint256, /* tokenId */ uint256 value) 75 : : public 76 : : view 77 : : virtual 78 : : override(IERC7943NonFungibleComplianceExtend) 79 : : returns (uint8) 80 : : { 81 : 4 : return detectTransferRestriction(from, to, value); 82 : : } 83 : : 84 : 10 : function detectTransferRestrictionFrom(address spender, address from, address to, uint256 value) 85 : : public 86 : : view 87 : : virtual 88 : : override(IERC1404Extend) 89 : : returns (uint8) 90 : : { 91 [ # ]: 12 : if (!checkSpender) { 92 : 0 : return detectTransferRestriction(from, to, value); 93 : : } 94 : : 95 : : /** 96 : : * @notice Return the message corresponding to the code 97 : : * @param _restrictionCode The target restriction code 98 : : * @return True if the transfer is valid, false otherwise 99 : : **/ 100 : : function messageForTransferRestriction( 101 : : uint8 _restrictionCode 102 : : ) external view override returns (string memory) { 103 : : // Validation 104 : 18 : uint256 rulesLength = _rulesValidation.length; 105 : 18 : for (uint256 i = 0; i < rulesLength; ++i) { 106 : : if ( 107 : 13 : IRuleValidation(_rulesValidation[i]) 108 : : .canReturnTransferRestrictionCode(_restrictionCode) 109 [ + ]: 10 : ) { 110 : 10 : return 111 : 10 : IRuleValidation(_rulesValidation[i]) 112 : : .messageForTransferRestriction(_restrictionCode); 113 : : } 114 : : } 115 : : // operation 116 : 8 : rulesLength = _rulesOperation.length; 117 : 8 : for (uint256 i = 0; i < rulesLength; ++i) { 118 : : if ( 119 : 2 : IRuleValidation(_rulesOperation[i]) 120 : : .canReturnTransferRestrictionCode(_restrictionCode) 121 [ + ]: 1 : ) { 122 : 1 : return 123 : 1 : IRuleValidation(_rulesOperation[i]) 124 : : .messageForTransferRestriction(_restrictionCode); 125 : : } 126 : : } 127 : 7 : return "Unknown restriction code"; 128 : : } 129 : : 130 : : /* 131 : : * @notice function protected by access control 132 : : */ 133 : : function operateOnTransfer( 134 : : address from, 135 : : address to, 136 : : uint256 amount 137 : : ) external override onlyRole(TOKEN_CONTRACT_ROLE) returns (bool isValid) { 138 : : // Validate the transfer 139 : : if ( 140 : 68 : !RuleEngineValidation.validateTransferValidation(from, to, amount) 141 [ + ]: 10 : ) { 142 : 10 : return false; 143 : : } 144 : : // Apply operation on RuleEngine 145 : 58 : return RuleEngineOperation._operateOnTransfer(from, to, amount); 146 : : } 147 : : 148 : : /* ============ ACCESS CONTROL ============ */ 149 : : /** 150 : : * @dev Returns `true` if `account` has been granted `role`. 151 : : */ 152 : : function hasRole( 153 : : bytes32 role, 154 : : address account 155 : : ) public view virtual override(AccessControl) returns (bool) { 156 : : // The Default Admin has all roles 157 [ + ]: 597 : if (AccessControl.hasRole(DEFAULT_ADMIN_ROLE, account)) { 158 : 220 : return true; 159 : : } 160 : 377 : return AccessControl.hasRole(role, account); 161 : : } 162 : : 163 : : /*////////////////////////////////////////////////////////////// 164 : : ERC-2771 165 : : //////////////////////////////////////////////////////////////*/ 166 : : 167 : : /** 168 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 169 : : */ 170 : : function _msgSender() 171 : : internal 172 : : view 173 : : override(ERC2771Context, Context) 174 : : returns (address sender) 175 : : { 176 : 588 : return ERC2771Context._msgSender(); 177 : : } 178 : : 179 : : /** 180 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 181 : : */ 182 : : function _msgData() 183 : : internal 184 : : view 185 : : override(ERC2771Context, Context) 186 : : returns (bytes calldata) 187 : : { 188 : 0 : return ERC2771Context._msgData(); 189 : : } 190 : : 191 : : /** 192 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 193 : : */ 194 : : function _contextSuffixLength() 195 : : internal 196 : : view 197 : : override(ERC2771Context, Context) 198 : : returns (uint256) 199 : : { 200 : 588 : return ERC2771Context._contextSuffixLength(); 201 : : } 202 : : } 95 : 12 : address[] memory targetAddress = new address[](3); 96 : 12 : targetAddress[0] = from; 97 : 12 : targetAddress[1] = to; 98 : 12 : targetAddress[2] = spender; 99 : : 100 : 12 : bool[] memory result = _detectTransferRestriction(targetAddress); 101 : : 102 [ # + ]: 12 : if (!result[0]) { 103 : 0 : return CODE_ADDRESS_FROM_NOT_WHITELISTED; 104 [ # + ]: 12 : } else if (!result[1]) { 105 : 0 : return CODE_ADDRESS_TO_NOT_WHITELISTED; 106 [ + + ]: 12 : } else if (!result[2]) { 107 : 6 : return CODE_ADDRESS_SPENDER_NOT_WHITELISTED; 108 : : } else { 109 : 6 : return uint8(REJECTED_CODE_BASE.TRANSFER_OK); 110 : : } 111 : : } 112 : : 113 : : /** 114 : : * @inheritdoc IERC7943NonFungibleComplianceExtend 115 : : */ 116 : 2 : function detectTransferRestrictionFrom( 117 : : address spender, 118 : : address from, 119 : : address to, 120 : : uint256, /* tokenId */ 121 : : uint256 value 122 : : ) public view virtual override(IERC7943NonFungibleComplianceExtend) returns (uint8) { 123 : 2 : return detectTransferRestrictionFrom(spender, from, to, value); 124 : : } 125 : : 126 : : /* ============ Access control ============ */ 127 : : 128 : : /** 129 : : * @dev Returns `true` if `account` has been granted `role`. 130 : : */ 131 : 20 : function hasRole(bytes32 role, address account) 132 : : public 133 : : view 134 : : virtual 135 : : override(AccessControl, AccessControlModuleStandalone) 136 : : returns (bool) 137 : : { 138 : 80 : return AccessControlModuleStandalone.hasRole(role, account); 139 : : } 140 : : 141 : : /*////////////////////////////////////////////////////////////// 142 : : INTERNAL/PRIVATE FUNCTIONS 143 : : //////////////////////////////////////////////////////////////*/ 144 : : 145 : 37 : function _detectTransferRestriction(address[] memory targetAddress) internal view returns (bool[] memory) { 146 : 37 : uint256 rulesLength = rulesCount(); 147 : 37 : bool[] memory result = new bool[](targetAddress.length); 148 : 37 : for (uint256 i = 0; i < rulesLength; ++i) { 149 : : // Call the whitelist rules 150 : 81 : bool[] memory isListed = RuleAddressSet(rule(i)).areAddressesListed(targetAddress); 151 : 81 : for (uint256 j = 0; j < targetAddress.length; ++j) { 152 [ + ]: 58 : if (isListed[j]) { 153 : 58 : result[j] = true; 154 : : } 155 : : } 156 : : 157 : : // Break early if all listed 158 : 81 : bool allListed = true; 159 : 81 : for (uint256 k = 0; k < result.length; ++k) { 160 [ + ]: 159 : if (!result[k]) { 161 : 65 : allListed = false; 162 : 65 : break; 163 : : } 164 : : } 165 [ + ]: 16 : if (allListed) { 166 : 16 : break; 167 : : } 168 : : } 169 : 37 : return result; 170 : : } 171 : : 172 : 0 : function supportsInterface(bytes4 interfaceId) public view virtual override(AccessControl, RuleValidateTransfer) returns (bool) { 173 : 0 : return AccessControl.supportsInterface(interfaceId) || RuleValidateTransfer.supportsInterface(interfaceId); 174 : : } 175 : : 176 : : /*////////////////////////////////////////////////////////////// 177 : : ERC-2771 178 : : //////////////////////////////////////////////////////////////*/ 179 : : 180 : : /** 181 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 182 : : */ 183 : 80 : function _msgSender() internal view override(ERC2771Context, Context) returns (address sender) { 184 : 80 : return ERC2771Context._msgSender(); 185 : : } 186 : : 187 : : /** 188 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 189 : : */ 190 : 0 : function _msgData() internal view override(ERC2771Context, Context) returns (bytes calldata) { 191 : 0 : return ERC2771Context._msgData(); 192 : : } 193 : : 194 : : /** 195 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 196 : : */ 197 : 80 : function _contextSuffixLength() internal view override(ERC2771Context, Context) returns (uint256) { 198 : 80 : return ERC2771Context._contextSuffixLength(); 199 : : } 200 : : }LCOV - lcov.info - src/rules/validation/RuleSanctionList.sol - functions
+ LCOV - lcov.info - validation/abstract/RuleAddressSet/RuleAddressSet.sol - functions
-
+
-
+
LCOV - lcov.info - src/rules/validation/RuleSanctionList.sol - functions
+ LCOV - lcov.info - validation/abstract/RuleAddressSet/RuleAddressSet.sol - functions
LCOV - lcov.info - src/rules/validation/abstract/RuleAddressList/RuleAddressList.sol
- LCOV - lcov.info - validation/abstract/RuleAddressSet/RuleAddressSet.sol
+
LCOV - code coverage report
-
+
-
+
-
-
@@ -70,181 +70,170 @@
Branch data Line data Source code
1 : : // SPDX-License-Identifier: MPL-2.0 2 : : 3 : : pragma solidity ^0.8.20; 4 : : 5 : : import "OZ/access/AccessControl.sol"; 6 : : import "./../../../../modules/MetaTxModuleStandalone.sol"; 7 : : import "./RuleAddressListInternal.sol"; 8 : : import "./invariantStorage/RuleAddressListInvariantStorage.sol"; 9 : : 10 : : /** 11 : : @title an addresses list manager 12 : : */ 13 : : 14 : : abstract contract RuleAddressList is 15 : : AccessControl, 16 : : MetaTxModuleStandalone, 17 : : RuleAddressListInternal, 18 : : RuleAddressListInvariantStorage 19 : : { 20 : : // Number of addresses in the list at the moment 21 : : uint256 private numAddressesWhitelisted; 22 : : 23 : : /** 24 : : * @param admin Address of the contract (Access Control) 25 : : * @param forwarderIrrevocable Address of the forwarder, required for the gasless support 26 : : */ 27 : : constructor( 28 : : address admin, 29 : : address forwarderIrrevocable 30 : : ) MetaTxModuleStandalone(forwarderIrrevocable) { 31 [ + ]: 185 : if (admin == address(0)) { 32 : 1 : revert RuleAddressList_AdminWithAddressZeroNotAllowed(); 33 : : } 34 : 184 : _grantRole(DEFAULT_ADMIN_ROLE, admin); 35 : : } 36 : : 37 : : /** 38 : : * @notice Add addresses to the list 39 : : * If one of addresses already exist, there is no change for this address. The transaction remains valid (no revert). 40 : : * @param listTargetAddresses an array with the addresses to list 41 : : */ 42 : : function addAddressesToTheList( 43 : : address[] calldata listTargetAddresses 44 : : ) public onlyRole(ADDRESS_LIST_ADD_ROLE) { 45 : 16 : _addAddressesToThelist(listTargetAddresses); 46 : 16 : emit AddAddressesToTheList(listTargetAddresses); 47 : : } 48 : : 49 : : /** 50 : : * @notice Remove addresses from the list 51 : : * If the address does not exist in the list, there is no change for this address. 52 : : * The transaction remains valid (no revert). 53 : : * @param listTargetAddresses an array with the addresses to remove 54 : : */ 55 : : function removeAddressesFromTheList( 56 : : address[] calldata listTargetAddresses 57 : : ) public onlyRole(ADDRESS_LIST_REMOVE_ROLE) { 58 : 3 : _removeAddressesFromThelist(listTargetAddresses); 59 : 3 : emit RemoveAddressesFromTheList(listTargetAddresses); 60 : : } 61 : : 62 : : /** 63 : : * @notice Add one address to the list 64 : : * If the address already exists, the transaction is reverted to save gas. 65 : : * @param targetAddress The address to list 66 : : */ 67 : : function addAddressToTheList( 68 : : address targetAddress 69 : : ) public onlyRole(ADDRESS_LIST_ADD_ROLE) { 70 : 51 : _addAddressToThelist(targetAddress); 71 : 50 : emit AddAddressToTheList(targetAddress); 72 : : } 73 : : 74 : : /** 75 : : * @notice Remove one address from the list 76 : : * If the address does not exist in the list, the transaction is reverted to save gas. 77 : : * @param targetAddress The address to remove 78 : : * 79 : : */ 80 : : function removeAddressFromTheList( 81 : : address targetAddress 82 : : ) public onlyRole(ADDRESS_LIST_REMOVE_ROLE) { 83 : 2 : _removeAddressFromThelist(targetAddress); 84 : 1 : emit RemoveAddressFromTheList(targetAddress); 85 : : } 86 : : 87 : : /** 88 : : * @notice Get the number of listed addresses 89 : : * @return Number of listed addresses 90 : : * 91 : : */ 92 : : function numberListedAddress() public view returns (uint256) { 93 : 24 : return _numberListedAddress(); 94 : : } 95 : : 96 : : /** 97 : : * @notice Know if an address is listed or not 98 : : * @param _targetAddress The concerned address 99 : : * @return True if the address is listed, false otherwise 100 : : * 2 : : pragma solidity ^0.8.20; 3 : : 4 : : import {AccessControlModuleStandalone} from "../../../../modules/AccessControlModuleStandalone.sol"; 5 : : import {MetaTxModuleStandalone, ERC2771Context, Context} from "../../../../modules/MetaTxModuleStandalone.sol"; 6 : : import {RuleAddressSetInternal} from "./RuleAddressSetInternal.sol"; 7 : : import {RuleAddressSetInvariantStorage} from "./invariantStorage/RuleAddressSetInvariantStorage.sol"; 8 : : /* ==== Interfaces === */ 9 : : import {IIdentityRegistryContains} from "../../../interfaces/IIdentityRegistry.sol"; 10 : : import {IAddressList} from "../../../interfaces/IAddressList.sol"; 11 : : /** 12 : : * @title Rule Address Set 13 : : * @notice Manages a permissioned set of addresses related to rule logic. 14 : : * @dev 15 : : * - Provides controlled functions for adding and removing addresses. 16 : : * - Integrates `AccessControl` for role-based access. 17 : : * - Supports gasless transactions via ERC-2771 meta-transactions. 18 : : * - Extends internal logic defined in {RuleAddressSetInternal}. 19 : : */ 20 : : 21 : : abstract contract RuleAddressSet is 22 : : AccessControlModuleStandalone, 23 : : MetaTxModuleStandalone, 24 : : RuleAddressSetInternal, 25 : : RuleAddressSetInvariantStorage, 26 : : IAddressList 27 : : { 28 : : /*////////////////////////////////////////////////////////////// 29 : : STATE 30 : : //////////////////////////////////////////////////////////////*/ 31 : : 32 : : /// @notice Cached number of currently listed addresses. 33 : : uint256 private _listedAddressCountCache; 34 : : 35 : : /*////////////////////////////////////////////////////////////// 36 : : CONSTRUCTOR 37 : : //////////////////////////////////////////////////////////////*/ 38 : : 39 : : /** 40 : : * @notice Initializes the RuleAddressSet contract. 41 : : * @param admin The address granted the default admin role. 42 : : * @param forwarderIrrevocable Address of the ERC2771 forwarder (for meta-transactions). 43 : : * @dev Reverts if the admin address is the zero address. 44 : : */ 45 : : constructor(address admin, address forwarderIrrevocable) 46 : : MetaTxModuleStandalone(forwarderIrrevocable) 47 : : AccessControlModuleStandalone(admin) 48 : : { 49 : : // nothing to do 50 : : } 51 : : 52 : : /*////////////////////////////////////////////////////////////// 53 : : CORE LOGIC 54 : : //////////////////////////////////////////////////////////////*/ 55 : : 56 : : /** 57 : : * @notice Adds multiple addresses to the set. 58 : : * @dev 59 : : * - Does not revert if an address is already listed. 60 : : * - Accessible only by accounts with the `ADDRESS_LIST_ADD_ROLE`. 61 : : * @param targetAddresses Array of addresses to be added. 62 : : */ 63 : 17 : function addAddresses(address[] calldata targetAddresses) public onlyRole(ADDRESS_LIST_ADD_ROLE) { 64 : 16 : _addAddresses(targetAddresses); 65 : 16 : emit AddAddresses(targetAddresses); 66 : : } 67 : : 68 : : /** 69 : : * @notice Removes multiple addresses from the set. 70 : : * @dev 71 : : * - Does not revert if an address is not listed. 72 : : * - Accessible only by accounts with the `ADDRESS_LIST_REMOVE_ROLE`. 73 : : * @param targetAddresses Array of addresses to remove. 74 : : */ 75 : 4 : function removeAddresses(address[] calldata targetAddresses) public onlyRole(ADDRESS_LIST_REMOVE_ROLE) { 76 : 3 : _removeAddresses(targetAddresses); 77 : 3 : emit RemoveAddresses(targetAddresses); 78 : : } 79 : : 80 : : /** 81 : : * @notice Adds a single address to the set. 82 : : * @dev 83 : : * - Reverts if the address is already listed. 84 : : * - Accessible only by accounts with the `ADDRESS_LIST_ADD_ROLE`. 85 : : * @param targetAddress The address to be added. 86 : : */ 87 : 52 : function addAddress(address targetAddress) public onlyRole(ADDRESS_LIST_ADD_ROLE) { 88 [ + ]: 51 : if (_isAddressListed(targetAddress)) { 89 : 1 : revert RuleAddressSet_AddressAlreadyListed(); 90 : : } 91 : 50 : _addAddress(targetAddress); 92 : 50 : emit AddAddress(targetAddress); 93 : : } 94 : : 95 : : /** 96 : : * @notice Removes a single address from the set. 97 : : * @dev 98 : : * - Reverts if the address is not listed. 99 : : * - Accessible only by accounts with the `ADDRESS_LIST_REMOVE_ROLE`. 100 : : * @param targetAddress The address to be removed. 101 : : */ 102 : : function addressIsListed( 103 : : address _targetAddress 104 : : ) public view returns (bool) { 105 : 159 : return _addressIsListed(_targetAddress); 106 : : } 107 : : 108 : : /** 109 : : * @notice batch version of {addressIsListed} 110 : : * 111 : : */ 112 : : function addressIsListedBatch( 113 : : address[] memory _targetAddresses 114 : : ) public view returns (bool[] memory) { 115 : 28 : bool[] memory isListed = new bool[](_targetAddresses.length); 116 : 28 : for (uint256 i = 0; i < _targetAddresses.length; ++i) { 117 : 55 : isListed[i] = _addressIsListed(_targetAddresses[i]); 118 : : } 119 : 28 : return isListed; 120 : : } 121 : : 122 : : /* ============ ACCESS CONTROL ============ */ 123 : : /** 124 : : * @dev Returns `true` if `account` has been granted `role`. 125 : : */ 126 : : function hasRole( 127 : : bytes32 role, 128 : : address account 129 : : ) public view virtual override(AccessControl) returns (bool) { 130 : : // The Default Admin has all roles 131 [ + ]: 280 : if (AccessControl.hasRole(DEFAULT_ADMIN_ROLE, account)) { 132 : 78 : return true; 133 : : } 134 : 202 : return AccessControl.hasRole(role, account); 135 : : } 136 : : 137 : : /*////////////////////////////////////////////////////////////// 138 : : ERC-2771 139 : : //////////////////////////////////////////////////////////////*/ 140 : : 141 : : /** 142 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 143 : : */ 144 : : function _msgSender() 145 : : internal 146 : : view 147 : : override(ERC2771Context, Context) 148 : : returns (address sender) 149 : : { 150 : 270 : return ERC2771Context._msgSender(); 151 : : } 152 : : 153 : : /** 154 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 155 : : */ 156 : : function _msgData() 157 : : internal 158 : : view 159 : : override(ERC2771Context, Context) 160 : : returns (bytes calldata) 161 : : { 162 : 0 : return ERC2771Context._msgData(); 163 : : } 164 : : 165 : : /** 166 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 167 : : */ 168 : : function _contextSuffixLength() 169 : : internal 170 : : view 171 : : override(ERC2771Context, Context) 172 : : returns (uint256) 173 : : { 174 : 270 : return ERC2771Context._contextSuffixLength(); 175 : : } 176 : : } 102 : 3 : function removeAddress(address targetAddress) public onlyRole(ADDRESS_LIST_REMOVE_ROLE) { 103 [ + ]: 2 : if (!_isAddressListed(targetAddress)) { 104 : 1 : revert RuleAddressSet_AddressNotFound(); 105 : : } 106 : 1 : _removeAddress(targetAddress); 107 : 1 : emit RemoveAddress(targetAddress); 108 : : } 109 : : 110 : : /** 111 : : * @notice Returns the total number of currently listed addresses. 112 : : * @return count The number of listed addresses. 113 : : */ 114 : 24 : function listedAddressCount() public view returns (uint256 count) { 115 : 24 : count = _listedAddressCount(); 116 : : } 117 : : 118 : : /** 119 : : * @notice Checks whether a specific address is currently listed. 120 : : * @param targetAddress The address to check. 121 : : * @return isListed True if listed, false otherwise. 122 : : */ 123 : 0 : function contains(address targetAddress) public view override(IIdentityRegistryContains) returns (bool isListed) { 124 : 0 : isListed = _isAddressListed(targetAddress); 125 : : } 126 : : 127 : : /** 128 : : * @notice Checks whether a specific address is currently listed. 129 : : * @param targetAddress The address to check. 130 : : * @return isListed True if listed, false otherwise. 131 : : */ 132 : 60 : function isAddressListed(address targetAddress) public view returns (bool isListed) { 133 : 219 : isListed = _isAddressListed(targetAddress); 134 : : } 135 : : 136 : : /** 137 : : * @notice Checks multiple addresses in a single call. 138 : : * @param targetAddresses Array of addresses to check. 139 : : * @return results Array of booleans corresponding to listing status. 140 : : */ 141 : 84 : function areAddressesListed(address[] memory targetAddresses) public view returns (bool[] memory results) { 142 : 84 : results = new bool[](targetAddresses.length); 143 : 84 : for (uint256 i = 0; i < targetAddresses.length; ++i) { 144 : 191 : results[i] = _isAddressListed(targetAddresses[i]); 145 : : } 146 : : } 147 : : /*////////////////////////////////////////////////////////////// 148 : : ERC-2771 META TX 149 : : //////////////////////////////////////////////////////////////*/ 150 : : 151 : : /// @inheritdoc ERC2771Context 152 : 207 : function _msgSender() internal view override(ERC2771Context, Context) returns (address sender) { 153 : 207 : return ERC2771Context._msgSender(); 154 : : } 155 : : 156 : : /// @inheritdoc ERC2771Context 157 : 0 : function _msgData() internal view override(ERC2771Context, Context) returns (bytes calldata) { 158 : 0 : return ERC2771Context._msgData(); 159 : : } 160 : : 161 : : /// @inheritdoc ERC2771Context 162 : 207 : function _contextSuffixLength() internal view override(ERC2771Context, Context) returns (uint256) { 163 : 207 : return ERC2771Context._contextSuffixLength(); 164 : : } 165 : : }
@@ -252,7 +241,7 @@
LCOV - lcov.info - test/RuleConditionalTransfer/utils/RuleCTDeployment.sol - functions
+ LCOV - lcov.info - validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol - functions
-
+
-
+
@@ -65,12 +65,32 @@
LCOV - lcov.info - test/RuleConditionalTransfer/utils/RuleCTDeployment.sol - functions
+ LCOV - lcov.info - validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol - functions
LCOV - lcov.info - src/rules/validation/RuleBlacklist.sol
+ LCOV - lcov.info - validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol
-
+
-
+
@@ -49,9 +49,9 @@
@@ -70,81 +70,92 @@
Branch data Line data Source code
1 : : // SPDX-License-Identifier: MPL-2.0 2 : : 3 : : pragma solidity ^0.8.20; 4 : : 5 : : import "./abstract/RuleAddressList/invariantStorage/RuleBlacklistInvariantStorage.sol"; 6 : : import "./abstract/RuleAddressList/RuleAddressList.sol"; 7 : : import "./abstract/RuleValidateTransfer.sol"; 8 : : 9 : : /** 10 : : * @title a blacklist manager 11 : : */ 12 : : 13 : : contract RuleBlacklist is 14 : : RuleValidateTransfer, 15 : : RuleAddressList, 16 : : RuleBlacklistInvariantStorage 17 : : { 18 : : /** 19 : : * @param admin Address of the contract (Access Control) 20 : : * @param forwarderIrrevocable Address of the forwarder, required for the gasless support 21 : : */ 22 : : constructor( 23 : : address admin, 24 : : address forwarderIrrevocable 25 : : ) RuleAddressList(admin, forwarderIrrevocable) {} 26 : : 27 : : /** 28 : : * @notice Check if an addres is in the whitelist or not 29 : : * @param _from the origin address 30 : : * @param _to the destination address 31 : : * @return The restricion code or REJECTED_CODE_BASE.TRANSFER_OK 32 : : **/ 33 : : function detectTransferRestriction( 34 : : address _from, 35 : : address _to, 36 : : uint256 /*_amount */ 37 : : ) public view override returns (uint8) { 38 [ + + ]: 10 : if (addressIsListed(_from)) { 39 : 5 : return CODE_ADDRESS_FROM_IS_BLACKLISTED; 40 [ + + ]: 5 : } else if (addressIsListed(_to)) { 41 : 2 : return CODE_ADDRESS_TO_IS_BLACKLISTED; 42 : : } else { 43 : 3 : return uint8(REJECTED_CODE_BASE.TRANSFER_OK); 44 : : } 45 : : } 46 : : 47 : : /** 48 : : * @notice To know if the restriction code is valid for this rule or not. 49 : : * @param _restrictionCode The target restriction code 50 : : * @return true if the restriction code is known, false otherwise 51 : : **/ 52 : : function canReturnTransferRestrictionCode( 53 : : uint8 _restrictionCode 54 : : ) external pure override returns (bool) { 55 : 4 : return 56 : 4 : _restrictionCode == CODE_ADDRESS_FROM_IS_BLACKLISTED || 57 : 2 : _restrictionCode == CODE_ADDRESS_TO_IS_BLACKLISTED; 58 : : } 59 : : 60 : : /** 61 : : * @notice Return the corresponding message 62 : : * @param _restrictionCode The target restriction code 63 : : * @return true if the transfer is valid, false otherwise 64 : : **/ 65 : : function messageForTransferRestriction( 66 : : uint8 _restrictionCode 67 : : ) external pure override returns (string memory) { 68 [ + + ]: 4 : if (_restrictionCode == CODE_ADDRESS_FROM_IS_BLACKLISTED) { 69 : 2 : return TEXT_ADDRESS_FROM_IS_BLACKLISTED; 70 [ + + ]: 2 : } else if (_restrictionCode == CODE_ADDRESS_TO_IS_BLACKLISTED) { 71 : 1 : return TEXT_ADDRESS_TO_IS_BLACKLISTED; 72 : : } else { 73 : 1 : return TEXT_CODE_NOT_FOUND; 74 : : } 75 : : } 76 : : } 2 : : pragma solidity ^0.8.20; 3 : : 4 : : /* ==== OpenZeppelin === */ 5 : : import {EnumerableSet} from "OZ/utils/structs/EnumerableSet.sol"; 6 : : 7 : : /** 8 : : * @title Rule Address Set (Internal) 9 : : * @notice Internal utility for managing a set of rule-related addresses. 10 : : * @dev 11 : : * - Uses OpenZeppelin's EnumerableSet for efficient enumeration. 12 : : * - Designed for internal inheritance and logic composition. 13 : : * - Batch operations do not revert when individual entries are invalid. 14 : : */ 15 : : abstract contract RuleAddressSetInternal { 16 : : using EnumerableSet for EnumerableSet.AddressSet; 17 : : 18 : : /*////////////////////////////////////////////////////////////// 19 : : STATE VARIABLES 20 : : //////////////////////////////////////////////////////////////*/ 21 : : 22 : : /// @dev Storage for all listed addresses. 23 : : EnumerableSet.AddressSet private _listedAddresses; 24 : : 25 : : /*////////////////////////////////////////////////////////////// 26 : : INTERNAL 27 : : //////////////////////////////////////////////////////////////*/ 28 : : 29 : : /** 30 : : * @notice Adds multiple addresses to the set. 31 : : * @dev 32 : : * - Does not revert if an address is already listed. 33 : : * - Skips existing entries silently. 34 : : * @param addressesToAdd The array of addresses to add. 35 : : */ 36 : 16 : function _addAddresses(address[] calldata addressesToAdd) internal { 37 : 16 : for (uint256 i = 0; i < addressesToAdd.length; ++i) { 38 : 34 : _listedAddresses.add(addressesToAdd[i]); 39 : : } 40 : : } 41 : : 42 : : /** 43 : : * @notice Removes multiple addresses from the set. 44 : : * @dev 45 : : * - Does not revert if an address is not found. 46 : : * - Skips non-existing entries silently. 47 : : * @param addressesToRemove The array of addresses to remove. 48 : : */ 49 : 3 : function _removeAddresses(address[] calldata addressesToRemove) internal { 50 : 3 : for (uint256 i = 0; i < addressesToRemove.length; ++i) { 51 : 7 : _listedAddresses.remove(addressesToRemove[i]); 52 : : } 53 : : } 54 : : 55 : : /** 56 : : * @notice Adds a single address to the set. 57 : : * @param targetAddress The address to add. 58 : : */ 59 : 50 : function _addAddress(address targetAddress) internal { 60 : 50 : _listedAddresses.add(targetAddress); 61 : : } 62 : : 63 : : /** 64 : : * @notice Removes a single address from the set. 65 : : * @param targetAddress The address to remove. 66 : : */ 67 : 1 : function _removeAddress(address targetAddress) internal { 68 : 1 : _listedAddresses.remove(targetAddress); 69 : : } 70 : : 71 : : /** 72 : : * @notice Returns the total number of listed addresses. 73 : : * @return count The number of listed addresses. 74 : : */ 75 : 24 : function _listedAddressCount() internal view returns (uint256 count) { 76 : 24 : count = _listedAddresses.length(); 77 : : } 78 : : 79 : : /** 80 : : * @notice Checks if an address is listed. 81 : : * @param targetAddress The address to check. 82 : : * @return isListed True if the address is listed, false otherwise. 83 : : */ 84 : 463 : function _isAddressListed(address targetAddress) internal view returns (bool isListed) { 85 : 463 : isListed = _listedAddresses.contains(targetAddress); 86 : : } 87 : : }
diff --git a/doc/coverage/coverage/test/RuleConditionalTransfer/utils/index-sort-b.html b/doc/coverage/coverage/validation/abstract/RuleAddressSet/index-sort-b.html
similarity index 71%
rename from doc/coverage/coverage/test/RuleConditionalTransfer/utils/index-sort-b.html
rename to doc/coverage/coverage/validation/abstract/RuleAddressSet/index-sort-b.html
index 273564b..fe9d655 100644
--- a/doc/coverage/coverage/test/RuleConditionalTransfer/utils/index-sort-b.html
+++ b/doc/coverage/coverage/validation/abstract/RuleAddressSet/index-sort-b.html
@@ -4,7 +4,7 @@
LCOV - lcov.info - test/RuleConditionalTransfer/utils
+ LCOV - lcov.info - validation/abstract/RuleAddressSet
-
+
-
+
@@ -82,17 +82,29 @@
Branches
- RuleCTDeployment.sol RuleAddressSetInternal.sol
100.0 %
- 10 / 10
+ 14 / 14
100.0 %
- 1 / 1
+ 6 / 6
-
0 / 0
+
+ RuleAddressSet.sol
+
+
+ 87.5 %
+ 28 / 32
+ 81.8 %
+ 9 / 11
+ 100.0 %
+ 2 / 2
+
LCOV - lcov.info - test/RuleConditionalTransfer/utils
+ LCOV - lcov.info - validation/abstract/RuleAddressSet
-
+
-
+
@@ -82,14 +82,26 @@
Branches
- RuleCTDeployment.sol RuleAddressSet.sol
+
+
+ 87.5 %
+ 28 / 32
+ 81.8 %
+ 9 / 11
+ 100.0 %
+ 2 / 2
+
+
+ RuleAddressSetInternal.sol
100.0 %
- 10 / 10
+ 14 / 14
100.0 %
- 1 / 1
+ 6 / 6
-
0 / 0
diff --git a/doc/coverage/coverage/test/RuleConditionalTransfer/utils/index-sort-l.html b/doc/coverage/coverage/validation/abstract/RuleAddressSet/index-sort-l.html
similarity index 71%
rename from doc/coverage/coverage/test/RuleConditionalTransfer/utils/index-sort-l.html
rename to doc/coverage/coverage/validation/abstract/RuleAddressSet/index-sort-l.html
index 8cfb2ca..7506cec 100644
--- a/doc/coverage/coverage/test/RuleConditionalTransfer/utils/index-sort-l.html
+++ b/doc/coverage/coverage/validation/abstract/RuleAddressSet/index-sort-l.html
@@ -4,7 +4,7 @@
LCOV - lcov.info - test/RuleConditionalTransfer/utils
+ LCOV - lcov.info - validation/abstract/RuleAddressSet
-
+
-
+
@@ -82,14 +82,26 @@
Branches
- RuleCTDeployment.sol RuleAddressSet.sol
+
+
+ 87.5 %
+ 28 / 32
+ 81.8 %
+ 9 / 11
+ 100.0 %
+ 2 / 2
+
+
+ RuleAddressSetInternal.sol
100.0 %
- 10 / 10
+ 14 / 14
100.0 %
- 1 / 1
+ 6 / 6
-
0 / 0
diff --git a/doc/coverage/coverage/test/RuleConditionalTransfer/utils/index.html b/doc/coverage/coverage/validation/abstract/RuleAddressSet/index.html
similarity index 71%
rename from doc/coverage/coverage/test/RuleConditionalTransfer/utils/index.html
rename to doc/coverage/coverage/validation/abstract/RuleAddressSet/index.html
index 0fb4392..4c0f604 100644
--- a/doc/coverage/coverage/test/RuleConditionalTransfer/utils/index.html
+++ b/doc/coverage/coverage/validation/abstract/RuleAddressSet/index.html
@@ -4,7 +4,7 @@
LCOV - lcov.info - test/RuleConditionalTransfer/utils
+ LCOV - lcov.info - validation/abstract/RuleAddressSet
-
+
-
+
@@ -82,14 +82,26 @@
Branches
- RuleCTDeployment.sol RuleAddressSet.sol
+
+
+ 87.5 %
+ 28 / 32
+ 81.8 %
+ 9 / 11
+ 100.0 %
+ 2 / 2
+
+
+ RuleAddressSetInternal.sol
100.0 %
- 10 / 10
+ 14 / 14
100.0 %
- 1 / 1
+ 6 / 6
-
0 / 0
diff --git a/doc/coverage/coverage/test/utils/SanctionListOracle.sol.func-sort-c.html b/doc/coverage/coverage/validation/abstract/RuleValidateTransfer.sol.func-sort-c.html
similarity index 63%
rename from doc/coverage/coverage/test/utils/SanctionListOracle.sol.func-sort-c.html
rename to doc/coverage/coverage/validation/abstract/RuleValidateTransfer.sol.func-sort-c.html
index 32ca64b..93f72fb 100644
--- a/doc/coverage/coverage/test/utils/SanctionListOracle.sol.func-sort-c.html
+++ b/doc/coverage/coverage/validation/abstract/RuleValidateTransfer.sol.func-sort-c.html
@@ -4,7 +4,7 @@
LCOV - lcov.info - test/utils/SanctionListOracle.sol - functions
+ LCOV - lcov.info - validation/abstract/RuleValidateTransfer.sol - functions
-
+
-
+
LCOV - lcov.info - test/utils/SanctionListOracle.sol - functions
+ LCOV - lcov.info - validation/abstract/RuleValidateTransfer.sol - functions
LCOV - lcov.info - src/modules/RuleInternal.sol
+ LCOV - lcov.info - validation/abstract/RuleValidateTransfer.sol
-
+
-
+
@@ -72,102 +72,88 @@
1 : : // SPDX-License-Identifier: MPL-2.0 2 : : 3 : : pragma solidity ^0.8.20; 4 : : import "./RuleEngineInvariantStorage.sol"; 5 : : 6 : : /** 7 : : * @title Implementation of a ruleEngine defined by the CMTAT 8 : : */ 9 : : abstract contract RuleInternal is RuleEngineInvariantStorage { 10 : : /// @dev Indicate if a rule already exists 11 : : // Can be shared betwen RuleOperation and RuleValidation since it is a mapping 12 : : mapping(address => bool) _ruleIsPresent; 13 : : 14 : : /** 15 : : * @notice Set all the rules, will overwrite all the previous rules. \n 16 : : * Revert if one rule is a zero address or if the rule is already present 17 : : * 18 : : */ 19 : : function _setRules(address[] calldata rules_) internal { 20 [ + ]: 32 : if (rules_.length == 0) { 21 : 2 : revert RuleEngine_ArrayIsEmpty(); 22 : : } 23 : 30 : for (uint256 i = 0; i < rules_.length; ) { 24 [ + ]: 48 : if (address(rules_[i]) == address(0x0)) { 25 : 2 : revert RuleEngine_RuleAddressZeroNotAllowed(); 26 : : } 27 [ + ]: 2 : if (_ruleIsPresent[rules_[i]]) { 28 : 2 : revert RuleEngine_RuleAlreadyExists(); 29 : : } 30 : 44 : _ruleIsPresent[rules_[i]] = true; 31 : 44 : emit AddRule(rules_[i]); 32 : : unchecked { 33 : 44 : ++i; 34 : : } 35 : : } 36 : : } 37 : : 38 : : /** 39 : : * @notice Add a rule to the array of rules 40 : : * Revert if one rule is a zero address or if the rule is already present 41 : : * 42 : : */ 43 : : function _addRule(address[] storage _rules, address rule_) internal { 44 [ + ]: 203 : if (address(rule_) == address(0x0)) { 45 : 2 : revert RuleEngine_RuleAddressZeroNotAllowed(); 46 : : } 47 [ + ]: 2 : if (_ruleIsPresent[rule_]) { 48 : 2 : revert RuleEngine_RuleAlreadyExists(); 49 : : } 50 : 199 : _rules.push(rule_); 51 : 199 : _ruleIsPresent[rule_] = true; 52 : : } 53 : : 54 : : /** 55 : : * @notice Remove a rule from the array of rules 56 : : * Revert if the rule found at the specified index does not match the rule in argument 57 : : * @param rule_ address of the target rule 58 : : * @param index the position inside the array of rule 59 : : * @dev To reduce the array size, the last rule is moved to the location occupied 60 : : * by the rule to remove 61 : : * 62 : : * 63 : : */ 64 : : function _removeRule( 65 : : address[] storage _rules, 66 : : address rule_, 67 : : uint256 index 68 : : ) internal { 69 [ + ]: 55 : if (_rules[index] != rule_) { 70 : 2 : revert RuleEngine_RuleDoNotMatch(); 71 : : } 72 [ + ]: 53 : if (index != _rules.length - 1) { 73 : 4 : _rules[index] = _rules[_rules.length - 1]; 74 : : } 75 : 53 : _rules.pop(); 76 : 53 : _ruleIsPresent[rule_] = false; 77 : 53 : emit RemoveRule(rule_); 78 : : } 79 : : 80 : : /** 81 : : * @notice Get the index of a rule inside the list 82 : : * @return index if the rule is found, _rules.length otherwise 83 : : */ 84 : : function _getRuleIndex( 85 : : address[] storage _rules, 86 : : address rule_ 87 : : ) internal view returns (uint256 index) { 88 : 6 : uint256 rulesLength = _rules.length; 89 : 6 : for (index = 0; index < rulesLength; ) { 90 [ + ]: 10 : if (_rules[index] == rule_) { 91 : 4 : return index; 92 : : } 93 : : unchecked { 94 : 6 : ++index; 95 : : } 96 : : } 97 : 2 : return _rules.length; 98 : : } 99 : : } 4 : : 5 : : /* ==== CMTAT === */ 6 : : import {IERC1404Extend} from "CMTAT/interfaces/tokenization/draft-IERC1404.sol"; 7 : : import {IERC3643ComplianceRead} from "CMTAT/interfaces/tokenization/IERC3643Partial.sol"; 8 : : import {IERC7551Compliance} from "CMTAT/interfaces/tokenization/draft-IERC7551.sol"; 9 : : /* ==== RuleEngine === */ 10 : : import {IRule} from "RuleEngine/interfaces/IRule.sol"; 11 : : import { 12 : : IERC7943NonFungibleCompliance, 13 : : IERC7943NonFungibleComplianceExtend 14 : : } from "../../interfaces/IERC7943NonFungibleCompliance.sol"; 15 : : 16 : : abstract contract RuleValidateTransfer is IERC7943NonFungibleComplianceExtend, IRule { 17 : : /** 18 : : * @notice Validate a transfer 19 : : * @param from the origin address 20 : : * @param to the destination address 21 : : * @param tokenId ERC-721 or ERC-1155 token Id 22 : : * @param amount to transfer, 1 for NFT 23 : : * @return isValid => true if the transfer is valid, false otherwise 24 : : * 25 : : */ 26 : 14 : function canTransfer(address from, address to, uint256 tokenId, uint256 amount) 27 : : public 28 : : view 29 : : override(IERC7943NonFungibleCompliance) 30 : : returns (bool isValid) 31 : : { 32 : : // does not work without `this` keyword => "Undeclared identifier" 33 : 14 : return this.detectTransferRestriction(from, to, tokenId, amount) 34 : : == uint8(IERC1404Extend.REJECTED_CODE_BASE.TRANSFER_OK); 35 : : } 36 : : 37 : : /** 38 : : * @notice Validate a transfer 39 : : * @param from the origin address 40 : : * @param to the destination address 41 : : * @param amount to transfer 42 : : * @return isValid => true if the transfer is valid, false otherwise 43 : : * 44 : : */ 45 : 14 : function canTransfer(address from, address to, uint256 amount) 46 : : public 47 : : view 48 : : override(IERC3643ComplianceRead) 49 : : returns (bool isValid) 50 : : { 51 : : // does not work without `this` keyword => "Undeclared identifier" 52 : 14 : return this.detectTransferRestriction(from, to, amount) == uint8(IERC1404Extend.REJECTED_CODE_BASE.TRANSFER_OK); 53 : : } 54 : : 55 : : /** 56 : : * @inheritdoc IERC7551Compliance 57 : : */ 58 : 10 : function canTransferFrom(address spender, address from, address to, uint256 value) 59 : : public 60 : : view 61 : : virtual 62 : : override(IERC7551Compliance) 63 : : returns (bool) 64 : : { 65 : 20 : return this.detectTransferRestrictionFrom(spender, from, to, value) 66 : : == uint8(IERC1404Extend.REJECTED_CODE_BASE.TRANSFER_OK); 67 : : } 68 : : 69 : : /** 70 : : * @inheritdoc IERC7943NonFungibleComplianceExtend 71 : : */ 72 : 10 : function canTransferFrom(address spender, address from, address to, uint256 tokenId, uint256 value) 73 : : public 74 : : view 75 : : virtual 76 : : override(IERC7943NonFungibleComplianceExtend) 77 : : returns (bool) 78 : : { 79 : 10 : return canTransferFrom(spender, from, to, value); 80 : : } 81 : : 82 : 0 : function supportsInterface(bytes4 interfaceId) public view virtual returns (bool) { 83 : 0 : return interfaceId == type(IRule).interfaceId; 84 : : } 85 : : }
diff --git a/doc/coverage/coverage/src/modules/RuleInternal.sol.func-sort-c.html b/doc/coverage/coverage/validation/abstract/RuleWhitelistCommon.sol.func-sort-c.html
similarity index 57%
rename from doc/coverage/coverage/src/modules/RuleInternal.sol.func-sort-c.html
rename to doc/coverage/coverage/validation/abstract/RuleWhitelistCommon.sol.func-sort-c.html
index 7456c15..bf6dc6f 100644
--- a/doc/coverage/coverage/src/modules/RuleInternal.sol.func-sort-c.html
+++ b/doc/coverage/coverage/validation/abstract/RuleWhitelistCommon.sol.func-sort-c.html
@@ -4,7 +4,7 @@
LCOV - lcov.info - src/modules/RuleInternal.sol - functions
+ LCOV - lcov.info - validation/abstract/RuleWhitelistCommon.sol - functions
-
+
-
+
@@ -49,8 +49,8 @@
LCOV - lcov.info - src/modules/RuleInternal.sol - functions
+ LCOV - lcov.info - validation/abstract/RuleWhitelistCommon.sol - functions
LCOV - lcov.info - src/rules/validation/RuleWhitelistWrapper.sol
- LCOV - lcov.info - validation/abstract/RuleWhitelistCommon.sol
+
LCOV - code coverage report
-
+
-
+
-
-
@@ -70,135 +70,128 @@
Branch data Line data Source code
1 : : // SPDX-License-Identifier: MPL-2.0 2 : : 3 : : pragma solidity ^0.8.20; 4 : : 5 : : import "OZ/access/AccessControl.sol"; 6 : : import "../../modules/RuleEngineValidationCommon.sol"; 7 : : import "../../modules/MetaTxModuleStandalone.sol"; 8 : : import "./abstract/RuleAddressList/RuleAddressList.sol"; 9 : : import "./abstract/RuleWhitelistCommon.sol"; 10 : : 11 : : /** 12 : : * @title Wrapper to call several different whitelist rules 13 : : */ 14 : : contract RuleWhitelistWrapper is 15 : : RuleEngineValidationCommon, 16 : : MetaTxModuleStandalone, 17 : : RuleWhitelistCommon 18 : : { 19 : : /** 20 : : * @param admin Address of the contract (Access Control) 21 : : * @param forwarderIrrevocable Address of the forwarder, required for the gasless support 22 : : */ 23 : : constructor( 24 : : address admin, 25 : : address forwarderIrrevocable 26 : : ) MetaTxModuleStandalone(forwarderIrrevocable) { 27 [ + ]: 14 : if (admin == address(0)) { 28 : 1 : revert RuleEngine_AdminWithAddressZeroNotAllowed(); 29 : : } 30 : 13 : _grantRole(DEFAULT_ADMIN_ROLE, admin); 31 : : } 32 : : 33 : : /** 34 : : * @notice Go through all the whitelist rules to know if a restriction exists on the transfer 35 : : * @param _from the origin address 36 : : * @param _to the destination address 37 : : * @return The restricion code or REJECTED_CODE_BASE.TRANSFER_OK 38 : : **/ 39 : : function detectTransferRestriction( 40 : : address _from, 41 : : address _to, 42 : : uint256 /*_amount*/ 43 : : ) public view override returns (uint8) { 44 : 11 : address[] memory targetAddress = new address[](2); 45 : 11 : bool[] memory isListed = new bool[](2); 46 : 11 : bool[] memory result = new bool[](2); 47 : 11 : targetAddress[0] = _from; 48 : 11 : targetAddress[1] = _to; 49 : 11 : uint256 rulesLength = _rulesValidation.length; 50 : : // For each whitelist rule, we ask if from or to are in the whitelist 51 : 11 : for (uint256 i = 0; i < rulesLength; ++i) { 52 : : // External call 53 : 25 : isListed = RuleAddressList(_rulesValidation[i]) 54 : : .addressIsListedBatch(targetAddress); 55 [ + ]: 25 : if (isListed[0] && !result[0]) { 56 : : // Update if from is in the list 57 : 7 : result[0] = true; 58 : : } 59 [ + ]: 25 : if (isListed[1] && !result[1]) { 60 : : // Update if to is in the list 61 : 7 : result[1] = true; 62 : : } 63 [ + ]: 25 : if (result[0] && result[1]) { 64 : 25 : break; 65 : : } 66 : : } 67 [ + + ]: 11 : if (!result[0]) { 68 : 4 : return CODE_ADDRESS_FROM_NOT_WHITELISTED; 69 [ + + ]: 7 : } else if (!result[1]) { 70 : 2 : return CODE_ADDRESS_TO_NOT_WHITELISTED; 71 : : } else { 72 : 5 : return uint8(REJECTED_CODE_BASE.TRANSFER_OK); 73 : : } 74 : : } 75 : : 76 : : /* ============ ACCESS CONTROL ============ */ 77 : : /** 78 : : * @dev Returns `true` if `account` has been granted `role`. 79 : : */ 80 : : function hasRole( 81 : : bytes32 role, 82 : : address account 83 : : ) public view virtual override(AccessControl) returns (bool) { 84 : : // The Default Admin has all roles 85 [ + ]: 52 : if (AccessControl.hasRole(DEFAULT_ADMIN_ROLE, account)) { 86 : 39 : return true; 87 : : } 88 : 13 : return AccessControl.hasRole(role, account); 89 : : } 90 : : 91 : : /*////////////////////////////////////////////////////////////// 92 : : ERC-2771 93 : : //////////////////////////////////////////////////////////////*/ 94 : : 95 : : /** 96 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 97 : : */ 98 : : function _msgSender() 99 : : internal 100 : : view 101 : : override(ERC2771Context, Context) 102 : : returns (address sender) 103 : : { 104 : 52 : return ERC2771Context._msgSender(); 105 : : } 106 : : 107 : : /** 108 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 109 : : */ 110 : : function _msgData() 111 : : internal 112 : : view 113 : : override(ERC2771Context, Context) 114 : : returns (bytes calldata) 115 : : { 116 : 0 : return ERC2771Context._msgData(); 117 : : } 118 : : 119 : : /** 120 : : * @dev This surcharge is not necessary if you do not use the MetaTxModule 121 : : */ 122 : : function _contextSuffixLength() 123 : : internal 124 : : view 125 : : override(ERC2771Context, Context) 126 : : returns (uint256) 127 : : { 128 : 52 : return ERC2771Context._contextSuffixLength(); 129 : : } 130 : : } 2 : : pragma solidity ^0.8.20; 3 : : 4 : : /* ==== CMTAT === */ 5 : : import {IERC3643IComplianceContract} from "CMTAT/interfaces/tokenization/IERC3643Partial.sol"; 6 : : import {IRuleEngine} from "CMTAT/interfaces/engine/IRuleEngine.sol"; 7 : : /* ==== Abstract contracts === */ 8 : : import {RuleWhitelistInvariantStorage} from "./RuleAddressSet/invariantStorage/RuleWhitelistInvariantStorage.sol"; 9 : : import {RuleValidateTransfer} from "./RuleValidateTransfer.sol"; 10 : : /* ==== Interface === */ 11 : : import { 12 : : IERC7943NonFungibleCompliance, 13 : : IERC7943NonFungibleComplianceExtend 14 : : } from "../../interfaces/IERC7943NonFungibleCompliance.sol"; 15 : : 16 : : /** 17 : : * @title Rule Whitelist Common 18 : : * @notice Provides common logic for validating whitelist-based transfer restrictions. 19 : : * @dev 20 : : * - Implements ERC-3643–compatible `transferred` hooks to enforce whitelist checks. 21 : : * - Defines utility functions for restriction code validation and message mapping. 22 : : * - Inherits restriction code constants and messages from {RuleWhitelistInvariantStorage}. 23 : : */ 24 : : abstract contract RuleWhitelistCommon is RuleValidateTransfer, RuleWhitelistInvariantStorage { 25 : : /** 26 : : * Indicate if the spender is verified or not 27 : : */ 28 : : bool public checkSpender; 29 : : 30 : : /* ============ View Functions ============ */ 31 : : /** 32 : : * @notice Checks whether a restriction code is recognized by this rule. 33 : : * @dev 34 : : * Used to verify if a returned restriction code belongs to the whitelist rule. 35 : : * @param restrictionCode The restriction code to validate. 36 : : * @return isKnown True if the restriction code is recognized by this rule, false otherwise. 37 : : */ 38 : 10 : function canReturnTransferRestrictionCode(uint8 restrictionCode) external pure override returns (bool isKnown) { 39 : 10 : return restrictionCode == CODE_ADDRESS_FROM_NOT_WHITELISTED 40 : 5 : || restrictionCode == CODE_ADDRESS_TO_NOT_WHITELISTED || restrictionCode == CODE_ADDRESS_SPENDER_NOT_WHITELISTED; 41 : : } 42 : : 43 : : /** 44 : : * @notice Returns the human-readable message corresponding to a restriction code. 45 : : * @dev 46 : : * Returns a descriptive text that explains why a transfer was restricted. 47 : : * @param restrictionCode The restriction code to decode. 48 : : * @return message A human-readable explanation of the restriction. 49 : : */ 50 : 14 : function messageForTransferRestriction(uint8 restrictionCode) 51 : : external 52 : : pure 53 : : override 54 : : returns (string memory message) 55 : : { 56 [ + + ]: 14 : if (restrictionCode == CODE_ADDRESS_FROM_NOT_WHITELISTED) { 57 : 6 : return TEXT_ADDRESS_FROM_NOT_WHITELISTED; 58 [ + + ]: 8 : } else if (restrictionCode == CODE_ADDRESS_TO_NOT_WHITELISTED) { 59 : 4 : return TEXT_ADDRESS_TO_NOT_WHITELISTED; 60 [ + + ]: 4 : } else if (restrictionCode == CODE_ADDRESS_SPENDER_NOT_WHITELISTED) { 61 : 2 : return TEXT_ADDRESS_SPENDER_NOT_WHITELISTED; 62 : : } else { 63 : 2 : return TEXT_CODE_NOT_FOUND; 64 : : } 65 : : } 66 : : 67 : : /* ============ State Functions ============ */ 68 : : 69 : : /** 70 : : * @notice ERC-3643 hook called when a transfer occurs. 71 : : * @dev 72 : : * - Validates that both `from` and `to` addresses are whitelisted. 73 : : * - Reverts if any restriction code other than `TRANSFER_OK` is returned. 74 : : * - Should be called during token transfer logic to enforce whitelist compliance. 75 : : * @param from The address sending tokens. 76 : : * @param to The address receiving tokens. 77 : : * @param value The token amount being transferred. 78 : : */ 79 : 17 : function transferred(address from, address to, uint256 value) public view override(IERC3643IComplianceContract) { 80 : 22 : uint8 code = this.detectTransferRestriction(from, to, value); 81 [ + + ]: 22 : require( 82 : : code == uint8(REJECTED_CODE_BASE.TRANSFER_OK), 83 : : RuleWhitelist_InvalidTransfer(address(this), from, to, value, code) 84 : : ); 85 : : } 86 : : 87 : : /** 88 : : * @notice hook called when a delegated transfer occurs (`transferFrom`). 89 : : * @dev 90 : : * - Validates that `spender`, `from`, and `to` are all whitelisted. 91 : : * - Reverts if any restriction code other than `TRANSFER_OK` is returned. 92 : : * @param spender The address performing the transfer on behalf of another. 93 : : * @param from The address from which tokens are transferred. 94 : : * @param to The recipient address. 95 : : * @param value The token amount being transferred. 96 : : */ 97 : 4 : function transferred(address spender, address from, address to, uint256 value) public view override(IRuleEngine) { 98 : 8 : uint8 code = this.detectTransferRestrictionFrom(spender, from, to, value); 99 [ + + ]: 8 : require( 100 : : code == uint8(REJECTED_CODE_BASE.TRANSFER_OK), 101 : : RuleWhitelist_InvalidTransferFrom(address(this), spender, from, to, value, code) 102 : : ); 103 : : } 104 : : 105 : : 106 : 4 : function transferred(address spender, address from, address to, uint256 /* tokenId */,uint256 value) 107 : : public 108 : : view 109 : : virtual 110 : : override(IERC7943NonFungibleComplianceExtend) 111 : : { 112 : 4 : transferred(spender, from, to, value); 113 : : } 114 : : 115 : 5 : function transferred(address from, address to, uint256 /* tokenId */,uint256 value) 116 : : public 117 : : view 118 : : virtual 119 : : override(IERC7943NonFungibleComplianceExtend) 120 : : { 121 : 5 : transferred(from, to, value); 122 : : } 123 : : }
@@ -206,7 +199,7 @@
LCOV - lcov.info - test/utils
+ LCOV - lcov.info - validation/abstract
-
+
-
+
@@ -82,28 +82,28 @@
Branches
- CMTATDeployment.sol RuleValidateTransfer.sol
-
+
- 100.0 %
- 4 / 4
- 100.0 %
- 1 / 1
+ 80.0 %
+ 8 / 10
+ 80.0 %
+ 4 / 5
-
0 / 0
- SanctionListOracle.sol RuleWhitelistCommon.sol
-
+
- 66.7 %
- 2 / 3
- 75.0 %
- 3 / 4
- -
- 0 / 0
+ 100.0 %
+ 21 / 21
+ 100.0 %
+ 6 / 6
+ 100.0 %
+ 10 / 10
diff --git a/doc/coverage/coverage/test/utils/index-sort-f.html b/doc/coverage/coverage/validation/abstract/index-sort-f.html
similarity index 73%
rename from doc/coverage/coverage/test/utils/index-sort-f.html
rename to doc/coverage/coverage/validation/abstract/index-sort-f.html
index ff0b711..b7e1816 100644
--- a/doc/coverage/coverage/test/utils/index-sort-f.html
+++ b/doc/coverage/coverage/validation/abstract/index-sort-f.html
@@ -4,7 +4,7 @@
LCOV - lcov.info - test/utils
+ LCOV - lcov.info - validation/abstract
-
+
-
+
@@ -82,28 +82,28 @@
Branches
- SanctionListOracle.sol RuleValidateTransfer.sol
-
+
- 66.7 %
- 2 / 3
- 75.0 %
- 3 / 4
+ 80.0 %
+ 8 / 10
+ 80.0 %
+ 4 / 5
-
0 / 0
- CMTATDeployment.sol RuleWhitelistCommon.sol
100.0 %
- 4 / 4
+ 21 / 21
100.0 %
- 1 / 1
- -
- 0 / 0
+ 6 / 6
+ 100.0 %
+ 10 / 10
diff --git a/doc/coverage/coverage/test/utils/index-sort-l.html b/doc/coverage/coverage/validation/abstract/index-sort-l.html
similarity index 73%
rename from doc/coverage/coverage/test/utils/index-sort-l.html
rename to doc/coverage/coverage/validation/abstract/index-sort-l.html
index b1f3e52..f752721 100644
--- a/doc/coverage/coverage/test/utils/index-sort-l.html
+++ b/doc/coverage/coverage/validation/abstract/index-sort-l.html
@@ -4,7 +4,7 @@
LCOV - lcov.info - test/utils
+ LCOV - lcov.info - validation/abstract
-
+
-
+
@@ -82,28 +82,28 @@
Branches
- SanctionListOracle.sol RuleValidateTransfer.sol
-
+
- 66.7 %
- 2 / 3
- 75.0 %
- 3 / 4
+ 80.0 %
+ 8 / 10
+ 80.0 %
+ 4 / 5
-
0 / 0
- CMTATDeployment.sol RuleWhitelistCommon.sol
100.0 %
- 4 / 4
+ 21 / 21
100.0 %
- 1 / 1
- -
- 0 / 0
+ 6 / 6
+ 100.0 %
+ 10 / 10
diff --git a/doc/coverage/coverage/test/utils/index.html b/doc/coverage/coverage/validation/abstract/index.html
similarity index 73%
rename from doc/coverage/coverage/test/utils/index.html
rename to doc/coverage/coverage/validation/abstract/index.html
index 0cb6aec..34817f4 100644
--- a/doc/coverage/coverage/test/utils/index.html
+++ b/doc/coverage/coverage/validation/abstract/index.html
@@ -4,7 +4,7 @@
LCOV - lcov.info - test/utils
+ LCOV - lcov.info - validation/abstract
-
+
-
+
@@ -82,28 +82,28 @@
Branches
- CMTATDeployment.sol RuleValidateTransfer.sol
-
+
- 100.0 %
- 4 / 4
- 100.0 %
- 1 / 1
+ 80.0 %
+ 8 / 10
+ 80.0 %
+ 4 / 5
-
0 / 0
- SanctionListOracle.sol RuleWhitelistCommon.sol
-
+
- 66.7 %
- 2 / 3
- 75.0 %
- 3 / 4
- -
- 0 / 0
+ 100.0 %
+ 21 / 21
+ 100.0 %
+ 6 / 6
+ 100.0 %
+ 10 / 10
diff --git a/doc/coverage/coverage/src/index-sort-b.html b/doc/coverage/coverage/validation/index-sort-b.html
similarity index 53%
rename from doc/coverage/coverage/src/index-sort-b.html
rename to doc/coverage/coverage/validation/index-sort-b.html
index 576ca6d..944c1e9 100644
--- a/doc/coverage/coverage/src/index-sort-b.html
+++ b/doc/coverage/coverage/validation/index-sort-b.html
@@ -4,7 +4,7 @@
LCOV - lcov.info - src
+ LCOV - lcov.info - validation
-
+
-
+
@@ -82,16 +82,52 @@
Branches
- RuleEngine.sol RuleWhitelistWrapper.sol
+
+
+ 87.7 %
+ 50 / 57
+ 81.8 %
+ 9 / 11
+ 78.6 %
+ 11 / 14
+
+
+ RuleWhitelist.sol
+
+
+ 80.0 %
+ 16 / 20
+ 71.4 %
+ 5 / 7
+ 100.0 %
+ 5 / 5
+
+
+ RuleBlacklist.sol
+
+
+ 94.6 %
+ 35 / 37
+ 90.9 %
+ 10 / 11
+ 100.0 %
+ 16 / 16
+
+
+ RuleSanctionsList.sol
-
+
- 97.4 %
- 38 / 39
- 88.9 %
- 8 / 9
+ 92.6 %
+ 50 / 54
+ 88.2 %
+ 15 / 17
100.0 %
- 8 / 8
+ 18 / 18
diff --git a/doc/coverage/coverage/src/index-sort-f.html b/doc/coverage/coverage/validation/index-sort-f.html
similarity index 53%
rename from doc/coverage/coverage/src/index-sort-f.html
rename to doc/coverage/coverage/validation/index-sort-f.html
index 8962246..803ea1c 100644
--- a/doc/coverage/coverage/src/index-sort-f.html
+++ b/doc/coverage/coverage/validation/index-sort-f.html
@@ -4,7 +4,7 @@
LCOV - lcov.info - src
+ LCOV - lcov.info - validation
-
+
-
+
@@ -82,16 +82,52 @@
Branches
- RuleEngine.sol RuleWhitelist.sol
+
+
+ 80.0 %
+ 16 / 20
+ 71.4 %
+ 5 / 7
+ 100.0 %
+ 5 / 5
+
+
+ RuleWhitelistWrapper.sol
+
+
+ 87.7 %
+ 50 / 57
+ 81.8 %
+ 9 / 11
+ 78.6 %
+ 11 / 14
+
+
+ RuleSanctionsList.sol
+
+
+ 92.6 %
+ 50 / 54
+ 88.2 %
+ 15 / 17
+ 100.0 %
+ 18 / 18
+
+
+ RuleBlacklist.sol
-
+
- 97.4 %
- 38 / 39
- 88.9 %
- 8 / 9
+ 94.6 %
+ 35 / 37
+ 90.9 %
+ 10 / 11
100.0 %
- 8 / 8
+ 16 / 16
diff --git a/doc/coverage/coverage/src/index-sort-l.html b/doc/coverage/coverage/validation/index-sort-l.html
similarity index 53%
rename from doc/coverage/coverage/src/index-sort-l.html
rename to doc/coverage/coverage/validation/index-sort-l.html
index f6e4883..b4d9395 100644
--- a/doc/coverage/coverage/src/index-sort-l.html
+++ b/doc/coverage/coverage/validation/index-sort-l.html
@@ -4,7 +4,7 @@
LCOV - lcov.info - src
+ LCOV - lcov.info - validation
-
+
-
+
@@ -82,16 +82,52 @@
Branches
- RuleEngine.sol RuleWhitelist.sol
+
+
+ 80.0 %
+ 16 / 20
+ 71.4 %
+ 5 / 7
+ 100.0 %
+ 5 / 5
+
+
+ RuleWhitelistWrapper.sol
+
+
+ 87.7 %
+ 50 / 57
+ 81.8 %
+ 9 / 11
+ 78.6 %
+ 11 / 14
+
+
+ RuleSanctionsList.sol
+
+
+ 92.6 %
+ 50 / 54
+ 88.2 %
+ 15 / 17
+ 100.0 %
+ 18 / 18
+
+
+ RuleBlacklist.sol
-
+
- 97.4 %
- 38 / 39
- 88.9 %
- 8 / 9
+ 94.6 %
+ 35 / 37
+ 90.9 %
+ 10 / 11
100.0 %
- 8 / 8
+ 16 / 16
diff --git a/doc/coverage/coverage/src/index.html b/doc/coverage/coverage/validation/index.html
similarity index 53%
rename from doc/coverage/coverage/src/index.html
rename to doc/coverage/coverage/validation/index.html
index 0762168..bffbd19 100644
--- a/doc/coverage/coverage/src/index.html
+++ b/doc/coverage/coverage/validation/index.html
@@ -4,7 +4,7 @@
LCOV - lcov.info - src
+ LCOV - lcov.info - validation
-
+
-
+
@@ -82,16 +82,52 @@
Branches
- RuleEngine.sol RuleBlacklist.sol
+
+
+ 94.6 %
+ 35 / 37
+ 90.9 %
+ 10 / 11
+ 100.0 %
+ 16 / 16
+
+
+ RuleSanctionsList.sol
+
+
+ 92.6 %
+ 50 / 54
+ 88.2 %
+ 15 / 17
+ 100.0 %
+ 18 / 18
+
+
+ RuleWhitelist.sol
-
+
- 97.4 %
- 38 / 39
- 88.9 %
- 8 / 9
+ 80.0 %
+ 16 / 20
+ 71.4 %
+ 5 / 7
100.0 %
- 8 / 8
+ 5 / 5
+
+
+ RuleWhitelistWrapper.sol
+
+
+ 87.7 %
+ 50 / 57
+ 81.8 %
+ 9 / 11
+ 78.6 %
+ 11 / 14
diff --git a/doc/coverage/lcov.info b/doc/coverage/lcov.info
index a4e6aaf..3c88298 100644
--- a/doc/coverage/lcov.info
+++ b/doc/coverage/lcov.info
@@ -1,1091 +1,554 @@
TN:
-SF:script/CMTATWithRuleEngineScript.s.sol
-FN:15,CMTATWithRuleEngineScript.run
-FNDA:0,CMTATWithRuleEngineScript.run
-DA:17,0
-DA:18,0
-DA:19,0
-DA:20,0
-DA:22,0
-DA:23,0
-DA:24,0
-DA:26,0
-DA:30,0
-DA:32,0
-DA:37,0
-DA:38,0
-DA:39,0
-DA:41,0
-FNF:1
-FNH:0
-LF:14
-LH:0
-BRF:0
-BRH:0
-end_of_record
-TN:
-SF:script/RuleEngineScript.s.sol
-FN:16,RuleEngineScript.run
-FNDA:0,RuleEngineScript.run
-DA:18,0
-DA:19,0
-DA:20,0
-DA:21,0
-DA:23,0
-DA:24,0
-DA:26,0
-DA:27,0
-DA:28,0
-DA:30,0
-DA:33,0
-BRDA:33,0,0,-
-BRDA:33,0,1,-
-DA:34,0
-FNF:1
-FNH:0
-LF:12
-LH:0
-BRF:2
-BRH:0
-end_of_record
-TN:
-SF:src/RuleEngine.sol
-FN:29,RuleEngine.
-FNDA:205,RuleEngine.
-DA:34,205
-BRDA:34,0,0,1
-DA:35,1
-DA:37,204
-BRDA:37,1,0,86
-DA:38,86
-DA:40,204
-FN:50,RuleEngine.detectTransferRestriction
-FNDA:20,RuleEngine.detectTransferRestriction
-DA:56,32
-DA:61,32
-BRDA:61,2,0,15
-DA:62,15
-DA:66,17
-DA:67,17
-DA:68,12
-DA:70,12
-BRDA:70,3,0,11
-DA:71,11
-DA:75,6
-FN:85,RuleEngine.validateTransfer
-FNDA:12,RuleEngine.validateTransfer
-DA:90,12
-DA:91,12
-FN:100,RuleEngine.messageForTransferRestriction
-FNDA:18,RuleEngine.messageForTransferRestriction
-DA:104,18
-DA:105,18
-DA:107,13
-DA:109,10
-BRDA:109,4,0,10
-DA:110,10
-DA:111,10
-DA:116,8
-DA:117,8
-DA:119,2
-DA:121,1
-BRDA:121,5,0,1
-DA:122,1
-DA:123,1
-DA:127,7
-FN:133,RuleEngine.operateOnTransfer
-FNDA:69,RuleEngine.operateOnTransfer
-DA:140,68
-DA:141,10
-BRDA:141,6,0,10
-DA:142,10
-DA:145,58
-FN:152,RuleEngine.hasRole
-FNDA:299,RuleEngine.hasRole
-DA:157,597
-BRDA:157,7,0,220
-DA:158,220
-DA:160,377
-FN:170,RuleEngine._msgSender
-FNDA:588,RuleEngine._msgSender
-DA:176,588
-FN:182,RuleEngine._msgData
-FNDA:0,RuleEngine._msgData
-DA:188,0
-FN:194,RuleEngine._contextSuffixLength
-FNDA:588,RuleEngine._contextSuffixLength
-DA:200,588
-FNF:9
-FNH:8
-LF:39
-LH:38
-BRF:8
-BRH:8
-end_of_record
-TN:
-SF:src/modules/MetaTxModuleStandalone.sol
-FN:11,MetaTxModuleStandalone.
-FNDA:575,MetaTxModuleStandalone.
-FNF:1
-FNH:1
-LF:0
-LH:0
-BRF:0
-BRH:0
-end_of_record
-TN:
-SF:src/modules/RuleEngineOperation.sol
-FN:26,RuleEngineOperation.setRulesOperation
-FNDA:11,RuleEngineOperation.setRulesOperation
-DA:29,11
-BRDA:29,0,0,10
-DA:30,10
-DA:32,11
-DA:33,8
-FN:40,RuleEngineOperation.clearRulesOperation
-FNDA:4,RuleEngineOperation.clearRulesOperation
-DA:41,4
-FN:48,RuleEngineOperation._clearRulesOperation
-FNDA:14,RuleEngineOperation._clearRulesOperation
-DA:49,14
-DA:51,14
-DA:54,17
-DA:56,17
-DA:58,14
-FN:66,RuleEngineOperation.addRuleOperation
-FNDA:85,RuleEngineOperation.addRuleOperation
-DA:69,85
-DA:70,83
-FN:83,RuleEngineOperation.removeRuleOperation
-FNDA:5,RuleEngineOperation.removeRuleOperation
-DA:87,5
-FN:100,RuleEngineOperation._removeRuleOperation
-FNDA:22,RuleEngineOperation._removeRuleOperation
-DA:101,22
-DA:102,21
-FN:108,RuleEngineOperation.rulesCountOperation
-FNDA:41,RuleEngineOperation.rulesCountOperation
-DA:109,41
-FN:116,RuleEngineOperation.getRuleIndexOperation
-FNDA:3,RuleEngineOperation.getRuleIndexOperation
-DA:119,3
-FN:127,RuleEngineOperation.ruleOperation
-FNDA:1,RuleEngineOperation.ruleOperation
-DA:130,1
-FN:137,RuleEngineOperation.rulesOperation
-FNDA:5,RuleEngineOperation.rulesOperation
-DA:143,5
-FN:152,RuleEngineOperation._operateOnTransfer
-FNDA:58,RuleEngineOperation._operateOnTransfer
-DA:157,58
-DA:158,58
-DA:159,50
-DA:164,50
-BRDA:164,1,0,24
-DA:165,24
-DA:168,34
-FNF:11
-FNH:11
-LF:25
-LH:25
-BRF:2
-BRH:2
-end_of_record
-TN:
-SF:src/modules/RuleEngineValidation.sol
-FN:29,RuleEngineValidation.detectTransferRestrictionValidation
-FNDA:3,RuleEngineValidation.detectTransferRestrictionValidation
-DA:34,105
-DA:35,105
-DA:36,43
-DA:38,43
-BRDA:38,0,0,28
-DA:39,28
-DA:43,77
-FN:53,RuleEngineValidation.validateTransferValidation
-FNDA:2,RuleEngineValidation.validateTransferValidation
-DA:58,70
-DA:59,70
+SF:src/modules/AccessControlModuleStandalone.sol
+DA:22,161
+FN:22,AccessControlModuleStandalone.constructor
+FNDA:161,AccessControlModuleStandalone.constructor
+DA:23,161
+BRDA:23,0,0,4
+DA:24,4
+DA:29,157
+DA:38,228
+FN:38,AccessControlModuleStandalone.hasRole
+FNDA:228,AccessControlModuleStandalone.hasRole
+DA:40,328
+BRDA:40,1,0,152
+BRDA:40,1,1,176
+DA:41,152
+DA:43,176
FNF:2
FNH:2
LF:8
LH:8
-BRF:1
-BRH:1
+BRF:3
+BRH:3
end_of_record
TN:
-SF:src/modules/RuleEngineValidationCommon.sol
-FN:30,RuleEngineValidationCommon.setRulesValidation
-FNDA:22,RuleEngineValidationCommon.setRulesValidation
-DA:33,21
-BRDA:33,0,0,20
-DA:34,20
-DA:36,21
-DA:37,18
-FN:44,RuleEngineValidationCommon.clearRulesValidation
-FNDA:6,RuleEngineValidationCommon.clearRulesValidation
-DA:45,5
-FN:53,RuleEngineValidationCommon.addRuleValidation
-FNDA:119,RuleEngineValidationCommon.addRuleValidation
-DA:56,118
-DA:57,116
-FN:70,RuleEngineValidationCommon.removeRuleValidation
-FNDA:6,RuleEngineValidationCommon.removeRuleValidation
-DA:74,5
-FN:80,RuleEngineValidationCommon.rulesCountValidation
-FNDA:69,RuleEngineValidationCommon.rulesCountValidation
-DA:81,69
-FN:88,RuleEngineValidationCommon.getRuleIndexValidation
-FNDA:3,RuleEngineValidationCommon.getRuleIndexValidation
-DA:91,3
-FN:99,RuleEngineValidationCommon.ruleValidation
-FNDA:1,RuleEngineValidationCommon.ruleValidation
-DA:102,1
-FN:109,RuleEngineValidationCommon.rulesValidation
-FNDA:5,RuleEngineValidationCommon.rulesValidation
-DA:115,5
-FN:125,RuleEngineValidationCommon._clearRulesValidation
-FNDA:25,RuleEngineValidationCommon._clearRulesValidation
-DA:126,25
-DA:128,25
-DA:131,28
-DA:133,28
-DA:135,25
-FN:148,RuleEngineValidationCommon._removeRuleValidation
-FNDA:33,RuleEngineValidationCommon._removeRuleValidation
-DA:149,33
-DA:150,32
-FNF:10
-FNH:10
-LF:19
-LH:19
-BRF:1
-BRH:1
-end_of_record
-TN:
-SF:src/modules/RuleInternal.sol
-FN:19,RuleInternal._setRules
-FNDA:32,RuleInternal._setRules
-DA:20,32
-BRDA:20,0,0,2
-DA:21,2
-DA:23,30
-DA:24,48
-BRDA:24,1,0,2
-DA:25,2
-DA:27,2
-BRDA:27,2,0,2
-DA:28,2
-DA:30,44
-DA:31,44
-DA:33,44
-FN:43,RuleInternal._addRule
-FNDA:203,RuleInternal._addRule
-DA:44,203
-BRDA:44,3,0,2
-DA:45,2
-DA:47,2
-BRDA:47,4,0,2
-DA:48,2
-DA:50,199
-DA:51,199
-FN:64,RuleInternal._removeRule
-FNDA:55,RuleInternal._removeRule
-DA:69,55
-BRDA:69,5,0,2
-DA:70,2
-DA:72,53
-BRDA:72,6,0,4
-DA:73,4
-DA:75,53
-DA:76,53
-DA:77,53
-FN:84,RuleInternal._getRuleIndex
-FNDA:6,RuleInternal._getRuleIndex
-DA:88,6
-DA:89,6
-DA:90,10
-BRDA:90,7,0,4
-DA:91,4
-DA:94,6
-DA:97,2
-FNF:4
-FNH:4
-LF:29
-LH:29
-BRF:8
-BRH:8
-end_of_record
-TN:
-SF:src/rules/operation/RuleConditionalTransfer.sol
-FN:27,RuleConditionalTransfer.
-FNDA:158,RuleConditionalTransfer.
-DA:33,158
-BRDA:33,0,0,1
-DA:34,1
-DA:36,157
-DA:37,157
-BRDA:37,1,0,153
-DA:38,153
-DA:40,157
-FN:51,RuleConditionalTransfer.operateOnTransfer
-FNDA:50,RuleConditionalTransfer.operateOnTransfer
-DA:61,50
-BRDA:61,2,0,8
-BRDA:61,2,1,24
-DA:62,8
-DA:64,42
-DA:65,42
-BRDA:65,3,0,18
-BRDA:65,3,1,24
-DA:66,18
-DA:67,18
-DA:69,24
-FN:79,RuleConditionalTransfer.createTransferRequest
-FNDA:114,RuleConditionalTransfer.createTransferRequest
-DA:83,117
-DA:84,117
-DA:85,117
-BRDA:85,4,0,1
-DA:86,1
-DA:88,116
-BRDA:88,5,0,113
-BRDA:88,5,1,3
-DA:89,113
-DA:90,113
-DA:102,113
-DA:103,113
-DA:104,113
-DA:105,113
-DA:108,3
-DA:109,3
-DA:110,3
-FN:123,RuleConditionalTransfer.createTransferRequestBatch
-FNDA:3,RuleConditionalTransfer.createTransferRequestBatch
-DA:127,3
-BRDA:127,6,0,1
-DA:128,1
-DA:130,2
-BRDA:130,7,0,1
-DA:131,1
-DA:133,1
-DA:134,3
-FN:141,RuleConditionalTransfer.cancelTransferRequest
-FNDA:6,RuleConditionalTransfer.cancelTransferRequest
-DA:142,6
-FN:148,RuleConditionalTransfer.cancelTransferRequestBatch
-FNDA:3,RuleConditionalTransfer.cancelTransferRequestBatch
-DA:149,3
-BRDA:149,8,0,1
-DA:150,1
-DA:153,2
-DA:154,5
-BRDA:154,9,0,1
-DA:155,1
-DA:158,1
-DA:159,3
-FN:163,RuleConditionalTransfer.getRequestTrade
-FNDA:57,RuleConditionalTransfer.getRequestTrade
-DA:168,57
-DA:169,57
-FN:177,RuleConditionalTransfer.getRequestByStatus
-FNDA:35,RuleConditionalTransfer.getRequestByStatus
-DA:180,35
-DA:181,35
-DA:182,35
-DA:185,35
-DA:186,38
-BRDA:186,10,0,36
-DA:187,36
-DA:192,35
-DA:195,35
-DA:196,38
-BRDA:196,11,0,36
-DA:198,36
-DA:201,36
-DA:202,36
-DA:205,35
-FN:214,RuleConditionalTransfer.detectTransferRestriction
-FNDA:56,RuleConditionalTransfer.detectTransferRestriction
-DA:220,56
-BRDA:220,12,0,1
-DA:221,1
-DA:223,55
-DA:224,55
-BRDA:224,13,0,8
-BRDA:224,13,1,8
-DA:225,8
-DA:227,47
-FN:236,RuleConditionalTransfer.canReturnTransferRestrictionCode
-FNDA:2,RuleConditionalTransfer.canReturnTransferRestrictionCode
-DA:239,2
-FN:247,RuleConditionalTransfer.messageForTransferRestriction
-FNDA:3,RuleConditionalTransfer.messageForTransferRestriction
-DA:250,3
-BRDA:250,14,0,2
-BRDA:250,14,1,1
-DA:251,2
-DA:253,1
-FN:260,RuleConditionalTransfer._validateTransfer
-FNDA:106,RuleConditionalTransfer._validateTransfer
-DA:265,106
-BRDA:265,15,0,36
-DA:267,36
-DA:268,5
-DA:269,3
-BRDA:269,16,0,3
-DA:270,3
-DA:275,103
-BRDA:275,17,0,6
-DA:276,6
-DA:278,97
-FN:281,RuleConditionalTransfer._cancelTransferRequest
-FNDA:9,RuleConditionalTransfer._cancelTransferRequest
-DA:282,9
-BRDA:282,18,0,1
-DA:283,1
-DA:285,8
-DA:287,8
-BRDA:287,19,0,1
-DA:288,1
-DA:292,7
-DA:293,2
-DA:294,1
-BRDA:294,20,0,1
-DA:295,1
-DA:297,6
-FN:307,RuleConditionalTransfer._validateBurnMint
-FNDA:103,RuleConditionalTransfer._validateBurnMint
-DA:313,103
-DA:317,6
-BRDA:317,21,0,6
-DA:318,6
-DA:320,97
-FN:329,RuleConditionalTransfer._validateApproval
-FNDA:97,RuleConditionalTransfer._validateApproval
-DA:333,97
-DA:335,50
-DA:337,47
-DA:338,50
-BRDA:338,22,0,50
-DA:339,50
-DA:341,47
-DA:342,47
-DA:343,47
-DA:344,20
-BRDA:344,23,0,20
-BRDA:343,23,1,27
-DA:345,20
-DA:348,27
-BRDA:348,24,0,27
-DA:350,27
-DA:355,47
-BRDA:355,25,0,26
-BRDA:355,25,1,21
-DA:356,26
-DA:358,21
-FN:369,RuleConditionalTransfer._msgSender
-FNDA:829,RuleConditionalTransfer._msgSender
-DA:375,829
-FN:381,RuleConditionalTransfer._msgData
-FNDA:0,RuleConditionalTransfer._msgData
-DA:387,0
-FN:393,RuleConditionalTransfer._contextSuffixLength
-FNDA:829,RuleConditionalTransfer._contextSuffixLength
-DA:399,829
-FNF:18
-FNH:17
-LF:106
-LH:105
-BRF:33
-BRH:33
-end_of_record
-TN:
-SF:src/rules/operation/abstract/RuleConditionalTransferOperator.sol
-FN:32,RuleConditionalTransferOperator.setConditionalWhitelist
-FNDA:26,RuleConditionalTransferOperator.setConditionalWhitelist
-DA:35,26
-DA:36,26
-FN:42,RuleConditionalTransferOperator.setIssuanceOptions
-FNDA:7,RuleConditionalTransferOperator.setIssuanceOptions
-DA:46,6
-DA:48,3
-BRDA:48,0,0,3
-DA:49,3
-DA:53,6
-DA:55,3
-BRDA:55,1,0,3
-DA:56,3
-FN:66,RuleConditionalTransferOperator.setAutomaticTransfer
-FNDA:4,RuleConditionalTransferOperator.setAutomaticTransfer
-DA:70,3
-DA:72,2
-BRDA:72,2,0,2
-DA:73,2
-DA:78,3
-DA:80,2
-BRDA:80,3,0,2
-DA:81,2
-FN:90,RuleConditionalTransferOperator.setTimeLimit
-FNDA:5,RuleConditionalTransferOperator.setTimeLimit
+SF:src/rules/validation/RuleBlacklist.sol
+DA:41,22
+FN:41,RuleBlacklist.detectTransferRestriction.0
+FNDA:22,RuleBlacklist.detectTransferRestriction.0
+DA:47,43
+BRDA:47,0,0,14
+BRDA:47,0,1,16
+DA:48,14
+DA:49,29
+BRDA:49,1,0,13
+BRDA:49,1,1,16
+DA:50,13
+DA:52,16
+DA:59,7
+FN:59,RuleBlacklist.detectTransferRestriction.1
+FNDA:7,RuleBlacklist.detectTransferRestriction.1
+DA:65,7
+DA:71,16
+FN:71,RuleBlacklist.detectTransferRestrictionFrom.0
+FNDA:16,RuleBlacklist.detectTransferRestrictionFrom.0
+DA:77,20
+BRDA:77,2,0,6
+BRDA:77,2,1,14
+DA:78,6
+DA:80,14
+DA:87,4
+FN:87,RuleBlacklist.detectTransferRestrictionFrom.1
+FNDA:4,RuleBlacklist.detectTransferRestrictionFrom.1
DA:94,4
-DA:96,4
-BRDA:96,4,0,4
-DA:97,4
-DA:101,4
DA:103,4
-BRDA:103,5,0,4
-DA:104,4
-FN:114,RuleConditionalTransferOperator.setAutomaticApproval
-FNDA:10,RuleConditionalTransferOperator.setAutomaticApproval
-DA:118,9
-DA:120,6
-BRDA:120,6,0,6
-DA:121,6
-DA:125,9
-DA:127,9
-BRDA:127,7,0,9
-DA:128,9
-FN:138,RuleConditionalTransferOperator.createTransferRequestWithApproval
-FNDA:6,RuleConditionalTransferOperator.createTransferRequestWithApproval
-DA:141,5
-FN:150,RuleConditionalTransferOperator.approveTransferRequest
-FNDA:40,RuleConditionalTransferOperator.approveTransferRequest
-DA:155,39
-FN:161,RuleConditionalTransferOperator.approveTransferRequestWithId
-FNDA:5,RuleConditionalTransferOperator.approveTransferRequestWithId
-DA:165,4
-BRDA:165,8,0,2
-DA:166,2
-DA:168,2
-DA:171,2
-FN:177,RuleConditionalTransferOperator.resetRequestStatus
-FNDA:3,RuleConditionalTransferOperator.resetRequestStatus
-DA:180,2
-BRDA:180,9,0,1
-DA:181,1
-DA:183,1
-DA:184,1
-FN:191,RuleConditionalTransferOperator.approveTransferRequestBatchWithId
-FNDA:7,RuleConditionalTransferOperator.approveTransferRequestBatchWithId
-DA:195,5
-BRDA:195,10,0,1
-DA:196,1
-DA:198,4
-BRDA:198,11,0,1
-DA:199,1
-DA:202,3
-DA:203,11
-BRDA:203,12,0,1
-DA:204,1
-DA:207,2
-DA:208,5
-DA:211,5
-FN:218,RuleConditionalTransferOperator.approveTransferRequestBatch
-FNDA:7,RuleConditionalTransferOperator.approveTransferRequestBatch
-DA:223,6
-BRDA:223,13,0,1
-DA:224,1
-DA:227,5
-DA:229,3
-BRDA:229,14,0,3
-DA:230,3
-DA:232,2
-DA:233,9
-FN:244,RuleConditionalTransferOperator.createTransferRequestWithApprovalBatch
-FNDA:3,RuleConditionalTransferOperator.createTransferRequestWithApprovalBatch
-DA:247,2
-BRDA:247,15,0,1
-DA:248,1
-DA:250,1
-DA:251,4
-FN:258,RuleConditionalTransferOperator.resetRequestStatusBatch
-FNDA:3,RuleConditionalTransferOperator.resetRequestStatusBatch
-DA:261,3
-BRDA:261,16,0,1
-DA:262,1
-DA:265,2
-DA:266,4
-BRDA:266,17,0,1
-DA:267,1
-DA:270,1
-DA:271,3
-DA:272,3
-FN:280,RuleConditionalTransferOperator.hasRole
-FNDA:310,RuleConditionalTransferOperator.hasRole
-DA:285,704
-BRDA:285,18,0,137
-DA:286,137
-DA:288,567
-FN:294,RuleConditionalTransferOperator._approveTransferRequestKeyElement
-FNDA:48,RuleConditionalTransferOperator._approveTransferRequestKeyElement
-DA:299,48
-BRDA:299,19,0,1
-DA:300,1
-DA:302,47
-DA:305,47
-DA:306,47
-BRDA:306,20,0,9
-BRDA:306,20,1,8
-DA:307,9
-BRDA:307,21,0,1
-DA:308,1
-DA:311,8
-DA:313,8
-DA:321,38
-FN:325,RuleConditionalTransferOperator._createTransferRequestWithApproval
-FNDA:17,RuleConditionalTransferOperator._createTransferRequestWithApproval
-DA:331,17
-DA:334,17
-BRDA:334,22,0,16
-BRDA:334,22,1,1
-DA:336,16
-DA:346,16
-DA:347,16
-DA:348,16
-DA:355,16
-DA:359,1
-DA:362,1
-DA:363,1
-FN:373,RuleConditionalTransferOperator._resetRequestStatus
-FNDA:10,RuleConditionalTransferOperator._resetRequestStatus
-DA:374,10
-DA:375,10
-FN:387,RuleConditionalTransferOperator._checkRequestStatus
-FNDA:133,RuleConditionalTransferOperator._checkRequestStatus
-DA:389,133
-DA:390,133
-FN:394,RuleConditionalTransferOperator._approveRequest
-FNDA:53,RuleConditionalTransferOperator._approveRequest
-DA:399,53
-BRDA:399,23,0,1
-DA:400,1
-DA:402,32
-BRDA:402,24,0,32
-BRDA:402,24,1,20
-DA:405,32
-DA:407,3
-BRDA:407,25,0,3
-DA:408,3
-DA:411,29
-DA:413,29
-DA:416,29
-DA:424,29
-DA:425,7
-DA:426,7
-BRDA:426,26,0,7
-DA:430,7
-DA:434,3
-BRDA:434,27,0,3
-DA:436,3
-DA:444,20
-DA:445,20
-FN:458,RuleConditionalTransferOperator._updateProcessedTransfer
-FNDA:18,RuleConditionalTransferOperator._updateProcessedTransfer
-DA:460,18
-DA:461,18
-DA:463,18
-DA:465,18
-FNF:20
-FNH:20
-LF:113
-LH:113
-BRF:31
-BRH:31
-end_of_record
-TN:
-SF:src/rules/validation/RuleBlacklist.sol
-FN:22,RuleBlacklist.
-FNDA:12,RuleBlacklist.
-FN:33,RuleBlacklist.detectTransferRestriction
-FNDA:10,RuleBlacklist.detectTransferRestriction
-DA:38,10
-BRDA:38,0,0,5
-BRDA:38,0,1,3
-DA:39,5
-DA:40,5
-BRDA:40,1,0,2
-BRDA:40,1,1,3
-DA:41,2
-DA:43,3
-FN:52,RuleBlacklist.canReturnTransferRestrictionCode
+FN:103,RuleBlacklist.canReturnTransferRestrictionCode
FNDA:4,RuleBlacklist.canReturnTransferRestrictionCode
-DA:55,4
-DA:56,4
-DA:57,2
-FN:65,RuleBlacklist.messageForTransferRestriction
-FNDA:4,RuleBlacklist.messageForTransferRestriction
-DA:68,4
-BRDA:68,2,0,2
-BRDA:68,2,1,1
-DA:69,2
-DA:70,2
-BRDA:70,3,0,1
-BRDA:70,3,1,1
-DA:71,1
-DA:73,1
-FNF:4
-FNH:4
-LF:13
-LH:13
-BRF:8
-BRH:8
+DA:110,4
+DA:111,2
+DA:120,8
+FN:120,RuleBlacklist.messageForTransferRestriction
+FNDA:8,RuleBlacklist.messageForTransferRestriction
+DA:127,8
+BRDA:127,3,0,3
+BRDA:127,3,1,2
+DA:128,3
+DA:129,5
+BRDA:129,4,0,2
+BRDA:129,4,1,2
+DA:130,2
+DA:131,3
+BRDA:131,5,0,1
+BRDA:131,5,1,2
+DA:132,1
+DA:134,2
+DA:138,0
+FN:138,RuleBlacklist.supportsInterface
+FNDA:0,RuleBlacklist.supportsInterface
+DA:139,0
+DA:144,9
+FN:144,RuleBlacklist.transferred.0
+FNDA:9,RuleBlacklist.transferred.0
+DA:150,12
+DA:151,12
+BRDA:151,6,0,8
+BRDA:151,6,1,4
+DA:157,2
+FN:157,RuleBlacklist.transferred.1
+FNDA:2,RuleBlacklist.transferred.1
+DA:163,4
+DA:164,4
+BRDA:164,7,0,2
+BRDA:164,7,1,2
+DA:170,2
+FN:170,RuleBlacklist.transferred.2
+FNDA:2,RuleBlacklist.transferred.2
+DA:176,2
+DA:179,3
+FN:179,RuleBlacklist.transferred.3
+FNDA:3,RuleBlacklist.transferred.3
+DA:185,3
+FNF:11
+FNH:10
+LF:37
+LH:35
+BRF:16
+BRH:16
end_of_record
TN:
-SF:src/rules/validation/RuleSanctionList.sol
-FN:26,RuleSanctionList.
-FNDA:13,RuleSanctionList.
-DA:31,13
-BRDA:31,0,0,1
-DA:32,1
-DA:34,12
-BRDA:34,1,0,1
-DA:35,1
-DA:37,12
-FN:45,RuleSanctionList.setSanctionListOracle
-FNDA:11,RuleSanctionList.setSanctionListOracle
-DA:48,10
-FN:57,RuleSanctionList.detectTransferRestriction
-FNDA:7,RuleSanctionList.detectTransferRestriction
-DA:62,7
-BRDA:62,2,0,7
-DA:63,7
-BRDA:63,3,0,2
-BRDA:63,3,1,3
-DA:64,2
-DA:65,5
-BRDA:65,4,0,2
-DA:66,2
-DA:69,3
-FN:77,RuleSanctionList.canReturnTransferRestrictionCode
-FNDA:3,RuleSanctionList.canReturnTransferRestrictionCode
-DA:80,3
-DA:81,3
-DA:82,2
-FN:90,RuleSanctionList.messageForTransferRestriction
-FNDA:3,RuleSanctionList.messageForTransferRestriction
-DA:93,3
-BRDA:93,5,0,1
-BRDA:93,5,1,1
-DA:94,1
-DA:95,2
-BRDA:95,6,0,1
-BRDA:95,6,1,1
-DA:96,1
-DA:98,1
-FN:106,RuleSanctionList.hasRole
-FNDA:13,RuleSanctionList.hasRole
-DA:111,24
-BRDA:111,7,0,11
-DA:112,11
-DA:114,13
-FN:121,RuleSanctionList._setSanctionListOracle
-FNDA:11,RuleSanctionList._setSanctionListOracle
-DA:122,11
-DA:123,11
-FN:133,RuleSanctionList._msgSender
-FNDA:23,RuleSanctionList._msgSender
-DA:139,23
-FN:145,RuleSanctionList._msgData
-FNDA:0,RuleSanctionList._msgData
-DA:151,0
-FN:157,RuleSanctionList._contextSuffixLength
-FNDA:23,RuleSanctionList._contextSuffixLength
-DA:163,23
-FNF:10
-FNH:9
-LF:28
-LH:27
-BRF:11
-BRH:11
+SF:src/rules/validation/RuleSanctionsList.sol
+DA:55,17
+FN:55,RuleSanctionsList.constructor
+FNDA:17,RuleSanctionsList.constructor
+DA:59,16
+BRDA:59,0,0,1
+DA:60,1
+DA:73,17
+FN:73,RuleSanctionsList.detectTransferRestriction.0
+FNDA:17,RuleSanctionsList.detectTransferRestriction.0
+DA:79,35
+BRDA:79,1,0,30
+DA:80,30
+BRDA:80,2,0,6
+BRDA:80,2,1,14
+DA:81,6
+DA:82,24
+BRDA:82,3,0,10
+DA:83,10
+DA:86,19
+DA:92,9
+FN:92,RuleSanctionsList.detectTransferRestriction.1
+FNDA:9,RuleSanctionsList.detectTransferRestriction.1
+DA:99,9
+DA:105,11
+FN:105,RuleSanctionsList.detectTransferRestrictionFrom.0
+FNDA:11,RuleSanctionsList.detectTransferRestrictionFrom.0
+DA:112,14
+BRDA:112,4,0,13
+DA:113,13
+BRDA:113,5,0,4
+BRDA:113,5,1,9
+DA:114,4
+DA:116,9
+DA:119,1
+DA:122,3
+FN:122,RuleSanctionsList.detectTransferRestrictionFrom.1
+FNDA:3,RuleSanctionsList.detectTransferRestrictionFrom.1
+DA:129,3
+DA:138,3
+FN:138,RuleSanctionsList.canReturnTransferRestrictionCode
+FNDA:3,RuleSanctionsList.canReturnTransferRestrictionCode
+DA:139,3
+DA:140,1
+DA:149,4
+FN:149,RuleSanctionsList.messageForTransferRestriction
+FNDA:4,RuleSanctionsList.messageForTransferRestriction
+DA:156,4
+BRDA:156,6,0,1
+BRDA:156,6,1,1
+DA:157,1
+DA:158,3
+BRDA:158,7,0,1
+BRDA:158,7,1,1
+DA:159,1
+DA:160,2
+BRDA:160,8,0,1
+BRDA:160,8,1,1
+DA:161,1
+DA:163,1
+DA:167,0
+FN:167,RuleSanctionsList.supportsInterface
+FNDA:0,RuleSanctionsList.supportsInterface
+DA:168,0
+DA:177,14
+FN:177,RuleSanctionsList.setSanctionListOracle
+FNDA:14,RuleSanctionsList.setSanctionListOracle
+DA:178,13
+DA:184,3
+FN:184,RuleSanctionsList.transferred.0
+FNDA:3,RuleSanctionsList.transferred.0
+DA:190,7
+DA:191,7
+BRDA:191,9,0,4
+BRDA:191,9,1,3
+DA:201,2
+FN:201,RuleSanctionsList.transferred.1
+FNDA:2,RuleSanctionsList.transferred.1
+DA:207,3
+DA:208,3
+BRDA:208,10,0,2
+BRDA:208,10,1,1
+DA:214,1
+FN:214,RuleSanctionsList.transferred.2
+FNDA:1,RuleSanctionsList.transferred.2
+DA:220,1
+DA:223,4
+FN:223,RuleSanctionsList.transferred.3
+FNDA:4,RuleSanctionsList.transferred.3
+DA:229,4
+DA:235,14
+FN:235,RuleSanctionsList._setSanctionListOracle
+FNDA:14,RuleSanctionsList._setSanctionListOracle
+DA:236,14
+DA:237,14
+DA:247,30
+FN:247,RuleSanctionsList._msgSender
+FNDA:30,RuleSanctionsList._msgSender
+DA:248,30
+DA:254,0
+FN:254,RuleSanctionsList._msgData
+FNDA:0,RuleSanctionsList._msgData
+DA:255,0
+DA:261,30
+FN:261,RuleSanctionsList._contextSuffixLength
+FNDA:30,RuleSanctionsList._contextSuffixLength
+DA:262,30
+FNF:17
+FNH:15
+LF:54
+LH:50
+BRF:18
+BRH:18
end_of_record
TN:
SF:src/rules/validation/RuleWhitelist.sol
-FN:16,RuleWhitelist.
-FNDA:173,RuleWhitelist.
-FN:27,RuleWhitelist.detectTransferRestriction
-FNDA:28,RuleWhitelist.detectTransferRestriction
-DA:32,28
-BRDA:32,0,0,13
-BRDA:32,0,1,10
-DA:33,13
-DA:34,15
-BRDA:34,1,0,5
-BRDA:34,1,1,10
-DA:35,5
-DA:37,10
-FNF:2
-FNH:2
-LF:5
-LH:5
-BRF:4
-BRH:4
+DA:33,102
+FN:33,RuleWhitelist.constructor
+FNDA:102,RuleWhitelist.constructor
+DA:36,101
+DA:56,20
+FN:56,RuleWhitelist.detectTransferRestriction.0
+FNDA:20,RuleWhitelist.detectTransferRestriction.0
+DA:63,33
+BRDA:63,0,0,11
+BRDA:63,0,1,16
+DA:64,11
+DA:65,22
+BRDA:65,1,0,6
+BRDA:65,1,1,16
+DA:66,6
+DA:68,16
+DA:75,7
+FN:75,RuleWhitelist.detectTransferRestriction.1
+FNDA:7,RuleWhitelist.detectTransferRestriction.1
+DA:82,7
+DA:102,10
+FN:102,RuleWhitelist.detectTransferRestrictionFrom.0
+FNDA:10,RuleWhitelist.detectTransferRestrictionFrom.0
+DA:109,12
+BRDA:109,2,0,6
+DA:110,6
+DA:112,6
+DA:118,2
+FN:118,RuleWhitelist.detectTransferRestrictionFrom.1
+FNDA:2,RuleWhitelist.detectTransferRestrictionFrom.1
+DA:125,2
+DA:133,0
+FN:133,RuleWhitelist.isVerified
+FNDA:0,RuleWhitelist.isVerified
+DA:140,0
+DA:143,0
+FN:143,RuleWhitelist.supportsInterface
+FNDA:0,RuleWhitelist.supportsInterface
+DA:144,0
+FNF:7
+FNH:5
+LF:20
+LH:16
+BRF:5
+BRH:5
end_of_record
TN:
SF:src/rules/validation/RuleWhitelistWrapper.sol
-FN:23,RuleWhitelistWrapper.
-FNDA:14,RuleWhitelistWrapper.
-DA:27,14
-BRDA:27,0,0,1
-DA:28,1
-DA:30,13
-FN:39,RuleWhitelistWrapper.detectTransferRestriction
-FNDA:11,RuleWhitelistWrapper.detectTransferRestriction
-DA:44,11
-DA:45,11
-DA:46,11
-DA:47,11
-DA:48,11
-DA:49,11
-DA:51,11
-DA:53,25
-DA:55,25
-BRDA:55,1,0,7
-DA:57,7
-DA:59,25
-BRDA:59,2,0,7
-DA:61,7
-DA:63,25
-BRDA:63,3,0,25
+DA:38,22
+FN:38,RuleWhitelistWrapper.constructor
+FNDA:22,RuleWhitelistWrapper.constructor
+DA:42,20
+DA:53,21
+FN:53,RuleWhitelistWrapper.detectTransferRestriction.0
+FNDA:21,RuleWhitelistWrapper.detectTransferRestriction.0
+DA:60,25
+DA:61,25
+DA:62,25
DA:64,25
-DA:67,11
-BRDA:67,4,0,4
-BRDA:67,4,1,5
-DA:68,4
-DA:69,7
-BRDA:69,5,0,2
-BRDA:69,5,1,5
-DA:70,2
-DA:72,5
-FN:80,RuleWhitelistWrapper.hasRole
-FNDA:13,RuleWhitelistWrapper.hasRole
-DA:85,52
-BRDA:85,6,0,39
-DA:86,39
-DA:88,13
-FN:98,RuleWhitelistWrapper._msgSender
-FNDA:52,RuleWhitelistWrapper._msgSender
-DA:104,52
-FN:110,RuleWhitelistWrapper._msgData
+DA:65,25
+BRDA:65,0,0,9
+BRDA:65,0,1,10
+DA:66,9
+DA:67,16
+BRDA:67,1,0,6
+BRDA:67,1,1,10
+DA:68,6
+DA:70,10
+DA:74,4
+FN:74,RuleWhitelistWrapper.detectTransferRestriction.1
+FNDA:4,RuleWhitelistWrapper.detectTransferRestriction.1
+DA:81,4
+DA:84,10
+FN:84,RuleWhitelistWrapper.detectTransferRestrictionFrom.0
+FNDA:10,RuleWhitelistWrapper.detectTransferRestrictionFrom.0
+DA:91,12
+BRDA:91,2,0,-
+DA:92,0
+DA:95,12
+DA:96,12
+DA:97,12
+DA:98,12
+DA:100,12
+DA:102,12
+BRDA:102,3,0,-
+BRDA:102,3,1,6
+DA:103,0
+DA:104,12
+BRDA:104,4,0,-
+BRDA:104,4,1,6
+DA:105,0
+DA:106,12
+BRDA:106,5,0,6
+BRDA:106,5,1,6
+DA:107,6
+DA:109,6
+DA:116,2
+FN:116,RuleWhitelistWrapper.detectTransferRestrictionFrom.1
+FNDA:2,RuleWhitelistWrapper.detectTransferRestrictionFrom.1
+DA:123,2
+DA:131,20
+FN:131,RuleWhitelistWrapper.hasRole
+FNDA:20,RuleWhitelistWrapper.hasRole
+DA:138,80
+DA:145,37
+FN:145,RuleWhitelistWrapper._detectTransferRestriction
+FNDA:37,RuleWhitelistWrapper._detectTransferRestriction
+DA:146,37
+DA:147,37
+DA:148,37
+DA:150,81
+DA:151,81
+DA:152,58
+BRDA:152,6,0,58
+DA:153,58
+DA:158,81
+DA:159,81
+DA:160,159
+BRDA:160,7,0,65
+DA:161,65
+DA:162,65
+DA:165,16
+BRDA:165,8,0,16
+DA:166,16
+DA:169,37
+DA:172,0
+FN:172,RuleWhitelistWrapper.supportsInterface
+FNDA:0,RuleWhitelistWrapper.supportsInterface
+DA:173,0
+DA:183,80
+FN:183,RuleWhitelistWrapper._msgSender
+FNDA:80,RuleWhitelistWrapper._msgSender
+DA:184,80
+DA:190,0
+FN:190,RuleWhitelistWrapper._msgData
FNDA:0,RuleWhitelistWrapper._msgData
-DA:116,0
-FN:122,RuleWhitelistWrapper._contextSuffixLength
-FNDA:52,RuleWhitelistWrapper._contextSuffixLength
-DA:128,52
-FNF:6
-FNH:5
-LF:28
-LH:27
-BRF:9
-BRH:9
+DA:191,0
+DA:197,80
+FN:197,RuleWhitelistWrapper._contextSuffixLength
+FNDA:80,RuleWhitelistWrapper._contextSuffixLength
+DA:198,80
+FNF:11
+FNH:9
+LF:57
+LH:50
+BRF:14
+BRH:11
end_of_record
TN:
-SF:src/rules/validation/abstract/RuleAddressList/RuleAddressList.sol
-FN:27,RuleAddressList.
-FNDA:185,RuleAddressList.
-DA:31,185
-BRDA:31,0,0,1
-DA:32,1
-DA:34,184
-FN:42,RuleAddressList.addAddressesToTheList
-FNDA:17,RuleAddressList.addAddressesToTheList
-DA:45,16
-DA:46,16
-FN:55,RuleAddressList.removeAddressesFromTheList
-FNDA:4,RuleAddressList.removeAddressesFromTheList
-DA:58,3
-DA:59,3
-FN:67,RuleAddressList.addAddressToTheList
-FNDA:52,RuleAddressList.addAddressToTheList
-DA:70,51
-DA:71,50
-FN:80,RuleAddressList.removeAddressFromTheList
-FNDA:3,RuleAddressList.removeAddressFromTheList
-DA:83,2
-DA:84,1
-FN:92,RuleAddressList.numberListedAddress
-FNDA:24,RuleAddressList.numberListedAddress
-DA:93,24
-FN:102,RuleAddressList.addressIsListed
-FNDA:101,RuleAddressList.addressIsListed
-DA:105,159
-FN:112,RuleAddressList.addressIsListedBatch
-FNDA:28,RuleAddressList.addressIsListedBatch
-DA:115,28
-DA:116,28
-DA:117,55
-DA:119,28
-FN:126,RuleAddressList.hasRole
-FNDA:194,RuleAddressList.hasRole
-DA:131,280
-BRDA:131,1,0,78
-DA:132,78
-DA:134,202
-FN:144,RuleAddressList._msgSender
-FNDA:270,RuleAddressList._msgSender
-DA:150,270
-FN:156,RuleAddressList._msgData
-FNDA:0,RuleAddressList._msgData
-DA:162,0
-FN:168,RuleAddressList._contextSuffixLength
-FNDA:270,RuleAddressList._contextSuffixLength
-DA:174,270
-FNF:12
-FNH:11
-LF:23
-LH:22
+SF:src/rules/validation/abstract/RuleAddressSet/RuleAddressSet.sol
+DA:63,17
+FN:63,RuleAddressSet.addAddresses
+FNDA:17,RuleAddressSet.addAddresses
+DA:64,16
+DA:65,16
+DA:75,4
+FN:75,RuleAddressSet.removeAddresses
+FNDA:4,RuleAddressSet.removeAddresses
+DA:76,3
+DA:77,3
+DA:87,52
+FN:87,RuleAddressSet.addAddress
+FNDA:52,RuleAddressSet.addAddress
+DA:88,51
+BRDA:88,0,0,1
+DA:89,1
+DA:91,50
+DA:92,50
+DA:102,3
+FN:102,RuleAddressSet.removeAddress
+FNDA:3,RuleAddressSet.removeAddress
+DA:103,2
+BRDA:103,1,0,1
+DA:104,1
+DA:106,1
+DA:107,1
+DA:114,24
+FN:114,RuleAddressSet.listedAddressCount
+FNDA:24,RuleAddressSet.listedAddressCount
+DA:115,24
+DA:123,0
+FN:123,RuleAddressSet.contains
+FNDA:0,RuleAddressSet.contains
+DA:124,0
+DA:132,60
+FN:132,RuleAddressSet.isAddressListed
+FNDA:60,RuleAddressSet.isAddressListed
+DA:133,219
+DA:141,84
+FN:141,RuleAddressSet.areAddressesListed
+FNDA:84,RuleAddressSet.areAddressesListed
+DA:142,84
+DA:143,84
+DA:144,191
+DA:152,207
+FN:152,RuleAddressSet._msgSender
+FNDA:207,RuleAddressSet._msgSender
+DA:153,207
+DA:157,0
+FN:157,RuleAddressSet._msgData
+FNDA:0,RuleAddressSet._msgData
+DA:158,0
+DA:162,207
+FN:162,RuleAddressSet._contextSuffixLength
+FNDA:207,RuleAddressSet._contextSuffixLength
+DA:163,207
+FNF:11
+FNH:9
+LF:32
+LH:28
BRF:2
BRH:2
end_of_record
TN:
-SF:src/rules/validation/abstract/RuleAddressList/RuleAddressListInternal.sol
-FN:22,RuleAddressListInternal._addAddressesToThelist
-FNDA:16,RuleAddressListInternal._addAddressesToThelist
-DA:25,16
-DA:26,16
-DA:27,34
-BRDA:27,0,0,32
-DA:28,32
-DA:29,32
-DA:32,16
-FN:41,RuleAddressListInternal._removeAddressesFromThelist
-FNDA:3,RuleAddressListInternal._removeAddressesFromThelist
-DA:44,3
-DA:45,3
-DA:46,6
-BRDA:46,1,0,6
-DA:47,6
-DA:48,6
-DA:51,3
-FN:59,RuleAddressListInternal._addAddressToThelist
-FNDA:51,RuleAddressListInternal._addAddressToThelist
-DA:60,1
-BRDA:60,2,0,1
-DA:61,1
-DA:63,50
-DA:64,50
-FN:73,RuleAddressListInternal._removeAddressFromThelist
-FNDA:2,RuleAddressListInternal._removeAddressFromThelist
-DA:74,2
-BRDA:74,3,0,1
-DA:75,1
-DA:77,1
-DA:78,1
-FN:86,RuleAddressListInternal._numberListedAddress
-FNDA:24,RuleAddressListInternal._numberListedAddress
-DA:87,24
-FN:96,RuleAddressListInternal._addressIsListed
-FNDA:214,RuleAddressListInternal._addressIsListed
-DA:99,214
+SF:src/rules/validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol
+DA:36,16
+FN:36,RuleAddressSetInternal._addAddresses
+FNDA:16,RuleAddressSetInternal._addAddresses
+DA:37,16
+DA:38,34
+DA:49,3
+FN:49,RuleAddressSetInternal._removeAddresses
+FNDA:3,RuleAddressSetInternal._removeAddresses
+DA:50,3
+DA:51,7
+DA:59,50
+FN:59,RuleAddressSetInternal._addAddress
+FNDA:50,RuleAddressSetInternal._addAddress
+DA:60,50
+DA:67,1
+FN:67,RuleAddressSetInternal._removeAddress
+FNDA:1,RuleAddressSetInternal._removeAddress
+DA:68,1
+DA:75,24
+FN:75,RuleAddressSetInternal._listedAddressCount
+FNDA:24,RuleAddressSetInternal._listedAddressCount
+DA:76,24
+DA:84,463
+FN:84,RuleAddressSetInternal._isAddressListed
+FNDA:463,RuleAddressSetInternal._isAddressListed
+DA:85,463
FNF:6
FNH:6
-LF:22
-LH:22
-BRF:4
-BRH:4
-end_of_record
-TN:
-SF:src/rules/validation/abstract/RuleValidateTransfer.sol
-FN:15,RuleValidateTransfer.validateTransfer
-FNDA:40,RuleValidateTransfer.validateTransfer
-DA:21,40
-DA:22,40
-FNF:1
-FNH:1
-LF:2
-LH:2
-BRF:0
-BRH:0
-end_of_record
-TN:
-SF:src/rules/validation/abstract/RuleWhitelistCommon.sol
-FN:17,RuleWhitelistCommon.canReturnTransferRestrictionCode
-FNDA:12,RuleWhitelistCommon.canReturnTransferRestrictionCode
-DA:20,12
-DA:21,12
-DA:22,6
-FN:30,RuleWhitelistCommon.messageForTransferRestriction
-FNDA:10,RuleWhitelistCommon.messageForTransferRestriction
-DA:33,10
-BRDA:33,0,0,6
-BRDA:33,0,1,1
-DA:34,6
-DA:35,4
-BRDA:35,1,0,3
-BRDA:35,1,1,1
-DA:36,3
-DA:38,1
-FNF:2
-FNH:2
-LF:8
-LH:8
-BRF:4
-BRH:4
-end_of_record
-TN:
-SF:test/HelperContract.sol
-FN:95,HelperContract.
-FNDA:0,HelperContract.
-FNF:1
-FNH:0
-LF:0
-LH:0
+LF:14
+LH:14
BRF:0
BRH:0
end_of_record
TN:
-SF:test/RuleConditionalTransfer/utils/RuleCTDeployment.sol
-FN:13,RuleCTDeployment.
-FNDA:13,RuleCTDeployment.
-DA:14,13
-DA:19,13
-DA:24,13
-DA:28,13
-DA:33,13
-DA:39,13
-DA:44,13
-DA:45,13
-DA:51,13
-DA:52,13
-FNF:1
-FNH:1
+SF:src/rules/validation/abstract/RuleValidateTransfer.sol
+DA:26,14
+FN:26,RuleValidateTransfer.canTransfer.0
+FNDA:14,RuleValidateTransfer.canTransfer.0
+DA:33,14
+DA:45,14
+FN:45,RuleValidateTransfer.canTransfer.1
+FNDA:14,RuleValidateTransfer.canTransfer.1
+DA:52,14
+DA:58,10
+FN:58,RuleValidateTransfer.canTransferFrom.0
+FNDA:10,RuleValidateTransfer.canTransferFrom.0
+DA:65,20
+DA:72,10
+FN:72,RuleValidateTransfer.canTransferFrom.1
+FNDA:10,RuleValidateTransfer.canTransferFrom.1
+DA:79,10
+DA:82,0
+FN:82,RuleValidateTransfer.supportsInterface
+FNDA:0,RuleValidateTransfer.supportsInterface
+DA:83,0
+FNF:5
+FNH:4
LF:10
-LH:10
-BRF:0
-BRH:0
-end_of_record
-TN:
-SF:test/utils/CMTATDeployment.sol
-FN:15,CMTATDeployment.
-FNDA:86,CMTATDeployment.
-DA:17,86
-DA:23,86
-DA:30,86
-DA:36,86
-FNF:1
-FNH:1
-LF:4
-LH:4
+LH:8
BRF:0
BRH:0
end_of_record
TN:
-SF:test/utils/SanctionListOracle.sol
-FN:9,SanctionListOracle.
-FNDA:11,SanctionListOracle.
-FN:13,SanctionListOracle.addToSanctionsList
-FNDA:10,SanctionListOracle.addToSanctionsList
-DA:14,10
-FN:17,SanctionListOracle.removeFromSanctionsList
-FNDA:0,SanctionListOracle.removeFromSanctionsList
-DA:18,0
-FN:21,SanctionListOracle.isSanctioned
-FNDA:12,SanctionListOracle.isSanctioned
-DA:22,12
-FNF:4
-FNH:3
-LF:3
-LH:2
-BRF:0
-BRH:0
+SF:src/rules/validation/abstract/RuleWhitelistCommon.sol
+DA:38,10
+FN:38,RuleWhitelistCommon.canReturnTransferRestrictionCode
+FNDA:10,RuleWhitelistCommon.canReturnTransferRestrictionCode
+DA:39,10
+DA:40,5
+DA:50,14
+FN:50,RuleWhitelistCommon.messageForTransferRestriction
+FNDA:14,RuleWhitelistCommon.messageForTransferRestriction
+DA:56,14
+BRDA:56,0,0,6
+BRDA:56,0,1,2
+DA:57,6
+DA:58,8
+BRDA:58,1,0,4
+BRDA:58,1,1,2
+DA:59,4
+DA:60,4
+BRDA:60,2,0,2
+BRDA:60,2,1,2
+DA:61,2
+DA:63,2
+DA:79,17
+FN:79,RuleWhitelistCommon.transferred.0
+FNDA:17,RuleWhitelistCommon.transferred.0
+DA:80,22
+DA:81,22
+BRDA:81,3,0,14
+BRDA:81,3,1,8
+DA:97,4
+FN:97,RuleWhitelistCommon.transferred.1
+FNDA:4,RuleWhitelistCommon.transferred.1
+DA:98,8
+DA:99,8
+BRDA:99,4,0,4
+BRDA:99,4,1,4
+DA:106,4
+FN:106,RuleWhitelistCommon.transferred.2
+FNDA:4,RuleWhitelistCommon.transferred.2
+DA:112,4
+DA:115,5
+FN:115,RuleWhitelistCommon.transferred.3
+FNDA:5,RuleWhitelistCommon.transferred.3
+DA:121,5
+FNF:6
+FNH:6
+LF:21
+LH:21
+BRF:10
+BRH:10
end_of_record
diff --git a/doc/security/audits/tools/aderyn-report.md b/doc/security/audits/tools/aderyn-report.md
new file mode 100644
index 0000000..c215e0d
--- /dev/null
+++ b/doc/security/audits/tools/aderyn-report.md
@@ -0,0 +1,454 @@
+# Aderyn Analysis Report
+
+This report was generated by [Aderyn](https://github.com/Cyfrin/aderyn), a static analysis tool built by [Cyfrin](https://cyfrin.io), a blockchain security company. This report is not a substitute for manual audit or security review. It should not be relied upon for any purpose other than to assist in the identification of potential security vulnerabilities.
+# Table of Contents
+
+- [Summary](#summary)
+ - [Files Summary](#files-summary)
+ - [Files Details](#files-details)
+ - [Issue Summary](#issue-summary)
+- [Low Issues](#low-issues)
+ - [L-1: Centralization Risk](#l-1-centralization-risk)
+ - [L-2: Unspecific Solidity Pragma](#l-2-unspecific-solidity-pragma)
+ - [L-3: Address State Variable Set Without Checks](#l-3-address-state-variable-set-without-checks)
+ - [L-4: PUSH0 Opcode](#l-4-push0-opcode)
+ - [L-5: Costly operations inside loop](#l-5-costly-operations-inside-loop)
+ - [L-6: Unchecked Return](#l-6-unchecked-return)
+
+
+# Summary
+
+## Files Summary
+
+| Key | Value |
+| --- | --- |
+| .sol Files | 19 |
+| Total nSLOC | 839 |
+
+
+## Files Details
+
+| Filepath | nSLOC |
+| --- | --- |
+| src/modules/AccessControlModuleStandalone.sol | 18 |
+| src/modules/MetaTxModuleStandalone.sol | 6 |
+| src/rules/interfaces/IAddressList.sol | 15 |
+| src/rules/interfaces/IERC7943NonFungibleCompliance.sol | 22 |
+| src/rules/interfaces/IIdentityRegistry.sol | 7 |
+| src/rules/interfaces/ISanctionsList.sol | 4 |
+| src/rules/validation/RuleBlacklist.sol | 127 |
+| src/rules/validation/RuleSanctionsList.sol | 157 |
+| src/rules/validation/RuleWhitelist.sol | 84 |
+| src/rules/validation/RuleWhitelistWrapper.sol | 141 |
+| src/rules/validation/abstract/RuleAddressSet/RuleAddressSet.sol | 67 |
+| src/rules/validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol | 28 |
+| src/rules/validation/abstract/RuleAddressSet/invariantStorage/RuleAddressSetInvariantStorage.sol | 7 |
+| src/rules/validation/abstract/RuleAddressSet/invariantStorage/RuleBlacklistInvariantStorage.sol | 12 |
+| src/rules/validation/abstract/RuleAddressSet/invariantStorage/RuleWhitelistInvariantStorage.sol | 13 |
+| src/rules/validation/abstract/RuleCommonInvariantStorage.sol | 4 |
+| src/rules/validation/abstract/RuleSanctionsListInvariantStorage.sol | 15 |
+| src/rules/validation/abstract/RuleValidateTransfer.sol | 50 |
+| src/rules/validation/abstract/RuleWhitelistCommon.sol | 62 |
+| **Total** | **839** |
+
+
+## Issue Summary
+
+| Category | No. of Issues |
+| --- | --- |
+| High | 0 |
+| Low | 6 |
+
+
+# Low Issues
+
+## L-1: Centralization Risk
+
+Contracts have owners with privileged rights to perform admin tasks and need to be trusted to not perform malicious updates or drain funds.
+
+8 Found Instances
+
+
+- Found in src/modules/AccessControlModuleStandalone.sol [Line: 8](src/modules/AccessControlModuleStandalone.sol#L8)
+
+ ```solidity
+ abstract contract AccessControlModuleStandalone is AccessControl {
+ ```
+
+- Found in src/rules/validation/RuleSanctionsList.sol [Line: 177](src/rules/validation/RuleSanctionsList.sol#L177)
+
+ ```solidity
+ function setSanctionListOracle(ISanctionsList sanctionContractOracle_) public virtual onlyRole(SANCTIONLIST_ROLE) {
+ ```
+
+- Found in src/rules/validation/RuleWhitelist.sol [Line: 157](src/rules/validation/RuleWhitelist.sol#L157)
+
+ ```solidity
+ onlyRole(DEFAULT_ADMIN_ROLE) // or a dedicated role if you prefer
+ ```
+
+- Found in src/rules/validation/RuleWhitelistWrapper.sol [Line: 155](src/rules/validation/RuleWhitelistWrapper.sol#L155)
+
+ ```solidity
+ onlyRole(DEFAULT_ADMIN_ROLE) // or a dedicated role if you prefer
+ ```
+
+- Found in src/rules/validation/abstract/RuleAddressSet/RuleAddressSet.sol [Line: 63](src/rules/validation/abstract/RuleAddressSet/RuleAddressSet.sol#L63)
+
+ ```solidity
+ function addAddresses(address[] calldata targetAddresses) public onlyRole(ADDRESS_LIST_ADD_ROLE) {
+ ```
+
+- Found in src/rules/validation/abstract/RuleAddressSet/RuleAddressSet.sol [Line: 75](src/rules/validation/abstract/RuleAddressSet/RuleAddressSet.sol#L75)
+
+ ```solidity
+ function removeAddresses(address[] calldata targetAddresses) public onlyRole(ADDRESS_LIST_REMOVE_ROLE) {
+ ```
+
+- Found in src/rules/validation/abstract/RuleAddressSet/RuleAddressSet.sol [Line: 87](src/rules/validation/abstract/RuleAddressSet/RuleAddressSet.sol#L87)
+
+ ```solidity
+ function addAddress(address targetAddress) public onlyRole(ADDRESS_LIST_ADD_ROLE) {
+ ```
+
+- Found in src/rules/validation/abstract/RuleAddressSet/RuleAddressSet.sol [Line: 102](src/rules/validation/abstract/RuleAddressSet/RuleAddressSet.sol#L102)
+
+ ```solidity
+ function removeAddress(address targetAddress) public onlyRole(ADDRESS_LIST_REMOVE_ROLE) {
+ ```
+
+19 Found Instances
+
+
+- Found in src/modules/AccessControlModuleStandalone.sol [Line: 3](src/modules/AccessControlModuleStandalone.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/modules/MetaTxModuleStandalone.sol [Line: 3](src/modules/MetaTxModuleStandalone.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/interfaces/IAddressList.sol [Line: 2](src/rules/interfaces/IAddressList.sol#L2)
+
+ ```solidity
+ pragma solidity ^0.8.0;
+ ```
+
+- Found in src/rules/interfaces/IERC7943NonFungibleCompliance.sol [Line: 3](src/rules/interfaces/IERC7943NonFungibleCompliance.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/interfaces/IIdentityRegistry.sol [Line: 3](src/rules/interfaces/IIdentityRegistry.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/interfaces/ISanctionsList.sol [Line: 3](src/rules/interfaces/ISanctionsList.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/RuleBlacklist.sol [Line: 3](src/rules/validation/RuleBlacklist.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/RuleSanctionsList.sol [Line: 3](src/rules/validation/RuleSanctionsList.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/RuleWhitelist.sol [Line: 2](src/rules/validation/RuleWhitelist.sol#L2)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/RuleWhitelistWrapper.sol [Line: 3](src/rules/validation/RuleWhitelistWrapper.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/abstract/RuleAddressSet/RuleAddressSet.sol [Line: 2](src/rules/validation/abstract/RuleAddressSet/RuleAddressSet.sol#L2)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol [Line: 2](src/rules/validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol#L2)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/abstract/RuleAddressSet/invariantStorage/RuleAddressSetInvariantStorage.sol [Line: 3](src/rules/validation/abstract/RuleAddressSet/invariantStorage/RuleAddressSetInvariantStorage.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/abstract/RuleAddressSet/invariantStorage/RuleBlacklistInvariantStorage.sol [Line: 3](src/rules/validation/abstract/RuleAddressSet/invariantStorage/RuleBlacklistInvariantStorage.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/abstract/RuleAddressSet/invariantStorage/RuleWhitelistInvariantStorage.sol [Line: 3](src/rules/validation/abstract/RuleAddressSet/invariantStorage/RuleWhitelistInvariantStorage.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/abstract/RuleCommonInvariantStorage.sol [Line: 2](src/rules/validation/abstract/RuleCommonInvariantStorage.sol#L2)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/abstract/RuleSanctionsListInvariantStorage.sol [Line: 3](src/rules/validation/abstract/RuleSanctionsListInvariantStorage.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/abstract/RuleValidateTransfer.sol [Line: 3](src/rules/validation/abstract/RuleValidateTransfer.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/abstract/RuleWhitelistCommon.sol [Line: 2](src/rules/validation/abstract/RuleWhitelistCommon.sol#L2)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+1 Found Instances
+
+
+- Found in src/rules/validation/RuleSanctionsList.sol [Line: 236](src/rules/validation/RuleSanctionsList.sol#L236)
+
+ ```solidity
+ sanctionsList = sanctionContractOracle_;
+ ```
+
+19 Found Instances
+
+
+- Found in src/modules/AccessControlModuleStandalone.sol [Line: 3](src/modules/AccessControlModuleStandalone.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/modules/MetaTxModuleStandalone.sol [Line: 3](src/modules/MetaTxModuleStandalone.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/interfaces/IAddressList.sol [Line: 2](src/rules/interfaces/IAddressList.sol#L2)
+
+ ```solidity
+ pragma solidity ^0.8.0;
+ ```
+
+- Found in src/rules/interfaces/IERC7943NonFungibleCompliance.sol [Line: 3](src/rules/interfaces/IERC7943NonFungibleCompliance.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/interfaces/IIdentityRegistry.sol [Line: 3](src/rules/interfaces/IIdentityRegistry.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/interfaces/ISanctionsList.sol [Line: 3](src/rules/interfaces/ISanctionsList.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/RuleBlacklist.sol [Line: 3](src/rules/validation/RuleBlacklist.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/RuleSanctionsList.sol [Line: 3](src/rules/validation/RuleSanctionsList.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/RuleWhitelist.sol [Line: 2](src/rules/validation/RuleWhitelist.sol#L2)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/RuleWhitelistWrapper.sol [Line: 3](src/rules/validation/RuleWhitelistWrapper.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/abstract/RuleAddressSet/RuleAddressSet.sol [Line: 2](src/rules/validation/abstract/RuleAddressSet/RuleAddressSet.sol#L2)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol [Line: 2](src/rules/validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol#L2)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/abstract/RuleAddressSet/invariantStorage/RuleAddressSetInvariantStorage.sol [Line: 3](src/rules/validation/abstract/RuleAddressSet/invariantStorage/RuleAddressSetInvariantStorage.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/abstract/RuleAddressSet/invariantStorage/RuleBlacklistInvariantStorage.sol [Line: 3](src/rules/validation/abstract/RuleAddressSet/invariantStorage/RuleBlacklistInvariantStorage.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/abstract/RuleAddressSet/invariantStorage/RuleWhitelistInvariantStorage.sol [Line: 3](src/rules/validation/abstract/RuleAddressSet/invariantStorage/RuleWhitelistInvariantStorage.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/abstract/RuleCommonInvariantStorage.sol [Line: 2](src/rules/validation/abstract/RuleCommonInvariantStorage.sol#L2)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/abstract/RuleSanctionsListInvariantStorage.sol [Line: 3](src/rules/validation/abstract/RuleSanctionsListInvariantStorage.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/abstract/RuleValidateTransfer.sol [Line: 3](src/rules/validation/abstract/RuleValidateTransfer.sol#L3)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+- Found in src/rules/validation/abstract/RuleWhitelistCommon.sol [Line: 2](src/rules/validation/abstract/RuleWhitelistCommon.sol#L2)
+
+ ```solidity
+ pragma solidity ^0.8.20;
+ ```
+
+2 Found Instances
+
+
+- Found in src/rules/validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol [Line: 37](src/rules/validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol#L37)
+
+ ```solidity
+ for (uint256 i = 0; i < addressesToAdd.length; ++i) {
+ ```
+
+- Found in src/rules/validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol [Line: 50](src/rules/validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol#L50)
+
+ ```solidity
+ for (uint256 i = 0; i < addressesToRemove.length; ++i) {
+ ```
+
+5 Found Instances
+
+
+- Found in src/modules/AccessControlModuleStandalone.sol [Line: 29](src/modules/AccessControlModuleStandalone.sol#L29)
+
+ ```solidity
+ _grantRole(DEFAULT_ADMIN_ROLE, admin);
+ ```
+
+- Found in src/rules/validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol [Line: 38](src/rules/validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol#L38)
+
+ ```solidity
+ _listedAddresses.add(addressesToAdd[i]);
+ ```
+
+- Found in src/rules/validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol [Line: 51](src/rules/validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol#L51)
+
+ ```solidity
+ _listedAddresses.remove(addressesToRemove[i]);
+ ```
+
+- Found in src/rules/validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol [Line: 60](src/rules/validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol#L60)
+
+ ```solidity
+ _listedAddresses.add(targetAddress);
+ ```
+
+- Found in src/rules/validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol [Line: 68](src/rules/validation/abstract/RuleAddressSet/RuleAddressSetInternal.sol#L68)
+
+ ```solidity
+ _listedAddresses.remove(targetAddress);
+ ```
+
+ 
