chore(bind): return structs instead of interfaces (#1167)

Author: darrenkel

thorclient/bind/bind_test.go

@@ -28,7 +28,7 @@ import (
 type testEnv struct {
 	t            *testing.T
 	client       *thorclient.Client
-	bindContract Contract
+	bindContract *Contract
 	owner        *PrivateKeySigner
 	user         *PrivateKeySigner
 	testNode     testnode.Node

thorclient/bind/call.go

@@ -9,50 +9,33 @@ import (
 	"errors"
 	"fmt"
 
-	"github.com/vechain/thor/v2/api"
-
 	"github.com/ethereum/go-ethereum/common/hexutil"
 	"github.com/ethereum/go-ethereum/common/math"
+	"github.com/vechain/thor/v2/api"
 	"github.com/vechain/thor/v2/thor"
 	"github.com/vechain/thor/v2/thorclient"
 )
 
-// CallBuilder is the interface for read operations.
-type CallBuilder interface {
-	// AtRevision sets the revision for the call.
-	AtRevision(rev string) CallBuilder
-
-	// Caller sets the caller for the simulation.
-	Caller(caller *thor.Address) CallBuilder
-
-	// ExecuteInto unpacks the result into the provided interface.
-	ExecuteInto(result any) error
-
-	// Execute performs the call and returns the raw result.
-	Execute() (*api.CallResult, error)
-}
-
-// callBuilder is the concrete implementation of CallBuilder.
-type callBuilder struct {
-	op     *methodBuilder
+type CallBuilder struct {
+	op     *MethodBuilder
 	rev    string
 	caller *thor.Address
 }
 
 // AtRevision implements CallBuilder.AtRevision.
-func (b *callBuilder) AtRevision(rev string) CallBuilder {
+func (b *CallBuilder) AtRevision(rev string) *CallBuilder {
 	b.rev = rev
 	return b
 }
 
 // Caller implements CallBuilder.AtRevision.
-func (b *callBuilder) Caller(caller *thor.Address) CallBuilder {
+func (b *CallBuilder) Caller(caller *thor.Address) *CallBuilder {
 	b.caller = caller
 	return b
 }
 
 // ExecuteInto implements CallBuilder.Into.
-func (b *callBuilder) ExecuteInto(result any) error {
+func (b *CallBuilder) ExecuteInto(result any) error {
 	method, ok := b.op.contract.abi.Methods[b.op.method]
 	if !ok {
 		return errors.New("method not found: " + b.op.method)
@@ -72,7 +55,7 @@ func (b *callBuilder) ExecuteInto(result any) error {
 }
 
 // Execute implements CallBuilder.Execute.
-func (b *callBuilder) Execute() (*api.CallResult, error) {
+func (b *CallBuilder) Execute() (*api.CallResult, error) {
 	// Build the clause
 	clause, err := b.op.Clause()
 	if err != nil {
@@ -100,24 +83,25 @@ func (b *callBuilder) Execute() (*api.CallResult, error) {
 		return nil, fmt.Errorf("expected 1 result, got %d", len(res))
 	}
 
-	if res[0].Reverted {
+	result := res[0]
+	if result.Reverted {
 		message := "contract call reverted"
-		if res[0].Data != "" {
-			decoded, err := hexutil.Decode(res[0].Data)
+		if result.Data != "" {
+			decoded, err := hexutil.Decode(result.Data)
 			if err != nil {
-				return nil, fmt.Errorf("failed to decode revert data: %w", err)
+				return result, fmt.Errorf("failed to decode revert data: %w", err)
 			}
 			revertReason, err := UnpackRevert(decoded)
 			if err == nil {
 				message = fmt.Sprintf("contract call reverted: %s", revertReason)
 			}
 		}
-		return nil, errors.New(message)
+		return result, errors.New(message)
 	}
 
-	if res[0].VMError != "" {
-		return nil, fmt.Errorf("VM error: %s", res[0].VMError)
+	if result.VMError != "" {
+		return nil, fmt.Errorf("VM error: %s", result.VMError)
 	}
 
-	return res[0], nil
+	return result, nil
 }

thorclient/bind/contract.go

@@ -21,50 +21,30 @@ import (
 	"github.com/vechain/thor/v2/tx"
 )
 
-// Contract is the main interface for contract interactions.
-// It provides a unified entry point for all contract operations.
-type Contract interface {
-	// Method creates a new method builder for the specified method and arguments.
-	Method(method string, args ...any) MethodBuilder
-
-	// FilterEvent creates a new filter builder for the specified event.
-	FilterEvent(eventName string) FilterBuilder
-
-	// Address returns the contract address.
-	Address() *thor.Address
-
-	// ABI returns the contract ABI.
-	ABI() *abi.ABI
-
-	// Client returns the underlying client.
-	Client() *thorclient.Client
-}
-
-// contract is the concrete implementation of Contract.
-type contract struct {
+type Contract struct {
 	client *thorclient.Client
 	abi    *abi.ABI
 	addr   *thor.Address
 }
 
 // NewContract creates a new contract instance with the given client, ABI data and address.
-func NewContract(client *thorclient.Client, abiData []byte, address *thor.Address) (Contract, error) {
+func NewContract(client *thorclient.Client, abiData []byte, address *thor.Address) (*Contract, error) {
 	if address == nil {
 		return nil, fmt.Errorf("empty contract address")
 	}
 	contractABI, err := abi.JSON(bytes.NewReader(abiData))
 	if err != nil {
 		return nil, err
 	}
-	return &contract{
+	return &Contract{
 		client: client,
 		abi:    &contractABI,
 		addr:   address,
 	}, nil
 }
 
 // DeployContract deploys a contract and creates a new contract instance with the given client, ABI data and address.
-func DeployContract(client *thorclient.Client, signer Signer, abiData []byte, bytecode string) (Contract, error) {
+func DeployContract(client *thorclient.Client, signer Signer, abiData []byte, bytecode string) (*Contract, error) {
 	bc, err := hexutil.Decode(bytecode)
 	if err != nil {
 		return nil, err
@@ -120,8 +100,8 @@ func DeployContract(client *thorclient.Client, signer Signer, abiData []byte, by
 }
 
 // Method implements Contract.Method.
-func (c *contract) Method(method string, args ...any) MethodBuilder {
-	return &methodBuilder{
+func (c *Contract) Method(method string, args ...any) *MethodBuilder {
+	return &MethodBuilder{
 		contract: c,
 		method:   method,
 		args:     args,
@@ -130,26 +110,26 @@ func (c *contract) Method(method string, args ...any) MethodBuilder {
 }
 
 // FilterEvent implements Contract.Event.
-func (c *contract) FilterEvent(eventName string) FilterBuilder {
-	return &filterBuilder{
-		op: &methodBuilder{
+func (c *Contract) FilterEvent(eventName string) *FilterBuilder {
+	return &FilterBuilder{
+		op: &MethodBuilder{
 			contract: c,
 			method:   eventName,
 		},
 	}
 }
 
 // Address returns the contract address.
-func (c *contract) Address() *thor.Address {
+func (c *Contract) Address() *thor.Address {
 	return c.addr
 }
 
 // ABI returns the contract ABI.
-func (c *contract) ABI() *abi.ABI {
+func (c *Contract) ABI() *abi.ABI {
 	return c.abi
 }
 
 // Client returns the underlying HTTP client.
-func (c *contract) Client() *thorclient.Client {
+func (c *Contract) Client() *thorclient.Client {
 	return c.client
 }

thorclient/bind/filter.go

@@ -9,54 +9,38 @@ import (
 	"errors"
 
 	"github.com/vechain/thor/v2/api"
-
 	"github.com/vechain/thor/v2/logdb"
 	"github.com/vechain/thor/v2/thor"
 )
 
-// FilterBuilder is the interface for event filtering.
-type FilterBuilder interface {
-	// InRange sets the range for event filtering.
-	InRange(r *api.Range) FilterBuilder
-
-	// WithOptions sets the filter options.
-	WithOptions(opts *api.Options) FilterBuilder
-
-	// OrderBy sets the order for event filtering.
-	OrderBy(order logdb.Order) FilterBuilder
-
-	// Execute performs the event filtering.
-	Execute() ([]api.FilteredEvent, error)
-}
-
-// filterBuilder is the concrete implementation of FilterBuilder.
-type filterBuilder struct {
-	op      *methodBuilder
+// FilterBuilder is the concrete implementation of FilterBuilder.
+type FilterBuilder struct {
+	op      *MethodBuilder
 	evRange *api.Range
 	opts    *api.Options
 	order   logdb.Order
 }
 
 // InRange implements FilterBuilder.InRange.
-func (b *filterBuilder) InRange(r *api.Range) FilterBuilder {
+func (b *FilterBuilder) InRange(r *api.Range) *FilterBuilder {
 	b.evRange = r
 	return b
 }
 
 // WithOptions implements FilterBuilder.WithOptions.
-func (b *filterBuilder) WithOptions(opts *api.Options) FilterBuilder {
+func (b *FilterBuilder) WithOptions(opts *api.Options) *FilterBuilder {
 	b.opts = opts
 	return b
 }
 
 // OrderBy implements FilterBuilder.OrderBy.
-func (b *filterBuilder) OrderBy(order logdb.Order) FilterBuilder {
+func (b *FilterBuilder) OrderBy(order logdb.Order) *FilterBuilder {
 	b.order = order
 	return b
 }
 
 // Execute implements FilterBuilder.Execute.
-func (b *filterBuilder) Execute() ([]api.FilteredEvent, error) {
+func (b *FilterBuilder) Execute() ([]api.FilteredEvent, error) {
 	event, ok := b.op.contract.abi.Events[b.op.method]
 	if !ok {
 		return nil, errors.New("event not found: " + b.op.method)

thorclient/bind/method.go

@@ -13,51 +13,35 @@ import (
 	"github.com/vechain/thor/v2/tx"
 )
 
-// MethodBuilder is the interface that routes to specific operation types.
-type MethodBuilder interface {
-	// WithValue sets the VET value for the operation.
-	WithValue(vet *big.Int) MethodBuilder
-
-	// Call returns a CallBuilder for read operations.
-	Call() CallBuilder
-
-	// Send returns a SendBuilder for write operations.
-	Send() SendBuilder
-
-	// Clause returns a ClauseBuilder for building transaction clauses.
-	Clause() (*tx.Clause, error)
-}
-
-// methodBuilder is the concrete implementation of MethodBuilder.
-type methodBuilder struct {
-	contract *contract
+type MethodBuilder struct {
+	contract *Contract
 	method   string
 	args     []any
 	vet      *big.Int
 }
 
 // WithValue implements MethodBuilder.WithValue.
-func (b *methodBuilder) WithValue(vet *big.Int) MethodBuilder {
+func (b *MethodBuilder) WithValue(vet *big.Int) *MethodBuilder {
 	b.vet = vet
 	return b
 }
 
 // Call implements MethodBuilder.Call.
-func (b *methodBuilder) Call() CallBuilder {
-	return &callBuilder{
+func (b *MethodBuilder) Call() *CallBuilder {
+	return &CallBuilder{
 		op: b,
 	}
 }
 
 // Send implements MethodBuilder.Send.
-func (b *methodBuilder) Send() SendBuilder {
-	return &sendBuilder{
+func (b *MethodBuilder) Send() *SendBuilder {
+	return &SendBuilder{
 		op: b,
 	}
 }
 
 // Clause implements Clause build.
-func (b *methodBuilder) Clause() (*tx.Clause, error) {
+func (b *MethodBuilder) Clause() (*tx.Clause, error) {
 	method, ok := b.contract.abi.Methods[b.method]
 	if !ok {
 		return nil, fmt.Errorf("method not found: %s", b.method)