Skip to content

Commit

Permalink
docs: add missing cli flags (#3736)
Browse files Browse the repository at this point in the history
* Add missing compiler flags to docs
* Add note on `opcodes` and `opcodes_runtime` wrong output
* docs: add missing cli flag `metadata`
  • Loading branch information
pcaversaccio authored Feb 13, 2024
1 parent d372378 commit 8e5e1c2
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/compiling-a-contract.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,10 @@ Include the ``-f`` flag to specify which output formats to return. Use ``vyper -

.. code:: shell
$ vyper -f abi,bytecode,bytecode_runtime,ir,asm,source_map,method_identifiers yourFileName.vy
$ vyper -f abi,abi_python,bytecode,bytecode_runtime,interface,external_interface,ast,ir,ir_json,ir_runtime,hex-ir,asm,opcodes,opcodes_runtime,source_map,method_identifiers,userdoc,devdoc,metadata,combined_json,layout yourFileName.vy
.. note::
The ``opcodes`` and ``opcodes_runtime`` output of the compiler has been returning incorrect opcodes since ``0.2.0`` due to a lack of 0 padding (patched via `PR 3735 <https://github.com/vyperlang/vyper/pull/3735>`_). If you rely on these functions for debugging, please use the latest patched versions.

The ``-p`` flag allows you to set a root path that is used when searching for interface files to import. If none is given, it will default to the current working directory. See :ref:`searching_for_imports` for more information.

Expand Down
1 change: 1 addition & 0 deletions vyper/cli/vyper_compile.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
method_identifiers - Dictionary of method signature to method identifier
userdoc - Natspec user documentation
devdoc - Natspec developer documentation
metadata - Contract metadata (intended for use by tooling developers)
combined_json - All of the above format options combined as single JSON output
layout - Storage layout of a Vyper contract
ast - AST (not yet annotated) in JSON format
Expand Down

0 comments on commit 8e5e1c2

Please sign in to comment.