reduce panic chance by checking CallToMethod return len on all cases

cmd/blockchaincmd/change_weight.go

@@ -166,7 +166,7 @@ func setWeight(_ *cobra.Command, args []string) error {
 		return fmt.Errorf("unable to find Validator Manager address")
 	}
 	validatorManagerAddress = sc.Networks[network.Name()].ValidatorManagerAddress
-	validationID, err := validator.GetValidationID(rpcURL, nodeID, validatorManagerAddress)
+	validationID, err := validator.GetValidationID(rpcURL, common.HexToAddress(validatorManagerAddress), nodeID)
 	if err != nil {
 		return err
 	}

cmd/blockchaincmd/remove_validator.go

@@ -167,7 +167,7 @@ func removeValidator(_ *cobra.Command, args []string) error {
 			}
 		}
 		validatorManagerAddress = sc.Networks[network.Name()].ValidatorManagerAddress
-		validationID, err := validatorsdk.GetRegisteredValidator(
+		validationID, err := validatorsdk.GetValidationID(
 			rpcURL,
 			common.HexToAddress(validatorManagerAddress),
 			nodeID,

cmd/validatorcmd/getBalance.go

@@ -194,7 +194,7 @@ func getNodeValidationID(
 			return ids.Empty, false, err
 		}
 		managerAddress := common.HexToAddress(validatorManagerAddress)
-		validationID, err = validator.GetRegisteredValidator(rpcURL, managerAddress, nodeID)
+		validationID, err = validator.GetValidationID(rpcURL, managerAddress, nodeID)
 		if err != nil {
 			return ids.Empty, false, err
 		}

cmd/validatorcmd/list.go

@@ -107,7 +107,7 @@ func list(_ *cobra.Command, args []string) error {
 			return err
 		}
 		balance := uint64(0)
-		validationID, err := validator.GetRegisteredValidator(rpcURL, managerAddress, nodeID)
+		validationID, err := validator.GetValidationID(rpcURL, managerAddress, nodeID)
 		if err != nil {
 			ux.Logger.RedXToUser("could not get validation ID for node %s due to %s", nodeID, err)
 		} else {

pkg/contract/contract.go

@@ -604,6 +604,21 @@ func CallToMethod(
 	return out, nil
 }
 
+func GetSmartContractCallResult[T any](methodName string, out []interface{}) (T, error) {
+	empty := new(T)
+	if len(out) == 0 {
+		return *empty, fmt.Errorf("error at %s call: no return value", methodName)
+	}
+	if len(out) != 1 {
+		return *empty, fmt.Errorf("error at %s call: expected 1 return value, got %d", methodName, len(out))
+	}
+	received, typeIsOk := out[0].(T)
+	if !typeIsOk {
+		return *empty, fmt.Errorf("error at %s call, expected %T, got %T", methodName, *empty, out[0])
+	}
+	return received, nil
+}
+
 func DeployContract(
 	rpcURL string,
 	privateKey string,

pkg/contract/ownable.go

@@ -2,12 +2,7 @@
 // See the file LICENSE for licensing terms.
 package contract
 
-import (
-	_ "embed"
-	"fmt"
-
-	"github.com/ethereum/go-ethereum/common"
-)
+import "github.com/ethereum/go-ethereum/common"
 
 // GetContractOwner gets owner for https://docs.openzeppelin.com/contracts/2.x/api/ownership#Ownable-owner contracts
 func GetContractOwner(
@@ -22,10 +17,5 @@ func GetContractOwner(
 	if err != nil {
 		return common.Address{}, err
 	}
-
-	ownerAddr, ok := out[0].(common.Address)
-	if !ok {
-		return common.Address{}, fmt.Errorf("error at owner() call, expected common.Address, got %T", out[0])
-	}
-	return ownerAddr, nil
+	return GetSmartContractCallResult[common.Address]("owner", out)
 }

pkg/ictt/operate.go

@@ -55,11 +55,7 @@ func ERC20TokenHomeGetTokenAddress(
 	if err != nil {
 		return common.Address{}, err
 	}
-	tokenAddress, b := out[0].(common.Address)
-	if !b {
-		return common.Address{}, fmt.Errorf("error at token call, expected common.Address, got %T", out[0])
-	}
-	return tokenAddress, nil
+	return contract.GetSmartContractCallResult[common.Address]("token", out)
 }
 
 func NativeTokenHomeGetTokenAddress(
@@ -74,11 +70,7 @@ func NativeTokenHomeGetTokenAddress(
 	if err != nil {
 		return common.Address{}, err
 	}
-	tokenAddress, b := out[0].(common.Address)
-	if !b {
-		return common.Address{}, fmt.Errorf("error at wrappedToken call, expected common.Address, got %T", out[0])
-	}
-	return tokenAddress, nil
+	return contract.GetSmartContractCallResult[common.Address]("wrappedToken", out)
 }
 
 func TokenRemoteIsCollateralized(
@@ -93,11 +85,7 @@ func TokenRemoteIsCollateralized(
 	if err != nil {
 		return false, err
 	}
-	isCollateralized, b := out[0].(bool)
-	if !b {
-		return false, fmt.Errorf("error at isCollateralized call, expected bool, got %T", out[0])
-	}
-	return isCollateralized, nil
+	return contract.GetSmartContractCallResult[bool]("isCollateralized", out)
 }
 
 func TokenHomeGetDecimals(
@@ -112,11 +100,7 @@ func TokenHomeGetDecimals(
 	if err != nil {
 		return 0, err
 	}
-	decimals, b := out[0].(uint8)
-	if !b {
-		return 0, fmt.Errorf("error at tokenDecimals, expected uint8, got %T", out[0])
-	}
-	return decimals, nil
+	return contract.GetSmartContractCallResult[uint8]("tokenDecimals", out)
 }
 
 type RegisteredRemote struct {
@@ -146,6 +130,9 @@ func TokenHomeGetRegisteredRemote(
 		registeredRemote RegisteredRemote
 		b                bool
 	)
+	if len(out) != 4 {
+		return RegisteredRemote{}, fmt.Errorf("error at registeredRemotes call, expected 4 return values, got %d", len(out))
+	}
 	registeredRemote.Registered, b = out[0].(bool)
 	if !b {
 		return RegisteredRemote{}, fmt.Errorf("error at registeredRemotes call, expected bool, got %T", out[0])
@@ -177,11 +164,7 @@ func ERC20TokenRemoteGetTokenHomeAddress(
 	if err != nil {
 		return common.Address{}, err
 	}
-	tokenHubAddress, b := out[0].(common.Address)
-	if !b {
-		return common.Address{}, fmt.Errorf("error at tokenHubAddress call, expected common.Address, got %T", out[0])
-	}
-	return tokenHubAddress, nil
+	return contract.GetSmartContractCallResult[common.Address]("tokenHomeAddress", out)
 }
 
 func NativeTokenRemoteGetTotalNativeAssetSupply(
@@ -196,11 +179,7 @@ func NativeTokenRemoteGetTotalNativeAssetSupply(
 	if err != nil {
 		return nil, err
 	}
-	supply, b := out[0].(*big.Int)
-	if !b {
-		return nil, fmt.Errorf("error at totalNativeAssetSupply, expected *big.Int, got %T", out[0])
-	}
-	return supply, nil
+	return contract.GetSmartContractCallResult[*big.Int]("totalNativeAssetSupply", out)
 }
 
 func ERC20TokenHomeSend(

pkg/interchain/operate.go

@@ -4,7 +4,6 @@ package interchain
 
 import (
 	_ "embed"
-	"fmt"
 	"math/big"
 
 	"github.com/ava-labs/avalanche-cli/pkg/contract"
@@ -27,11 +26,7 @@ func GetNextMessageID(
 	if err != nil {
 		return ids.Empty, err
 	}
-	received, b := out[0].([32]byte)
-	if !b {
-		return ids.Empty, fmt.Errorf("error at getNextMessageID call, expected ids.ID, got %T", out[0])
-	}
-	return received, nil
+	return contract.GetSmartContractCallResult[[32]byte]("getNextMessageID", out)
 }
 
 func MessageReceived(
@@ -48,11 +43,7 @@ func MessageReceived(
 	if err != nil {
 		return false, err
 	}
-	received, b := out[0].(bool)
-	if !b {
-		return false, fmt.Errorf("error at messageReceived call, expected bool, got %T", out[0])
-	}
-	return received, nil
+	return contract.GetSmartContractCallResult[bool]("messageReceived", out)
 }
 
 func SendCrossChainMessage(

pkg/precompiles/allowlist.go

@@ -4,7 +4,6 @@ package precompiles
 
 import (
 	_ "embed"
-	"fmt"
 	"math/big"
 
 	"github.com/ava-labs/avalanche-cli/pkg/contract"
@@ -109,9 +108,5 @@ func ReadAllowList(
 	if err != nil {
 		return nil, err
 	}
-	role, b := out[0].(*big.Int)
-	if !b {
-		return nil, fmt.Errorf("error at readAllowList, expected *big.Int, got %T", out[0])
-	}
-	return role, nil
+	return contract.GetSmartContractCallResult[*big.Int]("readAllowList", out)
 }

pkg/precompiles/warp.go

@@ -4,7 +4,6 @@ package precompiles
 
 import (
 	_ "embed"
-	"fmt"
 
 	"github.com/ava-labs/avalanche-cli/pkg/contract"
 	"github.com/ava-labs/avalanchego/ids"
@@ -21,12 +20,5 @@ func WarpPrecompileGetBlockchainID(
 	if err != nil {
 		return ids.Empty, err
 	}
-	if len(out) == 0 {
-		return ids.Empty, fmt.Errorf("error at getBlockchainID call: no return value")
-	}
-	received, ok := out[0].([32]byte)
-	if !ok {
-		return ids.Empty, fmt.Errorf("error at getBlockchainID call, expected ids.ID, got %T", out[0])
-	}
-	return received, nil
+	return contract.GetSmartContractCallResult[[32]byte]("getBlockchainID", out)
 }

pkg/validatormanager/proxy.go

@@ -4,7 +4,6 @@ package validatormanager
 
 import (
 	_ "embed"
-	"fmt"
 	"math/big"
 
 	"github.com/ava-labs/avalanche-cli/pkg/contract"
@@ -47,11 +46,7 @@ func GetProxyValidatorManager(
 	if err != nil {
 		return common.Address{}, err
 	}
-	validatorManagerAddress, b := out[0].(common.Address)
-	if !b {
-		return common.Address{}, fmt.Errorf("error obtaining proxy implementation, expected common.Address, got %T", out[0])
-	}
-	return validatorManagerAddress, nil
+	return contract.GetSmartContractCallResult[common.Address]("getProxyImplementation", out)
 }
 
 func ProxyHasValidatorManagerSet(

pkg/validatormanager/registration.go

@@ -201,7 +201,7 @@ func GetRegisterL1ValidatorMessage(
 	)
 	if registerSubnetValidatorUnsignedMessage == nil {
 		if alreadyInitialized {
-			validationID, err = validator.GetRegisteredValidator(
+			validationID, err = validator.GetValidationID(
 				rpcURL,
 				managerAddress,
 				nodeID,
@@ -299,11 +299,7 @@ func PoSWeightToValue(
 	if err != nil {
 		return nil, err
 	}
-	value, b := out[0].(*big.Int)
-	if !b {
-		return nil, fmt.Errorf("error at weightToValue, expected *big.Int, got %T", out[0])
-	}
-	return value, nil
+	return contract.GetSmartContractCallResult[*big.Int]("weightToValue", out)
 }
 
 func GetPChainL1ValidatorRegistrationMessage(

pkg/validatormanager/removal.go

@@ -184,7 +184,7 @@ func InitValidatorRemoval(
 	}
 	managerAddress := common.HexToAddress(validatorManagerAddressStr)
 	ownerAddress := common.HexToAddress(ownerAddressStr)
-	validationID, err := validator.GetRegisteredValidator(
+	validationID, err := validator.GetValidationID(
 		rpcURL,
 		managerAddress,
 		nodeID,

pkg/validatormanager/weight_update.go

@@ -91,7 +91,7 @@ func InitValidatorWeightChange(
 	}
 	managerAddress := common.HexToAddress(validatorManagerAddressStr)
 	ownerAddress := common.HexToAddress(ownerAddressStr)
-	validationID, err := validator.GetRegisteredValidator(
+	validationID, err := validator.GetValidationID(
 		rpcURL,
 		managerAddress,
 		nodeID,

sdk/validator/validator.go

@@ -3,14 +3,13 @@
 package validator
 
 import (
-	"fmt"
-
 	"github.com/ava-labs/avalanche-cli/pkg/contract"
 	"github.com/ava-labs/avalanche-cli/sdk/network"
 	"github.com/ava-labs/avalanche-cli/sdk/utils"
 	"github.com/ava-labs/avalanchego/ids"
 	"github.com/ava-labs/avalanchego/vms/platformvm"
 	"github.com/ava-labs/avalanchego/vms/platformvm/api"
+
 	"github.com/ethereum/go-ethereum/common"
 	"golang.org/x/exp/maps"
 )
@@ -70,12 +69,9 @@ func GetValidatorInfo(net network.Network, validationID ids.ID) (platformvm.L1Va
 	return vdrInfo, nil
 }
 
-func GetValidationID(rpcURL string, nodeID ids.NodeID, validatorManagerAddressStr string) (ids.ID, error) {
-	managerAddress := common.HexToAddress(validatorManagerAddressStr)
-	return GetRegisteredValidator(rpcURL, managerAddress, nodeID)
-}
-
-func GetRegisteredValidator(
+// Returns the validation ID for the Node ID, as registered at the validator manager
+// Will return ids.Empty in case it is not registered
+func GetValidationID(
 	rpcURL string,
 	managerAddress common.Address,
 	nodeID ids.NodeID,
@@ -89,14 +85,7 @@ func GetRegisteredValidator(
 	if err != nil {
 		return ids.Empty, err
 	}
-	if len(out) == 0 {
-		return ids.Empty, fmt.Errorf("error at registeredValidators call, no value returned")
-	}
-	validatorID, typeIsOk := out[0].([32]byte)
-	if !typeIsOk {
-		return ids.Empty, fmt.Errorf("error at registeredValidators call, expected [32]byte, got %T", out[0])
-	}
-	return validatorID, nil
+	return contract.GetSmartContractCallResult[[32]byte]("registeredValidators", out)
 }
 
 func IsSovereignValidator(

sdk/validatormanager/validator_manager_pos.go

@@ -6,6 +6,7 @@ package validatormanager
 import (
 	"github.com/ava-labs/avalanche-cli/pkg/contract"
 	"github.com/ava-labs/subnet-evm/core/types"
+
 	"github.com/ethereum/go-ethereum/common"
 )