cerc-io/solidity
16
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix nested lists in the ABI documentation

Browse Source
This commit is contained in:
Alex Beregszaszi 2017-09-13 17:39:48 +01:00
parent 5c9dbd5083
commit e1f90f0ad6
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/abi-spec.rst
View File

@ -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. 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": **Definition:** The following types are called "dynamic":
* ``bytes`` * ``bytes``
* ``string`` * ``string``
* ``T[]`` for any ``T`` * ``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>`); - ``type``: ``"function"``, ``"constructor"``, or ``"fallback"`` (the :ref:`unnamed "default" function <fallback-function>`);
- ``name``: the name of the function; - ``name``: the name of the function;
- ``inputs``: an array of objects, each of which contains: - ``inputs``: an array of objects, each of which contains:
* ``name``: the name of the parameter; * ``name``: the name of the parameter;
* ``type``: the canonical type 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; - ``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``; - ``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). - ``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"`` - ``type``: always ``"event"``
- ``name``: the name of the event; - ``name``: the name of the event;
- ``inputs``: an array of objects, each of which contains: - ``inputs``: an array of objects, each of which contains:
* ``name``: the name of the parameter; * ``name``: the name of the parameter;
* ``type``: the canonical type 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. * ``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``. - ``anonymous``: ``true`` if the event was declared as ``anonymous``.
For example, For example,