API

Introduction

The Solidity Analyzer API is designed to help developers and auditors analyze smart contracts for security vulnerabilities. It leverages the Slither static analysis tool to detect issues in Solidity contracts. The API also provides functionality to generate detailed security reports in PDF format.

Solidity Analyzer Web Interface

Endpoints

Home

Endpoint: https://api.iard.solutions/v2/

Method: GET

Description: This endpoint returns a welcome message.

Response:

{
    "message": "Welcome to the IARD Solutions API"
}

Analyze Contract

Endpoint: https://api.iard.solutions/v2/analyze

Method: POST

Description:

This endpoint analyzes a smart contract based on the provided blockchain, contract address, and code. It supports both single-file and multi-file contracts.

Parameters:

• blockchain (str, optional): The name of the blockchain (e.g., "ethereum").

• contract_address (str, optional): The address of the contract to be analyzed.

• code (str, optional): The code of the contract to be analyzed. For multi-file contracts, this should be a JSON string where each key is the file name and the value is the file content.

• sandboxId (str, optional): The sandbox ID for the BuildBear blockchain.

If you want to analyze by address, use the blockchain and contract_address parameters (and sandboxId if the blockchain is buildbear), and if you want to analyze by code, use the code parameter.

Response:

Success:

{
    "result": [
        {
            "check": "string",
            "description": "string",
            "impact": "string",
            "confidence": "string"
        }
    ],
    "linter" : "string"
}

Error:

{
    "error": "string"
}

Example Request:

Single-File Contract:

curl 'https://api.iard.solutions/v2/analyze' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY' \
  --data-raw '{"blockchain":"bsc","contract_address":"0x286c484A34417919758119dEF0aD7441bD780f57","sandboxId":""}'

Multi-File Contract:

curl 'https://api.iard.solutions/v2/analyze' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY' \
  --data-raw '{
    "blockchain": "ethereum",
    "contract_address": "0x286c484A34417919758119dEF0aD7441bD780f57",
    "code": {
        "Contract1.sol": {
            "content": "pragma solidity ^0.8.0;\n\ncontract Contract1 {\n    // Contract code here\n}\n"
        },
        "Contract2.sol": {
            "content": "pragma solidity ^0.8.0;\n\ncontract Contract2 {\n    // Contract code here\n}\n"
        }
    },
    "sandboxId": ""
}'

Generate Report

Endpoint: https://api.iard.solutions/v2/report

Method: POST

Description: This endpoint generates a security report in PDF format based on the provided analysis results and project name.

Parameters:

• results (str): The analysis results. (endpoint /v2/analyze)
• project_name (str): The name of the project.

Response:

• Success: A PDF file named IARD_Solutions_audit.pdf is returned as a download.

• Error:

{
    "error": "string"
}

Example Request:

curl 'https://api.iard.solutions/v2/report' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY' \
  --data-raw '{"results":"{\"result\":[{\"check\":\"arbitrary-send-eth\",\"confidence\":\"Medium\",\"description\":\"Pnut.transferToAddressETH(address,uint256) (Pnut.sol#331-333) sends eth to arbitrary user\\n\\tDangerous calls:\\n\\t- recipient.transfer(amount) (Pnut.sol#332)\\n\",\"impact\":\"High\"},{\"check\":\"immutable-states\",\"confidence\":\"High\",\"description\":\"Pnut._tokenOwner (Pnut.sol#150) should be immutable \\n\",\"impact\":\"Optimization\"},{\"check\":\"immutable-states\",\"confidence\":\"High\",\"description\":\"Pnut.marketingFee (Pnut.sol#161) should be immutable \\n\",\"impact\":\"Optimization\"}]}","project_name":"0x286c484A34417919758119dEF0aD7441bD780f57"}'

Get Recommendation

Endpoint: https://api.iard.solutions/v2/recommendation

Method: POST

Description: This endpoint provides AI-generated recommendations based on the provided vulnerability and recommendation details.

Parameters:

• vulnerability (str): The vulnerability description.

• recommendation (str): The recommendation details.

Response:

• Success:

  {
      "recommendation": "string"
  }

• Error:

  {
      "error": "string"
  }

Example Request:

curl 'https://api.iard.solutions/v2/recommendation' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY' \
  --data-raw '{"vulnerability":"Reentrancy vulnerability detected","recommendation":"Implement reentrancy guard"}'