aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAlex Beregszaszi <alex@rtfs.hu>2017-09-14 00:39:48 +0800
committerAlex Beregszaszi <alex@rtfs.hu>2017-09-14 00:39:48 +0800
commite1f90f0ad639baf2c14b6c1bbfb479cc469d2f33 (patch)
tree0c03ca348760fd207c9e7fbe60ee4a393a80d7a0 /docs
parent5c9dbd50839ac153f367ce69abb10dd22877842e (diff)
downloaddexon-solidity-e1f90f0ad639baf2c14b6c1bbfb479cc469d2f33.tar
dexon-solidity-e1f90f0ad639baf2c14b6c1bbfb479cc469d2f33.tar.gz
dexon-solidity-e1f90f0ad639baf2c14b6c1bbfb479cc469d2f33.tar.bz2
dexon-solidity-e1f90f0ad639baf2c14b6c1bbfb479cc469d2f33.tar.lz
dexon-solidity-e1f90f0ad639baf2c14b6c1bbfb479cc469d2f33.tar.xz
dexon-solidity-e1f90f0ad639baf2c14b6c1bbfb479cc469d2f33.tar.zst
dexon-solidity-e1f90f0ad639baf2c14b6c1bbfb479cc469d2f33.zip
Fix nested lists in the ABI documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/abi-spec.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/abi-spec.rst b/docs/abi-spec.rst
index 3ce7f50c..f75a6885 100644
--- a/docs/abi-spec.rst
+++ b/docs/abi-spec.rst
@@ -91,6 +91,7 @@ Properties:
We distinguish static and dynamic types. Static types are encoded in-place and dynamic types are encoded at a separately allocated location after the current block.
**Definition:** The following types are called "dynamic":
+
* ``bytes``
* ``string``
* ``T[]`` for any ``T``
@@ -293,8 +294,10 @@ The JSON format for a contract's interface is given by an array of function and/
- ``type``: ``"function"``, ``"constructor"``, or ``"fallback"`` (the :ref:`unnamed "default" function <fallback-function>`);
- ``name``: the name of the function;
- ``inputs``: an array of objects, each of which contains:
+
* ``name``: the name of the parameter;
* ``type``: the canonical type of the parameter.
+
- ``outputs``: an array of objects similar to ``inputs``, can be omitted if function doesn't return anything;
- ``payable``: ``true`` if function accepts ether, defaults to ``false``;
- ``stateMutability``: a string with one of the following values: ``pure`` (:ref:`specified to not read blockchain state <pure-functions>`), ``view`` (:ref:`specified to not modify the blockchain state <view-functions>`), ``nonpayable`` and ``payable`` (same as ``payable`` above).
@@ -311,9 +314,11 @@ An event description is a JSON object with fairly similar fields:
- ``type``: always ``"event"``
- ``name``: the name of the event;
- ``inputs``: an array of objects, each of which contains:
+
* ``name``: the name of the parameter;
* ``type``: the canonical type of the parameter.
* ``indexed``: ``true`` if the field is part of the log's topics, ``false`` if it one of the log's data segment.
+
- ``anonymous``: ``true`` if the event was declared as ``anonymous``.
For example,