lnrpc: add lncli command hint for API docs generator
What changed, and why it matters
This commit only adds a documentation hint showing which lncli command maps to the SignPsbt API. It changes comments in a .proto file, a generated swagger JSON file, and generated Go gRPC code. There is no functional code change and no security relevance.
No action required; this is a non-functional documentation-only change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff inserts the comment line ‘lncli: wallet psbt sign’ into the proto service comment for SignPsbt, which then propagates into the generated swagger.json summary and the generated walletkit_grpc.pb.go interface comments. No RPC behavior, request/response types, validation, or authorization logic is modified.
Changed components
lnrpc/walletrpc/walletkit.protolnrpc/walletrpc/walletkit.swagger.jsonlnrpc/walletrpc/walletkit_grpc.pb.goInspect captured patch +4 / −2
diff --git a/lnrpc/walletrpc/walletkit.proto b/lnrpc/walletrpc/walletkit.proto
index b50d2d6..a9d6ee0 100644
--- a/lnrpc/walletrpc/walletkit.proto
+++ b/lnrpc/walletrpc/walletkit.proto
@@ -328,7 +328,7 @@ service WalletKit {
*/
rpc FundPsbt (FundPsbtRequest) returns (FundPsbtResponse);
- /*
+ /* lncli: `wallet psbt sign`
SignPsbt expects a partial transaction with all inputs and outputs fully
declared and tries to sign all unsigned inputs that have all required fields
(UTXO information, BIP32 derivation information, witness or sig scripts)
diff --git a/lnrpc/walletrpc/walletkit.swagger.json b/lnrpc/walletrpc/walletkit.swagger.json
index 1e8e074..bb9ae5e 100644
--- a/lnrpc/walletrpc/walletkit.swagger.json
+++ b/lnrpc/walletrpc/walletkit.swagger.json
@@ -507,7 +507,7 @@
},
"/v2/wallet/psbt/sign": {
"post": {
- "summary": "SignPsbt expects a partial transaction with all inputs and outputs fully\ndeclared and tries to sign all unsigned inputs that have all required fields\n(UTXO information, BIP32 derivation information, witness or sig scripts)\nset.\nIf no error is returned, the PSBT is ready to be given to the next signer or\nto be finalized if lnd was the last signer.",
+ "summary": "lncli: `wallet psbt sign`\nSignPsbt expects a partial transaction with all inputs and outputs fully\ndeclared and tries to sign all unsigned inputs that have all required fields\n(UTXO information, BIP32 derivation information, witness or sig scripts)\nset.\nIf no error is returned, the PSBT is ready to be given to the next signer or\nto be finalized if lnd was the last signer.",
"description": "NOTE: This RPC only signs inputs (and only those it can sign), it does not\nperform any other tasks (such as coin selection, UTXO locking or\ninput/output/fee value validation, PSBT finalization). Any input that is\nincomplete will be skipped.",
"operationId": "WalletKit_SignPsbt",
"responses": {
diff --git a/lnrpc/walletrpc/walletkit_grpc.pb.go b/lnrpc/walletrpc/walletkit_grpc.pb.go
index 579aa47..4cd79a4 100644
--- a/lnrpc/walletrpc/walletkit_grpc.pb.go
+++ b/lnrpc/walletrpc/walletkit_grpc.pb.go
@@ -254,6 +254,7 @@ type WalletKitClient interface {
// publishing the transaction) or to unlock/release the locked UTXOs in case of
// an error on the caller's side.
FundPsbt(ctx context.Context, in *FundPsbtRequest, opts ...grpc.CallOption) (*FundPsbtResponse, error)
+ // lncli: `wallet psbt sign`
// SignPsbt expects a partial transaction with all inputs and outputs fully
// declared and tries to sign all unsigned inputs that have all required fields
// (UTXO information, BIP32 derivation information, witness or sig scripts)
@@ -779,6 +780,7 @@ type WalletKitServer interface {
// publishing the transaction) or to unlock/release the locked UTXOs in case of
// an error on the caller's side.
FundPsbt(context.Context, *FundPsbtRequest) (*FundPsbtResponse, error)
+ // lncli: `wallet psbt sign`
// SignPsbt expects a partial transaction with all inputs and outputs fully
// declared and tries to sign all unsigned inputs that have all required fields
// (UTXO information, BIP32 derivation information, witness or sig scripts)
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.