Skip to main content

Validator

Git Source

================== ✅ Validator

State Variables​

MUST​

Type constant MUST = Type.MUST;

SHOULD​

Type constant SHOULD = Type.SHOULD;

COMPLETION​

Type constant COMPLETION = Type.COMPLETION;

Functions​

validate​

function validate(Type T, bool condition, string memory messageHead, string memory messageBody)
    internal
    view
    returns (bool res);

noBroadcast​

modifier noBroadcast();

SHOULD_FileExists​

================ 📝 Config

function SHOULD_FileExists(string memory path) internal returns (bool condition);

MUST_FileExists​

function MUST_FileExists(string memory path) internal;

MUST_NotEmptyName​

=================== 🧱 Primitives

function MUST_NotEmptyName(string memory name) internal view;

MUST_NotEmptyEnvKey​

function MUST_NotEmptyEnvKey(string memory envKey) internal view;

SHOULD_NotEmptySelector​

function SHOULD_NotEmptySelector(bytes4 selector) internal view;

MUST_AddressIsContract​

function MUST_AddressIsContract(address addr) internal view;

SHOULD_FacadeIsContract​

function SHOULD_FacadeIsContract(address facade) internal view;

SHOULD_OwnerIsNotZeroAddress​

function SHOULD_OwnerIsNotZeroAddress(address owner) internal view;

MUST_NameFound​

====================== 📸 Current Context

function MUST_NameFound(Current storage current) internal view;

ValidateBuilder​

================== 🧩 Function

function ValidateBuilder(Function storage func) internal view returns (bool);

MUST_Completed​

function MUST_Completed(Function memory func) internal view;

MUST_NotLocked​

function MUST_NotLocked(Function storage func) internal view;

MUST_Building​

function MUST_Building(Function storage func) internal view;

MUST_Built​

function MUST_Built(Function storage func) internal view;

MUST_Registered​

function MUST_Registered(FunctionRegistry storage registry, string memory name) internal view;

ValidateBuilder​

=============== 🗂️ Bundle

function ValidateBuilder(Bundle storage bundle) internal view returns (bool);

MUST_NotInitialized​

function MUST_NotInitialized(Bundle storage bundle) internal view;

SHOULD_Completed​

function SHOULD_Completed(Bundle storage bundle) internal view;

MUST_Completed​

function MUST_Completed(Bundle storage bundle) internal view;

MUST_HaveFunction​

function MUST_HaveFunction(Bundle storage bundle) internal view;

MUST_HaveUniqueSelector​

function MUST_HaveUniqueSelector(Bundle storage bundle, Function storage func) internal view;

MUST_NotLocked​

function MUST_NotLocked(Bundle storage bundle) internal view;

MUST_Building​

function MUST_Building(Bundle storage bundle) internal view;

MUST_Built​

function MUST_Built(Bundle storage bundle) internal view;

SHOULD_ExistCurrentBundle​

function SHOULD_ExistCurrentBundle(BundleRegistry storage registry) internal view returns (bool condition);

MUST_ExistCurrentName​

function MUST_ExistCurrentName(BundleRegistry storage registry) internal view;

ValidateBuilder​

============== 🏠 Proxy

function ValidateBuilder(Proxy_2 memory proxy) internal view returns (bool);

MUST_Completed​

function MUST_Completed(Proxy_2 memory proxy) internal view;

MUST_NotLocked​

function MUST_NotLocked(Proxy_2 memory proxy) internal view;

MUST_Building​

function MUST_Building(Proxy_2 memory proxy) internal view;

MUST_Built​

function MUST_Built(Proxy_2 memory proxy) internal view;

MUST_Registered​

function MUST_Registered(ProxyRegistry storage registry, string memory name) internal view;

MUST_NotRegistered​

function MUST_NotRegistered(ProxyRegistry storage registry, string memory name) internal view;

MUST_ExistCurrentName​

function MUST_ExistCurrentName(ProxyRegistry storage registry) internal view;

ValidateBuilder​

==================== 📚 Dictionary

function ValidateBuilder(Dictionary_1 memory dictionary) internal view returns (bool);

MUST_Completed​

function MUST_Completed(Dictionary_1 memory dictionary) internal view;

MUST_Verifiable​

function MUST_Verifiable(Dictionary_1 memory dictionary) internal noBroadcast;

MUST_NotLocked​

function MUST_NotLocked(Dictionary_1 memory dictionary) internal view;

MUST_Building​

function MUST_Building(Dictionary_1 memory dictionary) internal view;

MUST_Built​

function MUST_Built(Dictionary_1 memory dictionary) internal view;

MUST_Registered​

function MUST_Registered(DictionaryRegistry storage registry, string memory name) internal view;

MUST_NotRegistered​

function MUST_NotRegistered(DictionaryRegistry storage registry, string memory name) internal view;

MUST_ExistCurrentName​

function MUST_ExistCurrentName(DictionaryRegistry storage registry) internal view;

ValidateBuilder​

========================== 🏛 Standard Registry

function ValidateBuilder(StdRegistry storage registry) internal view returns (bool);

MUST_Completed​

function MUST_Completed(StdRegistry storage registry) internal view;

MUST_NotLocked​

function MUST_NotLocked(StdRegistry storage registry) internal view;

MUST_Building​

function MUST_Building(StdRegistry storage registry) internal view;

MUST_Built​

function MUST_Built(StdRegistry memory registry) internal view;

ValidateBuilder​

========================== 🏰 Standard Functions

function ValidateBuilder(StdFunctions storage std) internal view returns (bool);

MUST_Completed​

function MUST_Completed(StdFunctions storage std) internal view;

MUST_NotLocked​

function MUST_NotLocked(StdFunctions storage std) internal view;

MUST_Building​

function MUST_Building(StdFunctions storage std) internal view;

MUST_Built​

function MUST_Built(StdFunctions memory std) internal view;

MUST_FoundInRange​

======================= 🏷️ Name Generator

function MUST_FoundInRange() internal view;

MUST_UseFunctionContract​

================ 🧪 MCTest

function MUST_UseFunctionContract(address implementation) internal view;

Enums​

Type​

enum Type {
    MUST,
    SHOULD,
    COMPLETION
}