Merge pull request #3820 from nspcc-dev/getblocknotifications

rpcclient: fix getblocknotifications filter handling

Author: AnnaShaleva

pkg/rpcclient/rpc.go

@@ -974,9 +974,15 @@ func (c *Client) GetRawNotaryPool() (*result.RawNotaryPool, error) {
 }
 
 // GetBlockNotifications returns notifications from a block organized by trigger type.
-func (c *Client) GetBlockNotifications(blockHash util.Uint256, filters ...*neorpc.NotificationFilter) (*result.BlockNotifications, error) {
-	var resp = &result.BlockNotifications{}
-	if err := c.performRequest("getblocknotifications", []any{blockHash.StringLE(), filters}, resp); err != nil {
+func (c *Client) GetBlockNotifications(blockHash util.Uint256, filter *neorpc.NotificationFilter) (*result.BlockNotifications, error) {
+	var (
+		resp   = &result.BlockNotifications{}
+		params = []any{blockHash.StringLE()}
+	)
+	if filter != nil {
+		params = append(params, *filter)
+	}
+	if err := c.performRequest("getblocknotifications", params, resp); err != nil {
 		return nil, err
 	}
 	return resp, nil

pkg/rpcclient/rpc_test.go

@@ -1335,6 +1335,72 @@ var rpcClientTestCases = map[string][]rpcClientTestCase{
 			},
 		},
 	},
+	"getblocknotifications": {
+		{
+			name: "positive, nil filter",
+			invoke: func(c *Client) (any, error) {
+				hash, err := util.Uint256DecodeStringLE("0f8fb4e17d2ab9f3097af75ca7fd16064160fb8043db94909e00dd4e257b9dc4")
+				if err != nil {
+					return nil, err
+				}
+				return c.GetBlockNotifications(hash, nil)
+			},
+			serverResponse: `{
+			"jsonrpc": "2.0",
+			"id": 1,
+			"result": {
+				"onpersist": [],
+				"application": [
+					{
+						"container": "0x0f8fb4e17d2ab9f3097af75ca7fd16064160fb8043db94909e00dd4e257b9dc4",
+						"contract": "0xfffdc93764dbaddd97c48f252a53ea4643faa3fd",
+						"eventname": "Deploy",
+						"state": {
+							"type": "Array",
+							"value": [
+								{
+									"type": "ByteString",
+									"value": "/aP6Q0bqUyolj8SX3a3bZDfJ/f8="
+								}
+							]
+						}
+					}
+				],
+				"postpersist": []
+			}
+		}`,
+			result: func(c *Client) any {
+				blockHash, _ := util.Uint256DecodeStringLE("0f8fb4e17d2ab9f3097af75ca7fd16064160fb8043db94909e00dd4e257b9dc4")
+				contract, _ := util.Uint160DecodeStringBE("fffdc93764dbaddd97c48f252a53ea4643faa3fd")
+				expectedBytes, _ := base64.StdEncoding.DecodeString("/aP6Q0bqUyolj8SX3a3bZDfJ/f8=")
+				return &result.BlockNotifications{
+					OnPersist: []state.ContainedNotificationEvent{},
+					Application: []state.ContainedNotificationEvent{
+						{
+							Container: blockHash,
+							NotificationEvent: state.NotificationEvent{
+								ScriptHash: contract,
+								Name:       "Deploy",
+								Item:       stackitem.NewArray([]stackitem.Item{stackitem.NewByteArray(expectedBytes)}),
+							},
+						},
+					},
+					PostPersist: []state.ContainedNotificationEvent{},
+				}
+			},
+			check: func(t *testing.T, c *Client, res any) {
+				bn, ok := res.(*result.BlockNotifications)
+				require.True(t, ok)
+				require.NotEmpty(t, bn)
+				require.Len(t, bn.Application, 1)
+				n := bn.Application[0]
+				require.Equal(t, "Deploy", n.Name)
+				require.Equal(t, "0f8fb4e17d2ab9f3097af75ca7fd16064160fb8043db94909e00dd4e257b9dc4", n.Container.StringLE())
+				require.Equal(t, "fffdc93764dbaddd97c48f252a53ea4643faa3fd", n.ScriptHash.StringLE())
+				require.Len(t, n.Item.Value().([]stackitem.Item), 1)
+			},
+		},
+	},
 }
 
 type rpcClientErrorCase struct {
@@ -1859,6 +1925,12 @@ var rpcClientErrorCases = map[string][]rpcClientErrorCase{
 				return nil, c.ValidateAddress("")
 			},
 		},
+		{
+			name: "getblocknotifications_unmarshalling_error",
+			invoke: func(c *Client) (any, error) {
+				return c.GetBlockNotifications(util.Uint256{}, nil)
+			},
+		},
 	},
 }
 

pkg/services/rpcsrv/client_test.go

@@ -2488,3 +2488,38 @@ func TestClient_NEP24(t *testing.T) {
 		}
 	})
 }
+
+func TestGetBlockNotifications(t *testing.T) {
+	chain, _, httpSrv := initServerWithInMemoryChain(t)
+	c, err := rpcclient.New(context.Background(), httpSrv.URL, rpcclient.Options{})
+	require.NoError(t, err)
+	t.Cleanup(c.Close)
+	require.NoError(t, c.Init())
+
+	t.Run("nil filter", func(t *testing.T) {
+		bn, err := c.GetBlockNotifications(chain.GetHeaderHash(1), nil)
+		require.NoError(t, err)
+		require.NotEmpty(t, bn)
+	})
+	t.Run("empty filter", func(t *testing.T) {
+		bn, err := c.GetBlockNotifications(chain.GetHeaderHash(1), &neorpc.NotificationFilter{})
+		require.NoError(t, err)
+		require.NotEmpty(t, bn)
+	})
+	t.Run("bad filter", func(t *testing.T) {
+		badName := "Transfer1"
+		bn, err := c.GetBlockNotifications(chain.GetHeaderHash(1), &neorpc.NotificationFilter{
+			Name: &badName,
+		})
+		require.NoError(t, err)
+		require.Empty(t, bn)
+	})
+	t.Run("good", func(t *testing.T) {
+		name := "Transfer"
+		bn, err := c.GetBlockNotifications(chain.GetHeaderHash(1), &neorpc.NotificationFilter{
+			Name: &name,
+		})
+		require.NoError(t, err)
+		require.NotEmpty(t, bn)
+	})
+}

pkg/services/rpcsrv/server_test.go

@@ -2324,6 +2324,12 @@ var rpcTestCases = map[string][]rpcTestCase{
 			fail:    true,
 			errCode: neorpc.InvalidParamsCode,
 		},
+		{
+			name:    "empty filter",
+			params:  `["` + genesisBlockHash + `", []]`,
+			fail:    true,
+			errCode: neorpc.InvalidParamsCode,
+		},
 	},
 }