Merge pull request #6644 from guggero/connect-peer-request-comment

lnrpc: fix comment and formatting in ConnectPeerRequest [skip ci]
This commit is contained in:
Oliver Gugger 2022-06-15 09:57:34 +02:00 committed by GitHub
commit 9e6f0ef46b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 19 additions and 13 deletions

View file

@ -2931,10 +2931,10 @@ type LightningAddress struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// The identity pubkey of the Lightning node
// The identity pubkey of the Lightning node.
Pubkey string `protobuf:"bytes,1,opt,name=pubkey,proto3" json:"pubkey,omitempty"`
// The network location of the lightning node, e.g. `69.69.69.69:1337` or
// `localhost:10011`
// `localhost:10011`.
Host string `protobuf:"bytes,2,opt,name=host,proto3" json:"host,omitempty"`
}
@ -3919,10 +3919,12 @@ type ConnectPeerRequest struct {
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Lightning address of the peer, in the format `<pubkey>@host`
//
//Lightning address of the peer to connect to.
Addr *LightningAddress `protobuf:"bytes,1,opt,name=addr,proto3" json:"addr,omitempty"`
// If set, the daemon will attempt to persistently connect to the target
// peer. Otherwise, the call will be synchronous.
//
//If set, the daemon will attempt to persistently connect to the target
//peer. Otherwise, the call will be synchronous.
Perm bool `protobuf:"varint,2,opt,name=perm,proto3" json:"perm,omitempty"`
//
//The connection timeout value (in seconds) for this request. It won't affect

View file

@ -1008,11 +1008,11 @@ message OutPoint {
}
message LightningAddress {
// The identity pubkey of the Lightning node
// The identity pubkey of the Lightning node.
string pubkey = 1;
// The network location of the lightning node, e.g. `69.69.69.69:1337` or
// `localhost:10011`
// `localhost:10011`.
string host = 2;
}
@ -1201,11 +1201,15 @@ message VerifyMessageResponse {
}
message ConnectPeerRequest {
// Lightning address of the peer, in the format `<pubkey>@host`
/*
Lightning address of the peer to connect to.
*/
LightningAddress addr = 1;
/* If set, the daemon will attempt to persistently connect to the target
* peer. Otherwise, the call will be synchronous. */
/*
If set, the daemon will attempt to persistently connect to the target
peer. Otherwise, the call will be synchronous.
*/
bool perm = 2;
/*

View file

@ -3901,7 +3901,7 @@
"properties": {
"addr": {
"$ref": "#/definitions/lnrpcLightningAddress",
"title": "Lightning address of the peer, in the format `\u003cpubkey\u003e@host`"
"description": "Lightning address of the peer to connect to."
},
"perm": {
"type": "boolean",
@ -4935,11 +4935,11 @@
"properties": {
"pubkey": {
"type": "string",
"title": "The identity pubkey of the Lightning node"
"description": "The identity pubkey of the Lightning node."
},
"host": {
"type": "string",
"title": "The network location of the lightning node, e.g. `69.69.69.69:1337` or\n`localhost:10011`"
"description": "The network location of the lightning node, e.g. `69.69.69.69:1337` or\n`localhost:10011`."
}
}
},