Skip to content

Latest commit

 

History

History
173 lines (104 loc) · 6.17 KB

enforcement.md

File metadata and controls

173 lines (104 loc) · 6.17 KB
Raw

Enforcement Module

This document defines Enforcement Module for the CMTA Token specification.

[TOC]

Rationale

The issuer (or a third party appointed by it) must be in a position to freeze tokens on specific distributed ledger addresses (as opposed to pausing the whole smart contract) to prevent the transfer of tokens that have been earmarked for transfer to a third party (e.g. between the execution of a transaction on a trading platform and the settlement of the trade in the distributed ledger).

Schema

Inheritance

EnforcementModule

surya_inheritance_EnforcementModule.sol

EnforcementModuleInternal

surya_inheritance_EnforcementModuleInternal.sol

UML

EnforcementModule

Graph

EnforcementModule

surya_graph_EnforcementModule.sol

EnforcementModuleInternal

surya_graph_EnforcementModuleInternal.sol

Sūrya's Description Report

Legend

Symbol Meaning
🛑 Function can modify state
💵 Function is payable

EnforcementModule

Files Description Table

File Name SHA-1 Hash
./modules/wrapper/core/EnforcementModule.sol 8d23b8c60e119a6421150f1bab0cb2061a1e640a

Contracts Description Table

Contract Type Bases
└ Function Name Visibility Mutability Modifiers
EnforcementModule Implementation EnforcementModuleInternal, AuthorizationModule
└ __EnforcementModule_init_unchained Internal 🔒 🛑 onlyInitializing
└ freeze Public ❗️ 🛑 onlyRole
└ unfreeze Public ❗️ 🛑 onlyRole

EnforcementModuleInternal

Files Description Table

File Name SHA-1 Hash
./modules/internal/EnforcementModuleInternal.sol 4b56bc3e6903e1a3fd67afcfdd4a6dd936827c0c

Contracts Description Table

Contract Type Bases
└ Function Name Visibility Mutability Modifiers
EnforcementModuleInternal Implementation Initializable, ContextUpgradeable
└ __Enforcement_init Internal 🔒 🛑 onlyInitializing
└ __Enforcement_init_unchained Internal 🔒 🛑 onlyInitializing
└ frozen Public ❗️ NO❗️
└ _freeze Internal 🔒 🛑
└ _unfreeze Internal 🔒 🛑

API for Ethereum

This section describes the Ethereum API of the Enforcement Module.

Functions

freeze(address,string)

Definition:
function freeze(address account,string memory reason) 
public onlyRole(ENFORCER_ROLE) 
returns (bool)

Description:

Prevents account to perform any transfer. Only authorized users are allowed to call this function. Returns true if the address is not yet frozen, false otherwise.

unfreeze(address,string)

Definition:
function unfreeze(address account,string memory reason) 
public onlyRole(ENFORCER_ROLE) 
returns (bool)

Description:

Re-authorizes account to perform transfers if it was frozen. Only authorized users are allowed to call this function. Returns true if the address was frozen, false otherwise.

frozen(address)

Origin: EnforcementModuleInternal

Definition:
function frozen(address account) 
public view virtual 
returns (bool)
Description:

Tell, whether the given account is frozen.

Events

Freeze(address,address)

Definition:
event Freeze (address indexed enforcer, address indexed owner)
Description:

Emitted when address owner is frozen by enforcer.

Unfreeze(address,address)

Definition:
event Unfreeze (address indexed enforcer, address indexed owner)
Description:

Emitted when address owner is unfrozen by enforcer.