Integrate with Truffle #18

dguido · 2018-09-14T22:46:29Z

Truffle is the most popular development framework for smart contracts, and building this feature would enable the largest possible audience to have instant access to Slither.

At Trail of Bits, we are not experts in the internals of Truffle, and we try to avoid writing anything in JavaScript whenever possible. Our expertise here is limited and we're looking for help to implement this feature the "right" way. A successful implementation should use the lowest number of installation and configuration steps. It should just work.

dguido · 2018-10-22T17:54:17Z

It should be more straightforward to support Truffle once we have the solc compact AST support merged in. truffle compile creates one AST json file per contract, which we can merge into a single json that Slither can analyze.

It's likely that we could do this as a package that does the json merging, and then hook into truffle via a truffle slither-analyze or similar command.

Or, we could be totally wrong and there is a simpler way to build this feature.

mkosowsk · 2018-10-23T20:12:04Z

@montyly you and @dguido have disagreements on what is an appropriate bounty size for this issue :)

I'll let you two hash it out on what makes sense for the best approach and then come back in later when scoping is figured out 👍

montyly · 2018-10-25T10:06:28Z

We have merged in support for the compact AST in #54.

Slither's dev branch supports now Truffle if you run the following:

truffle compile
slither .

I agree with Dan, we should integrate with truffle directly, like truffle slither-analyze, where the command runs the two commands above and prints the result to the user.

It seems feasible through the truffle package system: https://github.com/trufflesuite/truffle/blob/next/CONTRIBUTING.md#add-a-new-command-in-truffle

I am pushing this issue to high priority. We're going to stop working on other issues to focus on this one.

gitcoinbot · 2018-10-25T14:06:36Z

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

This issue now has a funding of 200.0 DAI (200.0 USD @ $1.0/DAI) attached to it as part of the Ethereum Community Fund via ECF Web 3.0 Infrastructure Fund fund.

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
$57,925.87 more funded OSS Work available on the Gitcoin Issue Explorer

gitcoinbot · 2018-10-25T14:57:35Z

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

Work has been started.

These users each claimed they can complete the work by 7 months, 2 weeks from now.
Please review their action plans below:

1) anukul has been approved to start work.

I'm quite comfortable with python and javascript, and I've started looking into how Truffle works and can be extended further with new commands so as to accommodate Slither.
I realize that this is high priority, so I'll work fast to keep pace with the requirement.

Learn more on the Gitcoin Issue Details page.

gitcoinbot · 2018-10-28T16:16:16Z

@anukul 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!

warning (3 days)
escalation to mods (6 days)

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

gitcoinbot · 2018-10-29T16:17:42Z

@anukul 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!

warning (3 days)
escalation to mods (6 days)

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

ghost · 2018-10-31T06:07:25Z

[In progress]

Does slither automatically have to be installed alongwith truffle?
I don't think that would be feasible since truffle is an npm package, and we have no reason to assume that those users would have python / pip installed.

Is it okay if truffle slither-analyze errors out with an appropriate message (and perhaps a suggestion to install slither) if it can't find the slither binary in the PATH?

montyly · 2018-10-31T09:06:52Z

If slither is not found, printing a message with the slither installation commands works for me.

gitcoinbot · 2018-11-03T16:16:17Z

@anukul 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!

warning (3 days)
escalation to mods (6 days)

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

gitcoinbot · 2018-11-04T17:16:08Z

@anukul 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!

warning (3 days)
escalation to mods (6 days)

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

gitcoinbot · 2018-11-06T17:22:31Z

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

@anukul 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!

warning (3 days)
escalation to mods (6 days)

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

gitcoinbot · 2018-11-07T17:31:26Z

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

@anukul 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!

warning (3 days)
escalation to mods (6 days)

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

rmshea · 2018-11-08T04:15:23Z

Hey @anukul, Ryan from Gitcoin checking in here. How's the progress coming on this bounty? Is there anything I can do to help move it along? Thanks 😸 🎉

anukul · 2018-11-12T21:35:48Z

@ryan-shea @montyly Given the response on the PR, do we keep this on hold?

montyly · 2018-11-14T16:05:52Z

Yes, unfortunately, we won't have a truffle slither-analyze.

We will see how the truffle run <command-plugin> works, maybe we can still have a npm package to integrate slither within truffle, though I may not sure that it will provide any advantage over just running slither .

I will integrate the execution of truffle compile with slither, and we will see what makes more sense for the users

anukul · 2018-11-17T15:35:02Z

Cool, is there anything else I can do to complete the bounty?

spm32 · 2018-11-28T08:16:21Z

Hey @montyly any thoughts on @anukul's comment?

montyly · 2018-11-28T08:28:37Z

@ceresstation yes you can validate the bounty, thanks!

@anukul: thank you for your contribution.
Truffle just release the version 0.5.0 which includes truffle run <cmd> (https://github.com/trufflesuite/truffle/releases#truffle-run), it looks like we can adapt your code to work with it!

mkosowsk · 2018-12-04T21:01:24Z

@anukul please submit work on the Gitcoin issues detail page and we will pay out ASAP. Thanks and my apologies about the delay! :)

anukul · 2018-12-04T21:14:13Z

@mkosowsk I can't seem to log in to Gitcoin.
I had reported the issue and it is being tracked on their repo - gitcoinco/web#2743

Can you proceed with the payment from your end?
Or I'll have to find some time this weekend and try to fix that bug myself. :P

gitcoinbot · 2018-12-04T21:27:42Z

⚡️ A tip worth 200.00000 DAI (200.0 USD @ $1.0/DAI) has been granted to @anukul for this issue from @. ⚡️

Nice work @anukul! Your tip has automatically been deposited in the ETH address we have on file.

$38977.06 in Funded OSS Work Available at: https://gitcoin.co/explorer
Incentivize contributions to your repo: Send a Tip or Fund a PR
No Email? Get help on the Gitcoin Slack

mkosowsk · 2018-12-04T21:28:12Z

@anukul should be paid out, thanks!

gitcoinbot · 2018-12-04T21:28:14Z

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

This Bounty has been completed.

Additional Tips for this Bounty:

tipped 200.0000 DAI worth 200.0 USD to anukul.

Learn more on the Gitcoin Issue Details page
Questions? Checkout Gitcoin Help or the Gitcoin Slack
$38,977.06 more funded OSS Work available on the Gitcoin Issue Explorer

BlinkyStitt · 2019-01-07T22:12:19Z

I think this should be closed.

dguido · 2019-01-07T22:13:22Z

Yes, I think this is sufficiently addressed for now.

montyly mentioned this issue Oct 10, 2018

Support compact solc AST #22

Closed

dguido added translation ux labels Oct 19, 2018

dguido changed the title ~~Support the Truffle AST~~ Integrate with Truffle Oct 19, 2018

dguido added the help wanted Extra attention is needed label Oct 19, 2018

montyly mentioned this issue Oct 22, 2018

[WIP] Support of compact AST #54

Merged

montyly added the High Priority label Oct 25, 2018

anukul mentioned this issue Nov 8, 2018

Add slither integration trufflesuite/truffle#1415

Closed

montyly removed the High Priority label Dec 13, 2018

dguido closed this as completed Jan 7, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Integrate with Truffle #18

Integrate with Truffle #18

dguido commented Sep 14, 2018 •

edited

Loading

dguido commented Oct 22, 2018

mkosowsk commented Oct 23, 2018

montyly commented Oct 25, 2018 •

edited by dguido

Loading

gitcoinbot commented Oct 25, 2018

gitcoinbot commented Oct 25, 2018 •

edited

Loading

gitcoinbot commented Oct 28, 2018

gitcoinbot commented Oct 29, 2018

ghost commented Oct 31, 2018 •

edited by ghost

Loading

montyly commented Oct 31, 2018

gitcoinbot commented Nov 3, 2018

gitcoinbot commented Nov 4, 2018

gitcoinbot commented Nov 6, 2018

gitcoinbot commented Nov 7, 2018

rmshea commented Nov 8, 2018

anukul commented Nov 12, 2018

montyly commented Nov 14, 2018

anukul commented Nov 17, 2018

spm32 commented Nov 28, 2018

montyly commented Nov 28, 2018

mkosowsk commented Dec 4, 2018

anukul commented Dec 4, 2018

gitcoinbot commented Dec 4, 2018

mkosowsk commented Dec 4, 2018

gitcoinbot commented Dec 4, 2018

BlinkyStitt commented Jan 7, 2019

dguido commented Jan 7, 2019

Integrate with Truffle #18

Integrate with Truffle #18

Comments

dguido commented Sep 14, 2018 • edited Loading

dguido commented Oct 22, 2018

mkosowsk commented Oct 23, 2018

montyly commented Oct 25, 2018 • edited by dguido Loading

gitcoinbot commented Oct 25, 2018

gitcoinbot commented Oct 25, 2018 • edited Loading

gitcoinbot commented Oct 28, 2018

gitcoinbot commented Oct 29, 2018

ghost commented Oct 31, 2018 • edited by ghost Loading

montyly commented Oct 31, 2018

gitcoinbot commented Nov 3, 2018

gitcoinbot commented Nov 4, 2018

gitcoinbot commented Nov 6, 2018

gitcoinbot commented Nov 7, 2018

rmshea commented Nov 8, 2018

anukul commented Nov 12, 2018

montyly commented Nov 14, 2018

anukul commented Nov 17, 2018

spm32 commented Nov 28, 2018

montyly commented Nov 28, 2018

mkosowsk commented Dec 4, 2018

anukul commented Dec 4, 2018

gitcoinbot commented Dec 4, 2018

mkosowsk commented Dec 4, 2018

gitcoinbot commented Dec 4, 2018

BlinkyStitt commented Jan 7, 2019

dguido commented Jan 7, 2019

dguido commented Sep 14, 2018 •

edited

Loading

montyly commented Oct 25, 2018 •

edited by dguido

Loading

gitcoinbot commented Oct 25, 2018 •

edited

Loading

ghost commented Oct 31, 2018 •

edited by ghost

Loading