Skip to content

wake.ir.meta.override_specifier module #

OverrideSpecifier class #

Bases: SolidityAbc

Example

An override specifier can be used:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
interface IERC20 {
    function transfer(address to, uint256 value) external returns (bool);

    function allowance(address owner, address spender) external view returns (uint256);
}

abstract contract ERC20 is IERC20 {
    modifier EOA() virtual;
}

contract C is ERC20 {
    modifier EOA() override {
        require(msg.sender == tx.origin);
        _;
    }

    mapping(address => mapping(address => uint256)) public override(IERC20) allowance;

    function transfer(address to, uint256 value) external override returns (bool) {
        // ...
    }
}
Source code in wake/ir/meta/override_specifier.py 
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
class OverrideSpecifier(SolidityAbc):
    """
    !!! example
        An override specifier can be used:

        - in a [FunctionDefinition][wake.ir.declarations.function_definition.FunctionDefinition]:
            - `:::solidity override` on line 19,
        - in a [ModifierDefinition][wake.ir.declarations.modifier_definition.ModifierDefinition]:
            - `:::solidity override` on line 12,
        - in a [VariableDeclaration][wake.ir.declarations.variable_declaration.VariableDeclaration]:
            - `:::solidity override(IERC20)` on line 17.

        ```solidity linenums="1"
        interface IERC20 {
            function transfer(address to, uint256 value) external returns (bool);

            function allowance(address owner, address spender) external view returns (uint256);
        }

        abstract contract ERC20 is IERC20 {
            modifier EOA() virtual;
        }

        contract C is ERC20 {
            modifier EOA() override {
                require(msg.sender == tx.origin);
                _;
            }

            mapping(address => mapping(address => uint256)) public override(IERC20) allowance;

            function transfer(address to, uint256 value) external override returns (bool) {
                // ...
            }
        }
        ```
    """

    _ast_node: SolcOverrideSpecifier
    _parent: weakref.ReferenceType[
        Union[FunctionDefinition, ModifierDefinition, VariableDeclaration]
    ]

    _overrides: List[Union[IdentifierPath, UserDefinedTypeName]]

    def __init__(
        self,
        init: IrInitTuple,
        override_specifier: SolcOverrideSpecifier,
        parent: SolidityAbc,
    ):
        super().__init__(init, override_specifier, parent)
        self._overrides = []

        for override in override_specifier.overrides:
            if isinstance(override, SolcIdentifierPath):
                self._overrides.append(IdentifierPath(init, override, self))
            elif isinstance(override, SolcUserDefinedTypeName):
                self._overrides.append(UserDefinedTypeName(init, override, self))

    def __iter__(self) -> Iterator[IrAbc]:
        yield self
        for override in self._overrides:
            yield from override

    @property
    def parent(
        self,
    ) -> Union[FunctionDefinition, ModifierDefinition, VariableDeclaration]:
        """
        Returns:
            Parent IR node.
        """
        return super().parent

    @property
    def children(self) -> Iterator[Union[IdentifierPath, UserDefinedTypeName]]:
        """
        Yields:
            Direct children of this node.
        """
        yield from self._overrides

    @property
    def overrides(self) -> Tuple[Union[IdentifierPath, UserDefinedTypeName], ...]:
        """
        !!! note
            Is empty when there are no round brackets after the `:::solidity override` keyword.

        Returns:
            Tuple of IR nodes referencing the contract or interface whose declaration is being overridden.
        """
        return tuple(self._overrides)

children: Iterator[Union[IdentifierPath, UserDefinedTypeName]] property #

Yields:

Type Description
Union[IdentifierPath, UserDefinedTypeName]

Direct children of this node.

overrides: Tuple[Union[IdentifierPath, UserDefinedTypeName], ...] property #

Note

Is empty when there are no round brackets after the override keyword.

Returns:

Type Description
Tuple[Union[IdentifierPath, UserDefinedTypeName], ...]

Tuple of IR nodes referencing the contract or interface whose declaration is being overridden.

parent: Union[FunctionDefinition, ModifierDefinition, VariableDeclaration] property #

Returns:

Type Description
Union[FunctionDefinition, ModifierDefinition, VariableDeclaration]

Parent IR node.