Merge pull request #3293 from halseth/bumpfee-doc

[trivial] lnrpc: make BumpFee doc start with RPC name
This commit is contained in:
Wilmer Paulino authored and GitHub committed 2019-07-10 12:02:41 -07:00
commit 03cf9a53e4
2 files changed
+24 -24

No files matched your search

+16 -16
View File
@@ -903,14 +903,14 @@ type WalletKitClient interface {
//the UtxoSweeper, so things may change. //the UtxoSweeper, so things may change.
PendingSweeps(ctx context.Context, in *PendingSweepsRequest, opts ...grpc.CallOption) (*PendingSweepsResponse, error) PendingSweeps(ctx context.Context, in *PendingSweepsRequest, opts ...grpc.CallOption) (*PendingSweepsResponse, error)
// //
//Bump the fee of an arbitrary input within a transaction. This RPC takes a //BumpFee bumps the fee of an arbitrary input within a transaction. This RPC
//different approach than bitcoind's bumpfee command. lnd has a central //takes a different approach than bitcoind's bumpfee command. lnd has a
//batching engine in which inputs with similar fee rates are batched together //central batching engine in which inputs with similar fee rates are batched
//to save on transaction fees. Due to this, we cannot rely on bumping the fee //together to save on transaction fees. Due to this, we cannot rely on
//on a specific transaction, since transactions can change at any point with //bumping the fee on a specific transaction, since transactions can change at
//the addition of new inputs. The list of inputs that currently exist within //any point with the addition of new inputs. The list of inputs that
//lnd's central batching engine can be retrieved through the PendingSweeps //currently exist within lnd's central batching engine can be retrieved
//RPC. //through the PendingSweeps RPC.
// //
//When bumping the fee of an input that currently exists within lnd's central //When bumping the fee of an input that currently exists within lnd's central
//batching engine, a higher fee transaction will be created that replaces the //batching engine, a higher fee transaction will be created that replaces the
@@ -1052,14 +1052,14 @@ type WalletKitServer interface {
//the UtxoSweeper, so things may change. //the UtxoSweeper, so things may change.
PendingSweeps(context.Context, *PendingSweepsRequest) (*PendingSweepsResponse, error) PendingSweeps(context.Context, *PendingSweepsRequest) (*PendingSweepsResponse, error)
// //
//Bump the fee of an arbitrary input within a transaction. This RPC takes a //BumpFee bumps the fee of an arbitrary input within a transaction. This RPC
//different approach than bitcoind's bumpfee command. lnd has a central //takes a different approach than bitcoind's bumpfee command. lnd has a
//batching engine in which inputs with similar fee rates are batched together //central batching engine in which inputs with similar fee rates are batched
//to save on transaction fees. Due to this, we cannot rely on bumping the fee //together to save on transaction fees. Due to this, we cannot rely on
//on a specific transaction, since transactions can change at any point with //bumping the fee on a specific transaction, since transactions can change at
//the addition of new inputs. The list of inputs that currently exist within //any point with the addition of new inputs. The list of inputs that
//lnd's central batching engine can be retrieved through the PendingSweeps //currently exist within lnd's central batching engine can be retrieved
//RPC. //through the PendingSweeps RPC.
// //
//When bumping the fee of an input that currently exists within lnd's central //When bumping the fee of an input that currently exists within lnd's central
//batching engine, a higher fee transaction will be created that replaces the //batching engine, a higher fee transaction will be created that replaces the
+8 -8
View File
@@ -274,14 +274,14 @@ service WalletKit {
rpc PendingSweeps(PendingSweepsRequest) returns (PendingSweepsResponse); rpc PendingSweeps(PendingSweepsRequest) returns (PendingSweepsResponse);
/* /*
Bump the fee of an arbitrary input within a transaction. This RPC takes a BumpFee bumps the fee of an arbitrary input within a transaction. This RPC
different approach than bitcoind's bumpfee command. lnd has a central takes a different approach than bitcoind's bumpfee command. lnd has a
batching engine in which inputs with similar fee rates are batched together central batching engine in which inputs with similar fee rates are batched
to save on transaction fees. Due to this, we cannot rely on bumping the fee together to save on transaction fees. Due to this, we cannot rely on
on a specific transaction, since transactions can change at any point with bumping the fee on a specific transaction, since transactions can change at
the addition of new inputs. The list of inputs that currently exist within any point with the addition of new inputs. The list of inputs that
lnd's central batching engine can be retrieved through the PendingSweeps currently exist within lnd's central batching engine can be retrieved
RPC. through the PendingSweeps RPC.
When bumping the fee of an input that currently exists within lnd's central When bumping the fee of an input that currently exists within lnd's central
batching engine, a higher fee transaction will be created that replaces the batching engine, a higher fee transaction will be created that replaces the