Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rya-sge committed May 3, 2024
1 parent 1f8af20 commit 4cc326e
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ Generally, these modules are not required to be compliant with the CMTA specific

### RuleEngine

The `RuleEngine` is an external contract used to apply transfer restriction to the CMTAT through whitelisting, blacklisting,..
The `RuleEngine` is an external contract used to apply transfer restriction to the CMTAT through whitelisting, blacklisting,...

This contract is defined in the `ValidationModule`.

Expand All @@ -162,11 +162,9 @@ A possible rule is a whitelist rule where only the address inside the whitelist

Since the version 2.4.0, the requirement to use a RuleEngine are the following:

While it has been designed for the CMTAT, the ruleEngine can be used with others contracts to apply restriction on transfer.
The `RuleEngine` has to import an implement the interface `IRuleEngine` which declares the function `operateOnTransfer`.

The `RuleEngine` has to import an implement the interface `IRuleEngine` which declares the function `operateOnTransfer`

This interface can be found in [./contracts/interfaces/engine/IRuleEngine.sol](./contracts/interfaces/engine/IRuleEngine.sol)`CMTAT/contracts/interfaces/engine/IRuleEngine.sol`.
This interface can be found in [./contracts/interfaces/engine/IRuleEngine.sol](./contracts/interfaces/engine/IRuleEngine.sol).

Before each transfer, the CMTAT calls the function `operateOnTransfer` which is the entrypoint for the RuleEngine.

Expand Down

0 comments on commit 4cc326e

Please sign in to comment.