Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore[docs]: amend revert_on_failure kwarg docs for create builtins #3921

Merged
merged 3 commits into from
Apr 10, 2024
Merged

chore[docs]: amend revert_on_failure kwarg docs for create builtins #3921

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0c096a2
chore[docs]: amend `revert_on_failure` kwarg docs
pcaversaccio Apr 8, 2024
e2a3c40
Merge branch 'master' into docs/revert_on_failure
charles-cooper Apr 10, 2024
6d9c8c7
Merge branch 'master' into docs/revert_on_failure
charles-cooper Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/built-in-functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Vyper has three built-ins for contract creation; all three contract creation bui

* ``target``: Address of the contract to proxy to
* ``value``: The wei value to send to the new contract address (Optional, default 0)
* ``revert_on_failure``: If ``False``, instead of reverting when the create operation fails, return the null address.
* ``revert_on_failure``: If ``False``, instead of reverting when the create operation fails, return the zero address (Optional, default ``True``)
* ``salt``: A ``bytes32`` value utilized by the deterministic ``CREATE2`` opcode (Optional, if not supplied, ``CREATE`` is used)

Returns the address of the newly created proxy contract. If the create operation fails (for instance, in the case of a ``CREATE2`` collision), execution will revert.
Expand Down Expand Up @@ -170,7 +170,7 @@ Vyper has three built-ins for contract creation; all three contract creation bui

* ``target``: Address of the contract to copy
* ``value``: The wei value to send to the new contract address (Optional, default 0)
* ``revert_on_failure``: If ``False``, instead of reverting when the create operation fails, return the null address.
* ``revert_on_failure``: If ``False``, instead of reverting when the create operation fails, return the zero address (Optional, default ``True``)
* ``salt``: A ``bytes32`` value utilized by the deterministic ``CREATE2`` opcode (Optional, if not supplied, ``CREATE`` is used)

Returns the address of the created contract. If the create operation fails (for instance, in the case of a ``CREATE2`` collision), execution will revert. If there is no code at ``target``, execution will revert.
Expand All @@ -195,7 +195,7 @@ Vyper has three built-ins for contract creation; all three contract creation bui
* ``value``: The wei value to send to the new contract address (Optional, default 0)
* ``raw_args``: If ``True``, ``*args`` must be a single ``Bytes[...]`` argument, which will be interpreted as a raw bytes buffer to forward to the create operation (which is useful for instance, if pre- ABI-encoded data is passed in from elsewhere). (Optional, default ``False``)
* ``code_offset``: The offset to start the ``EXTCODECOPY`` from (Optional, default 3)
* ``revert_on_failure``: If ``False``, instead of reverting when the create operation fails, return the null address.
* ``revert_on_failure``: If ``False``, instead of reverting when the create operation fails, return the zero address (Optional, default ``True``)
* ``salt``: A ``bytes32`` value utilized by the deterministic ``CREATE2`` opcode (Optional, if not supplied, ``CREATE`` is used)

Returns the address of the created contract. If the create operation fails (for instance, in the case of a ``CREATE2`` collision), execution will revert. If ``code_offset >= target.codesize`` (ex. if there is no code at ``target``), execution will revert.
Expand Down
Loading