Skip to content

wake.ir.type_names.mapping module #

Mapping class #

Bases: TypeNameAbc

Mapping type name.

Example

A mapping type name can be used:

  • inside a VariableDeclaration:
    • mapping(address => uint) on line 1,
    • mapping(address => mapping(address => uint)) on line 8,
  • inside a UsingForDirective:
    • mapping(address => uint) on line 5,
  • inside an ArrayTypeName:
    • mapping(address => uint) on line 9,
  • inside a Mapping:
    • mapping(address => uint) on line 8.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
function remove(mapping(address => uint) storage balances, address account) {
    delete balances[account];
}

using {remove} for mapping(address => uint);

contract C {
    mapping(address => mapping(address => uint)) public allowances;
    mapping(address => uint)[2] public balances;
}
Source code in wake/ir/type_names/mapping.py 
 20
 21
 22
 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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
class Mapping(TypeNameAbc):
    """
    Mapping type name.

    !!! example
        A mapping type name can be used:

        - inside a [VariableDeclaration][wake.ir.declarations.variable_declaration.VariableDeclaration]:
            - `:::solidity mapping(address => uint)` on line 1,
            - `:::solidity mapping(address => mapping(address => uint))` on line 8,
        - inside a [UsingForDirective][wake.ir.meta.using_for_directive.UsingForDirective]:
            - `:::solidity mapping(address => uint)` on line 5,
        - inside an [ArrayTypeName][wake.ir.type_names.array_type_name.ArrayTypeName]:
            - `:::solidity mapping(address => uint)` on line 9,
        - inside a [Mapping][wake.ir.type_names.mapping.Mapping]:
            - `:::solidity mapping(address => uint)` on line 8.

        ```solidity linenums="1"
        function remove(mapping(address => uint) storage balances, address account) {
            delete balances[account];
        }

        using {remove} for mapping(address => uint);

        contract C {
            mapping(address => mapping(address => uint)) public allowances;
            mapping(address => uint)[2] public balances;
        }
        ```
    """

    _ast_node: SolcMapping
    _parent: Union[VariableDeclaration, UsingForDirective, ArrayTypeName, Mapping]

    _key_type: Union[ElementaryTypeName, UserDefinedTypeName]
    _value_type: TypeNameAbc
    _key_name: Optional[str]
    _key_name_location: Optional[Tuple[int, int]]
    _value_name: Optional[str]
    _value_name_location: Optional[Tuple[int, int]]

    def __init__(self, init: IrInitTuple, mapping: SolcMapping, parent: SolidityAbc):
        super().__init__(init, mapping, parent)
        key_type = TypeNameAbc.from_ast(init, mapping.key_type, self)
        assert isinstance(key_type, (ElementaryTypeName, UserDefinedTypeName))
        self._key_type = key_type
        self._value_type = TypeNameAbc.from_ast(init, mapping.value_type, self)

        self._key_name = mapping.key_name
        if mapping.key_name_location is not None:
            self._key_name_location = (
                mapping.key_name_location.byte_offset,
                mapping.key_name_location.byte_offset
                + mapping.key_name_location.byte_length,
            )
        else:
            self._key_name_location = None

        self._value_name = mapping.value_name
        if mapping.value_name_location is not None:
            self._value_name_location = (
                mapping.value_name_location.byte_offset,
                mapping.value_name_location.byte_offset
                + mapping.value_name_location.byte_length,
            )
        else:
            self._value_name_location = None

    def __iter__(self) -> Iterator[IrAbc]:
        yield self
        yield from self._key_type
        yield from self._value_type

    @property
    def parent(
        self,
    ) -> Union[VariableDeclaration, UsingForDirective, ArrayTypeName, Mapping]:
        """
        Returns:
            Parent IR node.
        """
        return self._parent

    @property
    def type(self) -> types.Mapping:
        """
        Returns:
            Type description.
        """
        t = super().type
        assert isinstance(t, types.Mapping)
        return t

    @property
    def key_type(self) -> Union[ElementaryTypeName, UserDefinedTypeName]:
        """
        Can only be:

        - an [ElementaryTypeName][wake.ir.type_names.elementary_type_name.ElementaryTypeName],
        - a [UserDefinedTypeName][wake.ir.type_names.user_defined_type_name.UserDefinedTypeName] of a [Contract][wake.ir.types.Contract] type,
        - a [UserDefinedTypeName][wake.ir.type_names.user_defined_type_name.UserDefinedTypeName] of an [Enum][wake.ir.types.Enum] type,
        - a [UserDefinedTypeName][wake.ir.type_names.user_defined_type_name.UserDefinedTypeName] of a [UserDefinedValueType][wake.ir.types.UserDefinedValueType] type.

        Returns:
            Mapping key type name.
        """
        return self._key_type

    @property
    def value_type(self) -> TypeNameAbc:
        """
        Returns:
            Mapping value type name.
        """
        return self._value_type

    @property
    def key_name(self) -> Optional[str]:
        """
        !!! note
            Mapping key names were introduced in Solidity 0.8.18.

        !!! example
            Returns `account` in the following code:

            ```solidity
            mapping(address account => uint balance) public balances;
            ```

        Returns:
            Mapping key name, if present.
        """
        return self._key_name

    @property
    def key_name_location(self) -> Optional[Tuple[int, int]]:
        """
        !!! note
            Mapping key names were introduced in Solidity 0.8.18.

        Returns:
            Tuple of the start and end byte offsets of the [key_name][wake.ir.type_names.mapping.Mapping.key_name] in the source code, if present.
        """
        return self._key_name_location

    @property
    def value_name(self) -> Optional[str]:
        """
        !!! note
            Mapping value names were introduced in Solidity 0.8.18.

        !!! example
            Returns `balance` in the following code:

            ```solidity
            mapping(address account => uint balance) public balances;
            ```

        Returns:
            Mapping value name, if present.
        """
        return self._value_name

    @property
    def value_name_location(self) -> Optional[Tuple[int, int]]:
        """
        !!! note
            Mapping value names were introduced in Solidity 0.8.18.

        Returns:
            Tuple of the start and end byte offsets of the [value_name][wake.ir.type_names.mapping.Mapping.value_name] in the source code, if present.
        """
        return self._value_name_location

key_name: Optional[str] property #

Note

Mapping key names were introduced in Solidity 0.8.18.

Example

Returns account in the following code:

mapping(address account => uint balance) public balances;

Returns:

Type Description
Optional[str]

Mapping key name, if present.

key_name_location: Optional[Tuple[int, int]] property #

Note

Mapping key names were introduced in Solidity 0.8.18.

Returns:

Type Description
Optional[Tuple[int, int]]

Tuple of the start and end byte offsets of the key_name in the source code, if present.

key_type: Union[ElementaryTypeName, UserDefinedTypeName] property #

Can only be:

Returns:

Type Description
Union[ElementaryTypeName, UserDefinedTypeName]

Mapping key type name.

parent: Union[VariableDeclaration, UsingForDirective, ArrayTypeName, Mapping] property #

Returns:

Type Description
Union[VariableDeclaration, UsingForDirective, ArrayTypeName, Mapping]

Parent IR node.

type: types.Mapping property #

Returns:

Type Description
Mapping

Type description.

value_name: Optional[str] property #

Note

Mapping value names were introduced in Solidity 0.8.18.

Example

Returns balance in the following code:

mapping(address account => uint balance) public balances;

Returns:

Type Description
Optional[str]

Mapping value name, if present.

value_name_location: Optional[Tuple[int, int]] property #

Note

Mapping value names were introduced in Solidity 0.8.18.

Returns:

Type Description
Optional[Tuple[int, int]]

Tuple of the start and end byte offsets of the value_name in the source code, if present.

value_type: TypeNameAbc property #

Returns:

Type Description
TypeNameAbc

Mapping value type name.