akovalenko/lnd.xprv
1
0
Fork 0
Code Issues Pull Requests 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 2020-10-20 10:22:36 +08:00
parent d85d82824c
commit 2466758acd
No known key found for this signature in database
GPG Key ID: 9BCD95C4FF296868
9 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
cmd/lncli/cmd_open_channel.go
View File

@ -121,7 +121,7 @@ var openChannelCommand = cli.Command{
cli.Int64Flag{
Name: "sat_per_byte",
Usage: "(optional) a manual fee expressed in " +
"sat/byte that should be used when crafting " +
"sat/vbyte that should be used when crafting " +
"the transaction",
},
cli.BoolFlag{

8
cmd/lncli/commands.go
View File

@ -255,7 +255,7 @@ var sendCoinsCommand = cli.Command{
cli.Int64Flag{
Name: "sat_per_byte",
Usage: "(optional) a manual fee expressed in " +
"sat/byte that should be used when crafting " +
"sat/vbyte that should be used when crafting " +
"the transaction",
},
cli.Uint64Flag{
@ -481,7 +481,7 @@ var sendManyCommand = cli.Command{
},
cli.Int64Flag{
Name: "sat_per_byte",
Usage: "(optional) a manual fee expressed in sat/byte that should be " +
Usage: "(optional) a manual fee expressed in sat/vbyte that should be " +
"used when crafting the transaction",
},
cli.Uint64Flag{
@ -692,7 +692,7 @@ var closeChannelCommand = cli.Command{
cli.Int64Flag{
Name: "sat_per_byte",
Usage: "(optional) a manual fee expressed in " +
"sat/byte that should be used when crafting " +
"sat/vbyte that should be used when crafting " +
"the transaction",
},
cli.StringFlag{
@ -845,7 +845,7 @@ var closeAllChannelsCommand = cli.Command{
cli.Int64Flag{
Name: "sat_per_byte",
Usage: "(optional) a manual fee expressed in " +
"sat/byte that should be used when crafting " +
"sat/vbyte that should be used when crafting " +
"the closing transactions",
},
},

4
cmd/lncli/walletrpc_active.go
View File

@ -154,7 +154,7 @@ var bumpFeeCommand = cli.Command{
},
cli.Uint64Flag{
Name: "sat_per_byte",
Usage: "a manual fee expressed in sat/byte that " +
Usage: "a manual fee expressed in sat/vbyte that " +
"should be used when sweeping the output",
},
cli.BoolFlag{
@ -217,7 +217,7 @@ var bumpCloseFeeCommand = cli.Command{
},
cli.Uint64Flag{
Name: "sat_per_byte",
Usage: "a manual fee expressed in sat/byte that " +
Usage: "a manual fee expressed in sat/vbyte that " +
"should be used when sweeping the output",
},
},

10
lnrpc/rpc.pb.go
View File

@ -2075,7 +2075,7 @@ func (m *EstimateFeeRequest) GetTargetConf() int32 {
type EstimateFeeResponse struct {
// The total fee in satoshis.
FeeSat int64 `protobuf:"varint,1,opt,name=fee_sat,json=feeSat,proto3" json:"fee_sat,omitempty"`
// The fee rate in satoshi/byte.
// The fee rate in satoshi/vbyte.
FeerateSatPerByte int64 `protobuf:"varint,2,opt,name=feerate_sat_per_byte,json=feerateSatPerByte,proto3" json:"feerate_sat_per_byte,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
@ -2127,7 +2127,7 @@ type SendManyRequest struct {
// The target number of blocks that this transaction should be confirmed
// by.
TargetConf int32 `protobuf:"varint,3,opt,name=target_conf,json=targetConf,proto3" json:"target_conf,omitempty"`
// A manual fee rate set in sat/byte that should be used when crafting the
// A manual fee rate set in sat/vbyte that should be used when crafting the
// transaction.
SatPerByte int64 `protobuf:"varint,5,opt,name=sat_per_byte,json=satPerByte,proto3" json:"sat_per_byte,omitempty"`
// An optional label for the transaction, limited to 500 characters.
@ -2257,7 +2257,7 @@ type SendCoinsRequest struct {
// The target number of blocks that this transaction should be confirmed
// by.
TargetConf int32 `protobuf:"varint,3,opt,name=target_conf,json=targetConf,proto3" json:"target_conf,omitempty"`
// A manual fee rate set in sat/byte that should be used when crafting the
// A manual fee rate set in sat/vbyte that should be used when crafting the
// transaction.
SatPerByte int64 `protobuf:"varint,5,opt,name=sat_per_byte,json=satPerByte,proto3" json:"sat_per_byte,omitempty"`
//
@ -4801,7 +4801,7 @@ type CloseChannelRequest struct {
// The target number of blocks that the closure transaction should be
// confirmed by.
TargetConf int32 `protobuf:"varint,3,opt,name=target_conf,json=targetConf,proto3" json:"target_conf,omitempty"`
// A manual fee rate set in sat/byte that should be used when crafting the
// A manual fee rate set in sat/vbyte that should be used when crafting the
// closure transaction.
SatPerByte int64 `protobuf:"varint,4,opt,name=sat_per_byte,json=satPerByte,proto3" json:"sat_per_byte,omitempty"`
//
@ -5085,7 +5085,7 @@ type OpenChannelRequest struct {
// The target number of blocks that the funding transaction should be
// confirmed by.
TargetConf int32 `protobuf:"varint,6,opt,name=target_conf,json=targetConf,proto3" json:"target_conf,omitempty"`
// A manual fee rate set in sat/byte that should be used when crafting the
// A manual fee rate set in sat/vbyte that should be used when crafting the
// funding transaction.
SatPerByte int64 `protobuf:"varint,7,opt,name=sat_per_byte,json=satPerByte,proto3" json:"sat_per_byte,omitempty"`
// Whether this channel should be private, not announced to the greater

10
lnrpc/rpc.proto
View File

@ -902,7 +902,7 @@ message EstimateFeeResponse {
// The total fee in satoshis.
int64 fee_sat = 1;
// The fee rate in satoshi/byte.
// The fee rate in satoshi/vbyte.
int64 feerate_sat_per_byte = 2;
}
@ -914,7 +914,7 @@ message SendManyRequest {
// by.
int32 target_conf = 3;
// A manual fee rate set in sat/byte that should be used when crafting the
// A manual fee rate set in sat/vbyte that should be used when crafting the
// transaction.
int64 sat_per_byte = 5;
@ -944,7 +944,7 @@ message SendCoinsRequest {
// by.
int32 target_conf = 3;
// A manual fee rate set in sat/byte that should be used when crafting the
// A manual fee rate set in sat/vbyte that should be used when crafting the
// transaction.
int64 sat_per_byte = 5;
@ -1685,7 +1685,7 @@ message CloseChannelRequest {
// confirmed by.
int32 target_conf = 3;
// A manual fee rate set in sat/byte that should be used when crafting the
// A manual fee rate set in sat/vbyte that should be used when crafting the
// closure transaction.
int64 sat_per_byte = 4;
@ -1756,7 +1756,7 @@ message OpenChannelRequest {
// confirmed by.
int32 target_conf = 6;
// A manual fee rate set in sat/byte that should be used when crafting the
// A manual fee rate set in sat/vbyte that should be used when crafting the
// funding transaction.
int64 sat_per_byte = 7;

10
lnrpc/rpc.swagger.json
View File

@ -672,7 +672,7 @@
},
{
"name": "sat_per_byte",
"description": "A manual fee rate set in sat/byte that should be used when crafting the\nclosure transaction.",
"description": "A manual fee rate set in sat/vbyte that should be used when crafting the\nclosure transaction.",
"in": "query",
"required": false,
"type": "string",
@ -3397,7 +3397,7 @@
"feerate_sat_per_byte": {
"type": "string",
"format": "int64",
"description": "The fee rate in satoshi/byte."
"description": "The fee rate in satoshi/vbyte."
}
}
},
@ -4667,7 +4667,7 @@
"sat_per_byte": {
"type": "string",
"format": "int64",
"description": "A manual fee rate set in sat/byte that should be used when crafting the\nfunding transaction."
"description": "A manual fee rate set in sat/vbyte that should be used when crafting the\nfunding transaction."
},
"private": {
"type": "boolean",
@ -5347,7 +5347,7 @@
"sat_per_byte": {
"type": "string",
"format": "int64",
"description": "A manual fee rate set in sat/byte that should be used when crafting the\ntransaction."
"description": "A manual fee rate set in sat/vbyte that should be used when crafting the\ntransaction."
},
"send_all": {
"type": "boolean",
@ -5398,7 +5398,7 @@
"sat_per_byte": {
"type": "string",
"format": "int64",
"description": "A manual fee rate set in sat/byte that should be used when crafting the\ntransaction."
"description": "A manual fee rate set in sat/vbyte that should be used when crafting the\ntransaction."
},
"label": {
"type": "string",

10
lnrpc/walletrpc/walletkit.pb.go
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"`
//

10
lnrpc/walletrpc/walletkit.proto
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;

6
lnrpc/walletrpc/walletkit.swagger.json
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",