ethtypes: Serialize EthFilterID/EthSubscriptionID correctly

filecoin-project · Jan 31, 2023 · 9701b11 · 9701b11
1 parent 965b1cf
commit 9701b11
Show file tree

Hide file tree

Showing 5 changed files with 86 additions and 296 deletions.
diff --git a/build/openrpc/full.json.gz b/build/openrpc/full.json.gz
diff --git a/build/openrpc/gateway.json.gz b/build/openrpc/gateway.json.gz
diff --git a/chain/types/ethtypes/eth_types.go b/chain/types/ethtypes/eth_types.go
@@ -363,6 +363,18 @@ func (h *EthHash) UnmarshalJSON(b []byte) error {
 	return nil
 }
 
+func (h EthHash) String() string {
+	return "0x" + hex.EncodeToString(h[:])
+}
+
+// Should ONLY be used for blocks and Filecoin messages. Eth transactions expect a different hashing scheme.
+func (h EthHash) ToCid() cid.Cid {
+	// err is always nil
+	mh, _ := multihash.EncodeName(h[:], "blake2b-256")
+
+	return cid.NewCidV1(cid.DagCBOR, mh)
+}
+
 func decodeHexString(s string, expectedLen int) ([]byte, error) {
 	s = handleHexStringPrefix(s)
 	if len(s) != expectedLen*2 {
@@ -420,18 +432,6 @@ func EthHashFromTxBytes(b []byte) EthHash {
 	return ethHash
 }
 
-func (h EthHash) String() string {
-	return "0x" + hex.EncodeToString(h[:])
-}
-
-// Should ONLY be used for blocks and Filecoin messages. Eth transactions expect a different hashing scheme.
-func (h EthHash) ToCid() cid.Cid {
-	// err is always nil
-	mh, _ := multihash.EncodeName(h[:], "blake2b-256")
-
-	return cid.NewCidV1(cid.DagCBOR, mh)
-}
-
 type EthFeeHistory struct {
 	OldestBlock   uint64         `json:"oldestBlock"`
 	BaseFeePerGas []EthBigInt    `json:"baseFeePerGas"`
@@ -441,9 +441,33 @@ type EthFeeHistory struct {
 
 type EthFilterID EthHash
 
+func (h EthFilterID) MarshalJSON() ([]byte, error) {
+	return (EthHash)(h).MarshalJSON()
+}
+
+func (h *EthFilterID) UnmarshalJSON(b []byte) error {
+	return (*EthHash)(h).UnmarshalJSON(b)
+}
+
+func (h EthFilterID) String() string {
+	return (EthHash)(h).String()
+}
+
 // An opaque identifier generated by the Lotus node to refer to an active subscription.
 type EthSubscriptionID EthHash
 
+func (h EthSubscriptionID) MarshalJSON() ([]byte, error) {
+	return (EthHash)(h).MarshalJSON()
+}
+
+func (h *EthSubscriptionID) UnmarshalJSON(b []byte) error {
+	return (*EthHash)(h).UnmarshalJSON(b)
+}
+
+func (h EthSubscriptionID) String() string {
+	return (EthHash)(h).String()
+}
+
 type EthFilterSpec struct {
 	// Interpreted as an epoch or one of "latest" for last mined block, "earliest" for first,
 	// "pending" for not yet committed messages.

diff --git a/chain/types/ethtypes/eth_types_test.go b/chain/types/ethtypes/eth_types_test.go
@@ -93,6 +93,48 @@ func TestEthHash(t *testing.T) {
 		h1, err := EthHashFromCid(c)
 		require.Nil(t, err)
 		require.Equal(t, h, h1)
+
+		jm, err := json.Marshal(h)
+		require.NoError(t, err)
+		require.Equal(t, hash, string(jm))
+	}
+}
+
+func TestEthFilterID(t *testing.T) {
+	testcases := []string{
+		`"0x013dbb9442ca9667baccc6230fcd5c1c4b2d4d2870f4bd20681d4d47cfd15184"`,
+		`"0xab8653edf9f51785664a643b47605a7ba3d917b5339a0724e7642c114d0e4738"`,
+	}
+
+	for _, hash := range testcases {
+		var h EthFilterID
+		err := h.UnmarshalJSON([]byte(hash))
+
+		require.Nil(t, err)
+		require.Equal(t, h.String(), strings.Replace(hash, `"`, "", -1))
+
+		jm, err := json.Marshal(h)
+		require.NoError(t, err)
+		require.Equal(t, hash, string(jm))
+	}
+}
+
+func TestEthSubscriptionID(t *testing.T) {
+	testcases := []string{
+		`"0x013dbb9442ca9667baccc6230fcd5c1c4b2d4d2870f4bd20681d4d47cfd15184"`,
+		`"0xab8653edf9f51785664a643b47605a7ba3d917b5339a0724e7642c114d0e4738"`,
+	}
+
+	for _, hash := range testcases {
+		var h EthSubscriptionID
+		err := h.UnmarshalJSON([]byte(hash))
+
+		require.Nil(t, err)
+		require.Equal(t, h.String(), strings.Replace(hash, `"`, "", -1))
+
+		jm, err := json.Marshal(h)
+		require.NoError(t, err)
+		require.Equal(t, hash, string(jm))
 	}
 }