Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update bytecode object in docs #126

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+50 −12
Open

Update bytecode object in docs #126

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c2cf99
Update bytecode object in docs
njgheorghita Aug 24, 2018
7d17b9c
Add line about pre-linked libraries
njgheorghita Aug 24, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 50 additions & 12 deletions docs/source/package-spec.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,10 +405,10 @@ within the dependency tree the value is constructed as follows.

----

The *Bytecode* Object
~~~~~~~~~~~~~~~~~~~~~
The *UnlinkedBytecode* Object
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

A bytecode object has the following key/value pairs.
An unlinked bytecode object, representing a |ContractType|, has the following key/value pairs.

Bytecode: ``bytecode``
^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -420,18 +420,28 @@ hexadecimal representation of the bytecode.
:Type: String
:Format: ``0x`` prefixed hexadecimal.


Link References: ``link_references``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The ``link_references`` field defines the locations in the corresponding
bytecode which require |linking|.
bytecode which require |linking|. If bytecode contains no link references, this field **must** be an empty array.

:Required: No
:Required: Yes
:Type: Array
:Format: All values **must** be valid :ref:`Link Reference objects <link-reference-object>`.
See also below.

Link Dependencies: ``link_dependencies``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The ``link_dependencies`` defines the |LinkValues| that have been used to link
the corresponding bytecode. For example, if a contract type references a deployed library.

:Required: No
:Type: Array
:Format: All values **must** be valid :ref:`Link Value objects <link-value-object>`.
See also below.

**Format**

This field is considered invalid if *any* of the |LinkReferences| are
Expand All @@ -440,17 +450,45 @@ any of the link references intersect.

Intersection is defined as two link references which overlap.

----

The *LinkedBytecode* Object
~~~~~~~~~~~~~~~~~~~~~~~~~~~

A linked bytecode object, representing a deployed |ContractInstance|, has the following key/value pairs.

Link Dependencies: ``link_dependencies``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The ``link_dependencies`` defines the |LinkValues| that have been used
to link the corresponding bytecode.

:Required: No
:Required: Yes
:Type: Array
:Format: All values **must** be valid :ref:`Link Value objects <link-value-object>`.
See also below.

Bytecode: ``bytecode``
^^^^^^^^^^^^^^^^^^^^^^

The ``bytecode`` field is a string containing the ``0x`` prefixed
hexadecimal representation of the bytecode.

:Required: Only if a |LinkValue| differs from its corresponding |ContractType|.
:Type: String
:Format: ``0x`` prefixed hexadecimal.

Link References: ``link_references``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The ``link_references`` field defines the locations in the corresponding
bytecode which require |linking|.

:Required: Only if a |LinkValue| differs from its corresponding |ContractType|.
:Type: Array
:Format: All values **must** be valid :ref:`Link Reference objects <link-reference-object>`.
See also below.

**Format**

Validation of this field includes the following:
Expand All @@ -459,8 +497,8 @@ Validation of this field includes the following:
``offsets``.

- Each :ref:`link value object <link-value-object>` **must** have a
corresponding :ref:`link reference object <link-reference-object>` under
the ``link_references`` field.
corresponding :ref:`link reference object <link-reference-object>` in its
corresponding |ContractType| or in the ``link_references`` field.

- The length of the resolved ``value`` **must** be equal to the
``length`` of the corresponding |LinkReference|.
Expand Down Expand Up @@ -561,7 +599,7 @@ The ``deployment_bytecode`` field defines the bytecode for this |ContractType|.

:Required: No
:Type: Object
:Format: **must** conform to `the Bytecode Object`_ format.
:Format: **must** conform to `the UnlinkedBytecode Object`_ format.


Runtime Bytecode: ``runtime_bytecode``
Expand All @@ -572,7 +610,7 @@ runtime portion of |Bytecode| for this |ContractType|.

:Required: No
:Type: Object
:Format: **must** conform to `the Bytecode Object`_ format.
:Format: **must** conform to `the UnlinkedBytecode Object`_ format.

ABI: ``abi``
^^^^^^^^^^^^
Expand Down Expand Up @@ -685,7 +723,7 @@ the ``runtime_bytecode`` from the |ContractType| for this |ContractInstance|.

:Required: No
:Type: Object
:Format: **must** conform to `the Bytecode Object`_ format.
:Format: **must** conform to `the LinkedBytecode Object`_ format.

Every entry in the ``link_references`` for this bytecode **must** have a
corresponding entry in the ``link_dependencies`` section.
Expand Down