Flattening and etherscan upload

[montyly]

Slither should be able to flatten any codebase and upload it to the etherscan verified contracts database, through their API

One caveat is to support aliasing of import

[montyly]

Task Description

The goal is to create a new utility (ex: slither-upload-etherscan) that will:

• Takes as input a project and an address
• Flatten the codebase
• Upload the flatten code to etherscan verified contracts list

The utility guideline shows how to create new utility.

Acceptance criteria

• Projects can be flattened and uploaded to etherscan
• The utility removes unnecessary import and pragma statements when flattening the code

A nice to have feature is the handling of import aliasing.

Required Skill

• Experience with Python 3.6
• Experience with Solidity smart contracts

No experience with Slither is required, but it would be a plus

Feel free to ask questions here, or join our slack (#ethereum)

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

This issue now has a funding of 150.0 DAI (150.0 USD @ $1.0/DAI) attached to it.

• If you would like to work on this issue you can 'start work' on the Gitcoin Issue Details page.
• Want to chip in? Add your own contribution here.
• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $136,374.09 more funded OSS Work available on the Gitcoin Issue Explorer

[Skyge]

I am not sure, but for some have been verified contracts, they upload repeated pragma statements, such like this one: cDAI
so we want to remove these, Whether these have influence or not?

[montyly]

Hi @Skyge,

Thank you for your interest in this work.

It's a good question. After some thinking, maybe we can offer an option like --clean-code that will for now, remove the unnecessary pragma statements. In the long run, this option could do other modifications, like re-ordering the contracts to improve the readability, etc.

Does that make sense?

[Skyge]

OK, I see. That sounds good.

[spm32]

Hi @Skyge do you still have some time to take this one on, how's it going?

[Skyge]

@ceresstation Yeah, sorry for my delaying, I will finish this in three weeks.

[gitcoinbot]

@Skyge Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

• reminder (3 days)
• escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

[Skyge]

Hi, I want to find a file to save etherscan api key by this approach:

import os
os.environ['ETHERSCAN_API] = xxx

so which one has existed is suitable, if not, I will create a new file, or we would like to use some packages, such as python-dotenv or something else to do this in the .env.

[montyly]

Hi @Skyge ,

That's a potential solution, but I would favor another approach:

• Asking the key in an interactive mode, from the command line.
• Having an option to provide the key through a config file. Most of the options in Slither are configurable through json, so it would make sense to keep this format.

I would favor the use of the interactive mode, to prevent the write of the key locally. Only people uploading frequently to etherscan should have to save the key.

[Skyge]

@montyly Emmm, but when we verify the contract by the etherscan api, we need some config message, such as, compilerversion , optimizationUsed, constructorArguements and so on, so if we use the interactive mode, the user really needs to type these necessary parameters, so I think maybe we can use a config file to add these config parameters. so what's your final recommendation?

[gitcoinbot]

@Skyge Hello from Gitcoin Core - are you still working on this issue? Please submit a WIP PR or comment back within the next 3 days or you will be removed from this ticket and it will be returned to an ‘Open’ status. Please let us know if you have questions!

• reminder (3 days)
• escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

[Skyge]

I made a temporary pr, it has not been finished totally.

[gitcoinbot]

Issue Status: 1. Open 2. Started 3. Submitted 4. Done

---

@Skyge due to inactivity, we have escalated this issue to Gitcoin's moderation team. Let us know if you believe this has been done in error!

• reminder (3 days)
• escalation to mods (6 days)

Funders only: Snooze warnings for 1 day | 3 days | 5 days | 10 days | 100 days

[marcusrbrown]

Since this appears to be completd, would you mind closing out the bounty on Gitcoin?

[gitcoinbot]

Issue Status: 1. Open 2. Cancelled

---

The funding of 150.0 DAI (150.0 USD @ $1.0/DAI) attached to this issue has been cancelled by the bounty submitter

• Questions? Checkout Gitcoin Help or the Gitcoin Slack
• $128,402.96 more funded OSS Work available on the Gitcoin Issue Explorer