From 7db4166f77ccac90c30d4877aefc7368371caff1 Mon Sep 17 00:00:00 2001 From: nisdas Date: Sun, 7 Jan 2018 16:28:35 +0800 Subject: Fixed typos in abi-spec documentation --- docs/abi-spec.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/abi-spec.rst b/docs/abi-spec.rst index b0b16e28..152094af 100644 --- a/docs/abi-spec.rst +++ b/docs/abi-spec.rst @@ -115,7 +115,7 @@ that ``len(enc(X))`` depends on the value of ``X`` if and only if the type of `` **Definition:** For any ABI value ``X``, we recursively define ``enc(X)``, depending on the type of ``X`` being -- ``(T1,...,Tk)`` for ``k >= 0`` and any types ``T1``, ..., ``Tk`` +- ``(T1,...,Tk)`` for ``k >= 1`` and any types ``T1``, ..., ``Tk`` ``enc(X) = head(X(1)) ... head(X(k)) tail(X(1)) ... tail(X(k))`` @@ -126,7 +126,7 @@ on the type of ``X`` being and as - ``head(X(i)) = enc(len( head(X(1)) ... head(X(k)) tail(X(1)) ... tail(X(i-1)) ))`` + ``head(X(i)) = enc(len(head(X(1)) ... head(X(k)) tail(X(1)) ... tail(X(i-1)) ))`` ``tail(X(i)) = enc(X(i))`` otherwise, i.e. if ``Ti`` is a dynamic type. @@ -144,7 +144,7 @@ on the type of ``X`` being - ``T[]`` where ``X`` has ``k`` elements (``k`` is assumed to be of type ``uint256``): - ``enc(X) = enc(k) enc([X[1], ..., X[k]])`` + ``enc(X) = enc(k) enc([X[0], ..., X[k-1]])`` i.e. it is encoded as if it were an array of static size ``k``, prefixed with the number of elements. -- cgit v1.2.3 From 29572bdc482f8bac72e1acf0a67ce4f99d5f77f8 Mon Sep 17 00:00:00 2001 From: chriseth Date: Sun, 7 Jan 2018 13:55:40 +0100 Subject: Clarify components of X --- docs/abi-spec.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/abi-spec.rst b/docs/abi-spec.rst index 152094af..8591a07f 100644 --- a/docs/abi-spec.rst +++ b/docs/abi-spec.rst @@ -62,7 +62,7 @@ The following elementary types exist: The following (fixed-size) array type exists: -- ``[M]``: a fixed-length array of ``M`` elements, ``M > 0``, of the given type. +- ``[M]``: a fixed-length array of ``M`` elements, ``M >= 0``, of the given type. The following non-fixed-size types exist: @@ -101,8 +101,8 @@ We distinguish static and dynamic types. Static types are encoded in-place and d * ``bytes`` * ``string`` * ``T[]`` for any ``T`` -* ``T[k]`` for any dynamic ``T`` and any ``k > 0`` -* ``(T1,...,Tk)`` if any ``Ti`` is dynamic for ``1 <= i <= k`` +* ``T[k]`` for any dynamic ``T`` and any ``k >= 0`` +* ``(T1,...,Tk)`` if ``Ti`` is dynamic for some ``1 <= i <= k`` All other types are called "static". @@ -115,11 +115,11 @@ that ``len(enc(X))`` depends on the value of ``X`` if and only if the type of `` **Definition:** For any ABI value ``X``, we recursively define ``enc(X)``, depending on the type of ``X`` being -- ``(T1,...,Tk)`` for ``k >= 1`` and any types ``T1``, ..., ``Tk`` +- ``(T1,...,Tk)`` for ``k >= 0`` and any types ``T1``, ..., ``Tk`` ``enc(X) = head(X(1)) ... head(X(k)) tail(X(1)) ... tail(X(k))`` - where ``X(i)`` is the ``ith`` component of the value, and + where ``X = (X(1), ..., X(k))`` and ``head`` and ``tail`` are defined for ``Ti`` being a static type as ``head(X(i)) = enc(X(i))`` and ``tail(X(i)) = ""`` (the empty string) @@ -137,7 +137,7 @@ on the type of ``X`` being - ``T[k]`` for any ``T`` and ``k``: - ``enc(X) = enc((X[1], ..., X[k]))`` + ``enc(X) = enc((X[0], ..., X[k-1]))`` i.e. it is encoded as if it were a tuple with ``k`` elements of the same type. -- cgit v1.2.3