Merge pull request #703 from lightninglabs/add_cli_autogen_docs

taprpc: add missing cli autogen docs

Author: Roasbeef

cmd/tapcli/assets.go

@@ -261,8 +261,8 @@ var finalizeBatchCommand = cli.Command{
 		},
 		cli.Uint64Flag{
 			Name: feeRateName,
-			Usage: "if set, the fee rate in sat/kw to use for the" +
-				"minting transaction",
+			Usage: "if set, the fee rate in sat/kw to use for " +
+				"the minting transaction",
 		},
 	},
 	Action: finalizeBatch,
@@ -531,8 +531,8 @@ var sendAssetsCommand = cli.Command{
 		},
 		cli.Uint64Flag{
 			Name: feeRateName,
-			Usage: "if set, the fee rate in sat/kw to use for the" +
-				"anchor transaction",
+			Usage: "if set, the fee rate in sat/kw to use for " +
+				"the anchor transaction",
 		},
 		// TODO(roasbeef): add arg for file name to write sender proof
 		// blob

cmd/tapcli/universe.go

@@ -783,13 +783,13 @@ var (
 		},
 		cli.StringFlag{
 			Name: proofInsertName,
-			Usage: "if true, remote Universes can push proofs to" +
+			Usage: "if true, remote Universes can push proofs to " +
 				"the local Universe",
 		},
 		cli.StringFlag{
 			Name: proofExportName,
-			Usage: "if true, remote Universes can pull proofs from" +
-				"the local Universe",
+			Usage: "if true, remote Universes can pull proofs " +
+				"from the local Universe",
 		},
 	}
 )
@@ -1166,8 +1166,8 @@ func universeFederationGetConfigInfo(ctx *cli.Context) error {
 	}
 
 	if scope == "global" {
-		return fmt.Errorf("cannot specify global scope and a specific" +
-			"asset")
+		return fmt.Errorf("cannot specify global scope and a " +
+			"specific asset")
 	}
 
 	return printLocalConfig()

taprpc/assetwalletrpc/assetwallet.proto

@@ -49,7 +49,7 @@ service AssetWallet {
     */
     rpc NextScriptKey (NextScriptKeyRequest) returns (NextScriptKeyResponse);
 
-    /*
+    /* tapcli: `proofs proveownership`
     ProveAssetOwnership creates an ownership proof embedded in an asset
     transition proof. That ownership proof is a signed virtual transaction
     spending the asset with a valid witness to prove the prover owns the keys
@@ -58,7 +58,7 @@ service AssetWallet {
     rpc ProveAssetOwnership (ProveAssetOwnershipRequest)
         returns (ProveAssetOwnershipResponse);
 
-    /*
+    /* tapcli: `proofs verifyownership`
     VerifyAssetOwnership verifies the asset ownership proof embedded in the
     given transition proof of an asset and returns true if the proof is valid.
     */

taprpc/assetwalletrpc/assetwallet.swagger.json

@@ -51,7 +51,7 @@
     },
     "/v1/taproot-assets/wallet/ownership/prove": {
       "post": {
-        "summary": "ProveAssetOwnership creates an ownership proof embedded in an asset\ntransition proof. That ownership proof is a signed virtual transaction\nspending the asset with a valid witness to prove the prover owns the keys\nthat can spend the asset.",
+        "summary": "tapcli: `proofs proveownership`\nProveAssetOwnership creates an ownership proof embedded in an asset\ntransition proof. That ownership proof is a signed virtual transaction\nspending the asset with a valid witness to prove the prover owns the keys\nthat can spend the asset.",
         "operationId": "AssetWallet_ProveAssetOwnership",
         "responses": {
           "200": {
@@ -84,7 +84,7 @@
     },
     "/v1/taproot-assets/wallet/ownership/verify": {
       "post": {
-        "summary": "VerifyAssetOwnership verifies the asset ownership proof embedded in the\ngiven transition proof of an asset and returns true if the proof is valid.",
+        "summary": "tapcli: `proofs verifyownership`\nVerifyAssetOwnership verifies the asset ownership proof embedded in the\ngiven transition proof of an asset and returns true if the proof is valid.",
         "operationId": "AssetWallet_VerifyAssetOwnership",
         "responses": {
           "200": {

taprpc/assetwalletrpc/assetwallet_grpc.pb.go

@@ -123,7 +123,7 @@ service TaprootAssets {
     rpc SubscribeReceiveAssetEventNtfns (SubscribeReceiveAssetEventNtfnsRequest)
         returns (stream ReceiveAssetEvent);
 
-    /*
+    /* tapcli: `assets meta`
     FetchAssetMeta allows a caller to fetch the reveal meta data for an asset
     either by the asset ID for that asset, or a meta hash.
     */

taprpc/taprootassets.proto

@@ -293,7 +293,7 @@
     },
     "/v1/taproot-assets/assets/meta/asset-id/{asset_id_str}": {
       "get": {
-        "summary": "FetchAssetMeta allows a caller to fetch the reveal meta data for an asset\neither by the asset ID for that asset, or a meta hash.",
+        "summary": "tapcli: `assets meta`\nFetchAssetMeta allows a caller to fetch the reveal meta data for an asset\neither by the asset ID for that asset, or a meta hash.",
         "operationId": "TaprootAssets_FetchAssetMeta",
         "responses": {
           "200": {
@@ -348,7 +348,7 @@
     },
     "/v1/taproot-assets/assets/meta/hash/{meta_hash_str}": {
       "get": {
-        "summary": "FetchAssetMeta allows a caller to fetch the reveal meta data for an asset\neither by the asset ID for that asset, or a meta hash.",
+        "summary": "tapcli: `assets meta`\nFetchAssetMeta allows a caller to fetch the reveal meta data for an asset\neither by the asset ID for that asset, or a meta hash.",
         "operationId": "TaprootAssets_FetchAssetMeta2",
         "responses": {
           "200": {

taprpc/taprootassets.swagger.json

@@ -134,7 +134,7 @@ service Universe {
     rpc SetFederationSyncConfig (SetFederationSyncConfigRequest)
         returns (SetFederationSyncConfigResponse);
 
-    /*
+    /* tapcli: `universe federation config info`
     QueryFederationSyncConfig queries the universe federation sync configuration
     settings.
     */

taprpc/taprootassets_grpc.pb.go

@@ -1212,7 +1212,7 @@
     },
     "/v1/taproot-assets/universe/sync/config": {
       "get": {
-        "summary": "QueryFederationSyncConfig queries the universe federation sync configuration\nsettings.",
+        "summary": "tapcli: `universe federation config info`\nQueryFederationSyncConfig queries the universe federation sync configuration\nsettings.",
         "operationId": "Universe_QueryFederationSyncConfig",
         "responses": {
           "200": {