smart-contract-verifier.swagger.yaml

swagger: "2.0"
info:
  title: v2/smart-contract-verifier.proto
  version: version not set
tags:
  - name: SolidityVerifier
  - name: VyperVerifier
  - name: SourcifyVerifier
  - name: Health
consumes:
  - application/json
produces:
  - application/json
paths:
  /api/v2/verifier/solidity/methods:lookup:
    post:
      operationId: SolidityVerifier_LookupMethods
      responses:
        "200":
          description: A successful response.
          schema:
            $ref: '#/definitions/v2LookupMethodsResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
        - name: body
          in: body
          required: true
          schema:
            $ref: '#/definitions/v2LookupMethodsRequest'
      tags:
        - SolidityVerifier
  /api/v2/verifier/solidity/sources:verify-multi-part:
    post:
      operationId: SolidityVerifier_VerifyMultiPart
      responses:
        "200":
          description: A successful response.
          schema:
            $ref: '#/definitions/v2VerifyResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
        - name: body
          in: body
          required: true
          schema:
            $ref: '#/definitions/v2VerifySolidityMultiPartRequest'
      tags:
        - SolidityVerifier
  /api/v2/verifier/solidity/sources:verify-standard-json:
    post:
      operationId: SolidityVerifier_VerifyStandardJson
      responses:
        "200":
          description: A successful response.
          schema:
            $ref: '#/definitions/v2VerifyResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
        - name: body
          in: body
          required: true
          schema:
            $ref: '#/definitions/v2VerifySolidityStandardJsonRequest'
      tags:
        - SolidityVerifier
  /api/v2/verifier/solidity/versions:
    get:
      operationId: SolidityVerifier_ListCompilerVersions
      responses:
        "200":
          description: A successful response.
          schema:
            $ref: '#/definitions/v2ListCompilerVersionsResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      tags:
        - SolidityVerifier
  /api/v2/verifier/sourcify/sources:verify:
    post:
      operationId: SourcifyVerifier_Verify
      responses:
        "200":
          description: A successful response.
          schema:
            $ref: '#/definitions/v2VerifyResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
        - name: body
          in: body
          required: true
          schema:
            $ref: '#/definitions/v2VerifySourcifyRequest'
      tags:
        - SourcifyVerifier
  /api/v2/verifier/sourcify/sources:verify-from-etherscan:
    post:
      operationId: SourcifyVerifier_VerifyFromEtherscan
      responses:
        "200":
          description: A successful response.
          schema:
            $ref: '#/definitions/v2VerifyResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
        - name: body
          in: body
          required: true
          schema:
            $ref: '#/definitions/v2VerifyFromEtherscanSourcifyRequest'
      tags:
        - SourcifyVerifier
  /api/v2/verifier/vyper/sources:verify-multi-part:
    post:
      operationId: VyperVerifier_VerifyMultiPart
      responses:
        "200":
          description: A successful response.
          schema:
            $ref: '#/definitions/v2VerifyResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
        - name: body
          in: body
          required: true
          schema:
            $ref: '#/definitions/v2VerifyVyperMultiPartRequest'
      tags:
        - VyperVerifier
  /api/v2/verifier/vyper/sources:verify-standard-json:
    post:
      operationId: VyperVerifier_VerifyStandardJson
      responses:
        "200":
          description: A successful response.
          schema:
            $ref: '#/definitions/v2VerifyResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
        - name: body
          in: body
          required: true
          schema:
            $ref: '#/definitions/v2VerifyVyperStandardJsonRequest'
      tags:
        - VyperVerifier
  /api/v2/verifier/vyper/versions:
    get:
      operationId: VyperVerifier_ListCompilerVersions
      responses:
        "200":
          description: A successful response.
          schema:
            $ref: '#/definitions/v2ListCompilerVersionsResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      tags:
        - VyperVerifier
  /health:
    get:
      summary: |-
        If the requested service is unknown, the call will fail with status
        NOT_FOUND.
      operationId: Health_Check
      responses:
        "200":
          description: A successful response.
          schema:
            $ref: '#/definitions/v2HealthCheckResponse'
        default:
          description: An unexpected error response.
          schema:
            $ref: '#/definitions/googlerpcStatus'
      parameters:
        - name: service
          in: query
          required: false
          type: string
      tags:
        - Health
definitions:
  ExtraDataBytecodePart:
    type: object
    properties:
      type:
        type: string
      data:
        type: string
  HealthCheckResponseServingStatus:
    type: string
    enum:
      - UNKNOWN
      - SERVING
      - NOT_SERVING
      - SERVICE_UNKNOWN
    default: UNKNOWN
    description: ' - SERVICE_UNKNOWN: Used only by the Watch method.'
  LookupMethodsResponseMethod:
    type: object
    properties:
      fileName:
        type: string
      fileOffset:
        type: integer
        format: int64
      length:
        type: integer
        format: int64
  SourceMatchType:
    type: string
    enum:
      - MATCH_TYPE_UNSPECIFIED
      - PARTIAL
      - FULL
    default: MATCH_TYPE_UNSPECIFIED
    description: ' - MATCH_TYPE_UNSPECIFIED: Default value. This value is unused.'
  SourceSourceType:
    type: string
    enum:
      - SOURCE_TYPE_UNSPECIFIED
      - SOLIDITY
      - VYPER
      - YUL
    default: SOURCE_TYPE_UNSPECIFIED
    description: ' - SOURCE_TYPE_UNSPECIFIED: Default value. Used if is impossible to determine the source type.'
  VerifyResponseExtraData:
    type: object
    properties:
      localCreationInputParts:
        type: array
        items:
          type: object
          $ref: '#/definitions/ExtraDataBytecodePart'
        description: |-
          / Creation transaction input resultant from local compilation
          / parsed and split on Main and Meta parts. Is empty for Sourcify verification.
      localDeployedBytecodeParts:
        type: array
        items:
          type: object
          $ref: '#/definitions/ExtraDataBytecodePart'
        description: |-
          / Deployed bytecode resultant from local compilation
          / parsed and split on Main and Meta parts. Is empty for Sourcify verification.
  VerifyResponsePostActionResponses:
    type: object
    properties:
      lookupMethods:
        $ref: '#/definitions/v2LookupMethodsResponse'
        description: |-
          / If requested, will contain the response for
          / 'lookup-methods' processing applied to the verified contract.
  googlerpcStatus:
    type: object
    properties:
      code:
        type: integer
        format: int32
      message:
        type: string
      details:
        type: array
        items:
          type: object
          $ref: '#/definitions/protobufAny'
  protobufAny:
    type: object
    properties:
      '@type':
        type: string
    additionalProperties: {}
  v2BytecodeType:
    type: string
    enum:
      - BYTECODE_TYPE_UNSPECIFIED
      - CREATION_INPUT
      - DEPLOYED_BYTECODE
    default: BYTECODE_TYPE_UNSPECIFIED
  v2HealthCheckResponse:
    type: object
    properties:
      status:
        $ref: '#/definitions/HealthCheckResponseServingStatus'
  v2ListCompilerVersionsResponse:
    type: object
    properties:
      compilerVersions:
        type: array
        items:
          type: string
        title: / Compiler versions available
  v2LookupMethodsRequest:
    type: object
    properties:
      bytecode:
        type: string
      abi:
        type: string
      sourceMap:
        type: string
      fileIds:
        type: object
        additionalProperties:
          type: string
  v2LookupMethodsResponse:
    type: object
    properties:
      methods:
        type: object
        additionalProperties:
          $ref: '#/definitions/LookupMethodsResponseMethod'
  v2Source:
    type: object
    properties:
      fileName:
        type: string
        title: / The name of the file verified contract was located at
      contractName:
        type: string
        title: / The name of the contract which was verified
      compilerVersion:
        type: string
        title: Compiler version used to compile the contract
      compilerSettings:
        type: string
        title: |-
          / 'settings' key in Standard Input JSON
          / (https://docs.soliditylang.org/en/latest/using-the-compiler.html#input-description)
      sourceType:
        $ref: '#/definitions/SourceSourceType'
      sourceFiles:
        type: object
        additionalProperties:
          type: string
      abi:
        type: string
        title: |-
          / Contract abi (https://docs.soliditylang.org/en/latest/abi-spec.html?highlight=abi#json);
          / (does not exist for Yul contracts)
      constructorArguments:
        type: string
        title: |-
          / Constructor arguments used for deploying verified contract
          / (exists only for creation inputs)
      matchType:
        $ref: '#/definitions/SourceMatchType'
        title: / Similar to Sourcify (see https://docs.sourcify.dev/docs/full-vs-partial-match/)
      compilationArtifacts:
        type: string
        description: |-
          / General and compiler-specific artifacts (abi, userdoc, devdoc, licenses, ast, etc),
          / encoded as a json.
      creationInputArtifacts:
        type: string
        description: / Info about the creation code (sourcemaps, linkreferences) encoded as a json.
      deployedBytecodeArtifacts:
        type: string
        description: / Info about the runtime code (sourcemaps, linkreferences, immutables) encoded as a json.
  v2VerificationMetadata:
    type: object
    properties:
      chainId:
        type: string
        title: / Id of the chain the contract is verified on
      contractAddress:
        type: string
        title: / The address of the contract to be verified
  v2VerifyFromEtherscanSourcifyRequest:
    type: object
    properties:
      address:
        type: string
        title: / Address of the contract to be verified
      chain:
        type: string
        title: |-
          / The chain (network) the contract was deployed to
          / (https://docs.sourcify.dev/docs/api/chains/)
  v2VerifyResponse:
    type: object
    properties:
      message:
        type: string
      status:
        $ref: '#/definitions/v2VerifyResponseStatus'
      source:
        $ref: '#/definitions/v2Source'
      extraData:
        $ref: '#/definitions/VerifyResponseExtraData'
      postActionResponses:
        $ref: '#/definitions/VerifyResponsePostActionResponses'
  v2VerifyResponseStatus:
    type: string
    enum:
      - STATUS_UNSPECIFIED
      - SUCCESS
      - FAILURE
    default: STATUS_UNSPECIFIED
  v2VerifySolidityMultiPartRequest:
    type: object
    properties:
      bytecode:
        type: string
        title: / Bytecode to compare local compilation result with
      bytecodeType:
        $ref: '#/definitions/v2BytecodeType'
        title: / Either CREATION_INPUT or DEPLOYED_BYTECODE, depending on what should be verified
      compilerVersion:
        type: string
        title: / Compiler version used to compile the contract
      evmVersion:
        type: string
        title: / Version of the EVM to compile for. If absent results in default EVM version
      optimizationRuns:
        type: integer
        format: int32
        title: |-
          / If present, optimizations are enabled with specified number of runs,
          / otherwise optimizations are disabled
      sourceFiles:
        type: object
        additionalProperties:
          type: string
        title: / Map from a source file name to the actual source code
      libraries:
        type: object
        additionalProperties:
          type: string
        title: / Map from a library name to its address
      metadata:
        $ref: '#/definitions/v2VerificationMetadata'
        title: / An optional field to be filled by explorers
      postActions:
        type: array
        items:
          type: string
        description: |-
          / Additional actions the client wants the result to be returned.
          / Currently supports only: "lookup-methods" for Solidity contracts.
  v2VerifySolidityStandardJsonRequest:
    type: object
    properties:
      bytecode:
        type: string
        title: / Bytecode to compare local compilation result with
      bytecodeType:
        $ref: '#/definitions/v2BytecodeType'
        title: / Either CREATION_INPUT or DEPLOYED_BYTECODE, depending on what should be verified
      compilerVersion:
        type: string
        title: / Compiler version used to compile the contract
      input:
        type: string
        title: / https://docs.soliditylang.org/en/latest/using-the-compiler.html#input-description
      metadata:
        $ref: '#/definitions/v2VerificationMetadata'
        title: / An optional field to be filled by explorers
      postActions:
        type: array
        items:
          type: string
        description: |-
          / Additional actions the client wants the result to be returned.
          / Currently supports only: "lookup-methods" for Solidity contracts.
  v2VerifySourcifyRequest:
    type: object
    properties:
      address:
        type: string
        title: / Address of the contract to be verified
      chain:
        type: string
        title: |-
          / The chain (network) the contract was deployed to
          / (https://docs.sourcify.dev/docs/api/chains/)
      files:
        type: object
        additionalProperties:
          type: string
        title: |-
          / Files required for verification (see Sourcify Api)
          Is named as `files` instead of `source_files`
          to correspond with Sourcify api
      chosenContract:
        type: integer
        format: int32
        title: (optional) see Sourcify Api
  v2VerifyVyperMultiPartRequest:
    type: object
    properties:
      bytecode:
        type: string
        title: / Bytecode to compare local compilation result with
      bytecodeType:
        $ref: '#/definitions/v2BytecodeType'
        title: / Either CREATION_INPUT or DEPLOYED_BYTECODE, depending on what should be verified
      compilerVersion:
        type: string
        title: / Compiler version used to compile the contract
      evmVersion:
        type: string
        title: / Version of the EVM to compile for. If absent results in default EVM version
      sourceFiles:
        type: object
        additionalProperties:
          type: string
        title: / Map from a source file name to the actual source code
      interfaces:
        type: object
        additionalProperties:
          type: string
        description: |-
          / Map from an interface names to the actual interfaces.
          / If non-specified, no interfaces are considered.
      metadata:
        $ref: '#/definitions/v2VerificationMetadata'
        title: / An optional field to be filled by explorers
  v2VerifyVyperStandardJsonRequest:
    type: object
    properties:
      bytecode:
        type: string
        title: / Bytecode to compare local compilation result with
      bytecodeType:
        $ref: '#/definitions/v2BytecodeType'
        title: / Either CREATION_INPUT or DEPLOYED_BYTECODE, depending on what should be verified
      compilerVersion:
        type: string
        title: / Compiler version used to compile the contract
      input:
        type: string
        title: / https://docs.vyperlang.org/en/stable/compiling-a-contract.html#input-json-description
      metadata:
        $ref: '#/definitions/v2VerificationMetadata'
        title: / An optional field to be filled by explorers