smart-contract-auditor-api

Install

• install solc-select + run solc-select install all
• install slither

Documentation

Starts a new PDF report generation.

Method: POST
Endpoint: /audit/:contractId/
Responses:

• Success

{
    "status": "started"
}

• Already available

{
    "status": "ended"
}

• Server is too busy to take the request

{
    "status": "server is busy"
}

Gets the status of a report generation

Method: GET Endpoint: /audit/:contractId/status Responses:

• In progress

{
    "status": "message describing the state of the report generation"
}

• Errored

{
    "status": "errored",
    "error": "This contract is written in Vyper, which is not supported yet."
}

• Ended

{
    "status": "ended"
}

Gets the report of a contract (once status = "ended")

Method: GET Endpoint: /audit/:contractId/pdf Responses:

• Success

{
    "status": "success",
    "report": "base64 encoded pdf"
}

• Error

{
    "status": "unknown"
}