openapi: 3.0.3
info:
  title: Rocket Pool Protocol API (rocketpool-go) Auction Queue API
  description: Read-oriented protocol surface exposed by the rocketpool-go Golang library on top of the Rocket Pool smart contracts deployed on Ethereum. The API described here is a logical mapping of rocketpool-go packages — auction, deposit, minipool, network, node, rewards, settings, tokens, dao/protocol, dao/trustednode — onto HTTP-style operations. There is no hosted HTTP endpoint for this API; integrators read the equivalent state via Ethereum JSON-RPC eth_call requests against the deployed contracts using the Go library, the rocketpool-js library, or directly via web3 clients.
  version: 1.0.0
  license:
    name: GPL-3.0
    url: https://github.com/rocket-pool/rocketpool-go/blob/master/LICENSE
  contact:
    name: Rocket Pool
    url: https://github.com/rocket-pool/rocketpool-go
servers:
- url: https://protocol.rocketpool.example/v1
  description: Logical base path — actual access is via Ethereum smart contracts
tags:
- name: Queue
paths:
  /queue/status:
    get:
      tags:
      - Queue
      summary: Get Deposit And Minipool Queue Status
      operationId: getQueueStatus
      responses:
        '200':
          description: Queue status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueueStatus'
  /queue/process:
    post:
      tags:
      - Queue
      summary: Process Deposit Pool
      operationId: processQueue
      responses:
        '200':
          description: Process submitted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionResponse'
components:
  schemas:
    QueueStatus:
      type: object
      properties:
        depositPoolBalance:
          $ref: '#/components/schemas/EthAmount'
        depositPoolExcess:
          $ref: '#/components/schemas/EthAmount'
        minipoolQueueLength:
          type: integer
        minipoolQueueCapacity:
          $ref: '#/components/schemas/EthAmount'
    EthAmount:
      type: string
      description: Amount expressed in wei (1 ETH = 10^18 wei)
      example: '32000000000000000000'
    TransactionHash:
      type: string
      pattern: ^0x[a-fA-F0-9]{64}$
    TransactionResponse:
      type: object
      properties:
        status:
          type: string
          enum:
          - success
          - error
        txHash:
          $ref: '#/components/schemas/TransactionHash'
        gasInfo:
          type: object
          properties:
            estGasLimit:
              type: integer
            safeGasLimit:
              type: integer
        error:
          type: string