openapi: 3.0.3
info:
  title: Verification api
  description: This API allows you to get the information on TIP-3 tokens
  version: 1.0.0
tags:
- name: abi
- name: info
- name: parse
- name: versions
servers:
- url: https://verify.venomscan.com
paths:
  /info/code_hash/{hashRequest}:
    get:
      tags:
      - info
      summary: Get abi by code hash
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractInfo'
    parameters:
    - name: hashRequest
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/Hash'
  /info/address/{addressRequest}:
    get:
      tags:
      - info
      summary: Get abi by address
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractInfo'
    parameters:
    - name: addressRequest
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/AddressRequest'
  /info/list:
    post:
      tags:
      - info
      summary: Get abi list
      requestBody:
        required: true
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AbiListRequest'
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AbiInfo'
  /abi/code_hash/{hashRequest}:
    get:
      tags:
      - abi
      summary: Get abi by code hash
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: string
    parameters:
    - name: hashRequest
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/Hash'
  /abi/address/{addressRequest}:
    get:
      tags:
      - abi
      summary: Get abi by address
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: string
    parameters:
    - name: addressRequest
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/AddressRequest'
  /abi/list:
    post:
      tags:
      - abi
      summary: Get abi list
      requestBody:
        required: true
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AbiListRequest'
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AbiInfo'
  /parse/message/{hashRequest}:
    get:
      tags:
      - parse
      summary: Get parsed message by hash
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ParsedMessage'
    parameters:
    - name: hashRequest
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/Hash'
  /parse/transaction/{hashRequest}:
    get:
      tags:
      - parse
      summary: Get parsed transaction by hash
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ParsedData'
    parameters:
    - name: hashRequest
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/Hash'
  /supported/solc:
    get:
      tags:
      - versions
      summary: Get list of supported solc versions. Map commit hash to compiler info
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
  /supported/linker:
    get:
      tags:
      - versions
      summary: Get list of supported linker versions
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
  /compile:
    post:
      tags:
      - versions
      summary: Compile source code
      requestBody:
        required: true
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompileRequest'
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompileResponse'
components:
  schemas:
    AbiInfo:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ContractInfo'
        total_count:
          type: integer
          format: uint32
      required:
      - total_count
      - data
    AbiListRequest:
      type: object
      properties:
        limit:
          type: integer
          format: uint32
        offset:
          nullable: true
          type: integer
          format: uint32
      required:
      - limit
      - offset
    AddressRequest:
      description: StdAddr in any format
      type: string
      format: (-1|0):[0-9a-fA-F]{64}
      example: 0:0000000000000000000000000000000000000000000000000000000000000000
    CompileOutput:
      type: object
      properties:
        abi:
          nullable: true
          type: string
        code:
          nullable: true
          type: string
        dependencies_list:
          type: array
          items:
            type: string
        stderr:
          type: string
        stdout:
          type: string
        success:
          type: boolean
      required:
      - stdout
      - stderr
      - success
      - abi
      - code
      - dependencies_list
    CompileRequest:
      type: object
      properties:
        audit_url:
          nullable: true
          type: string
        compiler:
          $ref: '#/components/schemas/CompilerInfo'
        license:
          type: string
        linker:
          $ref: '#/components/schemas/LinkerInfo'
        project_link:
          nullable: true
          type: string
        sources:
          type: array
          items:
            $ref: '#/components/schemas/Source'
      required:
      - compiler
      - linker
      - sources
      - license
      - audit_url
      - project_link
    CompileResponse:
      type: object
      properties:
        already_verified:
          type: object
          additionalProperties:
            type: string
        compiled:
          type: array
          items:
            $ref: '#/components/schemas/VerificationResponse'
        failed_to_verify:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/CompileResult'
      required:
      - compiled
      - already_verified
      - failed_to_verify
    CompileResult:
      type: object
      properties:
        compiler_output:
          $ref: '#/components/schemas/CompileOutput'
        linker_output:
          $ref: '#/components/schemas/LinkerOutput'
      required:
      - linker_output
      - compiler_output
    CompilerInfo:
      type: object
      properties:
        flags:
          type: array
          items:
            type: string
        version:
          type: string
      required:
      - version
      - flags
    ContractInfo:
      type: object
      properties:
        abi: {}
        code_hash:
          type: string
          format: hex
        compiler_version:
          type: string
        contract_name:
          type: string
        linker_version:
          type: string
        project_link:
          nullable: true
          type: string
        sources: {}
        tvc:
          type: string
          format: base64
      required:
      - abi
      - contract_name
      - project_link
      - sources
      - tvc
      - code_hash
      - compiler_version
      - linker_version
    Hash:
      description: Hash
      type: string
      format: '[0-9a-fA-F]{64}'
      example: 0000000000000000000000000000000000000000000000000000000000000000
    LinkerInfo:
      type: object
      properties:
        version:
          type: string
      required:
      - version
    LinkerOutput:
      nullable: true
      type: object
      properties:
        code_hash:
          nullable: true
          type: string
        stderr:
          type: string
        stdout:
          type: string
        success:
          type: boolean
        tvc:
          nullable: true
          type: string
      required:
      - stdout
      - stderr
      - success
      - tvc
      - code_hash
    ParsedData:
      type: object
      properties:
        decoded_headers: {}
        function_id:
          type: integer
          format: uint32
        function_name:
          type: string
        message_hash:
          type: string
          format: hex
        parsed_data: {}
        parsed_type:
          type: string
          format: FunctionInput | FunctionOutput | BouncedFunction | Event
      required:
      - message_hash
      - parsed_data
      - parsed_type
      - function_id
      - function_name
      - decoded_headers
    ParsedMessage:
      nullable: true
      type: object
      properties:
        function_id:
          type: integer
          format: uint32
        headers: {}
        name:
          type: string
        parsed_type:
          type: string
          format: FunctionInput | FunctionOutput | BouncedFunction | Event
        tokens: {}
      required:
      - function_id
      - parsed_type
      - name
      - tokens
      - headers
    Source:
      type: object
      properties:
        content:
          type: string
        path:
          type: string
        source_type:
          type: string
          format: CompileTarget | VerifyTarget | Dependency
      required:
      - path
      - content
      - source_type
    VerificationResponse:
      type: object
      properties:
        code_hash:
          nullable: true
          type: string
        contract_name:
          type: string
        dependencies_list:
          type: array
          items:
            $ref: '#/components/schemas/Source'
        success:
          type: boolean
        tvc:
          nullable: true
          type: string
      required:
      - contract_name
      - code_hash
      - tvc
      - success
      - dependencies_list