Merge pull request #1690 from lightninglabs/cli-additions

cli: add missing `assets removelease` command, fix default value for balances

Author: ffranr

cmd/commands/assets.go

@@ -8,9 +8,11 @@ import (
 	"strconv"
 	"strings"
 
+	"github.com/btcsuite/btcd/wire"
 	taprootassets "github.com/lightninglabs/taproot-assets"
 	"github.com/lightninglabs/taproot-assets/tapcfg"
 	"github.com/lightninglabs/taproot-assets/taprpc"
+	wrpc "github.com/lightninglabs/taproot-assets/taprpc/assetwalletrpc"
 	"github.com/lightninglabs/taproot-assets/taprpc/mintrpc"
 	"github.com/lightningnetwork/lnd/lnwallet/chainfee"
 	"github.com/urfave/cli"
@@ -38,9 +40,28 @@ func parseScriptKeyType(c *cli.Context) (*taprpc.ScriptKeyTypeQuery, error) {
 			AllTypes: true,
 		},
 	}
+	bip86ScriptKeysQuery := &taprpc.ScriptKeyTypeQuery{
+		Type: &taprpc.ScriptKeyTypeQuery_ExplicitType{
+			ExplicitType: taprpc.ScriptKeyType_SCRIPT_KEY_BIP86,
+		},
+	}
 
-	if !c.IsSet(scriptKeyTypeName) || c.String(scriptKeyTypeName) == "" {
+	// The default value if no script key type is set is aligned with the
+	// default value of the RPC interface, which is BIP-86 script keys.
+	switch {
+	// Both flags are set, which is not allowed.
+	case c.IsSet(scriptKeyTypeName) && c.IsSet(scriptKeyTypeAll):
+		return nil, fmt.Errorf("cannot set both '%s' and '%s'",
+			scriptKeyTypeName, scriptKeyTypeAll)
+
+	// The "all script key types" flag is set, so we return a query
+	// that requests all script key types.
+	case c.Bool(scriptKeyTypeAll):
 		return allScriptKeysQuery, nil
+
+	// No flag is set, use the default value of BIP-86 script keys.
+	case !c.IsSet(scriptKeyTypeName) || c.String(scriptKeyTypeName) == "":
+		return bip86ScriptKeysQuery, nil
 	}
 
 	scriptKeyType, ok := scriptKeyTypeMap[c.String(scriptKeyTypeName)]
@@ -73,11 +94,12 @@ var assetsCommands = []cli.Command{
 			listBurnsCommand,
 			listTransfersCommand,
 			fetchMetaCommand,
+			removeUtxoLeaseCommand,
 		},
 	},
 }
 
-var (
+const (
 	assetTypeName                 = "type"
 	assetTagName                  = "name"
 	assetSupplyName               = "supply"
@@ -105,6 +127,7 @@ var (
 	assetAmountName               = "amount"
 	burnOverrideConfirmationName  = "override_confirmation_destroy_assets"
 	scriptKeyTypeName             = "script_key_type"
+	scriptKeyTypeAll              = "all_script_key_types"
 )
 
 var mintAssetCommand = cli.Command{
@@ -714,6 +737,13 @@ var listAssetsCommand = cli.Command{
 			Usage: "filter assets by the type of script key they " +
 				"use; possible values are: " +
 				strings.Join(maps.Keys(scriptKeyTypeMap), ", "),
+			Value: "bip86",
+		},
+		cli.BoolFlag{
+			Name: scriptKeyTypeAll,
+			Usage: "show all assets, regardless of the script " +
+				"key type; cannot be used at the same time " +
+				"as --" + scriptKeyTypeName,
 		},
 	},
 	Action: listAssets,
@@ -761,6 +791,13 @@ var listUtxosCommand = cli.Command{
 			Usage: "filter assets by the type of script key they " +
 				"use; possible values are: " +
 				strings.Join(maps.Keys(scriptKeyTypeMap), ", "),
+			Value: "bip86",
+		},
+		cli.BoolFlag{
+			Name: scriptKeyTypeAll,
+			Usage: "show all assets, regardless of the script " +
+				"key type; cannot be used at the same time " +
+				"as --" + scriptKeyTypeName,
 		},
 	},
 	Action: listUtxos,
@@ -840,6 +877,13 @@ var listAssetBalancesCommand = cli.Command{
 			Usage: "filter assets by the type of script key they " +
 				"use; possible values are: " +
 				strings.Join(maps.Keys(scriptKeyTypeMap), ", "),
+			Value: "bip86",
+		},
+		cli.BoolFlag{
+			Name: scriptKeyTypeAll,
+			Usage: "show all assets, regardless of the script " +
+				"key type; cannot be used at the same time " +
+				"as --" + scriptKeyTypeName,
 		},
 	},
 }
@@ -1212,3 +1256,53 @@ func fetchMeta(ctx *cli.Context) error {
 	printRespJSON(resp)
 	return nil
 }
+
+var removeUtxoLeaseCommand = cli.Command{
+	Name:      "removelease",
+	ShortName: "rl",
+	Usage:     "release the lease/lock/reservation on an asset UTXO",
+	Description: `
+	Allows the caller to release the lease/lock/reservation that is put on
+	an asset UTXO when it is used in a transaction. The lease is to prevent
+	the asset UTXO from being used in another transaction while the current
+	transaction is being signed and broadcast. If the transaction fails to
+	broadcast, the lease will remain in place for up to 10 minutes. With
+	this command, the caller can release the lease early, allowing the
+	UTXO to be used in another transaction immediately.
+
+	This command either returns an empty response ({}), or an error if the
+	lease could not be released.
+	`,
+	Flags: []cli.Flag{
+		cli.StringFlag{
+			Name: outpointName,
+			Usage: "the outpoint (<txid>:<vout>) of the UTXO to " +
+				"release the lease for",
+		},
+	},
+	Action: removeUtxoLease,
+}
+
+func removeUtxoLease(ctx *cli.Context) error {
+	ctxc := getContext()
+	client, cleanUp := getWalletClient(ctx)
+	defer cleanUp()
+
+	outpoint, err := wire.NewOutPointFromString(ctx.String(outpointName))
+	if err != nil {
+		return fmt.Errorf("error parsing outpoint: %w", err)
+	}
+
+	resp, err := client.RemoveUTXOLease(ctxc, &wrpc.RemoveUTXOLeaseRequest{
+		Outpoint: &taprpc.OutPoint{
+			Txid:        outpoint.Hash[:],
+			OutputIndex: outpoint.Index,
+		},
+	})
+	if err != nil {
+		return fmt.Errorf("unable to remove utxo lease: %w", err)
+	}
+
+	printRespJSON(resp)
+	return nil
+}

docs/release-notes/release-notes-0.7.0.md

@@ -85,6 +85,10 @@
   asset command flag from `--universe_commitments` to
   `--enable_supply_commitments` for consistency with the updated terminology.
 
+- The [CLI command `tapcli assets removelease` was added to give access to the
+  `RemoveUTXOLease` RPC method on the command line as
+  well](https://github.com/lightninglabs/taproot-assets/pull/1690).
+
 # Improvements
 
 ## Functional Updates
@@ -93,6 +97,12 @@
 
 ## tapcli Updates
 
+- The default script key type in the `tapcli assets list`,
+  `tapcli assets balance` and `tapcli assets utxos` commands was changed from
+  the default "all script key types" [to the value
+  `bip86`](https://github.com/lightninglabs/taproot-assets/pull/1690) to match
+  the default value of the RPC interface.
+
 ## Code Health
 
 - A series of PRs was created that refactored the send and funding logic in

taprpc/assetwalletrpc/assetwallet.proto

@@ -98,7 +98,7 @@ service AssetWallet {
     rpc VerifyAssetOwnership (VerifyAssetOwnershipRequest)
         returns (VerifyAssetOwnershipResponse);
 
-    /*
+    /* `tapcli: assets removelease`
     RemoveUTXOLease removes the lease/lock/reservation of the given managed
     UTXO.
     */

taprpc/assetwalletrpc/assetwallet.swagger.json

@@ -249,7 +249,7 @@
     },
     "/v1/taproot-assets/wallet/utxo-lease/delete": {
       "post": {
-        "summary": "RemoveUTXOLease removes the lease/lock/reservation of the given managed\nUTXO.",
+        "summary": "`tapcli: assets removelease`\nRemoveUTXOLease removes the lease/lock/reservation of the given managed\nUTXO.",
         "operationId": "AssetWallet_RemoveUTXOLease",
         "responses": {
           "200": {