aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorchriseth <chris@ethereum.org>2018-06-05 01:29:51 +0800
committerAlex Beregszaszi <alex@rtfs.hu>2018-06-20 01:53:02 +0800
commit3eebba10875f7cc736b4b15f4a8c1cebbeb61d96 (patch)
tree0de8caf0139a2213ec8176d2f69acdbd18f76dde /docs
parent4189b6b03dfcbcccacb17e4eeed4eaf6cd653002 (diff)
downloaddexon-solidity-3eebba10875f7cc736b4b15f4a8c1cebbeb61d96.tar
dexon-solidity-3eebba10875f7cc736b4b15f4a8c1cebbeb61d96.tar.gz
dexon-solidity-3eebba10875f7cc736b4b15f4a8c1cebbeb61d96.tar.bz2
dexon-solidity-3eebba10875f7cc736b4b15f4a8c1cebbeb61d96.tar.lz
dexon-solidity-3eebba10875f7cc736b4b15f4a8c1cebbeb61d96.tar.xz
dexon-solidity-3eebba10875f7cc736b4b15f4a8c1cebbeb61d96.tar.zst
dexon-solidity-3eebba10875f7cc736b4b15f4a8c1cebbeb61d96.zip
Clarify documentation about events (mostly topics).
Diffstat (limited to 'docs')
-rw-r--r--docs/contracts.rst20
1 files changed, 8 insertions, 12 deletions
diff --git a/docs/contracts.rst b/docs/contracts.rst
index 3c78d167..4dd185aa 100644
--- a/docs/contracts.rst
+++ b/docs/contracts.rst
@@ -723,22 +723,18 @@ the contract can only see the last 256 block hashes.
Up to three parameters can
receive the attribute ``indexed`` which will cause the respective arguments
-to be searched for: It is possible to filter for specific values of
-indexed arguments in the user interface.
-
-If arrays (including ``string`` and ``bytes``) are used as indexed arguments, the
-Keccak-256 hash of it is stored as topic instead.
-
-The hash of the signature of the event is one of the topics except if you
+to be stored in a special data structure as so-called "topics", which allows them to be searched for,
+for example when filtering a sequence of blocks for certain events. Events can always
+be filtered by the address of the contract that emitted the event. Also,
+the hash of the signature of the event is one of the topics except if you
declared the event with ``anonymous`` specifier. This means that it is
not possible to filter for specific anonymous events by name.
-All non-indexed arguments will be stored in the data part of the log.
+If arrays (including ``string`` and ``bytes``) are used as indexed arguments, the
+Keccak-256 hash of it is stored as topic instead. This is because a topic
+can only hold a single word (32 bytes).
-.. note::
- Indexed arguments will not be stored themselves. You can only
- search for the values, but it is impossible to retrieve the
- values themselves.
+All non-indexed arguments will be :ref:`ABI-encoded <ABI>` into the data part of the log.
::