TrueCloudLab/neoneo-go
7
0
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #3242 from nspcc-dev/improve-subs-doc

Browse source 
Improve notification subsystem documentation
This commit is contained in:
Roman Khimov 2023-11-29 14:35:38 +03:00 committed by GitHub
commit 90e18ec743
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/notifications.md
View file

@ -33,7 +33,7 @@ Filters use conjunctional logic.
* new in-block transaction is announced after block processing, but before * new in-block transaction is announced after block processing, but before
announcing the block itself announcing the block itself
* transaction notifications are only announced for successful transactions * transaction notifications are only announced for successful transactions
* all announcements are being done in the same order they happen on the chain * all announcements are being done in the same order they happen on the chain.
First, OnPersist script execution is announced followed by notifications generated First, OnPersist script execution is announced followed by notifications generated
during the script execution. After that transaction execution is announced. It is during the script execution. After that transaction execution is announced. It is
then followed by notifications generated during this execution. Next, follows the then followed by notifications generated during this execution. Next, follows the
@ -41,6 +41,10 @@ Filters use conjunctional logic.
they're in the block. After all in-block transactions announcements PostPersist they're in the block. After all in-block transactions announcements PostPersist
script execution is announced followed by notifications generated during the script execution is announced followed by notifications generated during the
script execution. Finally, block announcement is followed. script execution. Finally, block announcement is followed.
* notary request events announcements are not bound to the chain processing.
Trigger for notary request notifications is notary request mempool content
change, thus, notary request event is announced every time notary request
enters or leaves notary pool.
* unsubscription may not cancel pending, but not yet sent events * unsubscription may not cancel pending, but not yet sent events
## Subscription management ## Subscription management

4
pkg/rpcclient/wsclient.go
View file

@ -43,6 +43,10 @@ import (
// unblocking in this mode. No unsubscription is performed in this case, so it's // unblocking in this mode. No unsubscription is performed in this case, so it's
// still the user responsibility to unsubscribe. // still the user responsibility to unsubscribe.
// //
// All Receive* methods provide notifications ordering and persistence guarantees.
// See https://github.com/nspcc-dev/neo-go/blob/master/docs/notifications.md#ordering-and-persistence-guarantees
// for more details on this topic.
//
// Any received subscription items (blocks/transactions/nofitications) are passed // Any received subscription items (blocks/transactions/nofitications) are passed
// via pointers for efficiency, but the actual structures MUST NOT be changed, as // via pointers for efficiency, but the actual structures MUST NOT be changed, as
// it may affect the functionality of other notification receivers. If multiple // it may affect the functionality of other notification receivers. If multiple