feat(rpc): Custom RPC types

mod/execution/pkg/client/ethclient/types/logs.go

@@ -0,0 +1,76 @@
+// SPDX-License-Identifier: BUSL-1.1
+//
+// Copyright (C) 2024, Berachain Foundation. All rights reserved.
+// Use of this software is governed by the Business Source License included
+// in the LICENSE file of this repository and at www.mariadb.com/bsl11.
+//
+// ANY USE OF THE LICENSED WORK IN VIOLATION OF THIS LICENSE WILL AUTOMATICALLY
+// TERMINATE YOUR RIGHTS UNDER THIS LICENSE FOR THE CURRENT AND ALL OTHER
+// VERSIONS OF THE LICENSED WORK.
+//
+// THIS LICENSE DOES NOT GRANT YOU ANY RIGHT IN ANY TRADEMARK OR LOGO OF
+// LICENSOR OR ITS AFFILIATES (PROVIDED THAT YOU MAY USE A TRADEMARK OR LOGO OF
+// LICENSOR AS EXPRESSLY REQUIRED BY THIS LICENSE).
+//
+// TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+// AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+// EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+// TITLE.
+
+package types
+
+import (
+	"errors"
+
+	"github.com/berachain/beacon-kit/mod/primitives/pkg/common"
+)
+
+// FilterArgs is a map of string to any, used to configure a filter query.
+type FilterArgs map[string]any
+
+// New creates a new FilterArgs with the given addresses and topics.
+func (f FilterArgs) New(
+	addrs []common.ExecutionAddress, topics []common.ExecutionHash,
+) FilterArgs {
+	return FilterArgs{
+		"address": addrs,
+		"topics":  topics,
+	}
+}
+
+// SetFromBlock sets the "fromBlock" field in the FilterArgs, ensuring that
+// BlockHash is not also set.
+func (f FilterArgs) SetFromBlock(block BlockNumber) error {
+	var err error
+	if f["fromBlock"], err = block.MarshalText(); err != nil {
+		return err
+	}
+	if f["blockHash"] != nil {
+		return errors.New("cannot specify both BlockHash and FromBlock/ToBlock")
+	}
+	return nil
+}
+
+// SetToBlock sets the "toBlock" field in the FilterArgs, ensuring that
+// BlockHash is not also set.
+func (f FilterArgs) SetToBlock(block BlockNumber) error {
+	var err error
+	if f["toBlock"], err = block.MarshalText(); err != nil {
+		return err
+	}
+	if f["blockHash"] != nil {
+		return errors.New("cannot specify both BlockHash and FromBlock/ToBlock")
+	}
+	return nil
+}
+
+// SetBlockHash sets the "blockHash" field in the FilterArgs, ensuring that
+// FromBlock and ToBlock are not also set.
+func (f FilterArgs) SetBlockHash(hash common.ExecutionHash) error {
+	if f["fromBlock"] != nil || f["toBlock"] != nil {
+		return errors.New("cannot specify both BlockHash and FromBlock/ToBlock")
+	}
+	f["blockHash"] = hash.Hex()
+	return nil
+}

mod/execution/pkg/client/ethclient/types/number.go

@@ -0,0 +1,116 @@
+// SPDX-License-Identifier: BUSL-1.1
+//
+// Copyright (C) 2024, Berachain Foundation. All rights reserved.
+// Use of this software is governed by the Business Source License included
+// in the LICENSE file of this repository and at www.mariadb.com/bsl11.
+//
+// ANY USE OF THE LICENSED WORK IN VIOLATION OF THIS LICENSE WILL AUTOMATICALLY
+// TERMINATE YOUR RIGHTS UNDER THIS LICENSE FOR THE CURRENT AND ALL OTHER
+// VERSIONS OF THE LICENSED WORK.
+//
+// THIS LICENSE DOES NOT GRANT YOU ANY RIGHT IN ANY TRADEMARK OR LOGO OF
+// LICENSOR OR ITS AFFILIATES (PROVIDED THAT YOU MAY USE A TRADEMARK OR LOGO OF
+// LICENSOR AS EXPRESSLY REQUIRED BY THIS LICENSE).
+//
+// TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+// AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+// EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+// TITLE.
+
+package types
+
+import (
+	"errors"
+	"fmt"
+	stdmath "math"
+	"strings"
+
+	"github.com/berachain/beacon-kit/mod/primitives/pkg/math"
+)
+
+const (
+	SafeBlockNumbeStr      = "safe"
+	FinalizedBlockNumStr   = "finalized"
+	LatestBlockNumStr      = "latest"
+	PendingBlockNumStr     = "pending"
+	EarliestBlockNumberStr = "earliest"
+)
+
+const (
+	SafeBlockNumber      = BlockNumber(-4)
+	FinalizedBlockNumber = BlockNumber(-3)
+	LatestBlockNumber    = BlockNumber(-2)
+	PendingBlockNumber   = BlockNumber(-1)
+	EarliestBlockNumber  = BlockNumber(0)
+)
+
+type BlockNumber int64
+
+// UnmarshalJSON parses the given JSON fragment into a BlockNumber. It supports:
+// - "safe", "finalized", "latest", "earliest" or "pending" as string arguments
+// - the block number
+// Returned errors:
+// - an invalid block number error when the given argument isn't a known strings
+// - an out of range error when the given block number is either too little or too large
+func (bn *BlockNumber) UnmarshalJSON(data []byte) error {
+	input := strings.TrimSpace(string(data))
+
+	if len(input) >= 2 && input[0] == '"' && input[len(input)-1] == '"' {
+		input = input[1 : len(input)-1]
+	}
+
+	switch input {
+	case EarliestBlockNumberStr:
+		*bn = EarliestBlockNumber
+		return nil
+	case LatestBlockNumStr:
+		*bn = LatestBlockNumber
+		return nil
+	case PendingBlockNumStr:
+		*bn = PendingBlockNumber
+		return nil
+	case FinalizedBlockNumStr:
+		*bn = FinalizedBlockNumber
+		return nil
+	case SafeBlockNumbeStr:
+		*bn = SafeBlockNumber
+		return nil
+	}
+
+	result := new(math.U64)
+	result.UnmarshalJSON([]byte(input))
+	if *result > math.U64(uint64(stdmath.MaxInt64)) {
+		return errors.New("block number larger than int64")
+	}
+	//#nosec:G701 // handled by the guard above.
+	*bn = BlockNumber(*result.UnwrapPtr())
+	return nil
+}
+
+// MarshalText implements encoding.TextMarshaler. It marshals:
+// - "safe", "finalized", "latest", "earliest" or "pending" as strings
+// - other numbers as hex
+func (bn BlockNumber) MarshalText() ([]byte, error) {
+	return []byte(bn.String()), nil
+}
+
+func (bn BlockNumber) String() string {
+	switch bn {
+	case EarliestBlockNumber:
+		return EarliestBlockNumberStr
+	case LatestBlockNumber:
+		return LatestBlockNumStr
+	case PendingBlockNumber:
+		return PendingBlockNumStr
+	case FinalizedBlockNumber:
+		return FinalizedBlockNumStr
+	case SafeBlockNumber:
+		return SafeBlockNumbeStr
+	default:
+		if bn < 0 {
+			return fmt.Sprintf("<invalid %d>", bn)
+		}
+		return math.U64(bn).Hex()
+	}
+}

mod/primitives/pkg/math/u64.go

@@ -87,6 +87,13 @@ func (u U64) Base10() string {
 	return strconv.FormatUint(uint64(u), 10)
 }
 
+// Hex returns the hex representation of the U64.
+func (u U64) Hex() string {
+	//#nosec:G703 // its okay.
+	val, _ := hex.MarshalText(u.Unwrap())
+	return string(val)
+}
+
 // ----------------------- U64 Mathematical Methods -----------------------
 
 // Unwrap returns a copy of the underlying uint64 value of U64.