Update rpc files for v0.8.0-beta

This commit is contained in:
bumi 2019-10-27 15:52:31 +01:00
parent ac284d3e06
commit 3e622ebb54
3 changed files with 19 additions and 28 deletions

View File

@ -888,8 +888,9 @@ message SendRequest {
uint64 outgoing_chan_id = 9;
/**
An optional maximum total time lock for the route. If zero, there is no
maximum enforced.
An optional maximum total time lock for the route. This should not exceed
lnd's `--max-cltv-expiry` setting. If zero, then the value of
`--max-cltv-expiry` is enforced.
*/
uint32 cltv_limit = 10;
@ -1743,12 +1744,11 @@ message QueryRoutesRequest {
repeated NodePair ignored_pairs = 10;
/**
An optional field that can be used to pass an arbitrary set of TLV records
to a peer which understands the new records. This can be used to pass
application specific data during the payment attempt. If the destination
does not support the specified recrods, and error will be returned.
An optional maximum total time lock for the route. If the source is empty or
ourselves, this should not exceed lnd's `--max-cltv-expiry` setting. If
zero, then the value of `--max-cltv-expiry` is used as the limit.
*/
map<uint64, bytes> dest_tlv = 11;
uint32 cltv_limit = 11;
}
message NodePair {
@ -1808,17 +1808,9 @@ message Hop {
/**
If set to true, then this hop will be encoded using the new variable length
TLV format. Note that if any custom tlv_records below are specified, then
this field MUST be set to true for them to be encoded properly.
TLV format.
*/
bool tlv_payload = 9 [json_name = "tlv_payload"];
/**
An optional set of key-value TLV records. This is useful within the context
of the SendToRoute call as it allows callers to specify arbitrary K-V pairs
to drop off at each hop within the onion.
*/
map<uint64, bytes> tlv_records = 10 [json_name = "tlv_records"];
}
/**
@ -2204,7 +2196,7 @@ message Invoice {
enum InvoiceHTLCState {
ACCEPTED = 0;
SETTLED = 1;
CANCELLED = 2;
CANCELED = 2;
}
/// Details of an HTLC that paid to an invoice
@ -2224,7 +2216,7 @@ message InvoiceHTLC {
/// Time at which this htlc was accepted.
int64 accept_time = 5 [json_name = "accept_time"];
/// Time at which this htlc was settled or cancelled.
/// Time at which this htlc was settled or canceled.
int64 resolve_time = 6 [json_name = "resolve_time"];
/// Block height at which this htlc expires.

View File

@ -440,7 +440,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
optional :source_pub_key, :string, 8
optional :use_mission_control, :bool, 9
repeated :ignored_pairs, :message, 10, "lnrpc.NodePair"
map :dest_tlv, :uint64, :bytes, 11
optional :cltv_limit, :uint32, 11
end
add_message "lnrpc.NodePair" do
optional :from, :bytes, 1
@ -464,7 +464,6 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
optional :fee_msat, :int64, 7
optional :pub_key, :string, 8
optional :tlv_payload, :bool, 9
map :tlv_records, :uint64, :bytes, 10
end
add_message "lnrpc.Route" do
optional :total_time_lock, :uint32, 1
@ -788,7 +787,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
add_enum "lnrpc.InvoiceHTLCState" do
value :ACCEPTED, 0
value :SETTLED, 1
value :CANCELLED, 2
value :CANCELED, 2
end
end

View File

@ -2,7 +2,7 @@
# Source: rpc.proto for package 'lnrpc'
require 'grpc'
require 'rpc_pb'
require_relative 'rpc_pb'
module Lnrpc
module WalletUnlocker
@ -10,19 +10,19 @@ module Lnrpc
# Comments in this file will be directly parsed into the API
# Documentation as descriptions of the associated method, message, or field.
# These descriptions should go right above the definition of the object, and
# can be in either block or /// comment format.
#
# can be in either block or /// comment format.
#
# One edge case exists where a // comment followed by a /// comment in the
# next line will cause the description not to show up in the documentation. In
# that instance, simply separate the two comments with a blank line.
#
#
# An RPC method can be matched to an lncli command by placing a line in the
# beginning of the description in exactly the following format:
# lncli: `methodname`
#
#
# Failure to specify the exact name of the command will cause documentation
# generation to fail.
#
#
# More information on how exactly the gRPC documentation is generated from
# this proto file can be found here:
# https://github.com/lightninglabs/lightning-api
@ -47,7 +47,7 @@ module Lnrpc
# method should be used to commit the newly generated seed, and create the
# wallet.
rpc :GenSeed, GenSeedRequest, GenSeedResponse
# *
# *
# InitWallet is used when lnd is starting up for the first time to fully
# initialize the daemon and its internal wallet. At the very least a wallet
# password must be provided. This will be used to encrypt sensitive material