Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

taprpc: add missing cli autogen docs #703

Merged
merged 2 commits into from
Nov 28, 2023
Merged

taprpc: add missing cli autogen docs #703

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2869883
taprpc: add missing tapcli cmds for RPC endpoints
jharveyb Nov 28, 2023
58b3a3f
tapcli: fix spacing in misc help cmds
jharveyb Nov 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions cmd/tapcli/assets.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions cmd/tapcli/universe.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
},
}
)
Expand Down Expand Up @@ -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()
Expand Down
4 changes: 2 additions & 2 deletions taprpc/assetwalletrpc/assetwallet.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
*/
Expand Down
4 changes: 2 additions & 2 deletions taprpc/assetwalletrpc/assetwallet.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down
4 changes: 4 additions & 0 deletions taprpc/assetwalletrpc/assetwallet_grpc.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion taprpc/taprootassets.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand Down
4 changes: 2 additions & 2 deletions taprpc/taprootassets.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down
2 changes: 2 additions & 0 deletions taprpc/taprootassets_grpc.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion taprpc/universerpc/universe.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ service Universe {
rpc SetFederationSyncConfig (SetFederationSyncConfigRequest)
returns (SetFederationSyncConfigResponse);

/*
/* tapcli: `universe federation config info`
QueryFederationSyncConfig queries the universe federation sync configuration
settings.
*/
Expand Down
2 changes: 1 addition & 1 deletion taprpc/universerpc/universe.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
2 changes: 2 additions & 0 deletions taprpc/universerpc/universe_grpc.pb.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.