highperfocused/lnd
1
0
Fork 0
mirror of https://github.com/lightningnetwork/lnd.git synced 2025-06-28 17:53:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #6481 from torkelrogstad/2022-04-30-chain-notifier

Browse Source 
chainrpc: clarify documentation
This commit is contained in:
Oliver Gugger 2022-05-02 09:34:15 +02:00 committed by GitHub
commit aca22998bc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 19 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/release-notes/release-notes-0.15.0.md
View File

@ -206,6 +206,9 @@ close to continue after a peer disconnect](https://github.com/lightningnetwork/l
options](https://github.com/lightningnetwork/lnd/pull/6064) to allow
specifying non-default paths for the configuration and RPC cookie files.
* [Clarify comment](https://github.com/lightningnetwork/lnd/pull/6481) on
`chainnotifier.RegisterConfirmationsNtfn`.
## RPC Server
* [Add value to the field

8
lnrpc/chainrpc/chainnotifier.proto
View File

@ -12,9 +12,11 @@ service ChainNotifier {
registers an intent for a client to be notified once a confirmation request
has reached its required number of confirmations on-chain.
A client can specify whether the confirmation request should be for a
particular transaction by its hash or for an output script by specifying a
zero hash.
A confirmation request must have a valid output script. It is also possible
to give a transaction ID. If the transaction ID is not set, a notification
is sent once the output script confirms. If the transaction ID is also set,
a notification is sent once the output script confirms in the given
transaction.
*/
rpc RegisterConfirmationsNtfn (ConfRequest) returns (stream ConfEvent);

2
lnrpc/chainrpc/chainnotifier.swagger.json
View File

@ -62,7 +62,7 @@
"/v2/chainnotifier/register/confirmations": {
"post": {
"summary": "RegisterConfirmationsNtfn is a synchronous response-streaming RPC that\nregisters an intent for a client to be notified once a confirmation request\nhas reached its required number of confirmations on-chain.",
"description": "A client can specify whether the confirmation request should be for a\nparticular transaction by its hash or for an output script by specifying a\nzero hash.",
"description": "A confirmation request must have a valid output script. It is also possible\nto give a transaction ID. If the transaction ID is not set, a notification\nis sent once the output script confirms. If the transaction ID is also set,\na notification is sent once the output script confirms in the given\ntransaction.",
"operationId": "ChainNotifier_RegisterConfirmationsNtfn",
"responses": {
"200": {

16
lnrpc/chainrpc/chainnotifier_grpc.pb.go
View File

@ -23,9 +23,11 @@ type ChainNotifierClient interface {
//registers an intent for a client to be notified once a confirmation request
//has reached its required number of confirmations on-chain.
//
//A client can specify whether the confirmation request should be for a
//particular transaction by its hash or for an output script by specifying a
//zero hash.
//A confirmation request must have a valid output script. It is also possible
//to give a transaction ID. If the transaction ID is not set, a notification
//is sent once the output script confirms. If the transaction ID is also set,
//a notification is sent once the output script confirms in the given
//transaction.
RegisterConfirmationsNtfn(ctx context.Context, in *ConfRequest, opts ...grpc.CallOption) (ChainNotifier_RegisterConfirmationsNtfnClient, error)
//
//RegisterSpendNtfn is a synchronous response-streaming RPC that registers an
@ -161,9 +163,11 @@ type ChainNotifierServer interface {
//registers an intent for a client to be notified once a confirmation request
//has reached its required number of confirmations on-chain.
//
//A client can specify whether the confirmation request should be for a
//particular transaction by its hash or for an output script by specifying a
//zero hash.
//A confirmation request must have a valid output script. It is also possible
//to give a transaction ID. If the transaction ID is not set, a notification
//is sent once the output script confirms. If the transaction ID is also set,
//a notification is sent once the output script confirms in the given
//transaction.
RegisterConfirmationsNtfn(*ConfRequest, ChainNotifier_RegisterConfirmationsNtfnServer) error
//
//RegisterSpendNtfn is a synchronous response-streaming RPC that registers an