package com.mintter.p2p.v1alpha

Get desktop application:
View/edit binary Protocol Buffers messages

Mintter P2P API.

• rpc Handshake (HandshakeInfo, HandshakeInfo)

  p2p.proto:11

  Handshake gets called whenever two Mintter peers connect to each other. No matter who initiates the connect, this will make sure both peers exchange their information.

  message HandshakeInfo

  p2p.proto:25

  • bytes key_delegation_cid = 1

    The CID of the key delegation blob.

  • bytes key_delegation_data = 2

    The bytes of the key delegation blob.

• rpc ListBlobs (ListBlobsRequest, stream Blob)

  p2p.proto:19

  ListBlobs returns a stream of blobs that the peer has. It's assumed that all peers have a way to list their blobs in a monotonic order, i.e. blobs that a peer receives later will have a higher index/cursor. This allows peers to sync more efficiently by remembering the cursor from the previous request, and only asking for what's new since then in the next request. Clients must treat the cursor as an opaque string.

  message ListBlobsRequest

  p2p.proto:34

  Request to list blobs.

  • string cursor = 1

    Optional. A cursor obtained from a previous request to resume the stream.

  message Blob

  p2p.proto:60

  • bytes cid = 1

    CID of the blob.

  • string cursor = 2

    Cursor can be used to resume the stream to get only newer blobs than this one. Clients must not expect that all blobs will have a cursor (might be done as an optimization), but whenever they see a cursor for a blob they have already processed, they should remember it for future requests.

• rpc RequestInvoice (RequestInvoiceRequest, RequestInvoiceResponse)

  p2p.proto:22

  Request a peer to issue a lightning BOLT-11 invoice

  message RequestInvoiceRequest

  p2p.proto:40

  Request Invoice request.

  • int64 amount_sats = 1

    The invoice amount in satoshis

  • string memo = 2

    Optional requested memo to be attached in the invoice

  • bool hold_invoice = 3

    True to request a hold invoice instead of a regular one. If true, then preimage_hash should be filled

  • bytes preimage_hash = 4

    Preimage hash of the requested hold invoice. If hold_invoice is set to false this field is skipped

  message RequestInvoiceResponse

  p2p.proto:55

  Request invoice response

  • string pay_req = 1

    Text encoded BOLT-11 Invoice