openapi.yaml

openapi: 3.0.3
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.
  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: 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: 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'
  /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'
  /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:
    get:
      tags:
        - On-chain
      summary: Get the BTC balance
      description: Get the node's bitcoin balance for the vanilla and colored wallets
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BtcBalanceResponse'
  /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'
  /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:
        '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:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /createutxos:
    post:
      tags:
        - RGB
      summary: Create UTXOs
      description: Create a fixed number of UTXOs to be used for RGB operations
      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:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DecodeLNInvoiceResponse'
  /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:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /init:
    post:
      tags:
        - Other
      summary: Init the node
      description: Initialize a new node
      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:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceStatusResponse'
  /issueasset:
    post:
      tags:
        - RGB
      summary: Issue an RGB asset
      description: Issue an RGB asset
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IssueAssetRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IssueAssetResponse'
  /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:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeysendResponse'
  /listassets:
    get:
      tags:
        - RGB
      summary: List assets
      description: List the node's RGB assets
      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:
        '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
      responses:
        '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:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPeersResponse'
  /listtransactions:
    get:
      tags:
        - On-chain
      summary: List transactions
      description: List the node's on-chain transactions
      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 on-chain RGB transfers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListTransfersRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTransfersResponse'
  /listunspents:
    get:
      tags:
        - On-chain
      summary: List unspents
      description: List the unspent outputs of the internal BDK wallet
      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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LNInvoiceRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LNInvoiceResponse'
  /networkinfo:
    get:
      tags:
        - Other
      summary: Get network info
      description: Get info on the Bitcoin network where the LN is running
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkInfoResponse'
  /nodeinfo:
    get:
      tags:
        - Other
      summary: Get node info
      description: Get the LN node's info
      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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenChannelRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenChannelResponse'
  /refreshtransfers:
    post:
      tags:
        - RGB
      summary: Refresh transfers
      description: Refresh RGB pending transfers
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
  /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'
  /rgbinvoice:
    post:
      tags:
        - RGB
      summary: Get an RGB invoice
      description: Get an RGB invoice to receive assets on-chain
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RgbInvoiceResponse'
  /sendasset:
    post:
      tags:
        - RGB
      summary: Send assets
      description: Send RGB assets on-chain
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendAssetRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendAssetResponse'
  /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:
        '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:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendPaymentResponse'
  /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'
  /unlock:
    post:
      tags:
        - Other
      summary: Unlock the node
      description: Unlock a locked node
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UnlockRequest'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
components:
  schemas:
    AddressResponse:
      type: object
      properties:
        address:
          type: string
          example: bcrt1qnc5y6j6dmejrkwy93farhvpezk0lf46gk7aecs
    Asset:
      type: object
      properties:
        asset_id:
          type: string
          example: rgb:2dkSTbr-jFhznbPmo-TQafzswCN-av4gTsJjX-ttx6CNou5-M98k8Zd
        ticker:
          type: string
          example: USDT
        name:
          type: string
          example: Tether
        precision:
          type: integer
          example: 0
        issued_supply:
          type: integer
          example: 777
        timestamp:
          type: integer
          example: 1691160565
    AssetBalanceRequest:
      type: object
      properties:
        asset_id:
          type: string
          example: rgb:2dkSTbr-jFhznbPmo-TQafzswCN-av4gTsJjX-ttx6CNou5-M98k8Zd
    AssetBalanceResponse:
      type: object
      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
    BackupRequest:
      type: object
      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
        - Signet
        - Regtest
    BlockTime:
      type: object
      properties:
        height:
          type: integer
          example: 805434
        timestamp:
          type: integer
          example: 1691160659
    BtcBalance:
      type: object
      properties:
        settled:
          type: integer
          example: 777000
        future:
          type: integer
          example: 777000
        spendable:
          type: integer
          example: 777000
    BtcBalanceResponse:
      type: object
      properties:
        vanilla:
          $ref: '#/components/schemas/BtcBalance'
        colored:
          $ref: '#/components/schemas/BtcBalance'
    ChangePasswordRequest:
      type: object
      properties:
        old_password:
          type: string
          example: nodepassword
        new_password:
          type: string
          example: nodenewpassword
    Channel:
      type: object
      properties:
        channel_id:
          type: string
          example: 8129afe1b1d7cf60d5e1bf4c04b09bec925ed4df5417ceee0484e24f816a105a
        funding_txid:
          type: string
          example: 5a106a814fe28404eece1754dfd45e92ec9bb0044cbfe1d560cfd7b1e1af2981
        peer_pubkey:
          type: string
          example: 03b79a4bc1ec365524b4fab9a39eb133753646babb5a1da5c4bc94c53110b7795d
        peer_alias:
          type: string
          example: null
        short_channel_id:
          type: integer
          example: 120946279120896
        ready:
          type: boolean
          example: false
        capacity_sat:
          type: integer
          example: 30010
        local_balance_msat:
          type: integer
          example: 28616000
        outbound_balance_msat:
          type: integer
          example: 21616000
        inbound_balance_msat:
          type: integer
          example: 6394000
        is_usable:
          type: boolean
          example: false
        public:
          type: boolean
          example: true
        asset_id:
          type: string
          example: rgb:2dkSTbr-jFhznbPmo-TQafzswCN-av4gTsJjX-ttx6CNou5-M98k8Zd
        asset_local_amount:
          type: integer
          example: 777
        asset_remote_amount:
          type: integer
          example: 0
    CloseChannelRequest:
      type: object
      properties:
        channel_id:
          type: string
          example: 8129afe1b1d7cf60d5e1bf4c04b09bec925ed4df5417ceee0484e24f816a105a
        peer_pubkey:
          type: string
          example: 03b79a4bc1ec365524b4fab9a39eb133753646babb5a1da5c4bc94c53110b7795d
        force:
          type: boolean
          example: false
    ConnectPeerRequest:
      type: object
      properties:
        peer_pubkey_and_addr:
          type: string
          example: 03b79a4bc1ec365524b4fab9a39eb133753646babb5a1da5c4bc94c53110b7795d@localhost:9736
    DecodeLNInvoiceRequest:
      type: object
      properties:
        invoice:
          type: string
          example: lnbcrt30u1pjv6yzndqud3jxktt5w46x7unfv9kz6mn0v3jsnp4qdpc280eur52luxppv6f3nnj8l6vnd9g2hnv3qv6mjhmhvlzf6327pp5tjjasx6g9dqptea3fhm6yllq5wxzycnnvp8l6wcq3d6j2uvpryuqsp5l8az8x3g8fe05dg7cmgddld3da09nfjvky8xftwsk4cj8p2l7kfq9qyysgqcqpcxqzdylzlwfnkyw3jv344x4rzwgkk53ng0fhxy5rdduk4g5tpvea8xa6rfckkza35va28xjn2tqkhgarcxep5umm4x5k56wfcdvu95eq7qzp20vrl4xz76syapsa3c09j7lg5gerkaj63llj0ark7ph8hfketn6fkqzm8laf66dhsncm23wkwm5l5377we9e8lnlknnkwje5eefkccusqm6rqt8
    DecodeLNInvoiceResponse:
      type: object
      properties:
        amt_msat:
          type: integer
          example: 3000000
        expiry_sec:
          type: integer
          example: 420
        timestamp:
          type: integer
          example: 1691160659
        asset_id:
          type: string
          example: rgb:2dkSTbr-jFhznbPmo-TQafzswCN-av4gTsJjX-ttx6CNou5-M98k8Zd
        asset_amount:
          type: integer
          example: 42
        payment_hash:
          type: string
          example: 5ca5d81b482b4015e7b14df7a27fe0a38c226273604ffd3b008b752571811938
        payment_secret:
          type: string
          example: f9fa239a283a72fa351ec6d0d6fdb16f5e59a64cb10e64add0b57123855ff592
        payee_pubkey:
          type: string
          example: 0343851df9e0e8aff0c10b3498ce723ff4c9b4a855e6c8819adcafbbb3e24ea2af
        network:
          $ref: '#/components/schemas/BitcoinNetwork'
    DisconnectPeerRequest:
      type: object
      properties:
        peer_pubkey:
          type: string
          example: 03b79a4bc1ec365524b4fab9a39eb133753646babb5a1da5c4bc94c53110b7795d
    EmptyResponse:
      type: object
    HTLCStatus:
      type: string
      enum:
        - Pending
        - Succeeded
        - Failed
    InitRequest:
      type: object
      properties:
        password:
          type: string
          example: nodepassword
    InitResponse:
      type: object
      properties:
        mnemonic:
          type: string
          example: skill lamp please gown put season degree collect decline account monitor insane
    InvoiceStatus:
      type: string
      enum:
        - Pending
        - Succeeded
        - Failed
        - Expired
    InvoiceStatusRequest:
      type: object
      properties:
        invoice:
          type: string
          example: lnbcrt30u1pjv6yzndqud3jxktt5w46x7unfv9kz6mn0v3jsnp4qdpc280eur52luxppv6f3nnj8l6vnd9g2hnv3qv6mjhmhvlzf6327pp5tjjasx6g9dqptea3fhm6yllq5wxzycnnvp8l6wcq3d6j2uvpryuqsp5l8az8x3g8fe05dg7cmgddld3da09nfjvky8xftwsk4cj8p2l7kfq9qyysgqcqpcxqzdylzlwfnkyw3jv344x4rzwgkk53ng0fhxy5rdduk4g5tpvea8xa6rfckkza35va28xjn2tqkhgarcxep5umm4x5k56wfcdvu95eq7qzp20vrl4xz76syapsa3c09j7lg5gerkaj63llj0ark7ph8hfketn6fkqzm8laf66dhsncm23wkwm5l5377we9e8lnlknnkwje5eefkccusqm6rqt8
    InvoiceStatusResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/InvoiceStatus'
    IssueAssetRequest:
      type: object
      properties:
        amount:
          type: integer
          example: 777
        ticker:
          type: string
          example: USDT
        name:
          type: string
          example: Tether
        precision:
          type: integer
          example: 0
    IssueAssetResponse:
      type: object
      properties:
        asset_id:
          type: string
          example: rgb:2dkSTbr-jFhznbPmo-TQafzswCN-av4gTsJjX-ttx6CNou5-M98k8Zd
    KeysendRequest:
      type: object
      properties:
        dest_pubkey:
          type: string
          example: 03b79a4bc1ec365524b4fab9a39eb133753646babb5a1da5c4bc94c53110b7795d
        amt_msat:
          type: integer
          example: 3000000
        asset_id:
          type: string
          example: rgb:2dkSTbr-jFhznbPmo-TQafzswCN-av4gTsJjX-ttx6CNou5-M98k8Zd
        asset_amount:
          type: integer
          example: 42
    KeysendResponse:
      type: object
      properties:
        payment_hash:
          type: string
          example: 8ffd4c0642047bc51ea01a22e6b2ede0fc001aee0e9929b2e84e41cf6589d61e
        payment_preimage:
          type: string
          example: 89d28bd306aa9bb906fd0ac31092d04c37c919a171b343083167e2a3cdc60578
        status:
          $ref: '#/components/schemas/HTLCStatus'
    ListAssetsResponse:
      type: object
      properties:
        assets:
          type: array
          items:
              $ref: '#/components/schemas/Asset'
    ListChannelsResponse:
      type: object
      properties:
        channels:
          type: array
          items:
              $ref: '#/components/schemas/Channel'
    ListPaymentsResponse:
      type: object
      properties:
        payments:
          type: array
          items:
              $ref: '#/components/schemas/Payment'
    ListPeersResponse:
      type: object
      properties:
        peers:
          type: array
          items:
              $ref: '#/components/schemas/Peer'
    ListTransactionsResponse:
      type: object
      properties:
        transactions:
          type: array
          items:
              $ref: '#/components/schemas/Transaction'
    ListTransfersRequest:
      type: object
      properties:
        asset_id:
          type: string
          example: rgb:2dkSTbr-jFhznbPmo-TQafzswCN-av4gTsJjX-ttx6CNou5-M98k8Zd
    ListTransfersResponse:
      type: object
      properties:
        transfers:
          type: array
          items:
              $ref: '#/components/schemas/Transfer'
    ListUnspentsResponse:
      type: object
      properties:
        unspents:
          type: array
          items:
              $ref: '#/components/schemas/Unspent'
    LNInvoiceRequest:
      type: object
      properties:
        amt_msat:
          type: integer
          example: 3000000
        expiry_sec:
          type: integer
          example: 420
        asset_id:
          type: string
          example: rgb:2dkSTbr-jFhznbPmo-TQafzswCN-av4gTsJjX-ttx6CNou5-M98k8Zd
        asset_amount:
          type: integer
          example: 42
    LNInvoiceResponse:
      type: object
      properties:
        invoice:
          type: string
          example: lnbcrt30u1pjv6yzndqud3jxktt5w46x7unfv9kz6mn0v3jsnp4qdpc280eur52luxppv6f3nnj8l6vnd9g2hnv3qv6mjhmhvlzf6327pp5tjjasx6g9dqptea3fhm6yllq5wxzycnnvp8l6wcq3d6j2uvpryuqsp5l8az8x3g8fe05dg7cmgddld3da09nfjvky8xftwsk4cj8p2l7kfq9qyysgqcqpcxqzdylzlwfnkyw3jv344x4rzwgkk53ng0fhxy5rdduk4g5tpvea8xa6rfckkza35va28xjn2tqkhgarcxep5umm4x5k56wfcdvu95eq7qzp20vrl4xz76syapsa3c09j7lg5gerkaj63llj0ark7ph8hfketn6fkqzm8laf66dhsncm23wkwm5l5377we9e8lnlknnkwje5eefkccusqm6rqt8
    NetworkInfoResponse:
      type: object
      properties:
        network:
          $ref: '#/components/schemas/BitcoinNetwork'
        height:
          type: integer
          example: 805434
    NodeInfoResponse:
      type: object
      properties:
        pubkey:
          type: string
          example: 02270dadcd6e7ba0ef707dac72acccae1a3607453a8dd2aef36ff3be4e0d31f043
        num_channels:
          type: integer
          example: 1
        num_usable_channels:
          type: integer
          example: 0
        local_balance_msat:
          type: integer
          example: 28616000
        num_peers:
          type: integer
          example: 1
    OpenChannelRequest:
      type: object
      properties:
        peer_pubkey_and_addr:
          type: string
          example: 03b79a4bc1ec365524b4fab9a39eb133753646babb5a1da5c4bc94c53110b7795d@localhost:9736
        capacity_sat:
          type: integer
          example: 30010
        push_msat:
          type: integer
          example: 1394000
        asset_amount:
          type: integer
          example: 333
        asset_id:
          type: string
          example: rgb:2dkSTbr-jFhznbPmo-TQafzswCN-av4gTsJjX-ttx6CNou5-M98k8Zd
        public:
          type: boolean
          example: true
    OpenChannelResponse:
      type: object
      properties:
        temporary_channel_id:
          type: string
          example: a8b60c8ce3067b5fc881d4831323e24751daec3b64353c8df3205ec5d838f1c5
    Payment:
      type: object
      properties:
        amt_msat:
          type: integer
          example: 3000000
        asset_amount:
          type: integer
          example: 42
        asset_id:
          type: string
          example: rgb:2dkSTbr-jFhznbPmo-TQafzswCN-av4gTsJjX-ttx6CNou5-M98k8Zd
        payment_hash:
          type: string
          example: 3febfae1e68b190c15461f4c2a3290f9af1dae63fd7d620d2bd61601869026cd
        inbound:
          type: boolean
          example: true
        status:
          $ref: '#/components/schemas/HTLCStatus'
    Peer:
      type: object
      properties:
        pubkey:
          type: string
          example: 03b79a4bc1ec365524b4fab9a39eb133753646babb5a1da5c4bc94c53110b7795d
    RestoreRequest:
      type: object
      properties:
        backup_path:
          type: string
          example: /path/to/the/backup/file
        password:
          type: string
          example: nodepassword
    RgbAllocation:
      type: object
      properties:
        asset_id:
          type: string
          example: rgb:2dkSTbr-jFhznbPmo-TQafzswCN-av4gTsJjX-ttx6CNou5-M98k8Zd
        amount:
          type: integer
          example: 42
        settled:
          type: boolean
          example: false
    RgbInvoiceResponse:
      type: object
      properties:
        blinded_utxo:
          type: string
          example: utxob:2FZsSuk-iyVQLVuU4-Gc6J4qkE8-mLS17N4jd-MEx6cWz9F-MFkyE1n
    SendAssetRequest:
      type: object
      properties:
        asset_id:
          type: string
          example: rgb:2dkSTbr-jFhznbPmo-TQafzswCN-av4gTsJjX-ttx6CNou5-M98k8Zd
        amount:
          type: integer
          example: 42
        blinded_utxo:
          type: string
          example: utxob:2FZsSuk-iyVQLVuU4-Gc6J4qkE8-mLS17N4jd-MEx6cWz9F-MFkyE1n
        donation:
          type: boolean
          example: false
    SendAssetResponse:
      type: object
      properties:
        txid:
          type: string
          example: 7c2c95b9c2aa0a7d140495b664de7973b76561de833f0dd84def3efa08941664
    SendBtcRequest:
      type: object
      properties:
        amount:
          type: integer
          example: 16900
        address:
          type: string
          example: bcrt1qwxht5tut39dws8tjcf649tp908r8fr2j75c94k
        fee_rate:
          type: number
          example: 4.2
    SendBtcResponse:
      type: object
      properties:
        txid:
          type: string
          example: 7c2c95b9c2aa0a7d140495b664de7973b76561de833f0dd84def3efa08941664
    SendOnionMessageRequest:
      type: object
      properties:
        node_ids:
          type: array
          items:
            type: string
        tlv_type:
          type: integer
          example: 77
        data:
          type: string
          example: message to send
    SendPaymentRequest:
      type: object
      properties:
        invoice:
          type: string
          example: lnbcrt30u1pjv6yzndqud3jxktt5w46x7unfv9kz6mn0v3jsnp4qdpc280eur52luxppv6f3nnj8l6vnd9g2hnv3qv6mjhmhvlzf6327pp5tjjasx6g9dqptea3fhm6yllq5wxzycnnvp8l6wcq3d6j2uvpryuqsp5l8az8x3g8fe05dg7cmgddld3da09nfjvky8xftwsk4cj8p2l7kfq9qyysgqcqpcxqzdylzlwfnkyw3jv344x4rzwgkk53ng0fhxy5rdduk4g5tpvea8xa6rfckkza35va28xjn2tqkhgarcxep5umm4x5k56wfcdvu95eq7qzp20vrl4xz76syapsa3c09j7lg5gerkaj63llj0ark7ph8hfketn6fkqzm8laf66dhsncm23wkwm5l5377we9e8lnlknnkwje5eefkccusqm6rqt8
    SendPaymentResponse:
      type: object
      properties:
        payment_hash:
          type: string
          example: 3febfae1e68b190c15461f4c2a3290f9af1dae63fd7d620d2bd61601869026cd
        payment_secret:
          type: string
          example: 777a7756c620868199ed5fdc35bee4095b5709d543e5c2bf0494396bf27d2ea2
        status:
          $ref: '#/components/schemas/HTLCStatus'
    SignMessageRequest:
      type: object
      properties:
        message:
          type: string
          example: message to sign
    SignMessageResponse:
      type: object
      properties:
        signed_message:
          type: string
          example: signed message
    Transaction:
      type: object
      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:
          $ref: '#/components/schemas/BlockTime'
    TransactionType:
      type: string
      enum:
        - RgbSend
        - Drain
        - CreateUtxos
        - User
    Transfer:
      type: object
      properties:
        idx:
          type: integer
          example: 1
        created_at:
          type: integer
          example: 1691160765
        updated_at:
          type: integer
          example: 1691162674
        status:
          $ref: '#/components/schemas/TransferStatus'
        amount:
          type: integer
          example: 77
        kind:
          $ref: '#/components/schemas/TransferKind'
        txid:
          type: string
          example: 7c2c95b9c2aa0a7d140495b664de7973b76561de833f0dd84def3efa08941664
        recipient_id:
          type: string
          example: 61qsVbWtkNmU54F2i6qtB9uSmEGsPoaeypCi5uC5uctZ
        receive_utxo:
          type: string
          example: efed66f5309396ff43c8a09941c8103d9d5bbffd473ad9f13013ac89fb6b4671:0
        change_utxo:
          type: string
          example: null
        expiration:
          type: integer
          example: 1691171612
        transport_endpoints:
          type: array
          items:
            $ref: '#/components/schemas/TransferTransportEndpoint'
    TransferKind:
      type: string
      example: ReceiveBlind
      enum:
        - Issuance
        - ReceiveBlind
        - ReceiveWitness
        - Send
    TransferStatus:
      type: string
      enum:
        - WaitingCounterparty
        - WaitingConfirmations
        - Settled
        - Failed
    TransferTransportEndpoint:
      type: object
      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
      properties:
        password:
          type: string
          example: nodepassword
    Unspent:
      type: object
      properties:
        utxo:
          $ref: '#/components/schemas/Utxo'
        rgb_allocations:
          type: array
          items:
            $ref: '#/components/schemas/RgbAllocation'
    Utxo:
      type: object
      properties:
        outpoint:
          type: string
          example: efed66f5309396ff43c8a09941c8103d9d5bbffd473ad9f13013ac89fb6b4671:0
        btc_amount:
          type: integer
          example: 1000
        colorable:
          type: boolean
          example: true