mirror/lnd
1
0 Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

lncli+lnrpc: update docs for sat_per_byte

Browse Source 
Update the documentation for the field `sat_per_byte`. While the name
suggests it’s sat per byte, the value is actually in sat per virtual
byte.
This commit is contained in:
yyforyongyu committed 2021-03-26 17:09:14 +08:00
1 parent d85d82824c
commit 2466758acd
9 files changed
+35 -35
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

lnrpc/walletrpc/walletkit.pb.go
+5 -5
View File
@@ -839,9 +839,9 @@ type PendingSweep struct {
// The value of the output we're attempting to sweep.
AmountSat uint32 `protobuf:"varint,3,opt,name=amount_sat,json=amountSat,proto3" json:"amount_sat,omitempty"`
//
//The fee rate we'll use to sweep the output. The fee rate is only determined
//once a sweeping transaction for the output is created, so it's possible for
//this to be 0 before this.
//The fee rate we'll use to sweep the output, expressed in sat/vbyte. The fee
//rate is only determined once a sweeping transaction for the output is
//created, so it's possible for this to be 0 before this.
SatPerByte uint32 `protobuf:"varint,4,opt,name=sat_per_byte,json=satPerByte,proto3" json:"sat_per_byte,omitempty"`
// The number of broadcast attempts we've made to sweep the output.
BroadcastAttempts uint32 `protobuf:"varint,5,opt,name=broadcast_attempts,json=broadcastAttempts,proto3" json:"broadcast_attempts,omitempty"`
@@ -851,7 +851,7 @@ type PendingSweep struct {
NextBroadcastHeight uint32 `protobuf:"varint,6,opt,name=next_broadcast_height,json=nextBroadcastHeight,proto3" json:"next_broadcast_height,omitempty"`
// The requested confirmation target for this output.
RequestedConfTarget uint32 `protobuf:"varint,8,opt,name=requested_conf_target,json=requestedConfTarget,proto3" json:"requested_conf_target,omitempty"`
// The requested fee rate, expressed in sat/byte, for this output.
// The requested fee rate, expressed in sat/vbyte, for this output.
RequestedSatPerByte uint32 `protobuf:"varint,9,opt,name=requested_sat_per_byte,json=requestedSatPerByte,proto3" json:"requested_sat_per_byte,omitempty"`
//
//Whether this input must be force-swept. This means that it is swept even
@@ -1028,7 +1028,7 @@ type BumpFeeRequest struct {
// The target number of blocks that the input should be spent within.
TargetConf uint32 `protobuf:"varint,2,opt,name=target_conf,json=targetConf,proto3" json:"target_conf,omitempty"`
//
//The fee rate, expressed in sat/byte, that should be used to spend the input
//The fee rate, expressed in sat/vbyte, that should be used to spend the input
//with.
SatPerByte uint32 `protobuf:"varint,3,opt,name=sat_per_byte,json=satPerByte,proto3" json:"sat_per_byte,omitempty"`
//
lnrpc/walletrpc/walletkit.proto
+5 -5
View File
@@ -409,9 +409,9 @@ message PendingSweep {
uint32 amount_sat = 3;
/*
The fee rate we'll use to sweep the output. The fee rate is only determined
once a sweeping transaction for the output is created, so it's possible for
this to be 0 before this.
The fee rate we'll use to sweep the output, expressed in sat/vbyte. The fee
rate is only determined once a sweeping transaction for the output is
created, so it's possible for this to be 0 before this.
*/
uint32 sat_per_byte = 4;
@@ -427,7 +427,7 @@ message PendingSweep {
// The requested confirmation target for this output.
uint32 requested_conf_target = 8;
// The requested fee rate, expressed in sat/byte, for this output.
// The requested fee rate, expressed in sat/vbyte, for this output.
uint32 requested_sat_per_byte = 9;
/*
@@ -455,7 +455,7 @@ message BumpFeeRequest {
uint32 target_conf = 2;
/*
The fee rate, expressed in sat/byte, that should be used to spend the input
The fee rate, expressed in sat/vbyte, that should be used to spend the input
with.
*/
uint32 sat_per_byte = 3;
lnrpc/walletrpc/walletkit.swagger.json
+3 -3
View File
@@ -758,7 +758,7 @@
"sat_per_byte": {
"type": "integer",
"format": "int64",
"description": "The fee rate, expressed in sat/byte, that should be used to spend the input\nwith."
"description": "The fee rate, expressed in sat/vbyte, that should be used to spend the input\nwith."
},
"force": {
"type": "boolean",
@@ -971,7 +971,7 @@
"sat_per_byte": {
"type": "integer",
"format": "int64",
"description": "The fee rate we'll use to sweep the output. The fee rate is only determined\nonce a sweeping transaction for the output is created, so it's possible for\nthis to be 0 before this."
"description": "The fee rate we'll use to sweep the output, expressed in sat/vbyte. The fee\nrate is only determined once a sweeping transaction for the output is\ncreated, so it's possible for this to be 0 before this."
},
"broadcast_attempts": {
"type": "integer",
@@ -991,7 +991,7 @@
"requested_sat_per_byte": {
"type": "integer",
"format": "int64",
"description": "The requested fee rate, expressed in sat/byte, for this output."
"description": "The requested fee rate, expressed in sat/vbyte, for this output."
},
"force": {
"type": "boolean",