Feat publish source #914

matnad · 2020-12-28T23:30:27Z

What I did

Added a method to publish source to etherscan for solidity contracts.
DeployedContract.publish_source()

Related issue: #411

How I did it

Flatten source code into one file (thanks Ben for starting on this). Make sure to include all comments, proper licensing and exactly one pragma statement.
Will wait for contract to be recognized by etherscan after deploying, then submit request for verification and finally wait for the verification to be processed and report the result.

How to verify it

deployed = MyContract.deploy({'from': account}, publish_source=True)
and also
MyContract.get_verification_info()

-> https://ropsten.etherscan.io/address/0x6De9c6197bB8f61177C30946d90CAC2720272c5c#code

Tests are adapted for the changes to the solc versioning, but no new tests for this feature are written yet.

Checklist

I have confirmed that my PR passes all linting checks
I have included test cases
I have updated the documentation
I have added an entry to the changelog

matnad · 2020-12-28T23:54:40Z

@Macarse @banteg feel free to test the branch and provide feedback!

Edit: Contracts need to be re-compiled to add additional information about the compiler version. Delete the build and/or deployment artifacts if you try it on existing contracts.

iamdefinitelyahuman

🚀

brownie/network/contract.py

matnad · 2020-12-30T16:23:00Z

Update:

Applied requested changes
Handle pragma experimental ABIEncoderV2
Auto-fetch correct constructor arguments
Temporary fix for interfaces being saved into build/contracts/ (will discuss with @iamdefinitelyahuman for a better solution)

TODO:

Ensure correct order of files in the flattened file (base before derived is a hard requirement)
Isolate global structs and enums
Fix interface/contract issue
Callable while deploying via kwarg

Macarse · 2021-01-05T20:17:53Z

@iamdefinitelyahuman I have tested the last version: 763a5c8
and I could verify a couple of contracts I couldn't verify in the past. I believe this is a good first version for contract verification 🚀

Great work @matnad h/t

todo: add commit hash to compiler version

- improve formatting - handle bad request when checking for status

- filename without source location - linting

- Strip comments from source code between offsets - Find a set of all global structs and enums, insert them at the start of the flattened file - Sort files by topological order in respect to the dependencies

- to prevent failing tests when compound changes their implementation - also wrote a test for fetching proxy form etherscan, but it is too slow (commented out)

matnad · 2021-01-06T15:46:08Z

This turned out to be a monster of a feature! A lot of edge cases have been handled and I currently can't find a repo that doesn't verify (including all brownie mixes). Happy to merge after a review.

For repos that don't work please open an issue and I will look at it.

brownie/network/contract.py

docs/api-network.rst

tests/project/compiler/test_solidity.py

iamdefinitelyahuman

Coming along nicely..

docs/api-network.rst

brownie/network/contract.py

tests/project/compiler/test_solidity.py

including doc update

- added ast to interfaces

matnad · 2021-01-08T02:00:03Z

Big update.

Complete refactor of get_verification_info() to use py-solc-ast. No more regex (except one that is safe). This is much cleaner now!
Moved the methods to ContractContainer and adjusted docs.
Added a simple test to check if verification info breaks.
Tested functionality with various repos (brownie mixes, private repos, testing repos).

iamdefinitelyahuman

Amazing stuff.. this clearly has been a huge amount of work. The community loves you ❤️

brownie/network/contract.py

- more efficient writing - slight change to regex

misterblonde · 2022-01-16T22:27:53Z

I still have the issue, even when I'm using publish_source=True and your new get_verification_info() afterwards. I only have one solidity script with one compiler version, so that shouldn't be the issue. Has this been continued elsewhere/

turkishfilms · 2022-01-18T06:47:32Z

im getting a jsondecodererror when i use publish_source=True. I was able to manually verify(copy and paste) but wasnt able to automatically verify. only one .sol file

iamdefinitelyahuman previously approved these changes Dec 29, 2020

View reviewed changes

brownie/network/contract.py Outdated Show resolved Hide resolved

brownie/network/contract.py Outdated Show resolved Hide resolved

brownie/network/contract.py Outdated Show resolved Hide resolved

fubuloubu mentioned this pull request Dec 29, 2020

Allow publishing source on Etherscan #411

Closed

matnad dismissed iamdefinitelyahuman’s stale review via bed86bf December 30, 2020 16:19

iamdefinitelyahuman mentioned this pull request Dec 30, 2020

Understand dependencies from contracts-as-types without assignment iamdefinitelyahuman/py-solc-ast#17

Merged

Macarse previously approved these changes Jan 5, 2021

View reviewed changes

matnad dismissed Macarse’s stale review via f467797 January 6, 2021 12:35

iamdefinitelyahuman and others added 21 commits January 6, 2021 14:49

feat: flatten contracts

3729297

feat: add filename and license to flatten

e6754aa

feat: flatten returns more info for verification

c5b62c5

todo: add commit hash to compiler version

feat: publish source first version

e966d44

fix: linting, remove waiting_for_result option

de425fe

feat: solc version + commit, source top comments

dc6cb4a

test: fix tests for solc version

832ee23

fix: bump py-solc-x version

fc2316a

fix: linting

24e3f7d

fix: linting

7350313

fix: fix tests

3413b23

fix: fix tests

ad660c0

fix: requested changes

c80ab00

feat: handle experimental abiencoder

ba16c1e

- improve formatting - handle bad request when checking for status

feat: fetch constructor arguments

7b483a1

feat: dirty (temp) fix for interface build location

0ddd075

- filename without source location - linting

feat: add dependencies for interfaces

de13d6e

feat: add toposort

8de0703

feat: isolate global struct/enum, sort deps

2426115

- Strip comments from source code between offsets - Find a set of all global structs and enums, insert them at the start of the flattened file - Sort files by topological order in respect to the dependencies

fix: linting

5fe7d85

fix: test for interface build artifacts

b3250da

matnad added 2 commits January 6, 2021 16:36

test: replaced proxy test with custom kovan contracts

2cb51e3

- to prevent failing tests when compound changes their implementation - also wrote a test for fetching proxy form etherscan, but it is too slow (commented out)

docs: changelog

638431e

Macarse previously approved these changes Jan 6, 2021

View reviewed changes

brownie/network/contract.py Outdated Show resolved Hide resolved

docs/api-network.rst Show resolved Hide resolved

tests/project/compiler/test_solidity.py Outdated Show resolved Hide resolved

iamdefinitelyahuman reviewed Jan 7, 2021

View reviewed changes

matnad added 4 commits January 7, 2021 18:26

feat: move publish and verification to ContractContainer

84f0e03

including doc update

feat: huge solc-ast refactor

4e71318

- added ast to interfaces

test: Added a simple test for verification info

fd38f8d

fix: solcx.get_solc_version edited for clarity

277c6b9

matnad dismissed Macarse’s stale review via 277c6b9 January 8, 2021 01:52

fix: linting...

f514b5a

matnad added 2 commits January 8, 2021 03:13

tests: fix keyword argument test

e35d6dc

tests: fix verification pragma issue

079b60e

matnad requested a review from iamdefinitelyahuman January 8, 2021 11:15

iamdefinitelyahuman previously approved these changes Jan 8, 2021

View reviewed changes

brownie/network/contract.py Outdated Show resolved Hide resolved

fix: requested changes

51b3fbe

- more efficient writing - slight change to regex

matnad dismissed iamdefinitelyahuman’s stale review via 51b3fbe January 8, 2021 16:26

iamdefinitelyahuman approved these changes Jan 8, 2021

View reviewed changes

matnad merged commit 5b42f37 into eth-brownie:master Jan 8, 2021

cameel mentioned this pull request Aug 8, 2021

contractDependencies in the AST no longer includes inherited contracts on 0.8.4+ ethereum/solidity#11643

Closed

Schlagonia mentioned this pull request Apr 4, 2023

Contract Flattener [APE-794] ApeWorX/ape-solidity#92

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat publish source #914

Feat publish source #914

matnad commented Dec 28, 2020 •

edited

Loading

matnad commented Dec 28, 2020 •

edited

Loading

iamdefinitelyahuman left a comment

matnad commented Dec 30, 2020 •

edited

Loading

Macarse commented Jan 5, 2021

matnad commented Jan 6, 2021

iamdefinitelyahuman left a comment

matnad commented Jan 8, 2021 •

edited

Loading

iamdefinitelyahuman left a comment

misterblonde commented Jan 16, 2022

turkishfilms commented Jan 18, 2022

Feat publish source #914

Feat publish source #914

Conversation

matnad commented Dec 28, 2020 • edited Loading

What I did

How I did it

How to verify it

Checklist

matnad commented Dec 28, 2020 • edited Loading

iamdefinitelyahuman left a comment

Choose a reason for hiding this comment

matnad commented Dec 30, 2020 • edited Loading

Macarse commented Jan 5, 2021

matnad commented Jan 6, 2021

iamdefinitelyahuman left a comment

Choose a reason for hiding this comment

matnad commented Jan 8, 2021 • edited Loading

iamdefinitelyahuman left a comment

Choose a reason for hiding this comment

misterblonde commented Jan 16, 2022

turkishfilms commented Jan 18, 2022

matnad commented Dec 28, 2020 •

edited

Loading

matnad commented Dec 28, 2020 •

edited

Loading

matnad commented Dec 30, 2020 •

edited

Loading

matnad commented Jan 8, 2021 •

edited

Loading