akovalenko/lnd.xprv
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

routerrpc: proto comments updated

Browse Source
This commit is contained in:
Joost Jager 2019-05-28 10:12:12 +02:00
parent cbfc7dd42d
commit cc88bfb560
No known key found for this signature in database
GPG Key ID: A61B9D4C393C59C7
2 changed files with 84 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
lnrpc/routerrpc/router.pb.go
View File

@ -566,41 +566,47 @@ func (m *Failure) GetFlags() uint32 {
} }
type ChannelUpdate struct { type ChannelUpdate struct {
// Signature is used to validate the announced data and prove the //*
// ownership of node id. //The signature that validates the announced data and proves the ownership
//of node id.
Signature []byte `protobuf:"bytes,1,opt,name=signature,proto3" json:"signature,omitempty"` Signature []byte `protobuf:"bytes,1,opt,name=signature,proto3" json:"signature,omitempty"`
// ChainHash denotes the target chain that this channel was opened //*
// within. This value should be the genesis hash of the target chain. //The target chain that this channel was opened within. This value
// Along with the short channel ID, this uniquely identifies the //should be the genesis hash of the target chain. Along with the short
// channel globally in a blockchain. //channel ID, this uniquely identifies the channel globally in a
//blockchain.
ChainHash []byte `protobuf:"bytes,2,opt,name=chain_hash,json=chainHash,proto3" json:"chain_hash,omitempty"` ChainHash []byte `protobuf:"bytes,2,opt,name=chain_hash,json=chainHash,proto3" json:"chain_hash,omitempty"`
// ShortChannelID is the unique description of the funding transaction. //*
//The unique description of the funding transaction.
ChanId uint64 `protobuf:"varint,3,opt,name=chan_id,json=chanId,proto3" json:"chan_id,omitempty"` ChanId uint64 `protobuf:"varint,3,opt,name=chan_id,json=chanId,proto3" json:"chan_id,omitempty"`
// Timestamp allows ordering in the case of multiple announcements. We //*
// should ignore the message if timestamp is not greater than //A timestamp that allows ordering in the case of multiple announcements.
// the last-received. //We should ignore the message if timestamp is not greater than the
//last-received.
Timestamp uint32 `protobuf:"varint,4,opt,name=timestamp,proto3" json:"timestamp,omitempty"` Timestamp uint32 `protobuf:"varint,4,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
// Flags is a bitfield that describes additional meta-data concerning //*
// how the update is to be interpreted. Currently, the //The bitfield that describes additional meta-data concerning how the
// least-significant bit must be set to 0 if the creating node //update is to be interpreted. Currently, the least-significant bit must be
// corresponds to the first node in the previously sent channel //set to 0 if the creating node corresponds to the first node in the
// announcement and 1 otherwise. If the second bit is set, then the //previously sent channel announcement and 1 otherwise. If the second bit
// channel is set to be disabled. //is set, then the channel is set to be disabled.
ChannelFlags uint32 `protobuf:"varint,5,opt,name=channel_flags,json=channelFlags,proto3" json:"channel_flags,omitempty"` ChannelFlags uint32 `protobuf:"varint,5,opt,name=channel_flags,json=channelFlags,proto3" json:"channel_flags,omitempty"`
// TimeLockDelta is the minimum number of blocks this node requires to //*
// be added to the expiry of HTLCs. This is a security parameter //The minimum number of blocks this node requires to be added to the expiry
// determined by the node operator. This value represents the required //of HTLCs. This is a security parameter determined by the node operator.
// gap between the time locks of the incoming and outgoing HTLC's set //This value represents the required gap between the time locks of the
// to this node. //incoming and outgoing HTLC's set to this node.
TimeLockDelta uint32 `protobuf:"varint,6,opt,name=time_lock_delta,json=timeLockDelta,proto3" json:"time_lock_delta,omitempty"` TimeLockDelta uint32 `protobuf:"varint,6,opt,name=time_lock_delta,json=timeLockDelta,proto3" json:"time_lock_delta,omitempty"`
// HtlcMinimumMsat is the minimum HTLC value which will be accepted. //*
//The minimum HTLC value which will be accepted.
HtlcMinimumMsat uint64 `protobuf:"varint,7,opt,name=htlc_minimum_msat,json=htlcMinimumMsat,proto3" json:"htlc_minimum_msat,omitempty"` HtlcMinimumMsat uint64 `protobuf:"varint,7,opt,name=htlc_minimum_msat,json=htlcMinimumMsat,proto3" json:"htlc_minimum_msat,omitempty"`
// BaseFee is the base fee that must be used for incoming HTLC's to //*
// this particular channel. This value will be tacked onto the required //The base fee that must be used for incoming HTLC's to this particular
// for a payment independent of the size of the payment. //channel. This value will be tacked onto the required for a payment
//independent of the size of the payment.
BaseFee uint32 `protobuf:"varint,8,opt,name=base_fee,json=baseFee,proto3" json:"base_fee,omitempty"` BaseFee uint32 `protobuf:"varint,8,opt,name=base_fee,json=baseFee,proto3" json:"base_fee,omitempty"`
// FeeRate is the fee rate that will be charged per millionth of a //*
// satoshi. //The fee rate that will be charged per millionth of a satoshi.
FeeRate uint32 `protobuf:"varint,9,opt,name=fee_rate,json=feeRate,proto3" json:"fee_rate,omitempty"` FeeRate uint32 `protobuf:"varint,9,opt,name=fee_rate,json=feeRate,proto3" json:"fee_rate,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"` XXX_unrecognized []byte `json:"-"`

69
lnrpc/routerrpc/router.proto
View File

@ -164,49 +164,64 @@ message Failure {
message ChannelUpdate { message ChannelUpdate {
// Signature is used to validate the announced data and prove the /**
// ownership of node id. The signature that validates the announced data and proves the ownership
of node id.
*/
bytes signature = 1; bytes signature = 1;
// ChainHash denotes the target chain that this channel was opened /**
// within. This value should be the genesis hash of the target chain. The target chain that this channel was opened within. This value
// Along with the short channel ID, this uniquely identifies the should be the genesis hash of the target chain. Along with the short
// channel globally in a blockchain. channel ID, this uniquely identifies the channel globally in a
blockchain.
*/
bytes chain_hash = 2; bytes chain_hash = 2;
// ShortChannelID is the unique description of the funding transaction. /**
The unique description of the funding transaction.
*/
uint64 chan_id = 3; uint64 chan_id = 3;
// Timestamp allows ordering in the case of multiple announcements. We /**
// should ignore the message if timestamp is not greater than A timestamp that allows ordering in the case of multiple announcements.
// the last-received. We should ignore the message if timestamp is not greater than the
last-received.
*/
uint32 timestamp = 4; uint32 timestamp = 4;
// Flags is a bitfield that describes additional meta-data concerning /**
// how the update is to be interpreted. Currently, the The bitfield that describes additional meta-data concerning how the
// least-significant bit must be set to 0 if the creating node update is to be interpreted. Currently, the least-significant bit must be
// corresponds to the first node in the previously sent channel set to 0 if the creating node corresponds to the first node in the
// announcement and 1 otherwise. If the second bit is set, then the previously sent channel announcement and 1 otherwise. If the second bit
// channel is set to be disabled. is set, then the channel is set to be disabled.
*/
uint32 channel_flags = 5; uint32 channel_flags = 5;
// TimeLockDelta is the minimum number of blocks this node requires to /**
// be added to the expiry of HTLCs. This is a security parameter The minimum number of blocks this node requires to be added to the expiry
// determined by the node operator. This value represents the required of HTLCs. This is a security parameter determined by the node operator.
// gap between the time locks of the incoming and outgoing HTLC's set This value represents the required gap between the time locks of the
// to this node. incoming and outgoing HTLC's set to this node.
*/
uint32 time_lock_delta = 6; uint32 time_lock_delta = 6;
// HtlcMinimumMsat is the minimum HTLC value which will be accepted. /**
The minimum HTLC value which will be accepted.
*/
uint64 htlc_minimum_msat = 7; uint64 htlc_minimum_msat = 7;
// BaseFee is the base fee that must be used for incoming HTLC's to /**
// this particular channel. This value will be tacked onto the required The base fee that must be used for incoming HTLC's to this particular
// for a payment independent of the size of the payment. channel. This value will be tacked onto the required for a payment
independent of the size of the payment.
*/
uint32 base_fee = 8; uint32 base_fee = 8;
// FeeRate is the fee rate that will be charged per millionth of a /**
// satoshi. The fee rate that will be charged per millionth of a satoshi.
*/
uint32 fee_rate = 9; uint32 fee_rate = 9;
} }