Skip to content

Commit

Permalink
✏️ Add contract verification to docs (#23)
Browse files Browse the repository at this point in the history
  • Loading branch information
p-sad authored Jan 14, 2021
1 parent 22cdc1c commit 4a24c6d
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,12 @@ or if you prefer you can use npm:
.. code-block::
npm install --save-dev ethereum-mars
In order to generate an artifacts file that Mars will use when deploying, run:

.. code-block::
npx mars
It is advisable to add the above command at the end your build script so it
gets executed every time you build a new version of your contracts.
19 changes: 19 additions & 0 deletions docs/source/verifying-contracts.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Verifying smart contracts
=========================

Currently, you can automate contract verification on Etherscan
if you are using Waffle to build your contracts.

In order to verify your contracts, use your deployment script
with the following command line parameters:

.. code-block:: bash
yarn ts-node deployment.ts --verify --etherscan-key <ETHERSCAN_API_KEY>
In order for this to work, the :code:`compilerOptions` in your
:code:`waffle.json` config file must be stated explicitly, as
Waffle's default compiler options are different from Etherscan's.

The :code:`compilerVersion` setting also needs to be set to
one of the `compiler versions supported by Etherscan <https://etherscan.io/solcversions>`_.

0 comments on commit 4a24c6d

Please sign in to comment.