Skip to content

Commit

Permalink
Exclude libraries from Slither (#12)
Browse files Browse the repository at this point in the history
* Added ability to include or exclude uniswap/OZ libraries from scan

* Fixed import

* Script improvements

Co-authored-by: Lucas Janon <ljanon@gmail.com>
  • Loading branch information
CharlieMc0 and lucas-janon committed Jun 23, 2022
1 parent 50aefdc commit 6981173
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions scripts/slither.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,20 @@ async function getPackageName() {
}
}

async function getFilterPaths() {
if (process.env.CI) return "";

const { confirm: includeLibraries } = await inquirer.prompt([
{
type: "confirm",
message: "Do you want to include OpenZeppelin & Uniswap libraries in this scan?",
name: "confirm",
},
]);

return includeLibraries ? "" : `--filter-paths "node_modules/@openzeppelin/","node_modules/@uniswap/"`;
}

const run = async (command: string) => {
try {
console.log("Starting -- This may take a few minutes...");
Expand All @@ -50,21 +64,17 @@ const run = async (command: string) => {
console.error(`${error}`);
}
};

function runSlither(packageName: string) {
function runSlither(packageName: string, filterPaths: string) {
const dockerCommand = `cd /home/trufflecon/packages/${packageName} && \
solc-select use ${solcVersion} && \
slither --json ../../scripts/slither-results/${packageName}-${timestamp}.json \
--sarif ../../scripts/slither-results/${packageName}-${timestamp}.sarif \
--checklist ./ | tee ../../scripts/slither-results/${packageName}-${timestamp}.md`;

--checklist ./ ${filterPaths} | tee ../../scripts/slither-results/${packageName}-${timestamp}.md`;
run(`docker run -v "${projectRoot}":/home/trufflecon trailofbits/eth-security-toolbox -c "${dockerCommand}"`);
}

async function main() {
const packageName = await getPackageName();

runSlither(packageName);
runSlither(await getPackageName(), await getFilterPaths());
}

main()
Expand Down

0 comments on commit 6981173

Please sign in to comment.