Add sdk/ton/executor_test.go

Author: krebernisak

sdk/evm/executor.go

@@ -37,7 +37,7 @@ func (e *Executor) ExecuteOperation(
 	op types.Operation,
 ) (types.TransactionResult, error) {
 	if e.Encoder == nil {
-		return types.TransactionResult{}, errors.New("Executor was created without an encoder")
+		return types.TransactionResult{}, errors.New("failed to create sdk.Executor - encoder (sdk.Encoder) is nil")
 	}
 
 	bindOp, err := e.ToGethOperation(nonce, metadata, op)
@@ -74,7 +74,7 @@ func (e *Executor) SetRoot(
 	sortedSignatures []types.Signature,
 ) (types.TransactionResult, error) {
 	if e.Encoder == nil {
-		return types.TransactionResult{}, errors.New("Executor was created without an encoder")
+		return types.TransactionResult{}, errors.New("failed to create sdk.Executor - encoder (sdk.Encoder) is nil")
 	}
 
 	bindMeta, err := e.ToGethRootMetadata(metadata)

sdk/evm/executor_test.go

@@ -152,7 +152,7 @@ func TestExecutor_ExecuteOperation(t *testing.T) {
 			encoder:    nil,
 			mockSetup:  func(m *evm_mocks.ContractDeployBackend) {},
 			wantTxHash: "",
-			wantErr:    errors.New("Executor was created without an encoder"),
+			wantErr:    errors.New("failed to create sdk.Executor - encoder (sdk.Encoder) is nil"),
 		},
 		{
 			name: "failure in geth operation conversion due to invalid chain ID",
@@ -311,7 +311,7 @@ func TestExecutor_SetRoot(t *testing.T) {
 			encoder:    nil,
 			mockSetup:  func(m *evm_mocks.ContractDeployBackend) {},
 			wantTxHash: "",
-			wantErr:    errors.New("Executor was created without an encoder"),
+			wantErr:    errors.New("failed to create sdk.Executor - encoder (sdk.Encoder) is nil"),
 		},
 		{
 			name: "failure in geth operation conversion due to invalid chain ID",

sdk/ton/configurer_test.go

@@ -11,14 +11,16 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/require"
+
+	"github.com/smartcontractkit/mcms/internal/testutils/chaintest"
+	"github.com/smartcontractkit/mcms/types"
+
 	"github.com/xssnick/tonutils-go/tlb"
 	"github.com/xssnick/tonutils-go/ton"
 	"github.com/xssnick/tonutils-go/ton/wallet"
 
-	"github.com/smartcontractkit/mcms/internal/testutils/chaintest"
 	tonmcms "github.com/smartcontractkit/mcms/sdk/ton"
 	ton_mocks "github.com/smartcontractkit/mcms/sdk/ton/mocks"
-	"github.com/smartcontractkit/mcms/types"
 )
 
 // TestConfigurer_SetConfig tests the SetConfig method of the Configurer.
@@ -127,7 +129,7 @@ func TestConfigurer_SetConfig(t *testing.T) {
 
 				// Mock SendTransaction to return an error
 				m.EXPECT().SendExternalMessageWaitTransaction(mock.Anything, mock.Anything).
-					Return(&tlb.Transaction{Hash: []byte{1, 2, 3, 4, 15}}, &ton.BlockIDExt{}, []byte{}, errors.New("transaction failed"))
+					Return(&tlb.Transaction{Hash: []byte{1, 2, 3, 4, 14}}, &ton.BlockIDExt{}, []byte{}, errors.New("transaction failed"))
 			},
 			want:    "",
 			wantErr: errors.New("transaction failed"),

sdk/ton/executor.go

@@ -7,6 +7,7 @@ import (
 	"fmt"
 	"math/big"
 	"math/rand/v2"
+	"reflect"
 
 	"github.com/ethereum/go-ethereum/common"
 
@@ -38,13 +39,25 @@ type executor struct {
 }
 
 // NewExecutor creates a new Executor for TON chains
-func NewExecutor(encoder sdk.Encoder, client *ton.APIClient, wallet *wallet.Wallet, amount tlb.Coins) sdk.Executor {
+func NewExecutor(encoder sdk.Encoder, client ton.APIClientWrapped, wallet *wallet.Wallet, amount tlb.Coins) (sdk.Executor, error) {
+	if IsNil(encoder) {
+		return nil, errors.New("failed to create sdk.Executor - encoder (sdk.Encoder) is nil")
+	}
+
+	if IsNil(client) {
+		return nil, errors.New("failed to create sdk.Executor - client (ton.APIClientWrapped) is nil")
+	}
+
+	if wallet == nil {
+		return nil, errors.New("failed to create sdk.Executor - wallet (*wallet.Wallet) is nil")
+	}
+
 	return &executor{
 		Encoder:   encoder,
 		Inspector: NewInspector(client, NewConfigTransformer()),
 		wallet:    wallet,
 		amount:    amount,
-	}
+	}, nil
 }
 
 func (e *executor) ExecuteOperation(
@@ -54,10 +67,6 @@ func (e *executor) ExecuteOperation(
 	proof []common.Hash,
 	op types.Operation,
 ) (types.TransactionResult, error) {
-	if e.Encoder == nil {
-		return types.TransactionResult{}, errors.New("executor was created without an encoder")
-	}
-
 	oe, ok := e.Encoder.(OperationEncoder[mcms.Op])
 	if !ok {
 		return types.TransactionResult{}, fmt.Errorf("failed to assert OperationEncoder")
@@ -109,7 +118,7 @@ func (e *executor) ExecuteOperation(
 	// TODO: do we wait for execution trace?
 	tx, _, err := e.wallet.SendWaitTransaction(ctx, msg)
 	if err != nil {
-		return types.TransactionResult{}, fmt.Errorf("failed to set config: %w", err)
+		return types.TransactionResult{}, fmt.Errorf("failed to execute op: %w", err)
 	}
 
 	return types.TransactionResult{
@@ -127,16 +136,6 @@ func (e *executor) SetRoot(
 	validUntil uint32,
 	sortedSignatures []types.Signature,
 ) (types.TransactionResult, error) {
-	if e.Encoder == nil {
-		return types.TransactionResult{}, errors.New("Executor was created without an encoder")
-	}
-
-	// Map to Ton Address type
-	dstAddr, err := address.ParseAddr(metadata.MCMAddress)
-	if err != nil {
-		return types.TransactionResult{}, fmt.Errorf("invalid timelock address: %w", err)
-	}
-
 	rme, ok := e.Encoder.(RootMetadataEncoder[mcms.RootMetadata])
 	if !ok {
 		return types.TransactionResult{}, fmt.Errorf("failed to assert RootMetadataEncoder")
@@ -147,6 +146,12 @@ func (e *executor) SetRoot(
 		return types.TransactionResult{}, fmt.Errorf("failed to convert to root metadata: %w", err)
 	}
 
+	// Map to Ton Address type
+	dstAddr, err := address.ParseAddr(metadata.MCMAddress)
+	if err != nil {
+		return types.TransactionResult{}, fmt.Errorf("invalid timelock address: %w", err)
+	}
+
 	// Encode proofs
 	pe, ok := e.Encoder.(ProofEncoder[mcms.Proof])
 	if !ok {
@@ -197,7 +202,7 @@ func (e *executor) SetRoot(
 	// TODO: do we wait for execution trace?
 	tx, _, err := e.wallet.SendWaitTransaction(ctx, msg)
 	if err != nil {
-		return types.TransactionResult{}, fmt.Errorf("failed to set config: %w", err)
+		return types.TransactionResult{}, fmt.Errorf("failed to set root: %w", err)
 	}
 
 	return types.TransactionResult{
@@ -206,3 +211,18 @@ func (e *executor) SetRoot(
 		RawData:     tx,
 	}, nil
 }
+
+// IsNil checks if a value is nil or if it's a reference type with a nil underlying value.
+// Notice: vendoring github:samber/lo
+func IsNil(x any) bool {
+	if x == nil {
+		return true
+	}
+	v := reflect.ValueOf(x)
+	switch v.Kind() {
+	case reflect.Chan, reflect.Func, reflect.Map, reflect.Pointer, reflect.UnsafePointer, reflect.Interface, reflect.Slice:
+		return v.IsNil()
+	default:
+		return false
+	}
+}