SolidityScan Security API
  • Introduction
    • 📋Overview of SolidityScan
    • 💡Key Features
    • 💻Supported Platforms
  • Getting Started
    • ⭐Web Application
      • ⏩QuickScan
      • Scan a Online Git Repository
      • Scanning a Deployed Contract
      • 🗃️Upload and Scan Solidity Project
      • 👨‍💼Organisation
    • ⚙️APIs
      • 🔏Generating Private Key
      • 🌐SolidityScan Private API
        • WebSocket API
          • Project Scan
          • Verified Contract Scan
          • Project Quick Scan
          • Project Threat Scan
          • File Upload Scans
          • Scan Lifespan and Events
        • HTTP API
      • RustScan API
      • 🔐Vulnerability Score API V1
      • 💢ThreatScore API V1
      • ThreatScore API V2
      • SolidityScan WebSocket Events
        • Private QuickScan WS
        • 🔐Private ThreatScan WS
        • WS references
      • ⚙️Postman Collection
      • Platform Info
    • 📑SolidityScan SDK
    • Platform Parameters
      • Arbitrum
        • Arbiscan
        • Blockscout
      • Asset Chain
        • Blockscout
      • Astar
        • Blockscout
        • SubScan
      • Aurora
        • Aurora Explorer
      • Avalanche
        • Snowtrace
        • Routescan
      • Base
        • BaseScan
        • Blockscout
      • BlackFort
        • Blockscout
      • BOBA
        • Routescan
      • Binance
        • Bscscan
      • BuildBear
        • BuildBear
      • Camino
        • Blockscout
      • Celo
        • Celo Explorer
        • Blockscout
      • Chiliz
        • Routescan
      • Connext
        • Blockscout
      • Creditcoin
        • Blockscout
      • Cronos
        • Cronos Explorer
      • Darwinia
        • SubScan
      • Ethereum Classic
        • Blockscout
      • Ethereum
        • Etherscan
        • Blockscout
      • Etherlink
        • Blockscout
      • Fantom
        • Ftmscan
      • 5ireChain
        • 5ireChain
      • Flare
        • Routescan
      • Fuse
        • Fuse Explorer
        • Blockscout
      • Gnosis
        • Blockscout
      • Hemi
        • Blockscout
      • Immutable
        • Blockscout
      • IOTA
        • Blockscout
      • Japan Open Chain
        • Blockscout
      • Lightlink
        • Blockscout
      • Linea
        • LineaScan
        • Blockscout
      • Lisk
        • Blockscout
      • LUKSO
        • Blockscout
      • Metis
        • Routescan
      • Moonbeam Network
        • SubScan
      • Neon
        • Blockscout
      • Nordek
        • Nordekscan
      • Omni
        • Blockscout
      • One World Chain
        • Blockscout
      • Optimism
        • Optimism
        • Blockscout
      • Peaq Network
        • SubScan
      • Playnance
        • Blockscout
      • Polkadot
        • SubScan
      • Polygon
        • Polygonscan
        • Blockscout
      • re.al
        • Blockscout
      • Redstone
        • Blockscout
      • Reef
        • ReefScan
      • Reya
        • Blockscout
      • Rootstock
        • Blockscout
      • Shibarium
        • Blockscout
      • Shimmer
        • Blockscout
      • Soneium
        • Blockscout
      • Stability
        • Blockscout
      • Tron
        • Tronscan
      • XDC
        • BlocksScan
      • Zetachain
        • Blockscout
      • zkSync
        • Blockscout
  • Integrations
    • GitHub
    • BitBucket
    • GitLab
    • Slack
    • VS Code
    • Remix
  • Audit Reports
    • 📒QuickScan Report
    • 📢Generate and Publish Reports
  • Pricing
    • 💰SolidityScan Pricing
Powered by GitBook
On this page
  1. Getting Started
  2. APIs
  3. SolidityScan WebSocket Events

Private QuickScan WS

The flow for quickscan ws is as follows:

  • Register the token using auth_token_register event

  • Using the token, send an event to perform a quickscan

1. WebSocket API Documentation

  • URL: api-ws.solidityscan.com

  • Protocol: wss

  • Description: This request requires authorization. The bearer token is sent in the auth_tokenrequest parameter.

Step 1. Auth Token Registration Description: The first step is to register with your auth token to generate an UUID.

{
    "action": "message",
    "payload": {
        "type": "auth_token_register",
        "body": {
            "auth_token": "{Your_Auth_Token}"
        }
    }
}
{
    "type": "auth_token_register",
    "request_uuid": "Your_UUID",
    "payload": {
        "message": "Auth token registered."
    },
    "event_timestamp": "2024-04-19 11:37:17.854547"
}
  • contract_address: The address of the contract to be scanned.

  • contract_platform: The platform which the contract belongs to.

  • contract_chain: The chain which the contract belongs to.

{
    "action": "message",
    "payload": {
        "type": "private_quick_scan_initiate",
        "body": {
            "contract_address": "0xc2498D4fB17A956A847091D088f1D7f6fE745f5B",
            "contract_platform": "etherscan",
            "contract_chain": "mainnet"
        }
    }
}
{
  "type": "quick_scan_status",
  "request_uuid": "87accd51793efb5dfd6452497ab3e360",
  "payload": {
    "scan_id": "86f4db9567e8ebe5",
    "scan_status": "scan_done",
    "project_id": "ec8ce914842b91d1d0f59f289bbf0222",
    "scan_details": {
      "client_credit_system": "loc",
      "compilerversion": "v0.8.23+commit.f704f362",
      "connection_id": "",
      "contract_address": "0xc2498D4fB17A956A847091D088f1D7f6fE745f5B",
      "contract_chain": "mainnet",
      "contract_platform": "etherscan",
      "contract_url": "https://etherscan.io/address/0xc2498D4fB17A956A847091D088f1D7f6fE745f5B",
      "contractname": "TRIUMPH",
      "currency": "ETH",
      "evmversion": "Default",
      "is_quick_scan": false,
      "licensetype": "MIT",
      "multi_file_scan_status": "scan_done",
      "multi_file_scan_summary": {
        "issue_severity_distribution": {
          "critical": 7,
          "gas": 88,
          "high": 2,
          "informational": 46,
          "low": 6,
          "medium": 7
        },
        "lines_analyzed_count": 358,
        "scan_time_taken": 3,
        "score_v2": "41.34",
        "threat_score": "84.21",
        "score_rating": "Average"
      },
      "node_reference_id": null,
      "quick_file_scan_details": [
        {
          "issue_code_findings_enabled": true,
          "issue_description": "<p>The contract cannot mint new tokens. The <code>_mint</code> functions was not detected in the contracts.</br>Mint functions are used to create new tokens and transfer them to the user’s/owner’s wallet to whom the tokens are minted. This increases the overall circulation of the tokens.</p>",
          "issue_dynamic_desc": "The contract cannot mint new tokens.",
          "issue_id": "QUICK_SCAN_PRESENCE_OF_MINTING_FUNCTION",
          "issue_name": "PRESENCE OF MINTING FUNCTION",
          "issue_status": "pass"
        },
        {
          "bug_hash": "QTOaj1uRCHtkWLX6pRv9HZY4HKA=",
          "findings": [
            {
              "file_path": "contract.sol",
              "line_nos_end": [
                98
              ],
              "line_nos_start": [
                95
              ]
            },
            {
              "file_path": "contract.sol",
              "line_nos_end": [
                299
              ],
              "line_nos_start": [
                295
              ]
            }
          ],
          "issue_code_findings_enabled": true,
          "issue_description": "<p>The contracts are using 6 functions that can only be called by the owners.</br>Giving too many privileges to the owners via critical functions might put the user's funds at risk if the owners are compromised or if a rug-pulling attack happens.</p>",
          "issue_dynamic_desc": "The contracts are using functions that can only be called by the owners.",
          "issue_id": "QUICK_SCAN_OVERPOWERED_OWNERS",
          "issue_name": "OVERPOWERED OWNERS",
          "issue_status": "fail"
        },
        ...
      ],
      "request_type": "block_scan",
      "is_approved": false
    }
  },
  "event_timestamp": "2024-07-15 12:50:47.819430"
}
PreviousSolidityScan WebSocket EventsNextPrivate ThreatScan WS

Last updated 8 months ago

⚙️