Skip to content

Commit cfae77b

Browse files
committed
taprpc: add litcli command documentation
1 parent 17b125f commit cfae77b

File tree

3 files changed

+22
-14
lines changed

3 files changed

+22
-14
lines changed

taprpc/tapchannelrpc/tapchannel.proto

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import "routerrpc/router.proto";
1010
import "taprootassets.proto";
1111

1212
service TaprootAssetChannels {
13-
/*
13+
/* litcli: `ln fundchannel`
1414
FundChannel initiates the channel funding negotiation with a peer for the
1515
creation of a channel that contains a specified amount of a given asset.
1616
*/
@@ -26,25 +26,25 @@ service TaprootAssetChannels {
2626
rpc EncodeCustomRecords (EncodeCustomRecordsRequest)
2727
returns (EncodeCustomRecordsResponse);
2828

29-
/*
29+
/* litcli: `ln sendpayment`
3030
SendPayment is a wrapper around lnd's routerrpc.SendPaymentV2 RPC method
3131
with asset specific parameters. It allows RPC users to send asset keysend
3232
payments (direct payments) or payments to an invoice with a specified asset
3333
amount.
3434
*/
3535
rpc SendPayment (SendPaymentRequest) returns (stream SendPaymentResponse);
3636

37-
/*
37+
/* litcli: `ln addinvoice`
3838
AddInvoice is a wrapper around lnd's lnrpc.AddInvoice method with asset
3939
specific parameters. It allows RPC users to create invoices that correspond
4040
to the specified asset amount.
4141
*/
4242
rpc AddInvoice (AddInvoiceRequest) returns (AddInvoiceResponse);
4343

44-
/*
44+
/* litcli: `ln decodeassetinvoice`
4545
DecodeAssetPayReq is similar to lnd's lnrpc.DecodePayReq, but it accepts an
46-
asset ID and returns the invoice amount expressed in asset units along side
47-
the normal information.
46+
asset ID or group key and returns the invoice amount expressed in asset
47+
units along side the normal information.
4848
*/
4949
rpc DecodeAssetPayReq (AssetPayReq) returns (AssetPayReqResponse);
5050
}

taprpc/tapchannelrpc/tapchannel.swagger.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
},
5252
"/v1/taproot-assets/channels/fund": {
5353
"post": {
54-
"summary": "FundChannel initiates the channel funding negotiation with a peer for the\ncreation of a channel that contains a specified amount of a given asset.",
54+
"summary": "litcli: `ln fundchannel`\nFundChannel initiates the channel funding negotiation with a peer for the\ncreation of a channel that contains a specified amount of a given asset.",
5555
"operationId": "TaprootAssetChannels_FundChannel",
5656
"responses": {
5757
"200": {
@@ -84,7 +84,7 @@
8484
},
8585
"/v1/taproot-assets/channels/invoice": {
8686
"post": {
87-
"summary": "AddInvoice is a wrapper around lnd's lnrpc.AddInvoice method with asset\nspecific parameters. It allows RPC users to create invoices that correspond\nto the specified asset amount.",
87+
"summary": "litcli: `ln addinvoice`\nAddInvoice is a wrapper around lnd's lnrpc.AddInvoice method with asset\nspecific parameters. It allows RPC users to create invoices that correspond\nto the specified asset amount.",
8888
"operationId": "TaprootAssetChannels_AddInvoice",
8989
"responses": {
9090
"200": {
@@ -117,7 +117,7 @@
117117
},
118118
"/v1/taproot-assets/channels/invoice/decode": {
119119
"post": {
120-
"summary": "DecodeAssetPayReq is similar to lnd's lnrpc.DecodePayReq, but it accepts an\nasset ID and returns the invoice amount expressed in asset units along side\nthe normal information.",
120+
"summary": "litcli: `ln decodeassetinvoice`\nDecodeAssetPayReq is similar to lnd's lnrpc.DecodePayReq, but it accepts an\nasset ID or group key and returns the invoice amount expressed in asset\nunits along side the normal information.",
121121
"operationId": "TaprootAssetChannels_DecodeAssetPayReq",
122122
"responses": {
123123
"200": {
@@ -150,7 +150,7 @@
150150
},
151151
"/v1/taproot-assets/channels/send-payment": {
152152
"post": {
153-
"summary": "SendPayment is a wrapper around lnd's routerrpc.SendPaymentV2 RPC method\nwith asset specific parameters. It allows RPC users to send asset keysend\npayments (direct payments) or payments to an invoice with a specified asset\namount.",
153+
"summary": "litcli: `ln sendpayment`\nSendPayment is a wrapper around lnd's routerrpc.SendPaymentV2 RPC method\nwith asset specific parameters. It allows RPC users to send asset keysend\npayments (direct payments) or payments to an invoice with a specified asset\namount.",
154154
"operationId": "TaprootAssetChannels_SendPayment",
155155
"responses": {
156156
"200": {

taprpc/tapchannelrpc/tapchannel_grpc.pb.go

Lines changed: 12 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)