diff --git a/README.md b/README.md index 1b31c2d..edb76d2 100644 --- a/README.md +++ b/README.md @@ -208,6 +208,16 @@ There are two categories of rules: validation rules (Read-only) and operation ru ## Rules details +### Summary tab + +| Rule | Type
[ready-only / read-write] | Security Audit planned in the roadmap | Description | +| ------------------------------------------------------------ | ------------------------------------ | ------------------------------------- | ------------------------------------------------------------ | +| RuleWhitelist | Ready-only | ☑ | This rule can be used to restrict transfers from/to only addresses inside a whitelist. | +| RuleWhitelistWrapper | Ready-only | ☑ | This rule can be used to restrict transfers from/to only addresses inside a group of whitelist rules managed by different operators. | +| RuleBlacklist | Ready-only | ☑ | This rule can be used to forbid transfer from/to addresses in the blacklist | +| RuleSanctionList | Ready-only | ☑ | The purpose of this contract is to use the oracle contract from [Chainalysis](https://go.chainalysis.com/chainalysis-oracle-docs.html) to forbid transfer from/to an address included in a sanctions designation (US, EU, or UN). | +| RuleConditionalTransfer
(Separate [GitHub repository](https://github.com/CMTA/RuleConditionalTransfer)) | Ready-Write | ☒
(experimental rule) | This rule requires that transfers have to be approved before being executed by the token. Implement several options such as a time limit for approving a request as well as for carrying out the transfer. | + ### Read-only (validation) rule Currently, there are four validation rules: whitelist, whitelistWrapper, blacklist, and sanctionlist. @@ -1217,4 +1227,4 @@ Setting the oracle to the zero address is permitted and effectively disables all ## 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). +The code is copyright (c) Capital Market and Technology Association, 2022-2026, and is released under [Mozilla Public License 2.0](https://github.com/CMTA/CMTAT/blob/master/LICENSE.md).