astra-lightning 1.0.0

package/grpc/protos/peers.proto

@@ -0,0 +1,94 @@
+syntax = "proto3";
+
+package peersrpc;
+
+import "lightning.proto";
+
+option go_package = "github.com/lightningnetwork/lnd/lnrpc/peersrpc";
+
+// Peers is a service that can be used to get information and interact
+// with the other nodes of the network.
+service Peers {
+    /* lncli: peers updatenodeannouncement
+    UpdateNodeAnnouncement allows the caller to update the node parameters
+    and broadcasts a new version of the node announcement to its peers.
+    */
+    rpc UpdateNodeAnnouncement (NodeAnnouncementUpdateRequest)
+        returns (NodeAnnouncementUpdateResponse);
+}
+
+// UpdateAction is used to determine the kind of action we are referring to.
+enum UpdateAction {
+    // ADD indicates this is an "insertion" kind of action.
+    ADD = 0;
+
+    // REMOVE indicates this is a "deletion" kind of action.
+    REMOVE = 1;
+}
+
+enum FeatureSet {
+    /*
+    SET_INIT identifies features that should be sent in an Init message to
+    a remote peer.
+    */
+    SET_INIT = 0;
+
+    /*
+    SET_LEGACY_GLOBAL identifies features that should be set in the legacy
+    GlobalFeatures field of an Init message, which maintains backwards
+    compatibility with nodes that haven't implemented flat features.
+    */
+    SET_LEGACY_GLOBAL = 1;
+
+    /*
+    SET_NODE_ANN identifies features that should be advertised on node
+    announcements.
+    */
+    SET_NODE_ANN = 2;
+
+    /*
+    SET_INVOICE identifies features that should be advertised on invoices
+    generated by the daemon.
+    */
+    SET_INVOICE = 3;
+
+    /*
+    SET_INVOICE_AMP identifies the features that should be advertised on
+    AMP invoices generated by the daemon.
+    */
+    SET_INVOICE_AMP = 4;
+}
+
+message UpdateAddressAction {
+    // Determines the kind of action.
+    UpdateAction action = 1;
+
+    // The address used to apply the update action.
+    string address = 2;
+}
+
+message UpdateFeatureAction {
+    // Determines the kind of action.
+    UpdateAction action = 1;
+
+    // The feature bit used to apply the update action.
+    lnrpc.FeatureBit feature_bit = 2;
+}
+
+message NodeAnnouncementUpdateRequest {
+    // Set of changes for the features that the node supports.
+    repeated UpdateFeatureAction feature_updates = 1;
+
+    // Color is the node's color in hex code format.
+    string color = 2;
+
+    // Alias or nick name of the node.
+    string alias = 3;
+
+    // Set of changes for the node's known addresses.
+    repeated UpdateAddressAction address_updates = 4;
+}
+
+message NodeAnnouncementUpdateResponse {
+    repeated lnrpc.Op ops = 1;
+}

package/grpc/protos/rfqrpc/rfq.proto

@@ -0,0 +1,309 @@
+syntax = "proto3";
+
+package rfqrpc;
+
+option go_package = "github.com/lightninglabs/taproot-assets/taprpc/rfqrpc";
+
+service Rfq {
+    /* tapcli: `rfq buyorder`
+    AddAssetBuyOrder is used to add a buy order for a specific asset. If a buy
+    order already exists for the asset, it will be updated.
+    */
+    rpc AddAssetBuyOrder (AddAssetBuyOrderRequest)
+        returns (AddAssetBuyOrderResponse);
+
+    /* tapcli: `rfq sellorder`
+    AddAssetSellOrder is used to add a sell order for a specific asset. If a
+    sell order already exists for the asset, it will be updated.
+    */
+    rpc AddAssetSellOrder (AddAssetSellOrderRequest)
+        returns (AddAssetSellOrderResponse);
+
+    /* tapcli: `rfq selloffer`
+    AddAssetSellOffer is used to add a sell offer for a specific asset. If a
+    sell offer already exists for the asset, it will be updated.
+    */
+    rpc AddAssetSellOffer (AddAssetSellOfferRequest)
+        returns (AddAssetSellOfferResponse);
+
+    /* tapcli: `rfq buyoffer`
+    AddAssetBuyOffer is used to add a buy offer for a specific asset. If a
+    buy offer already exists for the asset, it will be updated.
+
+    A buy offer is used by the node to selectively accept or reject incoming
+    asset sell quote requests before price is considered.
+    */
+    rpc AddAssetBuyOffer (AddAssetBuyOfferRequest)
+        returns (AddAssetBuyOfferResponse);
+
+    /* tapcli: `rfq acceptedquotes`
+    QueryPeerAcceptedQuotes is used to query for quotes that were requested by
+    our node and have been accepted our peers.
+    */
+    rpc QueryPeerAcceptedQuotes (QueryPeerAcceptedQuotesRequest)
+        returns (QueryPeerAcceptedQuotesResponse);
+
+    /*
+    SubscribeRfqEventNtfns is used to subscribe to RFQ events.
+    */
+    rpc SubscribeRfqEventNtfns (SubscribeRfqEventNtfnsRequest)
+        returns (stream RfqEvent);
+}
+
+message AssetSpecifier {
+    oneof id {
+        // The 32-byte asset ID specified as raw bytes (gRPC only).
+        bytes asset_id = 1;
+
+        // The 32-byte asset ID encoded as a hex string (use this for REST).
+        string asset_id_str = 2;
+
+        // The 32-byte asset group key specified as raw bytes (gRPC only).
+        bytes group_key = 3;
+
+        // The 32-byte asset group key encoded as hex string (use this for
+        // REST).
+        string group_key_str = 4;
+    }
+}
+
+message AddAssetBuyOrderRequest {
+    // asset_specifier is the subject asset.
+    AssetSpecifier asset_specifier = 1;
+
+    // The minimum amount of the asset to buy.
+    uint64 min_asset_amount = 2;
+
+    // The maximum amount BTC to spend (units: millisats).
+    uint64 max_bid = 3;
+
+    // The unix timestamp in seconds after which the order is no longer valid.
+    uint64 expiry = 4;
+
+    // peer_pub_key is an optional field for specifying the public key of the
+    // intended recipient peer for the order.
+    bytes peer_pub_key = 5;
+
+    // timeout_seconds is the number of seconds to wait for the peer to respond
+    // with an accepted quote (or a rejection).
+    uint32 timeout_seconds = 6;
+}
+
+message AddAssetBuyOrderResponse {
+    oneof response {
+        // accepted_quote holds the quote received from the peer as a response
+        // to our quote request.
+        PeerAcceptedBuyQuote accepted_quote = 1;
+
+        // invalid_quote is returned if the quote response received from the
+        // peer was invalid or insufficient.
+        InvalidQuoteResponse invalid_quote = 2;
+
+        // rejected_quote is returned if the quote request was rejected by the
+        // peer.
+        RejectedQuoteResponse rejected_quote = 3;
+    }
+}
+
+message AddAssetSellOrderRequest {
+    // asset_specifier is the subject asset.
+    AssetSpecifier asset_specifier = 1;
+
+    // The maximum amount of the asset to sell.
+    uint64 max_asset_amount = 2;
+
+    // The minimum amount of BTC to accept (units: millisats).
+    uint64 min_ask = 3;
+
+    // The unix timestamp in seconds after which the order is no longer valid.
+    uint64 expiry = 4;
+
+    // peer_pub_key is an optional field for specifying the public key of the
+    // intended recipient peer for the order.
+    bytes peer_pub_key = 5;
+
+    // timeout_seconds is the number of seconds to wait for the peer to respond
+    // with an accepted quote (or a rejection).
+    uint32 timeout_seconds = 6;
+}
+
+message AddAssetSellOrderResponse {
+    oneof response {
+        // accepted_quote holds the quote received from the peer as a response
+        // to our quote request.
+        PeerAcceptedSellQuote accepted_quote = 1;
+
+        // invalid_quote is returned if the quote response received from the
+        // peer was invalid or insufficient.
+        InvalidQuoteResponse invalid_quote = 2;
+
+        // rejected_quote is returned if the quote request was rejected by the
+        // peer.
+        RejectedQuoteResponse rejected_quote = 3;
+    }
+}
+
+message AddAssetSellOfferRequest {
+    // asset_specifier is the subject asset.
+    AssetSpecifier asset_specifier = 1;
+
+    // max_units is the maximum amount of the asset to sell.
+    uint64 max_units = 2;
+}
+
+message AddAssetSellOfferResponse {
+}
+
+message AddAssetBuyOfferRequest {
+    // asset_specifier is the subject asset.
+    AssetSpecifier asset_specifier = 1;
+
+    // max_units is the maximum amount of the asset to buy.
+    uint64 max_units = 2;
+}
+
+message AddAssetBuyOfferResponse {
+}
+
+message QueryPeerAcceptedQuotesRequest {
+}
+
+message PeerAcceptedBuyQuote {
+    // Quote counterparty peer.
+    string peer = 1;
+
+    // The unique identifier of the quote request.
+    bytes id = 2;
+
+    // scid is the short channel ID of the channel over which the payment for
+    // the quote should be made.
+    uint64 scid = 3;
+
+    // asset_amount is the amount of the subject asset.
+    uint64 asset_amount = 4;
+
+    // ask_price is the price in milli-satoshi per asset unit.
+    uint64 ask_price = 5;
+
+    // The unix timestamp in seconds after which the quote is no longer valid.
+    uint64 expiry = 6;
+}
+
+message PeerAcceptedSellQuote {
+    // Quote counterparty peer.
+    string peer = 1;
+
+    // The unique identifier of the quote request.
+    bytes id = 2;
+
+    // scid is the short channel ID of the channel over which the payment for
+    // the quote should be made.
+    uint64 scid = 3;
+
+    // asset_amount is the amount of the subject asset.
+    uint64 asset_amount = 4;
+
+    // bid_price is the price in milli-satoshi per asset unit.
+    uint64 bid_price = 5;
+
+    // The unix timestamp in seconds after which the quote is no longer valid.
+    uint64 expiry = 6;
+}
+
+// QuoteRespStatus is an enum that represents the status of a quote response.
+enum QuoteRespStatus {
+    // INVALID_RATE_TICK indicates that the rate tick in the quote response is
+    // invalid.
+    INVALID_RATE_TICK = 0;
+
+    // INVALID_EXPIRY indicates that the expiry in the quote response is
+    // invalid.
+    INVALID_EXPIRY = 1;
+
+    // PRICE_ORACLE_QUERY_ERR indicates that an error occurred when querying the
+    // price oracle whilst evaluating the quote response.
+    PRICE_ORACLE_QUERY_ERR = 2;
+}
+
+// InvalidQuoteResponse is a message that is returned when a quote response is
+// invalid or insufficient.
+message InvalidQuoteResponse {
+    // status is the status of the quote response.
+    QuoteRespStatus status = 1;
+
+    // peer is the quote counterparty peer.
+    string peer = 2;
+
+    // id is the unique identifier of the quote request.
+    bytes id = 3;
+}
+
+// RejectedQuoteResponse is a message that is returned when a quote request is
+// rejected by the peer.
+message RejectedQuoteResponse {
+    // peer is the quote counterparty peer.
+    string peer = 1;
+
+    // id is the unique identifier of the quote request.
+    bytes id = 2;
+
+    // error_message is a human-readable error message.
+    string error_message = 3;
+
+    // error_code is a machine-readable error code.
+    uint32 error_code = 4;
+}
+
+message QueryPeerAcceptedQuotesResponse {
+    // buy_quotes is a list of asset buy quotes which were requested by our
+    // node and have been accepted by our peers.
+    repeated PeerAcceptedBuyQuote buy_quotes = 1;
+
+    // sell_quotes is a list of asset sell quotes which were requested by our
+    // node and have been accepted by our peers.
+    repeated PeerAcceptedSellQuote sell_quotes = 2;
+}
+
+message SubscribeRfqEventNtfnsRequest {
+}
+
+message PeerAcceptedBuyQuoteEvent {
+    // Unix timestamp in microseconds.
+    uint64 timestamp = 1;
+
+    // The asset buy quote that was accepted by out peer.
+    PeerAcceptedBuyQuote peer_accepted_buy_quote = 2;
+}
+
+message PeerAcceptedSellQuoteEvent {
+    // Unix timestamp in microseconds.
+    uint64 timestamp = 1;
+
+    // The asset sell quote that was accepted by out peer.
+    PeerAcceptedSellQuote peer_accepted_sell_quote = 2;
+}
+
+message AcceptHtlcEvent {
+    // Unix timestamp in microseconds.
+    uint64 timestamp = 1;
+
+    // scid is the short channel ID of the channel over which the payment for
+    // the quote is made.
+    uint64 scid = 2;
+}
+
+message RfqEvent {
+    oneof event {
+        // peer_accepted_buy_quote is an event that is emitted when a peer
+        // accepted (incoming) asset buy quote message is received.
+        PeerAcceptedBuyQuoteEvent peer_accepted_buy_quote = 1;
+
+        // peer_accepted_sell_offer is an event that is emitted when a peer
+        // accepted (incoming) asset sell quote message is received.
+        PeerAcceptedSellQuoteEvent peer_accepted_sell_quote = 2;
+
+        // accept_htlc is an event that is sent when a HTLC is accepted by the
+        // RFQ service.
+        AcceptHtlcEvent accept_htlc = 3;
+    }
+}