highperfocused/lnd
1
0
Fork 0
mirror of https://github.com/lightningnetwork/lnd.git synced 2025-12-08 03:41:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

cmd: more input parameters checks for listchaintxns cli command

Browse Source 
add a parsing block height function and error when block heights would produce invalid results
This commit is contained in:
Sam Korn
2025-03-18 11:19:48 -06:00
parent 5235f3b24f
commit bb398456b5
2 changed files with 146 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
cmd/commands/commands.go
View File

@@ -2228,9 +2228,11 @@ var listChainTxnsCommand = cli.Command{
cli.Int64Flag{
Name: "end_height",
Usage: "the block height until which to list " +
"transactions, inclusive, to get " +
"transactions until the chain tip, including " +
"unconfirmed, set this value to -1",
"transactions, inclusive; by default this " +
"will return all transactions up to the " +
"chain tip including unconfirmed " +
"transactions",
Value: -1,
},
cli.UintFlag{
Name: "index_offset",
@@ -2241,7 +2243,7 @@ var listChainTxnsCommand = cli.Command{
},
cli.IntFlag{
Name: "max_transactions",
Usage: "(optional) the max number of transactions to " +
Usage: "the max number of transactions to " +
"return; leave at default of 0 to return " +
"all transactions",
Value: 0,
@@ -2251,33 +2253,51 @@ var listChainTxnsCommand = cli.Command{
List all transactions an address of the wallet was involved in.
This call will return a list of wallet related transactions that paid
to an address our wallet controls, or spent utxos that we held. The
start_height and end_height flags can be used to specify an inclusive
block range over which to query for transactions. If the end_height is
less than the start_height, transactions will be queried in reverse.
To get all transactions until the chain tip, including unconfirmed
transactions (identifiable with BlockHeight=0), set end_height to -1.
By default, this call will get all transactions our wallet was involved
in, including unconfirmed transactions.
`,
to an address our wallet controls, or spent utxos that we held.
By default, this call will get all transactions until the chain tip,
including unconfirmed transactions (end_height=-1).`,
Action: actionDecorator(listChainTxns),
}
func parseBlockHeightInputs(ctx *cli.Context) (int32, int32, error) {
startHeight := int32(ctx.Int64("start_height"))
endHeight := int32(ctx.Int64("end_height"))
if ctx.IsSet("start_height") && ctx.IsSet("end_height") {
if endHeight != -1 && startHeight > endHeight {
return startHeight, endHeight,
errors.New("start_height should " +
"be less than end_height if " +
"end_height is not equal to -1")
}
}
if startHeight < 0 {
return startHeight, endHeight,
errors.New("start_height should " +
"be greater than or " +
"equal to 0")
}
return startHeight, endHeight, nil
}
func listChainTxns(ctx *cli.Context) error {
ctxc := getContext()
client, cleanUp := getClient(ctx)
defer cleanUp()
startHeight, endHeight, err := parseBlockHeightInputs(ctx)
if err != nil {
return err
}
req := &lnrpc.GetTransactionsRequest{
IndexOffset: uint32(ctx.Uint64("index_offset")),
MaxTransactions: uint32(ctx.Uint64("max_transactions")),
}
if ctx.IsSet("start_height") {
req.StartHeight = int32(ctx.Int64("start_height"))
}
if ctx.IsSet("end_height") {
req.EndHeight = int32(ctx.Int64("end_height"))
StartHeight: startHeight,
EndHeight: endHeight,
}
resp, err := client.GetTransactions(ctxc, req)