Improve index entries for selectors, events and selfdestruct

This commit is contained in:
Kamil Śliwak 2022-06-14 10:37:03 +02:00
parent 7785f46efd
commit f323cb2ef5
6 changed files with 10 additions and 7 deletions

View File

@ -19,7 +19,7 @@ We assume that all contracts will have the interface definitions of any contract
This specification does not address contracts whose interface is dynamic or otherwise known only at run-time. This specification does not address contracts whose interface is dynamic or otherwise known only at run-time.
.. _abi_function_selector: .. _abi_function_selector:
.. index:: selector .. index:: ! selector; of a function
Function Selector Function Selector
================= =================
@ -503,6 +503,7 @@ efficient search and arbitrary legibility by defining events with two arguments
indexed, one not — intended to hold the same value. indexed, one not — intended to hold the same value.
.. _abi_errors: .. _abi_errors:
.. index:: error, selector; of an error
Errors Errors
====== ======

View File

@ -116,7 +116,7 @@ efficient code, for example:
} }
} }
.. index:: selector; of a function
Access to External Variables, Functions and Libraries Access to External Variables, Functions and Libraries
----------------------------------------------------- -----------------------------------------------------

View File

@ -1,4 +1,4 @@
.. index:: ! error, revert, selector; of an error .. index:: ! error, revert, ! selector; of an error
.. _errors: .. _errors:
******************************* *******************************

View File

@ -1,4 +1,4 @@
.. index:: ! event .. index:: ! event, ! event; anonymous, ! event; indexed, ! event; topic
.. _events: .. _events:
@ -73,6 +73,8 @@ four indexed arguments rather than three.
In particular, it is possible to "fake" the signature of another event In particular, it is possible to "fake" the signature of another event
using an anonymous event. using an anonymous event.
.. index:: ! selector; of an event
Members of Events Members of Events
================= =================
@ -147,7 +149,7 @@ The output of the above looks like the following (trimmed):
} }
Additional Resources for Understanding Events Additional Resources for Understanding Events
============================================== =============================================
- `Javascript documentation <https://github.com/ethereum/web3.js/blob/1.x/docs/web3-eth-contract.rst#events>`_ - `Javascript documentation <https://github.com/ethereum/web3.js/blob/1.x/docs/web3-eth-contract.rst#events>`_
- `Example usage of events <https://github.com/ethchange/smart-exchange/blob/master/lib/contracts/SmartExchange.sol>`_ - `Example usage of events <https://github.com/ethchange/smart-exchange/blob/master/lib/contracts/SmartExchange.sol>`_

View File

@ -215,7 +215,7 @@ In comparison to contracts, libraries are restricted in the following ways:
(These might be lifted at a later point.) (These might be lifted at a later point.)
.. _library-selectors: .. _library-selectors:
.. index:: selector .. index:: ! selector; of a library function
Function Signatures and Selectors in Libraries Function Signatures and Selectors in Libraries
============================================== ==============================================

View File

@ -548,7 +548,7 @@ these **create calls** and normal message calls is that the payload data is
executed and the result stored as code and the caller / creator executed and the result stored as code and the caller / creator
receives the address of the new contract on the stack. receives the address of the new contract on the stack.
.. index:: selfdestruct, self-destruct, deactivate .. index:: ! selfdestruct, deactivate
Deactivate and Self-destruct Deactivate and Self-destruct
============================ ============================