openapi.yaml

openapi: 3.1.0
info:
  title: RGB Lightning Node
  description: |-
    This is the OpenAPI specification for the
    [RGB Lightning Node](https://github.com/RGB-Tools/rgb-lightning-node) APIs.

    On mainnet, Lightning APIs return HTTP 403 with name
    LightningUnsupportedOnMainnet and the message: "RLN on mainnet currently
    supports only on-chain methods. Lightning APIs are not supported."
    This includes channel/peer operations, Lightning invoices and decoding,
    payments, async payments, swaps and swap-string decoding, and onion messages.
    The configured node network controls the restriction, including while locked.
    Authentication and request extraction still apply before handler execution.
    Bitcoin/RGB on-chain APIs (including RGB invoices, transfers and asset linking)
    and shared administration/identity APIs retain their existing requirements.
    Mainnet unlock starts the wallet and signer without a Lightning runtime.
    Historical Lightning records remain inactive and do not prevent unlock. They
    are not decoded, replayed or recovered. The supported mainnet rollout assumes
    no unresolved historical Lightning obligations; unlock does not verify that
    assumption or monitor old channels. Lightning APIs on supported non-mainnet
    networks are unchanged.
  license:
    name: MIT
    url: https://mit-license.org/
  version: 0.1.0
servers:
  - url: http://localhost:3001
  - url: http://localhost:3002
  - url: http://localhost:3003
tags:
  - name: Channels
    description: APIs to perform operations related to LN channels
  - name: Peers
    description: APIs to perform operations related to LN peers
  - name: Payments
    description: APIs to perform operations related to LN payments
  - name: Async Payments
    description: APIs to perform async payment lifecycle operations
  - name: Invoices
    description: APIs to perform operations related to LN invoices
  - name: On-chain
    description: APIs to perform on-chain operations
  - name: RGB
    description: APIs to perform RGB operations
  - name: Swaps
    description: APIs to perform asset swaps
  - name: Other
    description: APIs to perform other operations
paths:
  /address:
    post:
      tags:
        - On-chain
      summary: Get a Bitcoin address
      description: Get a new Bitcoin address from the internal BDK wallet
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressResponse'
  /apay/new:
    post:
      tags:
        - Async Payments
      summary: Send a new order with async-payment hashes
      description: Derive deterministic payment hashes for async payments from the unlocked wallet. Send an async_order.new JSON-RPC request to the connected invoice-host peer so it can track those hashes and process asynchronous payments. A peer connection alone is not sufficient; the recipient-client must already have a live channel with the invoice-host peer. 
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AsyncOrderNewRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Host accepted the async order request and returned order state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncOrderNewResponse'
  /apay/outboundinvoice:
    post:
      tags:
        - Async Payments
      summary: Request an outbound LN invoice
      description: Request an outbound invoice from the connected recipient-client peer for an async payment claim session. A peer connection alone is not enough; the invoice-host must already have a live channel with the recipient-client peer.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AsyncOrderOutboundInvoiceRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Recipient peer returned an outbound invoice
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AsyncOrderOutboundInvoiceResponse'
  /assetbalance:
    post:
      tags:
        - RGB
      summary: Get the balance of an asset
      description: Get the balance for the provided RGB asset
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetBalanceRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetBalanceResponse'
  /assetlink:
    post:
      tags:
        - RGB
      summary: Create a contract link
      description: Link a parent IFA contract to a child IFA contract using a link-right UTXO
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetLinkRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetLinkResponse'
  /assetmetadata:
    post:
      tags:
        - RGB
      summary: Get the metadata of an asset
      description: Get the metadata for the provided RGB asset
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetMetadataRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetMetadataResponse'
  /backup:
    post:
      tags:
        - Other
      summary: Backup the node
      description: Create a backup of the node's data
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /btcbalance:
    post:
      tags:
        - On-chain
      summary: Get the BTC balance
      description: Get the node's bitcoin balance for the vanilla and colored wallets
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BtcBalanceRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BtcBalanceResponse'
  /cancelhodlinvoice:
    post:
      tags:
        - Invoices
      summary: Cancel a HODL invoice
      description: Cancel a held HTLC for a HODL invoice. Rejects cancellation if a settlement is already in progress.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvoiceCancelRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /changepassword:
    post:
      tags:
        - Other
      summary: Change the password
      description: Change the node's password
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangePasswordRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /checkindexerurl:
    post:
      tags:
        - Other
      summary: Check an indexer URL
      description: Check the given indexer URL is valid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckIndexerUrlRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckIndexerUrlResponse'
  /checkproxyendpoint:
    post:
      tags:
        - Other
      summary: Check a proxy endpoint
      description: Check the given proxy endpoint is valid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CheckProxyEndpointRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /claimhodlinvoice:
    post:
      tags:
        - Invoices
      summary: Claim a HODL invoice
      description: Claim a held HTLC for a HODL invoice
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClaimHodlInvoiceRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimHodlInvoiceResponse'
  /closechannel:
    post:
      tags:
        - Channels
      summary: Close a channel
      description: Close a LN channel cooperatively or forcibly
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloseChannelRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /connectpeer:
    post:
      tags:
        - Peers
      summary: Connect to a peer
      description: Connect to the provided LN peer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectPeerRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /createutxos:
    post:
      tags:
        - RGB
      summary: Create UTXOs
      description: Create UTXOs to be used for RGB operations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUtxosRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /decodelninvoice:
    post:
      tags:
        - Invoices
      summary: Decode a LN invoice
      description: Decode the provided LN invoice string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DecodeLNInvoiceRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DecodeLNInvoiceResponse'
  /decodergbinvoice:
    post:
      tags:
        - RGB
      summary: Decode an RGB invoice
      description: Decode the provided RGB invoice string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DecodeRGBInvoiceRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DecodeRGBInvoiceResponse'
  /decodeswapstring:
    post:
      tags:
        - Swaps
      summary: Decode a swapstring
      description: Decode the provided swapstring
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DecodeSwapstringRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DecodeSwapstringResponse'
  /disconnectpeer:
    post:
      tags:
        - Peers
      summary: Disconnect from a peer
      description: Disconnect from the provided LN peer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DisconnectPeerRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /estimatefee:
    post:
      tags:
        - On-chain
      summary: Get fee estimation
      description: Get on-chain fee estimation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EstimateFeeRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EstimateFeeResponse'
  /failtransfers:
    post:
      tags:
        - RGB
      summary: Fail RGB transfers
      description: Set the status for eligible RGB transfers to
        `TransferStatus::Failed`.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FailTransfersRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailTransfersResponse'
  /getassetmedia:
    post:
      tags:
        - RGB
      summary: Get an asset media
      description: Get the hex string of the media bytes of the provided media digest
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAssetMediaRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAssetMediaResponse'
  /getchannelid:
    post:
      tags:
        - Channels
      summary: Get a channel's ID
      description: Get a channel's ID from its former temporary channel ID
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetChannelIdRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetChannelIdResponse'
  /getconsignment:
    post:
      tags:
        - RGB
      summary: Get a send consignment
      description: Get the hex string of the consignment bytes for a send transfer,
        identified by its asset ID and txid (it also covers burns, where the
        consignment is the proof of the burn). Useful to hand the consignment to
        the counterparty out-of-band when the node filesystem is not accessible
        from the API caller.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetConsignmentRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConsignmentResponse'
  /getpayment:
    post:
      tags:
        - Payments
      summary: Get a payment
      description: Get a payment by its payment hash
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetPaymentRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPaymentResponse'
  /getswap:
    post:
      tags:
        - Swaps
      summary: Get a swap
      description: Get a swap by its payment hash
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetSwapRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSwapResponse'
  /burn:
    post:
      tags:
        - RGB
      summary: Burn RGB assets
      description: Burn RGB assets on-chain. For BFA assets a 32-byte burn_recipient
        (hex) is required, telling where the burned amount is released. The burn
        consignment, which proves the burn, can then be retrieved with
        /getconsignment using the asset ID and the returned txid.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BurnRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BurnResponse'
  /inflate:
    post:
      tags:
        - RGB
      summary: Inflate RGB assets
      description: Inflate RGB assets on-chain
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InflateRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InflateResponse'
  /init:
    post:
      tags:
        - Other
      summary: Init the node
      description: Initialize a new node, optionally providing a mnemonic.
        If no mnemonic is provided a new one is generated.
        Note that a mnemonic alone is not sufficient to recover RGB state, which also requires client-side data.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InitRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InitResponse'
  /invoicestatus:
    post:
      tags:
        - Invoices
      summary: Get an invoice status
      description: Get the status of the provided LN invoice
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvoiceStatusRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceStatusResponse'
  /issueassetcfa:
    post:
      tags:
        - RGB
      summary: Issue an RGB CFA asset
      description: Issue an RGB CFA asset. To provide a media first call the /postassetmedia API.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IssueAssetCFARequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueAssetCFAResponse'
  /issueassetifa:
    post:
      tags:
        - RGB
      summary: Issue an RGB IFA asset
      description: Issue an RGB IFA asset
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IssueAssetIFARequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueAssetIFAResponse'
  /issueassetnia:
    post:
      tags:
        - RGB
      summary: Issue an RGB NIA asset
      description: Issue an RGB NIA asset
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IssueAssetNIARequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueAssetNIAResponse'
  /issueassetuda:
    post:
      tags:
        - RGB
      summary: Issue an RGB UDA asset
      description: Issue an RGB UDA asset. To provide a media first call the /postassetmedia API.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IssueAssetUDARequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueAssetUDAResponse'
  /keysend:
    post:
      tags:
        - Payments
      summary: Send to a peer spontaneously
      description: Send bitcoins and RGB assets to a LN peer spontaneously (without a LN invoice)
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KeysendRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeysendResponse'
  /listassets:
    post:
      tags:
        - RGB
      summary: List assets
      description: List the node's RGB assets
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAssetsRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAssetsResponse'
  /listchannels:
    get:
      tags:
        - Channels
      summary: List channels
      description: List the node's LN channels
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListChannelsResponse'
  /listpayments:
    get:
      tags:
        - Payments
      summary: List payments
      description: >-
        List the node's LN payments (inbound and outbound) ordered most-recent
        first. Supports index-based cursor pagination: pass the
        last_index_offset of a page as the next index_offset to fetch the next,
        older page. Optionally filter by status, direction (inbound/outbound)
        and creation time interval.
      parameters:
        - in: query
          name: index_offset
          required: false
          schema:
            type: integer
            format: uint64
          description: >-
            Exclusive upper-bound cursor: only payments with a lower index are
            returned. 0 or absent means start from the most recent payment.
        - in: query
          name: max_payments
          required: false
          schema:
            type: integer
            format: uint64
          description: >-
            Maximum number of payments to return. Defaults to 100 when absent or
            zero.
        - in: query
          name: status
          required: false
          schema:
            type: string
            enum:
              - Pending
              - Succeeded
              - Failed
              - Claimable
              - Claiming
              - Cancelled
          description: Return only payments with this HTLC status.
        - in: query
          name: direction
          required: false
          schema:
            type: string
            enum:
              - Inbound
              - Outbound
          description: Return only inbound or only outbound payments.
        - in: query
          name: created_after
          required: false
          schema:
            type: integer
            format: uint64
          description: >-
            Return only payments created at or after this Unix timestamp
            (seconds).
        - in: query
          name: created_before
          required: false
          schema:
            type: integer
            format: uint64
          description: >-
            Return only payments created at or before this Unix timestamp
            (seconds).
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPaymentsResponse'
  /listpeers:
    get:
      tags:
        - Peers
      summary: List peers
      description: List the node's LN peers
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPeersResponse'
  /listswaps:
    get:
      tags:
        - Swaps
      summary: List swaps
      description: List the node's swaps
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSwapsResponse'
  /listtransactions:
    post:
      tags:
        - On-chain
      summary: List transactions
      description: >-
        List the node's on-chain transactions, ordered most-recent first.
        Supports index-based cursor pagination: pass the last_index_offset of a
        page as the next index_offset to fetch the next, older page.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListTransactionsRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTransactionsResponse'
  /listtransfers:
    post:
      tags:
        - RGB
      summary: List transfers
      description: >-
        List the node's RGB transfers, ordered most-recent first, scoped by an
        asset filter and optionally by txid. Supports index-based cursor
        pagination (idx) and optional filtering by status and creation time
        interval.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListTransfersRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTransfersResponse'
  /listunspents:
    post:
      tags:
        - On-chain
      summary: List unspents
      description: >-
        List the unspent outputs of the internal BDK wallet. Supports
        index-based cursor pagination: pass the last_index_offset of a page as
        the next index_offset to fetch the next page.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListUnspentsRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListUnspentsResponse'
  /lock:
    post:
      tags:
        - Other
      summary: Lock the node
      description: Lock an unlocked node
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /lninvoice:
    post:
      tags:
        - Invoices
      summary: Get a LN invoice
      description: >-
        Get a LN invoice to receive a payment. Provide `payment_hash` to create a HODL invoice.
        Provide `description` to include a BOLT11 description, or `description_hash` to include
        an out-of-band BOLT11 description hash (mutually exclusive).
        Provide `min_final_cltv_expiry_delta` to request an explicit inbound final CLTV policy.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LNInvoiceRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LNInvoiceResponse'
  /makerexecute:
    post:
      tags:
        - Swaps
      summary: Execute a maker swap
      description: Execute a swap on the maker side
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MakerExecuteRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /makerinit:
    post:
      tags:
        - Swaps
      summary: Init a maker swap
      description: Init a swap on the maker side
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MakerInitRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MakerInitResponse'
  /networkinfo:
    get:
      tags:
        - Other
      summary: Get network info
      description: >-
        Get the configured Bitcoin network and height. On mainnet the height is
        read from the wallet indexer on demand; an unavailable or wrong-network
        indexer returns an error. Other networks report the LDK best-block height.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInfoResponse'
  /nodeinfo:
    get:
      tags:
        - Other
      summary: Get node info
      description: >-
        Get node identity, wallet account keys and Lightning information. On mainnet,
        active Lightning counts and amounts are zero and the RGS timestamp is null.
        Lightning amounts do not represent the on-chain BTC wallet balance.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NodeInfoResponse'
  /openchannel:
    post:
      tags:
        - Channels
      summary: Open a channel
      description: Open a new LN channel (RGB-enabled when both asset_id and asset_amount are specified).
        You can optionally provide a 32 bytes temporary channel ID as a hex-encoded string.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenChannelRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenChannelResponse'
  /postassetmedia:
    post:
      tags:
        - RGB
      summary: Post an asset media
      description: Save the provided media
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PostAssetMediaRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostAssetMediaResponse'
  /provideoutofbandack:
    post:
      tags:
        - RGB
      summary: Provide an out-of-band ACK
      description: Record the out-of-band ACK received from a recipient of an outgoing transfer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProvideOutOfBandAckRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvideOutOfBandAckResponse'
  /provideoutofbandconsignment:
    post:
      tags:
        - RGB
      summary: Provide an out-of-band consignment
      description: Provide a consignment received out-of-band, as a binary upload,
        along with any media files it references (one `media` field per file)
        The consignment is validated and the matching incoming transfer(s) are processed.
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ProvideOutOfBandConsignmentRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvideOutOfBandConsignmentResponse'
  /refreshtransfers:
    post:
      tags:
        - RGB
      summary: Refresh transfers
      description: Refresh RGB pending transfers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefreshRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefreshResponse'
  /restore:
    post:
      tags:
        - Other
      summary: Restore the node
      description: Restore a node from a backup file
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestoreRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /revoketoken:
    post:
      tags:
        - Other
      summary: Revoke a token
      description: Revoke an authentication token
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RevokeTokenRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /rgbinvoice:
    post:
      tags:
        - RGB
      summary: Get an RGB invoice
      description: Get an RGB invoice to receive assets on-chain
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RgbInvoiceRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RgbInvoiceResponse'
  /rotateaddress:
    post:
      tags:
        - On-chain
      summary: Rotate the pinned Bitcoin address
      description: Advance the pinned Bitcoin address so the next `/address` call returns a fresh one. Only available when the node is started with `--reuse-addresses`; otherwise returns an `AddressReuseDisabled` error.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddressResponse'
  /sendbtc:
    post:
      tags:
        - On-chain
      summary: Send BTC
      description: Send bitcoins on-chain
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendBtcRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendBtcResponse'
  /sendonionmessage:
    post:
      tags:
        - Other
      summary: Send an onion message
      description: Send an onion message via the LN
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendOnionMessageRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /sendpayment:
    post:
      tags:
        - Payments
      summary: Send a payment
      description: Pay the provided LN invoice
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendPaymentRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendPaymentResponse'
  /sendrgb:
    post:
      tags:
        - RGB
      summary: Send RGB assets
      description: Send RGB assets on-chain, supporting batch transfers to multiple recipients and/or multiple assets in a single transaction
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendRgbRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendRgbResponse'
  /shutdown:
    post:
      tags:
        - Other
      summary: Shutdown the node
      description: Gracefully shutdown the node
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /signmessage:
    post:
      tags:
        - Other
      summary: Sign a message
      description: Sign the provided message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SignMessageRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignMessageResponse'
  /sync:
    post:
      tags:
        - RGB
      summary: Sync the RGB wallet
      description: Sync the RGB wallet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SyncRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /taker:
    post:
      tags:
        - Swaps
      summary: Accept a swap
      description: Accept a swap on the taker side
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TakerRequest'
      responses:
        '403':
          $ref: '#/components/responses/LightningUnsupportedOnMainnet'
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /unlock:
    post:
      tags:
        - Other
      summary: Unlock the node
      description: >-
        Unlock a locked node. Mainnet starts wallet, signer and configured RGB backup
        services without constructing or starting LDK. The required ldk_chain_sync
        payload is parsed but its backend and gossip settings are unused on mainnet.
        Existing Lightning records remain inactive without preventing wallet unlock.
        Node-store persistence updates only common configuration; historical Lightning
        records and their pending replication are preserved. RGB wallet backup and
        restore retain their separate store. The supported rollout assumes no unresolved
        historical mainnet Lightning obligations. Unlock does not verify that assumption,
        inspect other devices or remote histories, or monitor old channels.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnlockRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /vssbackup:
    post:
      tags:
        - Other
      summary: Trigger a manual VSS backup of the RGB wallet
      description: >
        Builds a zip of the current RGB wallet directory and uploads it to the
        configured VSS server. Only available when the node was started with
        --vss-url. The node's active KV state is replicated automatically on every
        persistence event and is not affected by this endpoint. On mainnet only
        common configuration is replicated; historical Lightning state remains inactive.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                required:
                  - version
                properties:
                  version:
                    type: integer
                    format: int64
                    description: Server-side version of the just-uploaded RGB wallet backup.
        '503':
          description: VSS is not configured or unreachable
  /vssbackupinfo:
    get:
      tags:
        - Other
      summary: Inspect VSS backup status
      description: >
        Returns whether a backup exists on the server, its server-side version,
        whether the local wallet has changes since the last backup, and how
        many KV-stream writes are queued for retry after a replication
        failure. On mainnet this counts common configuration retries only, excluding
        preserved historical Lightning intents. Read-only; callable by tokens with
        the read-only role.
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                required:
                  - backup_exists
                  - backup_required
                  - pending_kv_writes
                properties:
                  backup_exists:
                    type: boolean
                    description: True if the VSS server has a backup for this wallet.
                  server_version:
                    type: integer
                    format: int64
                    nullable: true
                    description: Server-side version of the most recent backup, if any.
                  backup_required:
                    type: boolean
                    description: >
                      True if the local wallet has changes since the last
                      successful upload (i.e. a manual backup is needed).
                  last_auto_backup_error:
                    type:
                      - string
                      - 'null'
                    description: Most recent automatic VSS backup error, if any.
                  pending_kv_writes:
                    type: integer
                    description: >
                      Number of KV writes that failed to replicate and are
                      queued for retry. A persistently non-zero value
                      indicates VSS replication is degraded. On mainnet this excludes
                      inactive historical Lightning intents.
        '503':
          description: VSS is not configured or unreachable
  /vssclearfence:
    post:
      tags:
        - Other
      summary: Clear the VSS single-writer fence so a fresh instance can take over
      description: >
        Deletes the `__rln_instance__` key from VSS. The fence is acquired on
        `/unlock` and intentionally persists across shutdowns to prevent two
        concurrent writers from corrupting state, so a legitimate
        wipe-and-restore on the same VSS store_id must clear it first. Must be
        called while the node is locked; the subsequent `/unlock` will claim a
        new fence and run the restore. Idempotent — succeeds even if no fence
        is present.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - password
              properties:
                password:
                  type: string
                  description: Wallet password; used to decrypt the mnemonic and
                    derive the VSS signing key (required to authenticate the
                    delete with the VSS server).
      responses:
        '200':
          description: Fence cleared (or no fence was present)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '403':
          description: Node is unlocked or password is wrong
        '503':
          description: VSS is not configured or unreachable
components:
  responses:
    LightningUnsupportedOnMainnet:
      description: Lightning APIs are unavailable on a node configured for mainnet.
      content:
        application/json:
          schema:
            type: object
            required: [name, code, error]
            properties:
              name:
                type: string
              code:
                type: integer
              error:
                type: string
          example:
            name: LightningUnsupportedOnMainnet
            code: 403
            error: RLN on mainnet currently supports only on-chain methods. Lightning APIs are not supported.
  schemas:
    AddressResponse:
      type: object
      required:
        - address
      properties:
        address:
          type: string
          example: bcrt1qnc5y6j6dmejrkwy93farhvpezk0lf46gk7aecs
    AsyncOrderNewHash:
      type: object
      required:
        - hash_index
        - payment_hash
      properties:
        hash_index:
          type: integer
          example: 1
        payment_hash:
          type: string
          example: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
    AsyncOrderNewRequest:
      type: object
      required:
        - host_node_id
      dependentRequired:
        username:
          - domain
        domain:
          - username
      properties:
        host_node_id:
          type: string
          example: 02123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0
        username:
          type: string
          description: >-
            Optional. LSP-assigned Lightning Address localpart. When supplied together with `domain`,
            the recipient signs a `recipient_pubkey <-> username@domain` address attestation and includes it with the order.
            Source it from the LSP's `GET /lightning_address/by_pubkey/{pubkey}` so it matches what the LSP serves.
          example: xalkan
        domain:
          type: string
          description: >-
            Optional. Lightning Address domain; required together with `username` to produce the address attestation.
          example: utexo.com
    AsyncOrderNewResponse:
      type: object
      required:
        - request_id
        - host_node_id
        - protocol_version
        - order_id
        - status
        - accepted_through_index
        - next_index_expected
        - unused_hashes
        - refill_batch_size
        - first_hash_index
        - last_hash_index
        - hashes
      properties:
        request_id:
          type: string
          example: 3aebcbb3-1230-4e78-933f-cdfba5ac9f30
        host_node_id:
          type: string
          example: 02123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef0
        protocol_version:
          type: integer
          example: 1
        order_id:
          type: string
          example: '1'
        status:
          type: string
          example: active
        accepted_through_index:
          type: integer
          example: 200
        next_index_expected:
          type: integer
          example: 201
        unused_hashes:
          type: integer
          example: 200
        refill_batch_size:
          type: integer
          example: 200
        first_hash_index:
          type: integer
          example: 1
        last_hash_index:
          type: integer
          example: 200
        hashes:
          type: array
          items:
            $ref: '#/components/schemas/AsyncOrderNewHash'
    AsyncOrderOutboundInvoiceRequest:
      type: object
      required:
        - client_node_id
        - params
      properties:
        client_node_id:
          type: string
          example: 02270dadcd6e7ba0ef707dac72acccae1a3607453a8dd2aef36ff3be4e0d31f043
        params:
          $ref: '#/components/schemas/AsyncOrderRequestInvoiceParams'
    AsyncOrderOutboundInvoiceResponse:
      type: object
      required:
        - payment_hash
        - bolt11
      properties:
        payment_hash:
          type: string
          example: abababababababababababababababababababababababababababababababab
        bolt11:
          type: string
          example: lnbc1test
    AsyncOrderRequestInvoiceParams:
      type: object
      required:
        - hash_index
        - payment_hash
        - amount_msat
        - description_hash
        - invoice_expiry_sec
        - min_final_cltv_expiry_delta
      properties:
        hash_index:
          type: string
          example: '42'
        payment_hash:
          type: string
          example: abababababababababababababababababababababababababababababababab
        amount_msat:
          type: integer
          example: 99000
        asset_id:
          type:
            - string
            - 'null'
          example: rgb:EIkAVQvq-WbAb5JG-CYxbUER-oqDNwne-ZNxBDID-p0cpf9U
        asset_amount:
          type:
            - integer
            - 'null'
          example: 10
        description_hash:
          type: string
          example: 5ca5d81b482b4015e7b14df7a27fe0a38c226273604ffd3b008b752571811938
        invoice_expiry_sec:
          type: integer
          example: 900
        min_final_cltv_expiry_delta:
          type: integer
          example: 18
    AssetBalanceRequest:
      type: object
      required:
        - asset_id
      properties:
        asset_id:
          type: string
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
    AssetBalanceResponse:
      type: object
      required:
        - settled
        - future
        - spendable
        - offchain_outbound
        - offchain_inbound
      properties:
        settled:
          type: integer
          example: 777
        future:
          type: integer
          example: 777
        spendable:
          type: integer
          example: 777
        offchain_outbound:
          type: integer
          example: 444
        offchain_inbound:
          type: integer
          example: 0
    AssetCFA:
      type: object
      required:
        - asset_id
        - name
        - precision
        - issued_supply
        - timestamp
        - added_at
        - balance
      properties:
        asset_id:
          type: string
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        name:
          type: string
          example: Collectible
        details:
          type:
            - string
            - 'null'
          example: asset details
        precision:
          type: integer
          example: 0
        issued_supply:
          type: integer
          example: 777
        timestamp:
          type: integer
          example: 1691160565
        added_at:
          type: integer
          example: 1691161979
        balance:
          $ref: '#/components/schemas/AssetBalanceResponse'
        media:
          oneOf:
            - $ref: '#/components/schemas/Media'
            - type: 'null'
    AssetFilter:
      oneOf:
        - $ref: '#/components/schemas/AssetFilterAnyOrNone'
        - $ref: '#/components/schemas/AssetFilterNone'
        - $ref: '#/components/schemas/AssetFilterId'
      discriminator:
        propertyName: type
        mapping:
          AnyOrNone: '#/components/schemas/AssetFilterAnyOrNone'
          None: '#/components/schemas/AssetFilterNone'
          Id: '#/components/schemas/AssetFilterId'
    AssetFilterAnyOrNone:
      type: object
      required:
        - type
      properties:
        type:
          type: string
          enum: [AnyOrNone]
    AssetFilterId:
      type: object
      required:
        - type
        - value
      properties:
        type:
          type: string
          enum: [Id]
        value:
          type: string
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
      example:
        type: Id
        value: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
    AssetFilterNone:
      type: object
      required:
        - type
      properties:
        type:
          type: string
          enum: [None]
    AssetIFA:
      type: object
      required:
        - asset_id
        - ticker
        - name
        - precision
        - initial_supply
        - max_supply
        - known_circulating_supply
        - timestamp
        - added_at
        - balance
      properties:
        asset_id:
          type: string
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        ticker:
          type: string
          example: USDT
        name:
          type: string
          example: Tether
        details:
          type:
            - string
            - 'null'
          example: asset details
        precision:
          type: integer
          example: 0
        initial_supply:
          type: integer
          example: 777
        max_supply:
          type: integer
          example: 999
        known_circulating_supply:
          type: integer
          example: 888
        timestamp:
          type: integer
          example: 1691160565
        added_at:
          type: integer
          example: 1691161979
        balance:
          $ref: '#/components/schemas/AssetBalanceResponse'
        media:
          oneOf:
            - $ref: '#/components/schemas/Media'
            - type: 'null'
        reject_list_url:
          type:
            - string
            - 'null'
          example: https://some.domain/someasset/rejectlist
        issuance_link_right_outpoint:
          oneOf:
            - $ref: '#/components/schemas/Outpoint'
            - type: 'null'
        linked_from_asset_id:
          type:
            - string
            - 'null'
        linked_to_asset_id:
          type:
            - string
            - 'null'
    AssetBFA:
      type: object
      required:
        - asset_id
        - ticker
        - name
        - precision
        - initial_supply
        - timestamp
        - added_at
        - balance
      properties:
        asset_id:
          type: string
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        ticker:
          type: string
          example: USDT
        name:
          type: string
          example: Tether
        details:
          type:
            - string
            - 'null'
          example: asset details
        precision:
          type: integer
          example: 6
        initial_supply:
          type: integer
          example: 777
        timestamp:
          type: integer
          example: 1691160565
        added_at:
          type: integer
          example: 1691161979
        balance:
          $ref: '#/components/schemas/AssetBalanceResponse'
        media:
          oneOf:
            - $ref: '#/components/schemas/Media'
            - type: 'null'
        reject_list_url:
          type:
            - string
            - 'null'
          example: https://some.domain/someasset/rejectlist
    AssetLinkRequest:
      type: object
      required:
        - parent_asset_id
        - child_asset_id
        - min_confirmations
      properties:
        parent_asset_id:
          type: string
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        child_asset_id:
          type: string
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ9
        min_confirmations:
          type: integer
          example: 1
    AssetLinkResponse:
      type: object
      required:
        - parent_asset_id
        - child_asset_id
        - created_at
        - txid
      properties:
        parent_asset_id:
          type: string
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        child_asset_id:
          type:
            - string
            - 'null'
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ9
        created_at:
          type:
            - integer
            - 'null'
          example: 1691160565
        txid:
          type:
            - string
            - 'null'
          example: 4b0d1f2c0d8a4e8d7e5e3f8f5a6b7c8d9e0f102132435465768798a9b0c1d2e3
    AssetMetadataRequest:
      type: object
      required:
        - asset_id
      properties:
        asset_id:
          type: string
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
    AssetMetadataResponse:
      type: object
      required:
        - asset_schema
        - initial_supply
        - max_supply
        - known_circulating_supply
        - timestamp
        - name
        - precision
      properties:
        asset_schema:
          $ref: '#/components/schemas/AssetSchema'
        initial_supply:
          type: integer
          example: 777
        max_supply:
          type: integer
          example: 777
        known_circulating_supply:
          type: integer
          example: 777
        timestamp:
          type: integer
          example: 1691160565
        name:
          type: string
          example: Collectible
        precision:
          type: integer
          example: 0
        ticker:
          type:
            - string
            - 'null'
          example: USDT
        details:
          type:
            - string
            - 'null'
          example: asset details
        token:
          oneOf:
            - $ref: '#/components/schemas/Token'
            - type: 'null'
        linked_from_asset_id:
          type:
            - string
            - 'null'
        linked_to_asset_id:
          type:
            - string
            - 'null'
        unspent_link_right_outpoint:
          oneOf:
            - $ref: '#/components/schemas/Outpoint'
            - type: 'null'
    AssetNIA:
      type: object
      required:
        - asset_id
        - ticker
        - name
        - precision
        - issued_supply
        - timestamp
        - added_at
        - balance
      properties:
        asset_id:
          type: string
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        ticker:
          type: string
          example: USDT
        name:
          type: string
          example: Tether
        details:
          type:
            - string
            - 'null'
          example: asset details
        precision:
          type: integer
          example: 0
        issued_supply:
          type: integer
          example: 777
        timestamp:
          type: integer
          example: 1691160565
        added_at:
          type: integer
          example: 1691161979
        balance:
          $ref: '#/components/schemas/AssetBalanceResponse'
        media:
          oneOf:
            - $ref: '#/components/schemas/Media'
            - type: 'null'
    AssetSchema:
      type: string
      enum:
        - Nia
        - Uda
        - Cfa
        - Ifa
        - Bfa
    AssetUDA:
      type: object
      required:
        - asset_id
        - ticker
        - name
        - precision
        - timestamp
        - added_at
        - balance
      properties:
        asset_id:
          type: string
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        ticker:
          type: string
          example: UNI
        name:
          type: string
          example: Unique
        details:
          type:
            - string
            - 'null'
          example: asset details
        precision:
          type: integer
          example: 0
        timestamp:
          type: integer
          example: 1691160565
        added_at:
          type: integer
          example: 1691161979
        balance:
          $ref: '#/components/schemas/AssetBalanceResponse'
        token:
          oneOf:
            - $ref: '#/components/schemas/TokenLight'
            - type: 'null'
    Assignment:
      oneOf:
        - $ref: '#/components/schemas/AssignmentFungible'
        - $ref: '#/components/schemas/AssignmentNonFungible'
        - $ref: '#/components/schemas/AssignmentInflationRight'
        - $ref: '#/components/schemas/AssignmentAny'
        - $ref: '#/components/schemas/AssignmentBridgeRight'
      discriminator:
        propertyName: type
        mapping:
          Fungible: '#/components/schemas/AssignmentFungible'
          NonFungible: '#/components/schemas/AssignmentNonFungible'
          InflationRight: '#/components/schemas/AssignmentInflationRight'
          Any: '#/components/schemas/AssignmentAny'
          BridgeRight: '#/components/schemas/AssignmentBridgeRight'
    AssignmentAny:
      type: object
      required:
        - type
      properties:
        type:
          type: string
          enum: [Any]
    AssignmentBridgeRight:
      type: object
      required:
        - type
      properties:
        type:
          type: string
          enum: [BridgeRight]
    AssignmentFungible:
      type: object
      required:
        - type
        - value
      properties:
        type:
          type: string
          enum: [Fungible]
        value:
          type: integer
          example: 42
      example:
        type: Fungible
        value: 42
    AssignmentInflationRight:
      type: object
      required:
        - type
        - value
      properties:
        type:
          type: string
          enum: [InflationRight]
        value:
          type: integer
          example: 200
    AssignmentNonFungible:
      type: object
      required:
        - type
      properties:
        type:
          type: string
          enum: [NonFungible]
    BackupRequest:
      type: object
      required:
        - backup_path
        - password
      properties:
        backup_path:
          type: string
          example: /path/where/to/save/the/backup/file
        password:
          type: string
          example: nodepassword
    BitcoinNetwork:
      type: string
      example: Regtest
      enum:
        - Mainnet
        - Testnet
        - Testnet4
        - Signet
        - SignetCustom
        - Regtest
    Outpoint:
      type: object
      required:
        - txid
        - vout
      properties:
        txid:
          type: string
          example: 4b0d1f2c0d8a4e8d7e5e3f8f5a6b7c8d9e0f102132435465768798a9b0c1d2e3
        vout:
          type: integer
          format: int32
          example: 0
    BlockTime:
      type: object
      required:
        - height
        - timestamp
      properties:
        height:
          type: integer
          example: 805434
        timestamp:
          type: integer
          example: 1691160659
    BtcBalance:
      type: object
      required:
        - settled
        - future
        - spendable
      properties:
        settled:
          type: integer
          example: 777000
        future:
          type: integer
          example: 777000
        spendable:
          type: integer
          example: 777000
    BtcBalanceRequest:
      type: object
      required:
        - skip_sync
      properties:
        skip_sync:
          type: boolean
          example: false
    BtcBalanceResponse:
      type: object
      required:
        - vanilla
        - colored
      properties:
        vanilla:
          $ref: '#/components/schemas/BtcBalance'
        colored:
          $ref: '#/components/schemas/BtcBalance'
    CancelHodlInvoiceRequest:
      type: object
      required:
        - payment_hash
      properties:
        payment_hash:
          type: string
          example: 3febfae1e68b190c15461f4c2a3290f9af1dae63fd7d620d2bd61601869026cd
    ChangePasswordRequest:
      type: object
      required:
        - old_password
        - new_password
      properties:
        old_password:
          type: string
          example: nodepassword
        new_password:
          type: string
          example: nodenewpassword
    Channel:
      type: object
      required:
        - channel_id
        - peer_pubkey
        - status
        - ready
        - capacity_sat
        - local_balance_sat
        - outbound_balance_msat
        - inbound_balance_msat
        - next_outbound_htlc_limit_msat
        - next_outbound_htlc_minimum_msat
        - is_usable
        - public
      properties:
        channel_id:
          type: string
          example: 8129afe1b1d7cf60d5e1bf4c04b09bec925ed4df5417ceee0484e24f816a105a
        funding_txid:
          type:
            - string
            - 'null'
          example: 5a106a814fe28404eece1754dfd45e92ec9bb0044cbfe1d560cfd7b1e1af2981
        peer_pubkey:
          type: string
          example: 03b79a4bc1ec365524b4fab9a39eb133753646babb5a1da5c4bc94c53110b7795d
        peer_alias:
          type:
            - string
            - 'null'
          example: null
        short_channel_id:
          type:
            - integer
            - 'null'
          example: 120946279120896
        status:
          $ref: '#/components/schemas/ChannelStatus'
        ready:
          type: boolean
          example: false
        capacity_sat:
          type: integer
          example: 30010
        local_balance_sat:
          type: integer
          example: 28616
        outbound_balance_msat:
          type: integer
          example: 21616000
        inbound_balance_msat:
          type: integer
          example: 6394000
        next_outbound_htlc_limit_msat:
          type: integer
          example: 3001000
        next_outbound_htlc_minimum_msat:
          type: integer
          example: 1
        is_usable:
          type: boolean
          example: false
        public:
          type: boolean
          example: true
        asset_id:
          type:
            - string
            - 'null'
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        asset_local_amount:
          type:
            - integer
            - 'null'
          example: 777
        asset_remote_amount:
          type:
            - integer
            - 'null'
          example: 0
        virtual_open_mode:
          type: string
          example: trusted_no_broadcast
    ChannelStatus:
      type: string
      enum:
        - Opening
        - Opened
        - Closing
    CheckIndexerUrlRequest:
      type: object
      required:
        - indexer_url
      properties:
        indexer_url:
          type: string
          example: 127.0.0.1:50001
    CheckIndexerUrlResponse:
      type: object
      required:
        - indexer_protocol
      properties:
        indexer_protocol:
          $ref: '#/components/schemas/IndexerProtocol'
    CheckProxyEndpointRequest:
      type: object
      required:
        - proxy_endpoint
      properties:
        proxy_endpoint:
          type: string
          example: rpc://127.0.0.1:3000/json-rpc
    ClaimHodlInvoiceRequest:
      type: object
      required:
        - payment_hash
        - payment_preimage
      properties:
        payment_hash:
          type: string
          example: b4cb2da889477082a2e47f37a07e646e60ef6f97ffa7a4d88c823efd673da94b
        payment_preimage:
          type: string
          example: eade701c7b23b8799465f4284ad84710fc16a776fbc6483001291149122695a8
    ClaimHodlInvoiceResponse:
      type: object
      properties:
        changed:
          type: boolean
          example: true
    CloseChannelRequest:
      type: object
      required:
        - channel_id
        - peer_pubkey
        - force
      properties:
        channel_id:
          type: string
          example: 8129afe1b1d7cf60d5e1bf4c04b09bec925ed4df5417ceee0484e24f816a105a
        peer_pubkey:
          type: string
          example: 03b79a4bc1ec365524b4fab9a39eb133753646babb5a1da5c4bc94c53110b7795d
        force:
          type: boolean
          example: false
    ConnectPeerRequest:
      type: object
      required:
        - peer_pubkey_and_addr
      properties:
        peer_pubkey_and_addr:
          type: string
          example: 03b79a4bc1ec365524b4fab9a39eb133753646babb5a1da5c4bc94c53110b7795d@localhost:9736
    CreateUtxosRequest:
      type: object
      required:
        - up_to
        - fee_rate
        - skip_sync
      properties:
        up_to:
          type: boolean
          example: false
        num:
          type:
            - integer
            - 'null'
          example: 4
        size:
          type:
            - integer
            - 'null'
          example: 32500
        fee_rate:
          type: integer
          example: 5
        skip_sync:
          type: boolean
          example: false
    DecodeLNInvoiceRequest:
      type: object
      required:
        - invoice
      properties:
        invoice:
          type: string
          example: lnbcrt30u1pjv6yzndqud3jxktt5w46x7unfv9kz6mn0v3jsnp4qdpc280eur52luxppv6f3nnj8l6vnd9g2hnv3qv6mjhmhvlzf6327pp5tjjasx6g9dqptea3fhm6yllq5wxzycnnvp8l6wcq3d6j2uvpryuqsp5l8az8x3g8fe05dg7cmgddld3da09nfjvky8xftwsk4cj8p2l7kfq9qyysgqcqpcxqzdylzlwfnkyw3jv344x4rzwgkk53ng0fhxy5rdduk4g5tpvea8xa6rfckkza35va28xjn2tqkhgarcxep5umm4x5k56wfcdvu95eq7qzp20vrl4xz76syapsa3c09j7lg5gerkaj63llj0ark7ph8hfketn6fkqzm8laf66dhsncm23wkwm5l5377we9e8lnlknnkwje5eefkccusqm6rqt8
    DecodeLNInvoiceResponse:
      type: object
      required:
        - expiry_sec
        - timestamp
        - payment_hash
        - payment_secret
        - min_final_cltv_expiry_delta
        - network
      properties:
        amt_msat:
          type:
            - integer
            - 'null'
          example: 3000000
        expiry_sec:
          type: integer
          example: 420
        timestamp:
          type: integer
          example: 1691160659
        asset_id:
          type:
            - string
            - 'null'
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        asset_amount:
          type:
            - integer
            - 'null'
          example: 42
        description:
          type:
            - string
            - 'null'
          example: 1 cup of coffee
        description_hash:
          type:
            - string
            - 'null'
          example: 5ca5d81b482b4015e7b14df7a27fe0a38c226273604ffd3b008b752571811938
        payment_hash:
          type: string
          example: 5ca5d81b482b4015e7b14df7a27fe0a38c226273604ffd3b008b752571811938
        payment_secret:
          type: string
          example: f9fa239a283a72fa351ec6d0d6fdb16f5e59a64cb10e64add0b57123855ff592
        payee_pubkey:
          type:
            - string
            - 'null'
          example: 0343851df9e0e8aff0c10b3498ce723ff4c9b4a855e6c8819adcafbbb3e24ea2af
        min_final_cltv_expiry_delta:
          type: integer
          example: 144
        network:
          $ref: '#/components/schemas/BitcoinNetwork'
    DecodeRGBInvoiceRequest:
      type: object
      required:
        - invoice
      properties:
        invoice:
          type: string
          example: rgb:icfqnK9y-wObZKTu-XJcDL98-sKbE5Mh-OuDJhiI-brRJrzE/RWhwUfTMpuP2Zfx1~j4nswCANGeJrYOqDcKelaMV4zU/~/bcrt:utxob:cbgHUJ4e-7QyKY4U-Jsj5AZw-oI0gxZh-7fxQY2_-tFFUAZN-4CgpX?expiry=1749906951&endpoints=rpcs://proxy.iriswallet.com/0.2/json-rpc
    DecodeRGBInvoiceResponse:
      type: object
      required:
        - recipient_id
        - proxy_recipient_id
        - recipient_type
        - assignment
        - network
        - transport_endpoints
        - unknown_query_params
      properties:
        recipient_id:
          type: string
          example: bcrt:utxob:cbgHUJ4e-7QyKY4U-Jsj5AZw-oI0gxZh-7fxQY2_-tFFUAZN-4CgpX
        proxy_recipient_id:
          type: string
          example: bcrt:utxob:cbgHUJ4e-7QyKY4U-Jsj5AZw-oI0gxZh-7fxQY2_-tFFUAZN-4CgpY
        recipient_type:
          $ref: '#/components/schemas/RecipientType'
        asset_schema:
          oneOf:
            - $ref: '#/components/schemas/AssetSchema'
            - type: 'null'
        asset_id:
          type:
            - string
            - 'null'
          example: rgb:icfqnK9y-wObZKTu-XJcDL98-sKbE5Mh-OuDJhiI-brRJrzE
        assignment:
          $ref: '#/components/schemas/Assignment'
        network:
          $ref: '#/components/schemas/BitcoinNetwork'
        expiration_timestamp:
          type:
            - integer
            - 'null'
          example: 1698325849
        transport_endpoints:
          type: array
          items:
            type: string
            example: rpcs://proxy.iriswallet.com/0.2/json-rpc
        unknown_query_params:
          type: object
          additionalProperties:
            type: string
          example: {}
    DecodeSwapstringRequest:
      type: object
      required:
        - swapstring
      properties:
        swapstring:
          type: string
          example: 30/rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8/10/rgb:icfqnK9y-wObZKTu-XJcDL98-sKbE5Mh-OuDJhiI-brRJrzE/1715896416/9d342c6ba006e24abee84a2e034a22d5e30c1f2599fb9c3574d46d3cde3d65a2
    DecodeSwapstringResponse:
      type: object
      required:
        - qty_from
        - qty_to
        - expiry
        - payment_hash
      properties:
        qty_from:
          type: integer
          example: 30
        qty_to:
          type: integer
          example: 10
        from_asset:
          type:
            - string
            - 'null'
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        to_asset:
          type:
            - string
            - 'null'
          example: rgb:icfqnK9y-wObZKTu-XJcDL98-sKbE5Mh-OuDJhiI-brRJrzE
        expiry:
          type: integer
          example: 1715896416
        payment_hash:
          type: string
          example: 9d342c6ba006e24abee84a2e034a22d5e30c1f2599fb9c3574d46d3cde3d65a2
    DisconnectPeerRequest:
      type: object
      required:
        - peer_pubkey
      properties:
        peer_pubkey:
          type: string
          example: 03b79a4bc1ec365524b4fab9a39eb133753646babb5a1da5c4bc94c53110b7795d
    EmbeddedMedia:
      type: object
      required:
        - mime
        - data
      properties:
        mime:
          type: string
          example: text/plain
        data:
          type: array
          items:
            type: integer
          example: [82, 76, 78]
    EmptyResponse:
      type: object
    EstimateFeeRequest:
      type: object
      required:
        - blocks
      properties:
        blocks:
          type: integer
          example: 7
    EstimateFeeResponse:
      type: object
      required:
        - fee_rate
      properties:
        fee_rate:
          type: number
          example: 9.3
    FailTransfersRequest:
      type: object
      required:
        - no_asset_only
        - skip_sync
      properties:
        batch_transfer_idx:
          type:
            - integer
            - 'null'
          example: null
        no_asset_only:
          type: boolean
          example: false
        skip_sync:
          type: boolean
          example: false
    FailTransfersResponse:
      type: object
      required:
        - transfers_changed
      properties:
        transfers_changed:
          type: boolean
          example: true
    GetAssetMediaRequest:
      type: object
      required:
        - digest
      properties:
        digest:
          type: string
          example: 5891b5b522d5df086d0ff0b110fbd9d21bb4fc7163af34d08286a2e846f6be03
    GetAssetMediaResponse:
      type: object
      required:
        - bytes_hex
      properties:
        bytes_hex:
          type: string
          example: 68656c6c6f0a
    GetChannelIdRequest:
      type: object
      required:
        - temporary_channel_id
      properties:
        temporary_channel_id:
          type: string
          example: a8b60c8ce3067b5fc881d4831323e24751daec3b64353c8df3205ec5d838f1c5
    GetChannelIdResponse:
      type: object
      required:
        - channel_id
      properties:
        channel_id:
          type: string
          example: 8129afe1b1d7cf60d5e1bf4c04b09bec925ed4df5417ceee0484e24f816a105a
    GetConsignmentRequest:
      type: object
      required:
        - asset_id
        - txid
      properties:
        asset_id:
          type: string
          example: rgb:2dkSTbr-jFhznbPmo-TQafzswCN-av4gTsJjX-ttx6CNou5-M98k8Zt
        txid:
          type: string
          example: 33cf3e42fb1c6faa0d47e6a498a9d4e5c56e8a06ea0d295c6d90e2b6c85f7a1e
    GetConsignmentResponse:
      type: object
      required:
        - bytes_hex
      properties:
        bytes_hex:
          type: string
          example: 52474200
    GetPaymentRequest:
      type: object
      required:
        - payment_hash
        - payment_type
      properties:
        payment_hash:
          type: string
          example: 5ca5d81b482b4015e7b14df7a27fe0a38c226273604ffd3b008b752571811938
        payment_type:
          $ref: '#/components/schemas/PaymentType'
    GetPaymentResponse:
      type: object
      required:
        - payment
      properties:
        payment:
          $ref: '#/components/schemas/Payment'
    GetSwapRequest:
      type: object
      required:
        - payment_hash
        - taker
      properties:
        payment_hash:
          type: string
          example: 5ca5d81b482b4015e7b14df7a27fe0a38c226273604ffd3b008b752571811938
        taker:
          type: boolean
          example: false
    GetSwapResponse:
      type: object
      required:
        - swap
      properties:
        swap:
          $ref: '#/components/schemas/Swap'
    HTLCStatus:
      type: string
      enum:
        - Pending
        - Claimable
        - Claiming
        - Succeeded
        - Cancelled
        - Failed
    IndexerProtocol:
      type: string
      enum:
        - Electrum
        - Esplora
    BurnRequest:
      type: object
      required:
        - asset_id
        - amount
        - fee_rate
        - min_confirmations
      properties:
        asset_id:
          type: string
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        amount:
          type: integer
          example: 100
        burn_recipient:
          type:
            - string
            - 'null'
          description: Hex-encoded 32-byte recipient of the burned amount, required for BFA assets
          example: 000000000000000000000000f39fd6e51aad88f6f4ce6ab8827279cfffb92266
        fee_rate:
          type: integer
          example: 5
        min_confirmations:
          type: integer
          example: 1
    BurnResponse:
      type: object
      required:
        - txid
        - batch_transfer_idx
      properties:
        txid:
          type: string
          example: 7c2c95b9c2aa0a7d140495b664de7973b76561de833f0dd84def3efa08941664
        batch_transfer_idx:
          type: integer
          example: 1
    InflateRequest:
      type: object
      required:
        - asset_id
        - inflation_amounts
        - fee_rate
        - min_confirmations
      properties:
        asset_id:
          type: string
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        inflation_amounts:
          type: array
          items:
            type: integer
          minItems: 1
          example: [ 100, 50 ]
        fee_rate:
          type: integer
          example: 5
        min_confirmations:
          type: integer
          example: 1
    InflateResponse:
      type: object
      required:
        - txid
      properties:
        txid:
          type: string
          example: 7c2c95b9c2aa0a7d140495b664de7973b76561de833f0dd84def3efa08941664
    InitRequest:
      type: object
      required:
        - password
      properties:
        password:
          type: string
          example: nodepassword
        mnemonic:
          type:
            - string
            - 'null'
          example: skill lamp please gown put season degree collect decline account monitor insane
    InitResponse:
      type: object
      required:
        - mnemonic
      properties:
        mnemonic:
          type: string
          example: skill lamp please gown put season degree collect decline account monitor insane
    InvoiceStatus:
      type: string
      enum:
        - Pending
        - Claimable
        - Claiming
        - Succeeded
        - Cancelled
        - Failed
        - Expired
    InvoiceStatusRequest:
      type: object
      required:
        - invoice
      properties:
        invoice:
          type: string
          example: lnbcrt30u1pjv6yzndqud3jxktt5w46x7unfv9kz6mn0v3jsnp4qdpc280eur52luxppv6f3nnj8l6vnd9g2hnv3qv6mjhmhvlzf6327pp5tjjasx6g9dqptea3fhm6yllq5wxzycnnvp8l6wcq3d6j2uvpryuqsp5l8az8x3g8fe05dg7cmgddld3da09nfjvky8xftwsk4cj8p2l7kfq9qyysgqcqpcxqzdylzlwfnkyw3jv344x4rzwgkk53ng0fhxy5rdduk4g5tpvea8xa6rfckkza35va28xjn2tqkhgarcxep5umm4x5k56wfcdvu95eq7qzp20vrl4xz76syapsa3c09j7lg5gerkaj63llj0ark7ph8hfketn6fkqzm8laf66dhsncm23wkwm5l5377we9e8lnlknnkwje5eefkccusqm6rqt8
    InvoiceStatusResponse:
      type: object
      required:
        - status
      properties:
        status:
          $ref: '#/components/schemas/InvoiceStatus'
    IssueAssetCFARequest:
      type: object
      required:
        - amounts
        - name
        - precision
      properties:
        amounts:
          type: array
          items:
            type: integer
          example: [ 1000, 600 ]
        name:
          type: string
          example: Tether
        details:
          type:
            - string
            - 'null'
          example: asset details
        precision:
          type: integer
          example: 0
        file_digest:
          type:
            - string
            - 'null'
          example: 5891b5b522d5df086d0ff0b110fbd9d21bb4fc7163af34d08286a2e846f6be03
    IssueAssetCFAResponse:
      type: object
      required:
        - asset
      properties:
        asset:
          $ref: '#/components/schemas/AssetCFA'
    IssueAssetIFARequest:
      type: object
      required:
        - amounts
        - inflation_amounts
        - ticker
        - name
        - precision
      properties:
        amounts:
          type: array
          items:
            type: integer
          minItems: 1
          example: [ 1000, 600 ]
        inflation_amounts:
          type: array
          items:
            type: integer
          example: [ 100, 50 ]
        ticker:
          type: string
          example: USDT
        name:
          type: string
          example: Tether
        precision:
          type: integer
          example: 0
        reject_list_url:
          type:
            - string
            - 'null'
          example: https://some.domain/someasset/rejectlist
        issuance_type:
          oneOf:
            - $ref: '#/components/schemas/IfaIssuanceType'
            - type: 'null'
    IssueAssetIFAResponse:
      type: object
      required:
        - asset
      properties:
        asset:
          $ref: '#/components/schemas/AssetIFA'
    IfaIssuanceType:
      oneOf:
        - $ref: '#/components/schemas/IfaIssuanceTypeLegacy'
        - $ref: '#/components/schemas/IfaIssuanceTypeLinkRightOnly'
        - $ref: '#/components/schemas/IfaIssuanceTypeLinkedFromParent'
    IfaIssuanceTypeLegacy:
      type: string
      enum: [legacy]
    IfaIssuanceTypeLinkRightOnly:
      type: string
      enum: [linkRightOnly]
    IfaIssuanceTypeLinkedFromParent:
      type: object
      required:
        - linkedFromParent
      properties:
        linkedFromParent:
          type: object
          required:
            - contractId
          properties:
            contractId:
              type: string
              example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
            requestLinkRight:
              type: boolean
              example: true
    IssueAssetNIARequest:
      type: object
      required:
        - amounts
        - ticker
        - name
        - precision
      properties:
        amounts:
          type: array
          items:
            type: integer
          example: [ 1000, 600 ]
        ticker:
          type: string
          example: USDT
        name:
          type: string
          example: Tether
        precision:
          type: integer
          example: 0
    IssueAssetNIAResponse:
      type: object
      required:
        - asset
      properties:
        asset:
          $ref: '#/components/schemas/AssetNIA'
    IssueAssetUDARequest:
      type: object
      required:
        - ticker
        - name
        - precision
        - attachments_file_digests
      properties:
        ticker:
          type: string
          example: UNI
        name:
          type: string
          example: Unique
        details:
          type:
            - string
            - 'null'
          example: asset details
        precision:
          type: integer
          example: 0
        media_file_digest:
          type:
            - string
            - 'null'
          example: /path/to/media
        attachments_file_digests:
          type: array
          items:
            type: string
          example: [ 5891b5b522d5df086d0ff0b110fbd9d21bb4fc7163af34d08286a2e846f6be03, d7516e3a27cdf35aa9dcb323b5f556344ef7f57570be30b88de2bfd4ba339b1a ]
    IssueAssetUDAResponse:
      type: object
      required:
        - asset
      properties:
        asset:
          $ref: '#/components/schemas/AssetUDA'
    KeysendRequest:
      type: object
      required:
        - dest_pubkey
        - amt_msat
      properties:
        dest_pubkey:
          type: string
          example: 03b79a4bc1ec365524b4fab9a39eb133753646babb5a1da5c4bc94c53110b7795d
        amt_msat:
          type: integer
          example: 3000000
        asset_id:
          type:
            - string
            - 'null'
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        asset_amount:
          type:
            - integer
            - 'null'
          example: 42
    KeysendResponse:
      type: object
      required:
        - payment_hash
        - payment_preimage
        - status
      properties:
        payment_hash:
          type: string
          example: 8ffd4c0642047bc51ea01a22e6b2ede0fc001aee0e9929b2e84e41cf6589d61e
        payment_preimage:
          type: string
          example: 89d28bd306aa9bb906fd0ac31092d04c37c919a171b343083167e2a3cdc60578
        status:
          $ref: '#/components/schemas/HTLCStatus'
    LdkChainSync:
      oneOf:
        - $ref: '#/components/schemas/LdkChainSyncBlockSync'
        - $ref: '#/components/schemas/LdkChainSyncTransactionSync'
      discriminator:
        propertyName: mode
        mapping:
          BlockSync: '#/components/schemas/LdkChainSyncBlockSync'
          TransactionSync: '#/components/schemas/LdkChainSyncTransactionSync'
    LdkChainSyncBlockSync:
      type: object
      required:
        - mode
        - config
      properties:
        mode:
          type: string
          enum: [BlockSync]
        config:
          type: object
          required:
            - bitcoind_rpc_username
            - bitcoind_rpc_password
            - bitcoind_rpc_host
            - bitcoind_rpc_port
          properties:
            bitcoind_rpc_username:
              type: string
              example: user
            bitcoind_rpc_password:
              type: string
              example: password
            bitcoind_rpc_host:
              type: string
              example: localhost
            bitcoind_rpc_port:
              type: integer
              example: 18443
    LdkChainSyncTransactionSync:
      type: object
      required:
        - mode
        - config
      properties:
        mode:
          type: string
          enum: [TransactionSync]
        config:
          type: object
          required:
            - indexer_url
          properties:
            indexer_url:
              type: string
              example: 127.0.0.1:50001
    ListAssetsRequest:
      type: object
      required:
        - filter_asset_schemas
      properties:
        filter_asset_schemas:
          type: array
          items:
            $ref: '#/components/schemas/AssetSchema'
          example: [ Nia, Uda, Cfa, Ifa ]
    ListAssetsResponse:
      type: object
      required:
        - nia
        - uda
        - cfa
        - ifa
        - bfa
      properties:
        nia:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/AssetNIA'
        uda:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/AssetUDA'
        cfa:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/AssetCFA'
        ifa:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/AssetIFA'
        bfa:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/AssetBFA'
    ListChannelsResponse:
      type: object
      required:
        - channels
      properties:
        channels:
          type: array
          items:
            $ref: '#/components/schemas/Channel'
    ListPaymentsResponse:
      type: object
      required:
        - payments
        - first_index_offset
        - last_index_offset
      properties:
        payments:
          type: array
          items:
            $ref: '#/components/schemas/Payment'
        first_index_offset:
          type: integer
          format: uint64
          description: >-
            Index of the first (most recent) payment in the returned page, or 0
            when the page is empty.
          example: 100
        last_index_offset:
          type: integer
          format: uint64
          description: >-
            Index of the last (oldest) payment in the returned page, or 0 when
            the page is empty. Pass this as index_offset to fetch the next,
            older page.
          example: 51
    ListPeersResponse:
      type: object
      required:
        - peers
      properties:
        peers:
          type: array
          items:
            $ref: '#/components/schemas/Peer'
    ListSwapsResponse:
      type: object
      required:
        - maker
        - taker
      properties:
        maker:
          type: array
          items:
            $ref: '#/components/schemas/Swap'
        taker:
          type: array
          items:
            $ref: '#/components/schemas/Swap'
    ListTransactionsRequest:
      type: object
      required:
        - skip_sync
      properties:
        skip_sync:
          type: boolean
          example: false
        index_offset:
          type:
            - integer
            - 'null'
          format: uint64
          description: >-
            Exclusive upper-bound cursor: only transactions with a lower index
            are returned. 0 or absent means start from the most recent.
        max_transactions:
          type:
            - integer
            - 'null'
          format: uint64
          description: Maximum number to return. Defaults to 100 when absent or zero.
        txid:
          type:
            - string
            - 'null'
          description: Return only the on-chain transaction with this txid.
    ListTransactionsResponse:
      type: object
      required:
        - transactions
        - first_index_offset
        - last_index_offset
      properties:
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/Transaction'
        first_index_offset:
          type: integer
          format: uint64
          description: Index of the first transaction in the page, or 0 when empty.
        last_index_offset:
          type: integer
          format: uint64
          description: >-
            Index of the last transaction in the page, or 0 when empty. Pass as
            index_offset to fetch the next, older page.
    ListTransfersRequest:
      type: object
      description: >-
        asset_filter selects the asset scope: Id (that asset's transfers), None
        (only transfers not tied to an asset) or AnyOrNone (no asset
        restriction). txid further restricts the result to the transfers
        committed by that on-chain transaction, across all assets; combined
        with an Id filter it acts as an intersection. AnyOrNone without a txid
        is rejected, so narrow by asset_filter, by txid, or by both.
      required:
        - asset_filter
      properties:
        asset_filter:
          $ref: '#/components/schemas/AssetFilter'
        txid:
          type:
            - string
            - 'null'
          example: 47ee0f5b7bd5b0dd7f10ce54a94fee1b5cd54e5241b0f70f9f373d10e7a3c3e2
          description: >-
            Return the transfers committed by the on-chain transaction with this
            txid. Combined with an Id asset_filter it acts as an intersection.
        index_offset:
          type:
            - integer
            - 'null'
          format: uint64
          description: >-
            Exclusive upper-bound cursor: only transfers with a lower idx are
            returned. 0 or absent means start from the most recent.
        max_transfers:
          type:
            - integer
            - 'null'
          format: uint64
          description: Maximum number to return. Defaults to 100 when absent or zero.
        status:
          type:
            - string
            - 'null'
          enum:
            - Initiated
            - WaitingCounterparty
            - WaitingSafeHeight
            - WaitingConfirmations
            - Settled
            - Failed
            - null
          description: Return only transfers with this status.
        created_after:
          type:
            - integer
            - 'null'
          format: uint64
          description: >-
            Return only transfers created at or after this Unix timestamp
            (seconds).
        created_before:
          type:
            - integer
            - 'null'
          format: uint64
          description: >-
            Return only transfers created at or before this Unix timestamp
            (seconds).
    ListTransfersResponse:
      type: object
      required:
        - transfers
        - first_index_offset
        - last_index_offset
      properties:
        transfers:
          type: array
          items:
            $ref: '#/components/schemas/Transfer'
        first_index_offset:
          type: integer
          format: uint64
          description: Index (idx) of the first transfer in the page, or 0 when empty.
        last_index_offset:
          type: integer
          format: uint64
          description: >-
            Index (idx) of the last transfer in the page, or 0 when empty. Pass
            as index_offset to fetch the next, older page.
    ListUnspentsRequest:
      type: object
      required:
        - settled_only
        - skip_sync
      properties:
        settled_only:
          type: boolean
          example: false
        skip_sync:
          type: boolean
          example: false
        index_offset:
          type:
            - integer
            - 'null'
          format: uint64
          description: >-
            Exclusive upper-bound cursor: only unspents with a lower index are
            returned. 0 or absent means start from the first.
        max_unspents:
          type:
            - integer
            - 'null'
          format: uint64
          description: Maximum number to return. Defaults to 100 when absent or zero.
    ListUnspentsResponse:
      type: object
      required:
        - unspents
        - first_index_offset
        - last_index_offset
      properties:
        unspents:
          type: array
          items:
            $ref: '#/components/schemas/Unspent'
        first_index_offset:
          type: integer
          format: uint64
          description: Index of the first unspent in the page, or 0 when empty.
        last_index_offset:
          type: integer
          format: uint64
          description: >-
            Index of the last unspent in the page, or 0 when empty. Pass as
            index_offset to fetch the next page.
    LNInvoiceRequest:
      type: object
      required:
        - expiry_sec
      properties:
        amt_msat:
          type:
            - integer
            - 'null'
          example: 3000000
        expiry_sec:
          type: integer
          example: 420
        asset_id:
          type:
            - string
            - 'null'
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        asset_amount:
          type:
            - integer
            - 'null'
          example: 42
        payment_hash:
          type: string
          description: Optional. When provided, the invoice is created as HODL.
          example: 3febfae1e68b190c15461f4c2a3290f9af1dae63fd7d620d2bd61601869026cd
        description:
          type: string
          description: Optional. When provided, the invoice includes a BOLT11 description. Mutually exclusive with description_hash.
          example: 1 cup of coffee
        description_hash:
          type: string
          description: Optional. When provided, the invoice includes a BOLT11 description hash. Mutually exclusive with description.
          example: 5ca5d81b482b4015e7b14df7a27fe0a38c226273604ffd3b008b752571811938
        min_final_cltv_expiry_delta:
          type: integer
          description: Optional. Requested inbound final CLTV policy in blocks.
          example: 144
    LNInvoiceResponse:
      type: object
      required:
        - invoice
      properties:
        invoice:
          type: string
          example: lnbcrt30u1pjv6yzndqud3jxktt5w46x7unfv9kz6mn0v3jsnp4qdpc280eur52luxppv6f3nnj8l6vnd9g2hnv3qv6mjhmhvlzf6327pp5tjjasx6g9dqptea3fhm6yllq5wxzycnnvp8l6wcq3d6j2uvpryuqsp5l8az8x3g8fe05dg7cmgddld3da09nfjvky8xftwsk4cj8p2l7kfq9qyysgqcqpcxqzdylzlwfnkyw3jv344x4rzwgkk53ng0fhxy5rdduk4g5tpvea8xa6rfckkza35va28xjn2tqkhgarcxep5umm4x5k56wfcdvu95eq7qzp20vrl4xz76syapsa3c09j7lg5gerkaj63llj0ark7ph8hfketn6fkqzm8laf66dhsncm23wkwm5l5377we9e8lnlknnkwje5eefkccusqm6rqt8
    MakerExecuteRequest:
      type: object
      required:
        - swapstring
        - payment_secret
        - taker_pubkey
      properties:
        swapstring:
          type: string
          example: 30/rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8/10/rgb:icfqnK9y-wObZKTu-XJcDL98-sKbE5Mh-OuDJhiI-brRJrzE/1715896416/9d342c6ba006e24abee84a2e034a22d5e30c1f2599fb9c3574d46d3cde3d65a2
        payment_secret:
          type: string
          example: 777a7756c620868199ed5fdc35bee4095b5709d543e5c2bf0494396bf27d2ea2
        taker_pubkey:
          type: string
          example: 02270dadcd6e7ba0ef707dac72acccae1a3607453a8dd2aef36ff3be4e0d31f043
    MakerInitRequest:
      type: object
      required:
        - qty_from
        - qty_to
        - timeout_sec
      properties:
        qty_from:
          type: integer
          example: 30
        qty_to:
          type: integer
          example: 10
        from_asset:
          type:
            - string
            - 'null'
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        to_asset:
          type:
            - string
            - 'null'
          example: rgb:icfqnK9y-wObZKTu-XJcDL98-sKbE5Mh-OuDJhiI-brRJrzE
        timeout_sec:
          type: integer
          example: 100
    MakerInitResponse:
      type: object
      required:
        - payment_hash
        - payment_secret
        - swapstring
      properties:
        payment_hash:
          type: string
          example: 3febfae1e68b190c15461f4c2a3290f9af1dae63fd7d620d2bd61601869026cd
        payment_secret:
          type: string
          example: 777a7756c620868199ed5fdc35bee4095b5709d543e5c2bf0494396bf27d2ea2
        swapstring:
          type: string
          example: 30/rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8/10/rgb:icfqnK9y-wObZKTu-XJcDL98-sKbE5Mh-OuDJhiI-brRJrzE/1715896416/9d342c6ba006e24abee84a2e034a22d5e30c1f2599fb9c3574d46d3cde3d65a2
    Media:
      type: object
      required:
        - file_path
        - digest
        - mime
      properties:
        file_path:
          type: string
          example: /path/to/media
        digest:
          type: string
          example: 5891b5b522d5df086d0ff0b110fbd9d21bb4fc7163af34d08286a2e846f6be03
        mime:
          type: string
          example: text/plain
    NetworkInfoResponse:
      type: object
      required:
        - network
        - height
      properties:
        network:
          $ref: '#/components/schemas/BitcoinNetwork'
        height:
          type: integer
          example: 805434
    NodeInfoResponse:
      type: object
      required:
        - pubkey
        - num_channels
        - num_usable_channels
        - local_balance_sat
        - eventual_close_fees_sat
        - pending_outbound_payments_sat
        - num_peers
        - account_xpub_vanilla
        - account_xpub_colored
        - max_media_upload_size_mb
        - rgb_htlc_min_msat
        - rgb_channel_capacity_min_sat
        - channel_capacity_min_sat
        - channel_capacity_max_sat
        - channel_asset_min_amount
        - channel_asset_max_amount
        - network_nodes
        - network_channels
      properties:
        pubkey:
          type: string
          example: 02270dadcd6e7ba0ef707dac72acccae1a3607453a8dd2aef36ff3be4e0d31f043
        num_channels:
          type: integer
          example: 1
        num_usable_channels:
          type: integer
          example: 0
        local_balance_sat:
          type: integer
          example: 28616
        eventual_close_fees_sat:
          type: integer
          example: 892
        pending_outbound_payments_sat:
          type: integer
          example: 7852
        num_peers:
          type: integer
          example: 1
        account_xpub_vanilla:
          type: string
          example: tpubDDfzqHEET3ksD81qshMHkw35yp6TuLP1kr5rWWeJcLAqDfMXKDJzmDwAnda6DCqw7kkkhPphuDZFE2a6Sw8h5ZA5NwmtTssEnjMqN7xMzSd
        account_xpub_colored:
          type: string
          example: tpubDDcdKhaxwVV2T6xwigti7dSY1a7LHFwZmKAaLWtNhzrvuTXqjjzo8U7YQkUuPah5yHvnk3cbXmb18ZRFwHEKTFUQmA9dij1nPVA2LCJCiEa
        max_media_upload_size_mb:
          type: integer
          example: 5
        rgb_htlc_min_msat:
          type: integer
          example: 3000000
        rgb_channel_capacity_min_sat:
          type: integer
          example: 30010
        channel_capacity_min_sat:
          type: integer
          example: 5506
        channel_capacity_max_sat:
          type: integer
          example: 16777215
        channel_asset_min_amount:
          type: integer
          example: 1
        channel_asset_max_amount:
          type: integer
          example: 18446744073709551615
        network_nodes:
          type: integer
          example: 987226
        network_channels:
          type: integer
          example: 7812821
        latest_rgs_snapshot_timestamp:
          type:
            - integer
            - 'null'
          description: >-
            Unix timestamp of the most recently applied Rapid Gossip Sync
            snapshot. Null when the node sources gossip via P2P or has not yet
            applied an RGS snapshot.
          example: 1715731200
    OpenChannelRequest:
      type: object
      required:
        - peer_pubkey_and_opt_addr
        - capacity_sat
        - push_msat
        - public
        - with_anchors
      properties:
        peer_pubkey_and_opt_addr:
          type: string
          example: 03b79a4bc1ec365524b4fab9a39eb133753646babb5a1da5c4bc94c53110b7795d@localhost:9736
        capacity_sat:
          type: integer
          example: 30010
        push_msat:
          type: integer
          example: 1394000
        asset_amount:
          type:
            - integer
            - 'null'
          example: 333
        asset_id:
          type:
            - string
            - 'null'
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        push_asset_amount:
          type: integer
          example: 100
        public:
          type: boolean
          example: true
        with_anchors:
          type: boolean
          example: true
        fee_base_msat:
          type:
            - integer
            - 'null'
          example: 1000
        fee_proportional_millionths:
          type:
            - integer
            - 'null'
          example: 0
        temporary_channel_id:
          type:
            - string
            - 'null'
          example: a8b60c8ce3067b5fc881d4831323e24751daec3b64353c8df3205ec5d838f1c5
        virtual_open_mode:
          type: string
          example: trusted_no_broadcast
    OpenChannelResponse:
      type: object
      required:
        - temporary_channel_id
      properties:
        temporary_channel_id:
          type: string
          example: a8b60c8ce3067b5fc881d4831323e24751daec3b64353c8df3205ec5d838f1c5
    OperationResult:
      type: object
      required:
        - txid
        - batch_transfer_idx
        - entropy
      properties:
        txid:
          type: string
          example: 33cf3e42fb1c6faa0d47e6a498a9d4e5c56e8a06ea0d295c6d90e2b6c85f7a1e
        batch_transfer_idx:
          type: integer
          example: 3
        entropy:
          type: integer
          format: int64
          example: 12345678901234567890
    PaymentType:
      type: string
      enum:
        - Outbound
        - InboundAutoClaim
        - InboundHodl
    Payment:
      type: object
      required:
        - payment_hash
        - payment_type
        - status
        - created_at
        - updated_at
        - payee_pubkey
      properties:
        amt_msat:
          type:
            - integer
            - 'null'
          example: 3000000
        asset_amount:
          type:
            - integer
            - 'null'
          example: 42
        asset_id:
          type:
            - string
            - 'null'
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        payment_hash:
          type: string
          example: 3febfae1e68b190c15461f4c2a3290f9af1dae63fd7d620d2bd61601869026cd
        payment_type:
          $ref: '#/components/schemas/PaymentType'
        status:
          $ref: '#/components/schemas/HTLCStatus'
        created_at:
          type: integer
          example: 1691160765
        updated_at:
          type: integer
          example: 1691162674
        payee_pubkey:
          type: string
          example: 03b79a4bc1ec365524b4fab9a39eb133753646babb5a1da5c4bc94c53110b7795d
        preimage:
          type: string
          example: 89d28bd306aa9bb906fd0ac31092d04c37c919a171b343083167e2a3cdc60578
        description:
          type:
            - string
            - 'null'
          description: BOLT11 description (the d tag), if present
          example: 1 cup of coffee
        description_hash:
          type:
            - string
            - 'null'
          description: BOLT11 description hash (the h tag), hex-encoded, if present
          example: 00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff
    Peer:
      type: object
      required:
        - pubkey
      properties:
        pubkey:
          type: string
          example: 03b79a4bc1ec365524b4fab9a39eb133753646babb5a1da5c4bc94c53110b7795d
    PostAssetMediaRequest:
      type: object
      required:
        - file
      properties:
        file:
          type: string
          format: binary
    PostAssetMediaResponse:
      type: object
      required:
        - digest
      properties:
        digest:
          type: string
          example: 5891b5b522d5df086d0ff0b110fbd9d21bb4fc7163af34d08286a2e846f6be03
    ProofOfReserves:
      type: object
      required:
        - utxo
        - proof
      properties:
        utxo:
          type: string
          example: efed66f5309396ff43c8a09941c8103d9d5bbffd473ad9f13013ac89fb6b4671:0
        proof:
          type: array
          items:
            type: integer
          example: [6, 36, 87, 13, 5, 17]
    ProvideOutOfBandAckRequest:
      type: object
      required:
        - recipient_id
      properties:
        recipient_id:
          type: string
          example: utxob:2Bwv2Vx-t7VD8XjTh-9EMbpBFKh-J5HDFY4pj-eywu4tKKk-hjTvzJa
    ProvideOutOfBandAckResponse:
      type: object
      properties:
        operation:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/OperationResult'
    ProvideOutOfBandConsignmentRequest:
      type: object
      required:
        - file
      properties:
        file:
          type: string
          format: binary
        media:
          type: array
          items:
            type: string
            format: binary
    ProvideOutOfBandConsignmentResponse:
      type: object
      required:
        - transfers
      properties:
        transfers:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RefreshedTransfer'
    Recipient:
      type: object
      required:
        - recipient_id
        - assignment
        - transport_endpoints
      properties:
        recipient_id:
          type: string
          example: bcrt:utxob:2FZsSuk-iyVQLVuU4-Gc6J4qkE8-mLS17N4jd-MEx6cWz9F-MFkyE1n
        witness_data:
          oneOf:
            - $ref: '#/components/schemas/WitnessData'
            - type: 'null'
        assignment:
          $ref: '#/components/schemas/Assignment'
        transport_endpoints:
          type: array
          items:
            type: string
            example: rpc://127.0.0.1:3000/json-rpc
    RecipientType:
      type: string
      enum:
        - Blind
        - Witness
    RefreshedTransfer:
      type: object
      properties:
        updated_status:
          nullable: true
          type: string
          enum:
            - Initiated
            - WaitingCounterparty
            - WaitingSafeHeight
            - WaitingConfirmations
            - WaitingBroadcast
            - Settled
            - Failed
          example: WaitingBroadcast
        failure:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RefreshFailure'
    RefreshFailure:
      type: object
      required:
        - name
        - message
      properties:
        name:
          type: string
          example: InvalidConsignment
        message:
          type: string
          example: Invalid consignment
    RefreshFilter:
      type: object
      required:
        - status
        - incoming
      properties:
        status:
          $ref: '#/components/schemas/RefreshTransferStatus'
        incoming:
          type: boolean
    RefreshRequest:
      type: object
      required:
        - filter
        - skip_sync
      properties:
        asset_id:
          type: string
          nullable: true
          example: rgb:2dkSTbr-jFhznbPmo-TQafzswCN-av4gTsJjX-ttx6CNou5-M98k8Zd
        filter:
          type: array
          items:
            $ref: '#/components/schemas/RefreshFilter'
          example: []
        skip_sync:
          type: boolean
          example: false
    RefreshResponse:
      type: object
      required:
        - transfers
      properties:
        transfers:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/RefreshedTransfer'
    RefreshTransferStatus:
      type: string
      enum:
        - WaitingCounterparty
        - WaitingConfirmations
    RestoreRequest:
      type: object
      required:
        - backup_path
        - password
      properties:
        backup_path:
          type: string
          example: /path/to/the/backup/file
        password:
          type: string
          example: nodepassword
    RevokeTokenRequest:
      type: object
      required:
        - token
      properties:
        token:
          type: string
          example: EnYKDBgDIggKBggGEgIYDRIkCAASICqCgqtFMIJ1eLCM3raDzqg9UqV-6nJWzGjjJG0S5IIUGkBpF-itmppHcdcSrSCiKklz9VZT4UmIND_0RFc32Imq3bLR_Y7GYaSpJo5lJfU1cA2BG_hy7P1UN4g5jKTKS88GIiIKIAUKXrrx0Ca-rMZa537VOFw2X8q_KVQ6OC4Z0ztro0sQ
    RgbAllocation:
      type: object
      required:
        - assignment
        - settled
      properties:
        asset_id:
          type:
            - string
            - 'null'
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        assignment:
          $ref: '#/components/schemas/Assignment'
        settled:
          type: boolean
          example: false
    RgbInvoiceRequest:
      type: object
      required:
        - min_confirmations
        - witness
        - transport_endpoints
      properties:
        min_confirmations:
          type: integer
          example: 1
        asset_id:
          type:
            - string
            - 'null'
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        assignment:
          oneOf:
            - $ref: '#/components/schemas/Assignment'
            - type: 'null'
          example: null
        expiration_timestamp:
          type: integer
          example: 1695811760
        witness:
          type: boolean
          example: false
        transport_endpoints:
          type: array
          items:
            type: string
          example:
            - rpc://127.0.0.1:3000/json-rpc
    RgbInvoiceResponse:
      type: object
      required:
        - recipient_id
        - invoice
        - batch_transfer_idx
        - expiration_timestamp
      properties:
        recipient_id:
          type: string
          example: bcrt:utxob:cbgHUJ4e-7QyKY4U-Jsj5AZw-oI0gxZh-7fxQY2_-tFFUAZN-4CgpX
        invoice:
          type: string
          example: rgb:~/~/~/bcrt:utxob:cbgHUJ4e-7QyKY4U-Jsj5AZw-oI0gxZh-7fxQY2_-tFFUAZN-4CgpX?expiry=1695811760&endpoints=rpc://127.0.0.1:3000/json-rpc
        expiration_timestamp:
          type: integer
          example: 1695811760
        batch_transfer_idx:
          type: integer
          example: 1
    SendBtcRequest:
      type: object
      required:
        - amount
        - address
        - fee_rate
        - skip_sync
      properties:
        amount:
          type: integer
          example: 16900
        address:
          type: string
          example: bcrt1qwxht5tut39dws8tjcf649tp908r8fr2j75c94k
        fee_rate:
          type: integer
          example: 5
        skip_sync:
          type: boolean
          example: false
    SendBtcResponse:
      type: object
      required:
        - txid
      properties:
        txid:
          type: string
          example: 7c2c95b9c2aa0a7d140495b664de7973b76561de833f0dd84def3efa08941664
    SendOnionMessageRequest:
      type: object
      required:
        - node_ids
        - tlv_type
        - data
      properties:
        node_ids:
          type: array
          items:
            type: string
            example: 03b79a4bc1ec365524b4fab9a39eb133753646babb5a1da5c4bc94c53110b7795d
        tlv_type:
          type: integer
          example: 77
        data:
          type: string
          example: message to send
    SendPaymentRequest:
      type: object
      required:
        - invoice
      properties:
        invoice:
          type: string
          example: lnbcrt30u1pjv6yzndqud3jxktt5w46x7unfv9kz6mn0v3jsnp4qdpc280eur52luxppv6f3nnj8l6vnd9g2hnv3qv6mjhmhvlzf6327pp5tjjasx6g9dqptea3fhm6yllq5wxzycnnvp8l6wcq3d6j2uvpryuqsp5l8az8x3g8fe05dg7cmgddld3da09nfjvky8xftwsk4cj8p2l7kfq9qyysgqcqpcxqzdylzlwfnkyw3jv344x4rzwgkk53ng0fhxy5rdduk4g5tpvea8xa6rfckkza35va28xjn2tqkhgarcxep5umm4x5k56wfcdvu95eq7qzp20vrl4xz76syapsa3c09j7lg5gerkaj63llj0ark7ph8hfketn6fkqzm8laf66dhsncm23wkwm5l5377we9e8lnlknnkwje5eefkccusqm6rqt8
        amt_msat:
          type:
            - integer
            - 'null'
          example: 3000000
        asset_id:
          type:
            - string
            - 'null'
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        asset_amount:
          type:
            - integer
            - 'null'
          example: 100
    SendPaymentResponse:
      type: object
      required:
        - payment_id
        - status
      properties:
        payment_id:
          type: string
          example: 3febfae1e68b190c15461f4c2a3290f9af1dae63fd7d620d2bd61601869026cd
        payment_hash:
          type:
            - string
            - 'null'
          example: 3febfae1e68b190c15461f4c2a3290f9af1dae63fd7d620d2bd61601869026cd
        payment_secret:
          type:
            - string
            - 'null'
          example: 777a7756c620868199ed5fdc35bee4095b5709d543e5c2bf0494396bf27d2ea2
        status:
          $ref: '#/components/schemas/HTLCStatus'
    SendRgbRequest:
      type: object
      required:
        - donation
        - fee_rate
        - min_confirmations
        - recipient_map
      properties:
        donation:
          type: boolean
          example: false
        fee_rate:
          type: integer
          example: 5
        min_confirmations:
          type: integer
          example: 1
        expiration_timestamp:
          type: integer
          example: 1695811760
        recipient_map:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/Recipient'
          example:
            rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8:
              - recipient_id: "utxob:2FjRqgQ-eEWCVHY5-zmpFtYzT-gGm3MdR-sTnxNcS-7RtUbY9-4NYuuh"
                assignment:
                  type: Fungible
                  value: 400
                transport_endpoints:
                  - rpc://127.0.0.1:3000/json-rpc
              - recipient_id: "utxob:3GkRrhR-fFXDLIZ6-0anqGuzU-hHn4NeS-tUoyOdT-8SuVcZ0-5OZvvi"
                assignment:
                  type: Fungible
                  value: 200
                transport_endpoints:
                  - rpc://127.0.0.1:3000/json-rpc
            rgb:d8qDVS5X-ICVG2uM-CPr3yO4-lfBhgjt-7FN1EPE-ApY1LcM:
              - recipient_id: "utxob:4HlSsiS-gGYEMKA7-1borHvaV-iIo5OfT-uVpzPeU-9TvWdA1-6PAwwj"
                assignment:
                  type: Fungible
                  value: 100
                transport_endpoints:
                  - rpc://127.0.0.1:3000/json-rpc
    SendRgbResponse:
      type: object
      required:
        - txid
      properties:
        txid:
          type: string
          example: 7c2c95b9c2aa0a7d140495b664de7973b76561de833f0dd84def3efa08941664
    SignMessageRequest:
      type: object
      required:
        - message
      properties:
        message:
          type: string
          example: message to sign
    SignMessageResponse:
      type: object
      required:
        - signed_message
      properties:
        signed_message:
          type: string
          example: signed message
    Swap:
      type: object
      required:
        - qty_from
        - qty_to
        - payment_hash
        - status
        - requested_at
        - expires_at
      properties:
        qty_from:
          type: integer
          example: 30
        qty_to:
          type: integer
          example: 10
        from_asset:
          type:
            - string
            - 'null'
          example: rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8
        to_asset:
          type:
            - string
            - 'null'
          example: rgb:icfqnK9y-wObZKTu-XJcDL98-sKbE5Mh-OuDJhiI-brRJrzE
        payment_hash:
          type: string
          example: 7c2c95b9c2aa0a7d140495b664de7973b76561de833f0dd84def3efa08941664
        status:
          $ref: '#/components/schemas/SwapStatus'
        requested_at:
          type: integer
          example: 1691160765
        initiated_at:
          type:
            - integer
            - 'null'
          example: 1691168512
        expires_at:
          type: integer
          example: 1691172703
        completed_at:
          type:
            - integer
            - 'null'
          example: 1691171075
    SwapStatus:
      type: string
      enum:
        - Waiting
        - Pending
        - Succeeded
        - Expired
        - Failed
    SyncKeychain:
      oneOf:
        - type: string
          enum:
            - Colored
        - type: object
          required:
            - Vanilla
          properties:
            Vanilla:
              type: object
              required:
                - lookback
              properties:
                lookback:
                  type: integer
                  example: 20
      example:
        Vanilla:
          lookback: 20
    SyncOptions:
      type: object
      required:
        - keychain
        - strategy
      properties:
        keychain:
          $ref: '#/components/schemas/SyncKeychain'
        strategy:
          $ref: '#/components/schemas/SyncStrategy'
    SyncRequest:
      type: object
      required:
        - options
      properties:
        options:
          $ref: '#/components/schemas/SyncOptions'
    SyncStrategy:
      type: string
      enum:
        - FastSync
        - FullSync
        - FullScan
    TakerRequest:
      type: object
      required:
        - swapstring
      properties:
        swapstring:
          type: string
          example: 30/rgb:CJkb4YZw-jRiz2sk-~PARPio-wtVYI1c-XAEYCqO-wTfvRZ8/10/rgb:icfqnK9y-wObZKTu-XJcDL98-sKbE5Mh-OuDJhiI-brRJrzE/1715896416/9d342c6ba006e24abee84a2e034a22d5e30c1f2599fb9c3574d46d3cde3d65a2
    Token:
      type: object
      required:
        - index
        - attachments
      properties:
        index:
          type: integer
          example: 0
        ticker:
          type:
            - string
            - 'null'
          example: TKN
        name:
          type:
            - string
            - 'null'
          example: Token
        details:
          type:
            - string
            - 'null'
          example: token details
        embedded_media:
          oneOf:
            - $ref: '#/components/schemas/EmbeddedMedia'
            - type: 'null'
        media:
          oneOf:
            - $ref: '#/components/schemas/Media'
            - type: 'null'
        attachments:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Media'
          example:
            0: { file_path: path/to/attachment0, digest: 5891b5b522d5df086d0ff0b110fbd9d21bb4fc7163af34d08286a2e846f6be03, mime: text/plain }
            1: { file_path: path/to/attachment1, digest: d7516e3a27cdf35aa9dcb323b5f556344ef7f57570be30b88de2bfd4ba339b1a, mime: image/png }
        reserves:
          oneOf:
            - $ref: '#/components/schemas/ProofOfReserves'
            - type: 'null'
    TokenLight:
      type: object
      required:
        - index
        - embedded_media
        - attachments
        - reserves
      properties:
        index:
          type: integer
          example: 0
        ticker:
          type:
            - string
            - 'null'
          example: TKN
        name:
          type:
            - string
            - 'null'
          example: Token
        details:
          type:
            - string
            - 'null'
          example: token details
        embedded_media:
          type: boolean
          example: true
        media:
          oneOf:
            - $ref: '#/components/schemas/Media'
            - type: 'null'
        attachments:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Media'
          example:
            0: { file_path: path/to/attachment0, digest: 5891b5b522d5df086d0ff0b110fbd9d21bb4fc7163af34d08286a2e846f6be03, mime: text/plain }
            1: { file_path: path/to/attachment1, digest: d7516e3a27cdf35aa9dcb323b5f556344ef7f57570be30b88de2bfd4ba339b1a, mime: image/png }
        reserves:
          type: boolean
          example: false
    Transaction:
      type: object
      required:
        - transaction_type
        - txid
        - received
        - sent
        - fee
      properties:
        transaction_type:
          $ref: '#/components/schemas/TransactionType'
        txid:
          type: string
          example: 7c2c95b9c2aa0a7d140495b664de7973b76561de833f0dd84def3efa08941664
        received:
          type: integer
          example: 650
        sent:
          type: integer
          example: 1050
        fee:
          type: integer
          example: 100
        confirmation_time:
          oneOf:
            - $ref: '#/components/schemas/BlockTime'
            - type: 'null'
    TransactionType:
      type: string
      enum:
        - RgbSend
        - Drain
        - CreateUtxos
        - SendBtc
        - Incoming
    Transfer:
      type: object
      required:
        - idx
        - created_at
        - updated_at
        - status
        - assignments
        - kind
        - transport_endpoints
      properties:
        idx:
          type: integer
          example: 1
        created_at:
          type: integer
          example: 1691160765
        updated_at:
          type: integer
          example: 1691162674
        status:
          $ref: '#/components/schemas/TransferStatus'
        requested_assignment:
          oneOf:
            - $ref: '#/components/schemas/Assignment'
            - type: 'null'
        assignments:
          type: array
          items:
            $ref: '#/components/schemas/Assignment'
        kind:
          $ref: '#/components/schemas/TransferKind'
        txid:
          type:
            - string
            - 'null'
          example: 7c2c95b9c2aa0a7d140495b664de7973b76561de833f0dd84def3efa08941664
        recipient_id:
          type:
            - string
            - 'null'
          example: 61qsVbWtkNmU54F2i6qtB9uSmEGsPoaeypCi5uC5uctZ
        proxy_recipient_id:
          type:
            - string
            - 'null'
          example: 61qsVbWtkNmU54F2i6qtB9uSmEGsPoaeypCi5uC5ucX
        receive_utxo:
          type:
            - string
            - 'null'
          example: efed66f5309396ff43c8a09941c8103d9d5bbffd473ad9f13013ac89fb6b4671:0
        change_utxo:
          type:
            - string
            - 'null'
          example: null
        expiration_timestamp:
          type:
            - integer
            - 'null'
          example: 1691171612
        transport_endpoints:
          type: array
          items:
            $ref: '#/components/schemas/TransferTransportEndpoint'
    TransferKind:
      type: string
      example: ReceiveBlind
      enum:
        - Issuance
        - ReceiveBlind
        - ReceiveWitness
        - Send
        - Inflation
        - Burn
    TransferStatus:
      type: string
      enum:
        - Initiated
        - WaitingCounterparty
        - WaitingSafeHeight
        - WaitingConfirmations
        - WaitingBroadcast
        - Settled
        - Failed
    TransferTransportEndpoint:
      type: object
      required:
        - endpoint
        - transport_type
        - used
      properties:
        endpoint:
          type: string
          example: http://127.0.0.1:3000/json-rpc
        transport_type:
          $ref: '#/components/schemas/TransportType'
        used:
          type: boolean
          example: false
    TransportType:
      type: string
      enum:
        - JsonRpc
    UnlockRequest:
      type: object
      required:
        - password
        - ldk_chain_sync
        - announce_addresses
      properties:
        password:
          type: string
          example: nodepassword
        ldk_chain_sync:
          $ref: '#/components/schemas/LdkChainSync'
        indexer_url:
          type:
            - string
            - 'null'
          example: 127.0.0.1:50001
        eth_rpc_url:
          type:
            - string
            - 'null'
          description: Ethereum RPC used to validate BFA consignments. When set (here
            or via the config file) the node supports BFA assets, otherwise BFA is disabled
          example: http://127.0.0.1:8545
        proxy_endpoint:
          type:
            - string
            - 'null'
          example: rpc://127.0.0.1:3000/json-rpc
        announce_addresses:
          type: array
          items:
            type: string
            example: pub.addr.example.com:9735
        announce_alias:
          type:
            - string
            - 'null'
          example: nodeAlias
        gossip_source:
          description: >-
            Selects how the node sources Lightning network gossip. Omit for the
            default (P2P gossip with UTXO verification against the configured
            bitcoind). In RGS mode the node downloads a compact snapshot from a
            trusted server hourly and drops inbound P2P gossip; outbound node
            announcements still work. Sync freshness is exposed via
            latest_rgs_snapshot_timestamp on /nodeinfo.
          oneOf:
            - type: 'null'
            - type: object
              required:
                - type
              properties:
                type:
                  type: string
                  enum:
                    - p2p
            - type: object
              required:
                - type
                - server_url
              properties:
                type:
                  type: string
                  enum:
                    - rgs
                server_url:
                  type: string
                  example: https://rapidsync.lightningdevkit.org/testnet/v2/snapshot
    Unspent:
      type: object
      required:
        - utxo
        - rgb_allocations
        - pending_blinded
      properties:
        utxo:
          $ref: '#/components/schemas/Utxo'
        rgb_allocations:
          type: array
          items:
            $ref: '#/components/schemas/RgbAllocation'
        pending_blinded:
          type: integer
          description: >-
            Number of pending blind receive operations reserving this UTXO. A
            colorable UTXO with empty rgb_allocations but pending_blinded > 0 is
            already reserved and is not allocatable.
          example: 0
    Utxo:
      type: object
      required:
        - outpoint
        - btc_amount
        - colorable
        - exists
        - derivation_index
      properties:
        outpoint:
          type: string
          example: efed66f5309396ff43c8a09941c8103d9d5bbffd473ad9f13013ac89fb6b4671:0
        btc_amount:
          type: integer
          example: 1000
        colorable:
          type: boolean
          example: true
        exists:
          type: boolean
          example: true
        derivation_index:
          type:
            - integer
            - 'null'
          example: 42
    WitnessData:
      type: object
      required:
        - amount_sat
      properties:
        amount_sat:
          type: integer
          example: 1000
        blinding:
          type:
            - integer
            - 'null'
          example: 439017309
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Biscuit
security:
  - bearerAuth: []