wake.ir.expressions.function_call_options module

FunctionCallOptions class

Bases: ExpressionAbc

Sets gas, value and salt function call options.

Serves as a replacement for old-style syntax, e.g. this.foo.gas(1000).value(1)().

Example

this.foo{gas: 1000, value: 1} in the following example:

function foo() public {
    this.foo{gas: 1000, value: 1}();
}

Source code in wake/ir/expressions/function_call_options.py

class FunctionCallOptions(ExpressionAbc):
    """
    Sets `gas`, `value` and `salt` function call options.

    Serves as a replacement for old-style syntax, e.g. `:::solidity this.foo.gas(1000).value(1)()`.

    !!! example
        `:::solidity this.foo{gas: 1000, value: 1}` in the following example:
        ```solidity
        function foo() public {
            this.foo{gas: 1000, value: 1}();
        }
        ```
    """

    _ast_node: SolcFunctionCallOptions
    _parent: weakref.ReferenceType[SolidityAbc]  # TODO: make this more specific

    _expression: ExpressionAbc
    _names: List[str]
    _options: List[ExpressionAbc]

    def __init__(
        self,
        init: IrInitTuple,
        function_call_options: SolcFunctionCallOptions,
        parent: SolidityAbc,
    ):
        super().__init__(init, function_call_options, parent)
        self._expression = ExpressionAbc.from_ast(
            init, function_call_options.expression, self
        )
        self._names = list(function_call_options.names)
        self._options = [
            ExpressionAbc.from_ast(init, option, self)
            for option in function_call_options.options
        ]

    def __iter__(self) -> Iterator[IrAbc]:
        yield self
        yield from self._expression
        for option in self._options:
            yield from option

    @property
    def parent(self) -> SolidityAbc:
        return super().parent

    @property
    def children(self) -> Iterator[ExpressionAbc]:
        """
        Yields:
            Direct children of this node.
        """
        yield self._expression
        yield from self._options

    @property
    def expression(self) -> ExpressionAbc:
        """
        !!! example
            `:::solidity address(this).call` and `:::solidity new MyToken` in the following example:

            ```solidity
            function f() public {
                address(this).call{value: 1}("");
                new MyToken{salt: 0x1234}();
            }
            ```

        Returns:
            Sub-expression the function call options are applied to.
        """
        return self._expression

    @property
    def names(self) -> Tuple[str, ...]:
        """
        Returns:
            Names of the function call options in the order they appear in the source code.
        """
        return tuple(self._names)

    @property
    def options(self) -> Tuple[ExpressionAbc, ...]:
        """
        Returns:
            Values of the function call options in the order they appear in the source code.
        """
        return tuple(self._options)

    @property
    def is_ref_to_state_variable(self) -> bool:
        return False

children: Iterator[ExpressionAbc] property

Yields:

Type	Description
ExpressionAbc	Direct children of this node.

expression: ExpressionAbc property

Example

address(this).call and new MyToken in the following example:

function f() public {
    address(this).call{value: 1}("");
    new MyToken{salt: 0x1234}();
}

Returns:

Type	Description
ExpressionAbc	Sub-expression the function call options are applied to.

names: Tuple[str, ...] property

Returns:

Type	Description
Tuple[str, ...]	Names of the function call options in the order they appear in the source code.

options: Tuple[ExpressionAbc, ...] property

Returns:

Type	Description
Tuple[ExpressionAbc, ...]	Values of the function call options in the order they appear in the source code.