astra-lightning 1.0.2 → 1.1.1

package/grpc/grpc_services.json

@@ -34,7 +34,7 @@
     "WalletKit": "walletkit.proto",
     "Watchtower": "watchtower.proto",
     "WatchtowerClient": "wtclient.proto",
-    "TaprootAssetChannels":"taprootassetchannels.proto"
+    "TaprootAssetChannels":"tapchannelrpc.proto"
   },
   "protosDir": "../grpc/protos",
   "serviceTypes": {

package/grpc/protos/invoices.proto

@@ -204,10 +204,10 @@ message LookupInvoiceMsg {
 
 // CircuitKey is a unique identifier for an HTLC.
 message CircuitKey {
-    /// The id of the channel that the is part of this circuit.
+    // The id of the channel that the is part of this circuit.
     uint64 chan_id = 1;
 
-    /// The index of the incoming htlc in the incoming channel.
+    // The index of the incoming htlc in the incoming channel.
     uint64 htlc_id = 2;
 }
 
@@ -240,6 +240,12 @@ message HtlcModifyResponse {
     // The modified amount in milli-satoshi that the exit HTLC is paying. This
     // value can be different from the actual on-chain HTLC amount, in case the
     // HTLC carries other valuable items, as can be the case with custom channel
-    // types. In order to not modify this value, the client should set it zero.
-    uint64 amt_paid = 2;
+    // types.
+    optional uint64 amt_paid = 2;
+
+    // This flag indicates whether the HTLCs associated with the invoices should
+    // be cancelled. The interceptor client may set this field if some
+    // unexpected behavior is encountered. Setting this will ignore the amt_paid
+    // field.
+    bool cancel_set = 3;
 }

package/grpc/protos/lightning.proto

@@ -1190,9 +1190,8 @@ message SendCoinsRequest {
     int64 sat_per_byte = 5 [deprecated = true];
 
     /*
-    If set, then the amount field will be ignored, and lnd will attempt to
-    send all the coins under control of the internal wallet to the specified
-    address.
+    If set, the amount field should be unset. It indicates lnd will send all
+    wallet coins or all selected coins to the specified address.
     */
     bool send_all = 6;
 
@@ -1208,6 +1207,9 @@ message SendCoinsRequest {
 
     // The strategy to use for selecting coins.
     CoinSelectionStrategy coin_selection_strategy = 10;
+
+    // A list of selected outpoints as inputs for the transaction.
+    repeated OutPoint outpoints = 11;
 }
 message SendCoinsResponse {
     // The transaction ID of the transaction
@@ -3341,6 +3343,20 @@ message Route {
     The total amount in millisatoshis.
     */
     int64 total_amt_msat = 6;
+
+    /*
+    The actual on-chain amount that was sent out to the first hop. This value is
+    only different from the total_amt_msat field if this is a custom channel
+    payment and the value transported in the HTLC is different from the BTC
+    amount in the HTLC. If this value is zero, then this is an old payment that
+    didn't have this value yet and can be ignored.
+    */
+    int64 first_hop_amount_msat = 7;
+
+    /*
+    Custom channel data that might be populated in custom channels.
+    */
+    bytes custom_channel_data = 8;
 }
 
 message NodeInfoRequest {
@@ -3493,6 +3509,10 @@ message ChanInfoRequest {
     output index for the channel.
     */
     uint64 chan_id = 1 [jstype = JS_STRING];
+
+    // The channel point of the channel in format funding_txid:output_index. If
+    // chan_id is specified, this field is ignored.
+    string chan_point = 2;
 }
 
 message NetworkInfoRequest {
@@ -3882,6 +3902,48 @@ message Invoice {
     Note: Output only, don't specify for creating an invoice.
     */
     map<string, AMPInvoiceState> amp_invoice_state = 28;
+
+    /*
+    Signals that the invoice should include blinded paths to hide the true
+    identity of the recipient.
+    */
+    bool is_blinded = 29;
+
+    /*
+    Config values to use when creating blinded paths for this invoice. These
+    can be used to override the defaults config values provided in by the
+    global config. This field is only used if is_blinded is true.
+    */
+    BlindedPathConfig blinded_path_config = 30;
+}
+
+message BlindedPathConfig {
+    /*
+    The minimum number of real hops to include in a blinded path. This doesn't
+    include our node, so if the minimum is 1, then the path will contain at
+    minimum our node along with an introduction node hop. If it is zero then
+    the shortest path will use our node as an introduction node.
+    */
+    optional uint32 min_num_real_hops = 1;
+
+    /*
+    The number of hops to include in a blinded path. This doesn't include our
+    node, so if it is 1, then the path will contain our node along with an
+    introduction node or dummy node hop. If paths shorter than NumHops is
+    found, then they will be padded using dummy hops.
+    */
+    optional uint32 num_hops = 2;
+
+    /*
+    The maximum number of blinded paths to select and add to an invoice.
+    */
+    optional uint32 max_num_paths = 3;
+
+    /*
+    A list of node IDs of nodes that should not be used in any of our generated
+    blinded paths.
+    */
+    repeated bytes node_omission_list = 4;
 }
 
 enum InvoiceHTLCState {
@@ -3925,9 +3987,10 @@ message InvoiceHTLC {
     // Details relevant to AMP HTLCs, only populated if this is an AMP HTLC.
     AMP amp = 11;
 
-    // Custom tlv records that were only sent on the p2p wire message, not in
-    // the onion.
-    map<uint64, bytes> wire_custom_records = 12;
+    /*
+    Custom channel data that might be populated in custom channels.
+    */
+    bytes custom_channel_data = 12;
 }
 
 // Details specific to AMP HTLCs.
@@ -4094,6 +4157,11 @@ enum PaymentFailureReason {
     Insufficient local balance.
     */
     FAILURE_REASON_INSUFFICIENT_BALANCE = 5;
+
+    /*
+    The payment was canceled.
+    */
+    FAILURE_REASON_CANCELED = 6;
 }
 
 message Payment {
@@ -4163,6 +4231,12 @@ message Payment {
     uint64 payment_index = 15;
 
     PaymentFailureReason failure_reason = 16;
+
+    /*
+    The custom TLV records that were sent to the first hop as part of the HTLC
+    wire message for this payment.
+    */
+    map<uint64, bytes> first_hop_custom_records = 17;
 }
 
 message HTLCAttempt {
@@ -4339,6 +4413,7 @@ message PayReq {
     bytes payment_addr = 11;
     int64 num_msat = 12;
     map<uint32, Feature> features = 13;
+    repeated BlindedPaymentPath blinded_paths = 14;
 }
 
 enum FeatureBit {

package/grpc/protos/rfqrpc/rfq.proto

@@ -8,6 +8,26 @@ 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.
+
+    A buy order instructs the RFQ (Request For Quote) system to request a quote
+    from a peer for the acquisition of an asset.
+
+    The normal use of a buy order is as follows:
+    1. Alice, operating a wallet node, wants to receive a Tap asset as payment
+       by issuing a Lightning invoice.
+    2. Alice has an asset channel established with Bob's edge node.
+    3. Before issuing the invoice, Alice needs to agree on an exchange rate with
+       Bob, who will facilitate the asset transfer.
+    4. To obtain the best exchange rate, Alice creates a buy order specifying
+       the desired asset.
+    5. Alice's RFQ subsystem processes the buy order and sends buy requests to
+       relevant peers to find the best rate. In this example, Bob is the only
+       available peer.
+    6. Once Bob provides a satisfactory quote, Alice accepts it.
+    7. Alice issues the Lightning invoice, which Charlie will pay.
+    8. Instead of paying Alice directly, Charlie pays Bob.
+    9. Bob then forwards the agreed amount of the Tap asset to Alice over their
+       asset channel.
     */
     rpc AddAssetBuyOrder (AddAssetBuyOrderRequest)
         returns (AddAssetBuyOrderResponse);
@@ -67,26 +87,63 @@ message AssetSpecifier {
     }
 }
 
+// FixedPoint is a scaled integer representation of a fractional number.
+//
+// This type consists of two integer fields: a coefficient and a scale.
+// Using this format enables precise and consistent representation of fractional
+// numbers while avoiding floating-point data types, which are prone to
+// precision errors.
+//
+// The relationship between the fractional representation and its fixed-point
+// representation is expressed as:
+// ```
+// V = F_c / (10^F_s)
+// ```
+// where:
+//
+// * `V` is the fractional value.
+//
+// * `F_c` is the coefficient component of the fixed-point representation. It is
+//    the scaled-up fractional value represented as an integer.
+//
+// * `F_s` is the scale component. It is an integer specifying how
+//   many decimal places `F_c` should be divided by to obtain the fractional
+//   representation.
+message FixedPoint {
+    // The coefficient is the fractional value scaled-up as an integer. This
+    // integer is represented as a string as it may be too large to fit in a
+    // uint64.
+    string coefficient = 1;
+
+    // The scale is the component that determines how many decimal places
+    // the coefficient should be divided by to obtain the fractional value.
+    uint32 scale = 2;
+}
+
 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 maximum amount of the asset that the provider must be willing to
+    // offer.
+    uint64 asset_max_amt = 2;
 
     // The unix timestamp in seconds after which the order is no longer valid.
-    uint64 expiry = 4;
+    uint64 expiry = 3;
 
     // 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;
+    bytes peer_pub_key = 4;
 
     // 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;
+    uint32 timeout_seconds = 5;
+
+    // If set, the check if a channel with the given asset exists with the peer
+    // will be skipped. An active channel with the peer is still required for
+    // the RFQ negotiation to work. This flag shouldn't be set outside of test
+    // scenarios.
+    bool skip_asset_channel_check = 6;
 }
 
 message AddAssetBuyOrderResponse {
@@ -109,22 +166,26 @@ 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 maximum msat amount that the responding peer must agree to pay
+    // (units: millisats).
+    uint64 payment_max_amt = 2;
 
     // The unix timestamp in seconds after which the order is no longer valid.
-    uint64 expiry = 4;
+    uint64 expiry = 3;
 
     // 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;
+    bytes peer_pub_key = 4;
 
     // 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;
+    uint32 timeout_seconds = 5;
+
+    // If set, the check if a channel with the given asset exists with the peer
+    // will be skipped. An active channel with the peer is still required for
+    // the RFQ negotiation to work. This flag shouldn't be set outside of test
+    // scenarios.
+    bool skip_asset_channel_check = 6;
 }
 
 message AddAssetSellOrderResponse {
@@ -175,18 +236,28 @@ message PeerAcceptedBuyQuote {
     // 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.
+    // 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;
+    // The maximum exchange amount denoted in the subject asset. This includes
+    // the user-configured maximum routing fees, so the actual payment amount
+    // will be less than this. This just defines the maximum volume that the
+    // edge node has accepted to divest with the given rate.
+    uint64 asset_max_amount = 4;
 
-    // ask_price is the price in milli-satoshi per asset unit.
-    uint64 ask_price = 5;
+    // ask_asset_rate is the asset to BTC conversion rate represented as a
+    // fixed-point number.
+    FixedPoint ask_asset_rate = 5;
 
     // The unix timestamp in seconds after which the quote is no longer valid.
     uint64 expiry = 6;
+
+    // The smallest amount of asset units that can be transported within a
+    // single HTLC over the Lightning Network with the given rate. This is the
+    // asset unit equivalent of 354 satoshis, which is the minimum amount for an
+    // HTLC to be above the dust limit.
+    uint64 min_transportable_units = 7;
 }
 
 message PeerAcceptedSellQuote {
@@ -203,18 +274,26 @@ message PeerAcceptedSellQuote {
     // 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;
+    // bid_asset_rate is the asset to BTC conversion rate represented as a
+    // fixed-point number.
+    FixedPoint bid_asset_rate = 5;
 
     // The unix timestamp in seconds after which the quote is no longer valid.
     uint64 expiry = 6;
+
+    // The minimum amount of milli-satoshis that need to be sent out in order to
+    // transport a single asset unit over the Lightning Network with the given
+    // rate. This is the base amount of 354,000 milli-satoshi (the minimum
+    // amount for a non-dust HTLC) plus the equivalent of one asset unit in
+    // milli-satoshis.
+    uint64 min_transportable_msat = 7;
 }
 
 // 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_ASSET_RATES indicates that at least one asset rate in the
+    // quote response is invalid.
+    INVALID_ASSET_RATES = 0;
 
     // INVALID_EXPIRY indicates that the expiry in the quote response is
     // invalid.
@@ -306,4 +385,4 @@ message RfqEvent {
         // RFQ service.
         AcceptHtlcEvent accept_htlc = 3;
     }
-}
+}

package/grpc/protos/router.proto

@@ -176,6 +176,25 @@ service Router {
     */
     rpc UpdateChanStatus (UpdateChanStatusRequest)
         returns (UpdateChanStatusResponse);
+
+    /*
+    XAddLocalChanAliases is an experimental API that creates a set of new
+    channel SCID alias mappings. The final total set of aliases in the manager
+    after the add operation is returned. This is only a locally stored alias,
+    and will not be communicated to the channel peer via any message. Therefore,
+    routing over such an alias will only work if the peer also calls this same
+    RPC on their end. If an alias already exists, an error is returned
+    */
+    rpc XAddLocalChanAliases (AddAliasesRequest) returns (AddAliasesResponse);
+
+    /*
+    XDeleteLocalChanAliases is an experimental API that deletes a set of alias
+    mappings. The final total set of aliases in the manager after the delete
+    operation is returned. The deletion will not be communicated to the channel
+    peer via any message.
+    */
+    rpc XDeleteLocalChanAliases (DeleteAliasesRequest)
+        returns (DeleteAliasesResponse);
 }
 
 message SendPaymentRequest {
@@ -339,6 +358,15 @@ message SendPaymentRequest {
     being sent.
     */
     bool cancelable = 24;
+
+    /*
+    An optional field that can be used to pass an arbitrary set of TLV records
+    to the first hop peer of this payment. This can be used to pass application
+    specific data during the payment attempt. Record types are required to be in
+    the custom range >= 65536. When using REST, the values must be encoded as
+    base64.
+    */
+    map<uint64, bytes> first_hop_custom_records = 25;
 }
 
 message TrackPaymentRequest {
@@ -432,6 +460,15 @@ message SendToRouteRequest {
     routes, incorrect payment details, or insufficient funds.
     */
     bool skip_temp_err = 3;
+
+    /*
+    An optional field that can be used to pass an arbitrary set of TLV records
+    to the first hop peer of this payment. This can be used to pass application
+    specific data during the payment attempt. Record types are required to be in
+    the custom range >= 65536. When using REST, the values must be encoded as
+    base64.
+    */
+    map<uint64, bytes> first_hop_custom_records = 4;
 }
 
 message SendToRouteResponse {
@@ -707,6 +744,15 @@ message BuildRouteRequest {
     This is also called payment secret in specifications (e.g. BOLT 11).
     */
     bytes payment_addr = 5;
+
+    /*
+    An optional field that can be used to pass an arbitrary set of TLV records
+    to the first hop peer of this payment. This can be used to pass application
+    specific data during the payment attempt. Record types are required to be in
+    the custom range >= 65536. When using REST, the values must be encoded as
+    base64.
+    */
+    map<uint64, bytes> first_hop_custom_records = 6;
 }
 
 message BuildRouteResponse {
@@ -963,12 +1009,17 @@ message ForwardHtlcInterceptRequest {
     // The block height at which this htlc will be auto-failed to prevent the
     // channel from force-closing.
     int32 auto_fail_height = 10;
+
+    // The custom records of the peer's incoming p2p wire message.
+    map<uint64, bytes> in_wire_custom_records = 11;
 }
 
 /**
 ForwardHtlcInterceptResponse enables the caller to resolve a previously hold
 forward. The caller can choose either to:
 - `Resume`: Execute the default behavior (usually forward).
+- `ResumeModified`: Execute the default behavior (usually forward) with HTLC
+                    field modifications.
 - `Reject`: Fail the htlc backwards.
 - `Settle`: Settle this htlc with a given preimage.
 */
@@ -999,12 +1050,36 @@ message ForwardHtlcInterceptResponse {
     // For backwards-compatibility reasons, TEMPORARY_CHANNEL_FAILURE is the
     // default value for this field.
     lnrpc.Failure.FailureCode failure_code = 5;
+
+    // The amount that was set on the p2p wire message of the incoming HTLC.
+    // This field is ignored if the action is not RESUME_MODIFIED or the amount
+    // is zero.
+    uint64 in_amount_msat = 6;
+
+    // The amount to set on the p2p wire message of the resumed HTLC. This field
+    // is ignored if the action is not RESUME_MODIFIED or the amount is zero.
+    uint64 out_amount_msat = 7;
+
+    // Any custom records that should be set on the p2p wire message message of
+    // the resumed HTLC. This field is ignored if the action is not
+    // RESUME_MODIFIED.
+    map<uint64, bytes> out_wire_custom_records = 8;
 }
 
 enum ResolveHoldForwardAction {
+    // SETTLE is an action that is used to settle an HTLC instead of forwarding
+    // it.
     SETTLE = 0;
+
+    // FAIL is an action that is used to fail an HTLC backwards.
     FAIL = 1;
+
+    // RESUME is an action that is used to resume a forward HTLC.
     RESUME = 2;
+
+    // RESUME_MODIFIED is an action that is used to resume a hold forward HTLC
+    // with modifications specified during interception.
+    RESUME_MODIFIED = 3;
 }
 
 message UpdateChanStatusRequest {
@@ -1020,4 +1095,20 @@ enum ChanStatusAction {
 }
 
 message UpdateChanStatusResponse {
+}
+
+message AddAliasesRequest {
+    repeated lnrpc.AliasMap alias_maps = 1;
+}
+
+message AddAliasesResponse {
+    repeated lnrpc.AliasMap alias_maps = 1;
+}
+
+message DeleteAliasesRequest {
+    repeated lnrpc.AliasMap alias_maps = 1;
+}
+
+message DeleteAliasesResponse {
+    repeated lnrpc.AliasMap alias_maps = 1;
 }

package/grpc/protos/routerrpc/router.proto

@@ -179,17 +179,19 @@ service Router {
 
     /*
     XAddLocalChanAliases is an experimental API that creates a set of new
-    channel SCID alias mappings. The list of successfully created mappings is
-    returned. This is only a locally stored alias, and will not be communicated
-    to the channel peer via any message. Therefore, routing over such an alias
-    will only work of the peer also calls this same RPC on their end.
+    channel SCID alias mappings. The final total set of aliases in the manager
+    after the add operation is returned. This is only a locally stored alias,
+    and will not be communicated to the channel peer via any message. Therefore,
+    routing over such an alias will only work if the peer also calls this same
+    RPC on their end. If an alias already exists, an error is returned
     */
     rpc XAddLocalChanAliases (AddAliasesRequest) returns (AddAliasesResponse);
 
     /*
-    XDeleteLocalChanAliases is an experimental API that deletes a set of new
-    alias mappings. The list of successfully deleted mappings is returned. The
-    deletion will not be communicated to the channel peer via any message.
+    XDeleteLocalChanAliases is an experimental API that deletes a set of alias
+    mappings. The final total set of aliases in the manager after the delete
+    operation is returned. The deletion will not be communicated to the channel
+    peer via any message.
     */
     rpc XDeleteLocalChanAliases (DeleteAliasesRequest)
         returns (DeleteAliasesResponse);
@@ -348,6 +350,15 @@ message SendPaymentRequest {
     */
     double time_pref = 23;
 
+    /*
+    If set, the payment loop can be interrupted by manually canceling the
+    payment context, even before the payment timeout is reached. Note that the
+    payment may still succeed after cancellation, as in-flight attempts can
+    still settle afterwards. Canceling will only prevent further attempts from
+    being sent.
+    */
+    bool cancelable = 24;
+
     /*
     An optional field that can be used to pass an arbitrary set of TLV records
     to the first hop peer of this payment. This can be used to pass application
@@ -355,7 +366,7 @@ message SendPaymentRequest {
     the custom range >= 65536. When using REST, the values must be encoded as
     base64.
     */
-    map<uint64, bytes> first_hop_custom_records = 24;
+    map<uint64, bytes> first_hop_custom_records = 25;
 }
 
 message TrackPaymentRequest {
@@ -449,6 +460,15 @@ message SendToRouteRequest {
     routes, incorrect payment details, or insufficient funds.
     */
     bool skip_temp_err = 3;
+
+    /*
+    An optional field that can be used to pass an arbitrary set of TLV records
+    to the first hop peer of this payment. This can be used to pass application
+    specific data during the payment attempt. Record types are required to be in
+    the custom range >= 65536. When using REST, the values must be encoded as
+    base64.
+    */
+    map<uint64, bytes> first_hop_custom_records = 4;
 }
 
 message SendToRouteResponse {
@@ -724,6 +744,15 @@ message BuildRouteRequest {
     This is also called payment secret in specifications (e.g. BOLT 11).
     */
     bytes payment_addr = 5;
+
+    /*
+    An optional field that can be used to pass an arbitrary set of TLV records
+    to the first hop peer of this payment. This can be used to pass application
+    specific data during the payment attempt. Record types are required to be in
+    the custom range >= 65536. When using REST, the values must be encoded as
+    base64.
+    */
+    map<uint64, bytes> first_hop_custom_records = 6;
 }
 
 message BuildRouteResponse {
@@ -981,8 +1010,8 @@ message ForwardHtlcInterceptRequest {
     // channel from force-closing.
     int32 auto_fail_height = 10;
 
-    // The custom records of the peer's incoming wire message.
-    map<uint64, bytes> incoming_htlc_wire_custom_records = 11;
+    // The custom records of the peer's incoming p2p wire message.
+    map<uint64, bytes> in_wire_custom_records = 11;
 }
 
 /**
@@ -1022,22 +1051,30 @@ message ForwardHtlcInterceptResponse {
     // default value for this field.
     lnrpc.Failure.FailureCode failure_code = 5;
 
-    // incoming_amount_msat is used to set the p2p message incoming amount field
-    // for validating an incoming HTLC.
-    uint64 incoming_amount_msat = 6;
+    // The amount that was set on the p2p wire message of the incoming HTLC.
+    // This field is ignored if the action is not RESUME_MODIFIED or the amount
+    // is zero.
+    uint64 in_amount_msat = 6;
 
-    // outgoing_amount_msat is used to set the p2p message outgoing amount field
-    // for resuming a HTLC.
-    uint64 outgoing_amount_msat = 7;
+    // The amount to set on the p2p wire message of the resumed HTLC. This field
+    // is ignored if the action is not RESUME_MODIFIED or the amount is zero.
+    uint64 out_amount_msat = 7;
 
-    // Outgoing htlc wire custom records is used to set the p2p message custom
-    // records field for resuming a HTLC.
-    map<uint64, bytes> outgoing_htlc_wire_custom_records = 8;
+    // Any custom records that should be set on the p2p wire message message of
+    // the resumed HTLC. This field is ignored if the action is not
+    // RESUME_MODIFIED.
+    map<uint64, bytes> out_wire_custom_records = 8;
 }
 
 enum ResolveHoldForwardAction {
+    // SETTLE is an action that is used to settle an HTLC instead of forwarding
+    // it.
     SETTLE = 0;
+
+    // FAIL is an action that is used to fail an HTLC backwards.
     FAIL = 1;
+
+    // RESUME is an action that is used to resume a forward HTLC.
     RESUME = 2;
 
     // RESUME_MODIFIED is an action that is used to resume a hold forward HTLC