highperfocused/lnd
1
0
Fork 0
mirror of https://github.com/lightningnetwork/lnd.git synced 2025-06-05 04:30:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

lnrpc: fix lncli documentation tags in walletkit.proto

Browse Source 
Fixes the tag for `wallet pendingsweeps` and adds the tag for
`wallet estimatefeerate`.
This commit is contained in:
feelancer21 2024-10-08 18:12:03 +02:00
parent 0dd58ee529
commit 5290598f1b
No known key found for this signature in database
GPG Key ID: 1F7071EE8449729C
3 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lnrpc/walletrpc/walletkit.proto
View File

@ -222,14 +222,14 @@ service WalletKit {
*/ */
rpc SendOutputs (SendOutputsRequest) returns (SendOutputsResponse); rpc SendOutputs (SendOutputsRequest) returns (SendOutputsResponse);
/* /* lncli: `wallet estimatefeerate`
EstimateFee attempts to query the internal fee estimator of the wallet to EstimateFee attempts to query the internal fee estimator of the wallet to
determine the fee (in sat/kw) to attach to a transaction in order to determine the fee (in sat/kw) to attach to a transaction in order to
achieve the confirmation target. achieve the confirmation target.
*/ */
rpc EstimateFee (EstimateFeeRequest) returns (EstimateFeeResponse); rpc EstimateFee (EstimateFeeRequest) returns (EstimateFeeResponse);
/* lncli: `pendingsweeps` /* lncli: `wallet pendingsweeps`
PendingSweeps returns lists of on-chain outputs that lnd is currently PendingSweeps returns lists of on-chain outputs that lnd is currently
attempting to sweep within its central batching engine. Outputs with similar attempting to sweep within its central batching engine. Outputs with similar
fee rates are batched together in order to sweep them within a single fee rates are batched together in order to sweep them within a single

4
lnrpc/walletrpc/walletkit.swagger.json
View File

@ -306,7 +306,7 @@
}, },
"/v2/wallet/estimatefee/{conf_target}": { "/v2/wallet/estimatefee/{conf_target}": {
"get": { "get": {
"summary": "EstimateFee attempts to query the internal fee estimator of the wallet to\ndetermine the fee (in sat/kw) to attach to a transaction in order to\nachieve the confirmation target.", "summary": "lncli: `wallet estimatefeerate`\nEstimateFee attempts to query the internal fee estimator of the wallet to\ndetermine the fee (in sat/kw) to attach to a transaction in order to\nachieve the confirmation target.",
"operationId": "WalletKit_EstimateFee", "operationId": "WalletKit_EstimateFee",
"responses": { "responses": {
"200": { "200": {
@ -680,7 +680,7 @@
}, },
"/v2/wallet/sweeps/pending": { "/v2/wallet/sweeps/pending": {
"get": { "get": {
"summary": "lncli: `pendingsweeps`\nPendingSweeps returns lists of on-chain outputs that lnd is currently\nattempting to sweep within its central batching engine. Outputs with similar\nfee rates are batched together in order to sweep them within a single\ntransaction.", "summary": "lncli: `wallet pendingsweeps`\nPendingSweeps returns lists of on-chain outputs that lnd is currently\nattempting to sweep within its central batching engine. Outputs with similar\nfee rates are batched together in order to sweep them within a single\ntransaction.",
"description": "NOTE: Some of the fields within PendingSweepsRequest are not guaranteed to\nremain supported. This is an advanced API that depends on the internals of\nthe UtxoSweeper, so things may change.", "description": "NOTE: Some of the fields within PendingSweepsRequest are not guaranteed to\nremain supported. This is an advanced API that depends on the internals of\nthe UtxoSweeper, so things may change.",
"operationId": "WalletKit_PendingSweeps", "operationId": "WalletKit_PendingSweeps",
"responses": { "responses": {

6
lnrpc/walletrpc/walletkit_grpc.pb.go
View File

@ -164,11 +164,12 @@ type WalletKitClient interface {
// allows the caller to create a transaction that sends to several outputs at // allows the caller to create a transaction that sends to several outputs at
// once. This is ideal when wanting to batch create a set of transactions. // once. This is ideal when wanting to batch create a set of transactions.
SendOutputs(ctx context.Context, in *SendOutputsRequest, opts ...grpc.CallOption) (*SendOutputsResponse, error) SendOutputs(ctx context.Context, in *SendOutputsRequest, opts ...grpc.CallOption) (*SendOutputsResponse, error)
// lncli: `wallet estimatefeerate`
// EstimateFee attempts to query the internal fee estimator of the wallet to // EstimateFee attempts to query the internal fee estimator of the wallet to
// determine the fee (in sat/kw) to attach to a transaction in order to // determine the fee (in sat/kw) to attach to a transaction in order to
// achieve the confirmation target. // achieve the confirmation target.
EstimateFee(ctx context.Context, in *EstimateFeeRequest, opts ...grpc.CallOption) (*EstimateFeeResponse, error) EstimateFee(ctx context.Context, in *EstimateFeeRequest, opts ...grpc.CallOption) (*EstimateFeeResponse, error)
// lncli: `pendingsweeps` // lncli: `wallet pendingsweeps`
// PendingSweeps returns lists of on-chain outputs that lnd is currently // PendingSweeps returns lists of on-chain outputs that lnd is currently
// attempting to sweep within its central batching engine. Outputs with similar // attempting to sweep within its central batching engine. Outputs with similar
// fee rates are batched together in order to sweep them within a single // fee rates are batched together in order to sweep them within a single
@ -688,11 +689,12 @@ type WalletKitServer interface {
// allows the caller to create a transaction that sends to several outputs at // allows the caller to create a transaction that sends to several outputs at
// once. This is ideal when wanting to batch create a set of transactions. // once. This is ideal when wanting to batch create a set of transactions.
SendOutputs(context.Context, *SendOutputsRequest) (*SendOutputsResponse, error) SendOutputs(context.Context, *SendOutputsRequest) (*SendOutputsResponse, error)
// lncli: `wallet estimatefeerate`
// EstimateFee attempts to query the internal fee estimator of the wallet to // EstimateFee attempts to query the internal fee estimator of the wallet to
// determine the fee (in sat/kw) to attach to a transaction in order to // determine the fee (in sat/kw) to attach to a transaction in order to
// achieve the confirmation target. // achieve the confirmation target.
EstimateFee(context.Context, *EstimateFeeRequest) (*EstimateFeeResponse, error) EstimateFee(context.Context, *EstimateFeeRequest) (*EstimateFeeResponse, error)
// lncli: `pendingsweeps` // lncli: `wallet pendingsweeps`
// PendingSweeps returns lists of on-chain outputs that lnd is currently // PendingSweeps returns lists of on-chain outputs that lnd is currently
// attempting to sweep within its central batching engine. Outputs with similar // attempting to sweep within its central batching engine. Outputs with similar
// fee rates are batched together in order to sweep them within a single // fee rates are batched together in order to sweep them within a single