Get block notifications API #3781

lock9 · 2025-01-06T19:09:18Z

Closes #3779.

It works but I don't know if this is the best way to do it.

roman-khimov

Nice one overall.

pkg/services/rpcsrv/server.go

pkg/services/rpcsrv/server_test.go

roman-khimov · 2025-01-09T08:04:16Z

RPC client needs to be updated to support this as well.

AnnaShaleva

A useful extension.

pkg/services/rpcsrv/server.go

pkg/services/rpcsrv/server_test.go

pkg/services/rpcsrv/server.go

AnnaShaleva · 2025-01-09T10:36:07Z

Please, ensure testing jobs are passing. Currently, unit-tests, project linter and DCO checks are failing.

lock9 · 2025-01-15T18:11:43Z

Hey guys, got some busy days ahead. I'll come back to this in one or two weeks max. Sorry for the delay

lock9 · 2025-01-20T06:57:50Z

PR Updated.

Changes:

Added GetTrimmedBlock and TrimmedBlock
- Note: There's already the concept of 'trimmed block' and this name may not be ideal
Added a new struct "BlockNotifications", grouping notifications by trigger type
Updated the tests to use the neo token hash
Updated the tests to check the notification content
Changed the name of some functions/types
Moved reusable logic to the utils file
Added the new endpoint to the rpc docs file
Updated the client class to support the new endpoint

Still pending:

RPC Client tests

About trigger filters: I don't know/don't have an opinion.

pkg/core/block/block.go

codecov · 2025-01-20T09:40:58Z

Codecov Report

Attention: Patch coverage is 61.25000% with 62 lines in your changes missing coverage. Please review.

Project coverage is 82.99%. Comparing base (16a6a59) to head (d012a6b).

Files with missing lines	Patch %	Lines
pkg/core/block/block.go	45.33%	33 Missing and 8 partials ⚠️
pkg/services/rpcsrv/server.go	67.56%	9 Missing and 3 partials ⚠️
pkg/rpcclient/rpc.go	0.00%	6 Missing ⚠️
pkg/core/dao/dao.go	72.72%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3781      +/-   ##
==========================================
- Coverage   83.14%   82.99%   -0.16%     
==========================================
  Files         335      335              
  Lines       46896    47056     +160     
==========================================
+ Hits        38994    39054      +60     
- Misses       6310     6399      +89     
- Partials     1592     1603      +11

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

docs/rpc.md

AnnaShaleva · 2025-01-20T11:19:09Z

pkg/core/block/block.go

@@ -221,7 +235,6 @@ func (b *Block) GetExpectedBlockSizeWithoutTransactions(txCount int) int {
 	return size
 }

-// ToStackItem converts Block to stackitem.Item.


Useless change.

Still relevant.

pkg/core/block/block.go

pkg/services/rpcsrv/util.go

AnnaShaleva · 2025-01-20T12:51:13Z

pkg/services/rpcsrv/util.go

+			Container:         container,
+			NotificationEvent: evt,
+		}
+		if filter == nil || rpcevent.Matches(&notificationComparatorFilter{


filter == nil check is excessive. rpcevent.Matche perfectly handle this case.

AnnaShaleva · 2025-01-20T12:54:16Z

About trigger filters: I don't know/don't have an opinion.

Seems that we don't need it for now, so nothing should be done wrt this question.

AnnaShaleva · 2025-01-20T12:57:17Z

Please, format commits according to https://github.com/nspcc-dev/.github/blob/master/git.md#commits. See https://github.com/nspcc-dev/neo-go/pull/3787/commits for example.

Also, please ensure your commits have valid signed-off-by signature.

pkg/core/dao/dao.go

Add new RPC method to retrieve block notifications organized by trigger type. Signed-off-by: Ricardo Prado <[email protected]>

roman-khimov · 2025-02-10T15:31:10Z

pkg/core/block/block.go

@@ -221,7 +235,6 @@ func (b *Block) GetExpectedBlockSizeWithoutTransactions(txCount int) int {
 	return size
 }

-// ToStackItem converts Block to stackitem.Item.


Still relevant.

roman-khimov · 2025-02-10T15:32:04Z

pkg/core/dao/dao_test.go

@@ -123,6 +124,55 @@ func TestPutGetBlock(t *testing.T) {
 	require.Error(t, err)
 }

+func TestGetTrimmedBlock(t *testing.T) {


Leftover, fails to test.

roman-khimov · 2025-02-10T15:32:28Z

pkg/core/blockchain.go

@@ -3149,3 +3149,8 @@ func (bc *Blockchain) GetStoragePrice() int64 {
 	}
 	return bc.contracts.Policy.GetStoragePriceInternal(bc.dao)
 }
+
+// GetTrimmedBlock returns a block with only the header and transaction hashes.
+func (bc *Blockchain) GetTrimmedBlock(hash util.Uint256) (*block.TrimmedBlock, error) {


Needs to be fixed, fails to build.

roman-khimov · 2025-02-10T15:34:17Z

pkg/neorpc/result/block_notifications.go

+
+// BlockNotifications represents notifications from a block organized by trigger type.
+type BlockNotifications struct {
+	PrePersistNotifications  []state.ContainedNotificationEvent `json:"prepersist,omitempty"`


I think we better have onpersist instead of prepersist in JSON, while pre is technically more correct here we have on used in trigger, method and many other places, so it'd be a bit more consistent this way.

roman-khimov · 2025-02-10T15:35:08Z

pkg/neorpc/result/block_notifications.go

+// BlockNotifications represents notifications from a block organized by trigger type.
+type BlockNotifications struct {
+	PrePersistNotifications  []state.ContainedNotificationEvent `json:"prepersist,omitempty"`
+	TxNotifications          []state.ContainedNotificationEvent `json:"transactions,omitempty"`
+	PostPersistNotifications []state.ContainedNotificationEvent `json:"postpersist,omitempty"`


You can still drop Notifications from all of the field names, it's excessive. Actually following trigger names makes total sense here, OnPersist/Application/PostPersist like in https://github.com/nspcc-dev/neo-go/blob/8d728b4ec179e6354c21fc7e2c4f8a7c4df7312e/pkg/smartcontract/trigger/trigger_type.go

roman-khimov · 2025-02-10T15:40:10Z

pkg/services/rpcsrv/server.go

+	notifications := &result.BlockNotifications{}
+
+	aers, err := s.chain.GetAppExecResults(block.Hash(), trigger.OnPersist)
+	if err == nil && len(aers) > 0 {


Still relevant.

roman-khimov · 2025-02-10T15:40:15Z

pkg/services/rpcsrv/server.go

+	}
+
+	aers, err = s.chain.GetAppExecResults(block.Hash(), trigger.PostPersist)
+	if err == nil && len(aers) > 0 {


roman-khimov · 2025-02-10T15:42:26Z

pkg/services/rpcsrv/notification_comparator.go

+			NotificationEvent: evt,
+		}
+		if rpcevent.Matches(&notificationEventComparator{
+			filter: *filter,


Won't this panic on nil filter? Probably something was a bit different when #3781 (comment) was made.

roman-khimov · 2025-02-11T13:10:20Z

I can't push to linkd-academy:block-notifications, so this one is replaced with #3805 (which includes changes from this PR), thanks!

lock9 requested review from AnnaShaleva and roman-khimov as code owners January 6, 2025 19:09

roman-khimov requested changes Jan 7, 2025

View reviewed changes

AnnaShaleva reviewed Jan 9, 2025

View reviewed changes

lock9 force-pushed the block-notifications branch 2 times, most recently from dee62f4 to cb76197 Compare January 20, 2025 06:34

lock9 commented Jan 20, 2025

View reviewed changes

pkg/core/block/block.go Outdated Show resolved Hide resolved

AnnaShaleva reviewed Jan 20, 2025

View reviewed changes

roman-khimov reviewed Feb 6, 2025

View reviewed changes

pkg/core/dao/dao.go Outdated Show resolved Hide resolved

rpc: implement getblocknotifications API

3d27ef8

Add new RPC method to retrieve block notifications organized by trigger type. Signed-off-by: Ricardo Prado <[email protected]>

lock9 force-pushed the block-notifications branch from d012a6b to 3d27ef8 Compare February 10, 2025 15:23

roman-khimov reviewed Feb 10, 2025

View reviewed changes

roman-khimov mentioned this pull request Feb 11, 2025

Block notifications #3805

Merged

roman-khimov closed this Feb 11, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Get block notifications API #3781

Get block notifications API #3781

lock9 commented Jan 6, 2025

roman-khimov left a comment

roman-khimov commented Jan 9, 2025

AnnaShaleva left a comment

AnnaShaleva commented Jan 9, 2025

lock9 commented Jan 15, 2025

lock9 commented Jan 20, 2025

codecov bot commented Jan 20, 2025

AnnaShaleva Jan 20, 2025

roman-khimov Feb 10, 2025

AnnaShaleva Jan 20, 2025

AnnaShaleva commented Jan 20, 2025

AnnaShaleva commented Jan 20, 2025

roman-khimov Feb 10, 2025

roman-khimov Feb 10, 2025

roman-khimov Feb 10, 2025

roman-khimov Feb 10, 2025

roman-khimov Feb 10, 2025

roman-khimov Feb 10, 2025

roman-khimov Feb 10, 2025

roman-khimov Feb 10, 2025

roman-khimov commented Feb 11, 2025

Get block notifications API #3781

Get block notifications API #3781

Conversation

lock9 commented Jan 6, 2025

roman-khimov left a comment

Choose a reason for hiding this comment

roman-khimov commented Jan 9, 2025

AnnaShaleva left a comment

Choose a reason for hiding this comment

AnnaShaleva commented Jan 9, 2025

lock9 commented Jan 15, 2025

lock9 commented Jan 20, 2025

codecov bot commented Jan 20, 2025

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AnnaShaleva commented Jan 20, 2025

AnnaShaleva commented Jan 20, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

roman-khimov commented Feb 11, 2025