Refactoring user commands to remove user nomenclature and replacing with appointee (#254)

Co-authored-by: Brandon Chatham <[email protected]>

Author: bdchatham

go.mod

@@ -10,7 +10,7 @@ require (
 	//<<<<<<< HEAD
 	//	github.com/Layr-Labs/eigensdk-go v0.1.14-0.20241212190947-9985122d81fe
 	//=======
-	github.com/Layr-Labs/eigensdk-go v0.1.14-0.20241211204646-f49e96f7ee7a
+	github.com/Layr-Labs/eigensdk-go v0.1.14-0.20241212003044-37139a7d8ea8
 	github.com/blang/semver/v4 v4.0.0
 	github.com/consensys/gnark-crypto v0.12.1
 	github.com/ethereum/go-ethereum v1.14.5

go.sum

@@ -12,8 +12,8 @@ github.com/Layr-Labs/eigenlayer-rewards-proofs v0.2.12 h1:G5Q1SnLmFbEjhOkky3vIHk
 github.com/Layr-Labs/eigenlayer-rewards-proofs v0.2.12/go.mod h1:OlJd1QjqEW53wfWG/lJyPCGvrXwWVEjPQsP4TV+gttQ=
 github.com/Layr-Labs/eigenpod-proofs-generation v0.0.14-stable.0.20240730152248-5c11a259293e h1:DvW0/kWHV9mZsbH2KOjEHKTSIONNPUj6X05FJvUohy4=
 github.com/Layr-Labs/eigenpod-proofs-generation v0.0.14-stable.0.20240730152248-5c11a259293e/go.mod h1:T7tYN8bTdca2pkMnz9G2+ZwXYWw5gWqQUIu4KLgC/vM=
-github.com/Layr-Labs/eigensdk-go v0.1.14-0.20241211204646-f49e96f7ee7a h1:U1pibFpUsMfL8h9EGrHtm/z94nKKuEvLdWEpkCkCZr4=
-github.com/Layr-Labs/eigensdk-go v0.1.14-0.20241211204646-f49e96f7ee7a/go.mod h1:aYdNURUhaqeYOS+Cq12TfSdPbjFfiLaHkxPdR4Exq/s=
+github.com/Layr-Labs/eigensdk-go v0.1.14-0.20241212003044-37139a7d8ea8 h1:flOwiF9Z9xburwDodNbd6VBi8rzzNSbRy2KG5kqoAak=
+github.com/Layr-Labs/eigensdk-go v0.1.14-0.20241212003044-37139a7d8ea8/go.mod h1:aYdNURUhaqeYOS+Cq12TfSdPbjFfiLaHkxPdR4Exq/s=
 github.com/Microsoft/go-winio v0.6.2 h1:F2VQgta7ecxGYO8k3ZZz3RS8fVIXVxONVUPlNERoyfY=
 github.com/Microsoft/go-winio v0.6.2/go.mod h1:yd8OoFMLzJbo9gZq8j5qaps8bJ9aShtEA8Ipt1oGCvU=
 github.com/Microsoft/hcsshim v0.11.4 h1:68vKo2VN8DE9AdN4tnkWnmdhqdbpUFM8OF3Airm7fz8=

pkg/user/admin/flags.go

@@ -15,12 +15,6 @@ var (
 		Usage:   "user admin ... --admin-address \"0x...\"",
 		EnvVars: []string{"ADMIN_ADDRESS"},
 	}
-	CallerAddressFlag = cli.StringFlag{
-		Name:    "caller-address",
-		Aliases: []string{"ca"},
-		Usage:   "user admin ... --caller-address \"0x...\"",
-		EnvVars: []string{"CALLER_ADDRESS"},
-	}
 	PendingAdminAddressFlag = cli.StringFlag{
 		Name:    "pending-admin-address",
 		Aliases: []string{"paa"},

pkg/user/admin/is_admin.go

@@ -29,7 +29,7 @@ type IsAdminReader interface {
 func IsAdminCmd(readerGenerator func(logging.Logger, *isAdminConfig) (IsAdminReader, error)) *cli.Command {
 	cmd := &cli.Command{
 		Name:      "is-admin",
-		Usage:     "user admin is-admin --account-address <AccountAddress> --caller-address <CallerAddress>",
+		Usage:     "user admin is-admin --account-address <AccountAddress> --admin-address <AdminAddress>",
 		UsageText: "Checks if a user is an admin.",
 		Description: `
 		Checks if a user is an admin.
@@ -133,7 +133,7 @@ func IsAdminFlags() []cli.Flag {
 	cmdFlags := []cli.Flag{
 		&flags.VerboseFlag,
 		&AccountAddressFlag,
-		&CallerAddressFlag,
+		&AdminAddressFlag,
 		&PermissionControllerAddressFlag,
 		&flags.NetworkFlag,
 		&flags.EnvironmentFlag,

pkg/user/admin/is_admin_test.go

@@ -44,7 +44,7 @@ func TestIsAdminCmd_Success(t *testing.T) {
 		"TestIsAdminCmd_Success",
 		"is-admin",
 		"--account-address", "0xabcdef1234567890abcdef1234567890abcdef12",
-		"--caller-address", "0x1234567890abcdef1234567890abcdef12345678",
+		"--admin-address", "0x1234567890abcdef1234567890abcdef12345678",
 		"--eth-rpc-url", "https://ethereum-holesky.publicnode.com/",
 		"--network", "holesky",
 	}
@@ -63,7 +63,7 @@ func TestIsAdminCmd_NotAdmin(t *testing.T) {
 		"TestIsAdminCmd_NotAdmin",
 		"is-admin",
 		"--account-address", "0xabcdef1234567890abcdef1234567890abcdef12",
-		"--caller-address", "0x1234567890abcdef1234567890abcdef12345678",
+		"--admin-address", "0x1234567890abcdef1234567890abcdef12345678",
 		"--eth-rpc-url", "https://ethereum-holesky.publicnode.com/",
 		"--network", "holesky",
 	}
@@ -85,7 +85,7 @@ func TestIsAdminCmd_GeneratorError(t *testing.T) {
 		"TestIsAdminCmd_GeneratorError",
 		"is-admin",
 		"--account-address", "0xabcdef1234567890abcdef1234567890abcdef12",
-		"--caller-address", "0x1234567890abcdef1234567890abcdef12345678",
+		"--admin-address", "0x1234567890abcdef1234567890abcdef12345678",
 		"--eth-rpc-url", "https://ethereum-holesky.publicnode.com/",
 		"--network", "holesky",
 	}
@@ -106,7 +106,7 @@ func TestIsAdminCmd_IsAdminError(t *testing.T) {
 		"TestIsAdminCmd_IsAdminError",
 		"is-admin",
 		"--account-address", "0xabcdef1234567890abcdef1234567890abcdef12",
-		"--caller-address", "0x1234567890abcdef1234567890abcdef12345678",
+		"--admin-address", "0x1234567890abcdef1234567890abcdef12345678",
 		"--eth-rpc-url", "https://ethereum-holesky.publicnode.com/",
 		"--network", "holesky",
 	}

pkg/user/appointee/appointee.go

@@ -21,11 +21,11 @@ func AppointeeCmd(prompter utils.Prompter) *cli.Command {
 		},
 		Subcommands: []*cli.Command{
 			BatchSetCmd(),
-			canCallCmd(generateUserCanCallReader),
-			ListCmd(generateListUsersReader),
-			ListPermissionsCmd(generateListUserPermissionsReader),
-			RemoveCmd(generateRemoveUserPermissionWriter(prompter)),
-			SetCmd(generateSetUserPermissionWriter(prompter)),
+			canCallCmd(generateCanCallReader),
+			ListCmd(generateListAppointeesReader),
+			ListPermissionsCmd(generateListAppointeePermissionsReader),
+			RemoveCmd(generateRemoveAppointeePermissionWriter(prompter)),
+			SetCmd(generateSetAppointeePermissionWriter(prompter)),
 		},
 	}
 

pkg/user/appointee/can_call.go

@@ -17,23 +17,23 @@ import (
 	"github.com/urfave/cli/v2"
 )
 
-type UserCanCallReader interface {
-	UserCanCall(
+type CanCallReader interface {
+	CanCall(
 		ctx context.Context,
-		userAddress gethcommon.Address,
-		callerAddress gethcommon.Address,
+		accountAddress gethcommon.Address,
+		appointeeAddress gethcommon.Address,
 		target gethcommon.Address,
 		selector [4]byte,
 	) (bool, error)
 }
 
-func canCallCmd(readerGenerator func(logging.Logger, *canCallConfig) (UserCanCallReader, error)) *cli.Command {
+func canCallCmd(readerGenerator func(logging.Logger, *canCallConfig) (CanCallReader, error)) *cli.Command {
 	cmd := &cli.Command{
 		Name:      "can-call",
-		Usage:     "user appointee can-call --account-address <AccountsAddress> --caller-address <CallerAddress> --taget-address <TargetAddress> --selector <Selector>",
-		UsageText: "Checks if a user has a specific permission.",
+		Usage:     "user appointee can-call --account-address <AccountsAddress> --appointee-address <AppointeeAddress> --target-address <TargetAddress> --selector <Selector>",
+		UsageText: "Checks if an appointee has a specific permission.",
 		Description: `
-		Checks if a user has a specific permission.
+		Checks if an appointee has a specific permission.
 		`,
 		Action: func(c *cli.Context) error {
 			return canCall(c, readerGenerator)
@@ -45,11 +45,11 @@ func canCallCmd(readerGenerator func(logging.Logger, *canCallConfig) (UserCanCal
 	return cmd
 }
 
-func canCall(cliCtx *cli.Context, generator func(logging.Logger, *canCallConfig) (UserCanCallReader, error)) error {
+func canCall(cliCtx *cli.Context, generator func(logging.Logger, *canCallConfig) (CanCallReader, error)) error {
 	ctx := cliCtx.Context
 	logger := common.GetLogger(cliCtx)
 
-	config, err := readAndValidateUserConfig(cliCtx, logger)
+	config, err := readAndValidateCanCallConfig(cliCtx, logger)
 	if err != nil {
 		return eigenSdkUtils.WrapError("failed to read and validate user can call config", err)
 	}
@@ -59,15 +59,20 @@ func canCall(cliCtx *cli.Context, generator func(logging.Logger, *canCallConfig)
 		return err
 	}
 
-	result, err := elReader.UserCanCall(ctx, config.UserAddress, config.CallerAddress, config.Target, config.Selector)
+	result, err := elReader.CanCall(ctx, config.AppointeeAddress, config.AccountAddress, config.Target, config.Selector)
 	fmt.Printf("CanCall Result: %v\n", result)
-	fmt.Printf("Selector, Target and User: %s, %x, %s\n", config.Target, string(config.Selector[:]), config.UserAddress)
+	fmt.Printf(
+		"Selector, Target and Appointee: %s, %x, %s\n",
+		config.Target,
+		string(config.Selector[:]),
+		config.AppointeeAddress,
+	)
 	return err
 }
 
-func readAndValidateUserConfig(cliContext *cli.Context, logger logging.Logger) (*canCallConfig, error) {
-	userAddress := gethcommon.HexToAddress(cliContext.String(AccountAddressFlag.Name))
-	callerAddress := gethcommon.HexToAddress(cliContext.String(CallerAddressFlag.Name))
+func readAndValidateCanCallConfig(cliContext *cli.Context, logger logging.Logger) (*canCallConfig, error) {
+	accountAddress := gethcommon.HexToAddress(cliContext.String(AccountAddressFlag.Name))
+	appointeeAddress := gethcommon.HexToAddress(cliContext.String(AppointeeAddressFlag.Name))
 	ethRpcUrl := cliContext.String(flags.ETHRpcUrlFlag.Name)
 	network := cliContext.String(flags.NetworkFlag.Name)
 	environment := cliContext.String(flags.EnvironmentFlag.Name)
@@ -103,8 +108,8 @@ func readAndValidateUserConfig(cliContext *cli.Context, logger logging.Logger) (
 	return &canCallConfig{
 		Network:                  network,
 		RPCUrl:                   ethRpcUrl,
-		UserAddress:              userAddress,
-		CallerAddress:            callerAddress,
+		AccountAddress:           accountAddress,
+		AppointeeAddress:         appointeeAddress,
 		Target:                   target,
 		Selector:                 selectorBytes,
 		PermissionManagerAddress: gethcommon.HexToAddress(permissionManagerAddress),
@@ -113,10 +118,10 @@ func readAndValidateUserConfig(cliContext *cli.Context, logger logging.Logger) (
 	}, nil
 }
 
-func generateUserCanCallReader(
+func generateCanCallReader(
 	logger logging.Logger,
 	config *canCallConfig,
-) (UserCanCallReader, error) {
+) (CanCallReader, error) {
 	ethClient, err := ethclient.Dial(config.RPCUrl)
 	if err != nil {
 		return nil, eigenSdkUtils.WrapError("failed to create new eth client", err)
@@ -134,7 +139,7 @@ func generateUserCanCallReader(
 func canCallFlags() []cli.Flag {
 	cmdFlags := []cli.Flag{
 		&AccountAddressFlag,
-		&CallerAddressFlag,
+		&AppointeeAddressFlag,
 		&TargetAddressFlag,
 		&SelectorFlag,
 		&PermissionControllerAddressFlag,

pkg/user/appointee/can_call_test.go

@@ -14,36 +14,36 @@ import (
 type mockElChainReader struct {
 	canCallFunc func(
 		ctx context.Context,
-		userAddress gethcommon.Address,
-		callerAddress gethcommon.Address,
+		accountAddress gethcommon.Address,
+		appointeeAddress gethcommon.Address,
 		target gethcommon.Address,
 		selector [4]byte,
 	) (bool, error)
 }
 
 func newMockElChainReader() mockElChainReader {
 	return mockElChainReader{
-		canCallFunc: func(ctx context.Context, userAddress, callerAddress, target gethcommon.Address, selector [4]byte) (bool, error) {
+		canCallFunc: func(ctx context.Context, accountAddress, appointeeAddress, target gethcommon.Address, selector [4]byte) (bool, error) {
 			return true, nil
 		},
 	}
 }
 
 func newErrorMockElChainReader(expectedError string) mockElChainReader {
 	return mockElChainReader{
-		canCallFunc: func(ctx context.Context, userAddress, callerAddress, target gethcommon.Address, selector [4]byte) (bool, error) {
+		canCallFunc: func(ctx context.Context, accountAddress, appointeeAddress, target gethcommon.Address, selector [4]byte) (bool, error) {
 			return false, errors.New(expectedError)
 		},
 	}
 }
 
-func (m *mockElChainReader) UserCanCall(
+func (m *mockElChainReader) CanCall(
 	ctx context.Context,
-	userAddress, callerAddress,
+	accountAddress, appointeeAddress,
 	target gethcommon.Address,
 	selector [4]byte,
 ) (bool, error) {
-	return m.canCallFunc(ctx, userAddress, callerAddress, target, selector)
+	return m.canCallFunc(ctx, accountAddress, appointeeAddress, target, selector)
 }
 
 func TestCanCallCmd_Success(t *testing.T) {
@@ -54,7 +54,7 @@ func TestCanCallCmd_Success(t *testing.T) {
 		"TestCanCallCmd_Success",
 		"can-call",
 		"--account-address", "0x1234567890abcdef1234567890abcdef12345678",
-		"--caller-address", "0x9876543210fedcba9876543210fedcba98765432",
+		"--appointee-address", "0x9876543210fedcba9876543210fedcba98765432",
 		"--target-address", "0xabcdef1234567890abcdef1234567890abcdef12",
 		"--selector", "0x1A2B3C4D",
 		"--network", "holesky",
@@ -66,22 +66,22 @@ func TestCanCallCmd_Success(t *testing.T) {
 	assert.NoError(t, err)
 }
 
-func TestCanCallCmd_UserCanCallError(t *testing.T) {
+func TestCanCallCmd_CanCallError(t *testing.T) {
 	errString := "Error while executing call from reader"
 	mockReader := newErrorMockElChainReader(errString)
 
 	app := cli.NewApp()
 	app.Commands = []*cli.Command{
-		canCallCmd(func(logger logging.Logger, config *canCallConfig) (UserCanCallReader, error) {
-			return UserCanCallReader(&mockReader), nil
+		canCallCmd(func(logger logging.Logger, config *canCallConfig) (CanCallReader, error) {
+			return CanCallReader(&mockReader), nil
 		}),
 	}
 
 	args := []string{
-		"TestCanCallCmd_UserCanCallError",
+		"TestCanCallCmd_CanCallError",
 		"can-call",
 		"--account-address", "0x1234567890abcdef1234567890abcdef12345678",
-		"--caller-address", "0x9876543210fedcba9876543210fedcba98765432",
+		"--appointee-address", "0x9876543210fedcba9876543210fedcba98765432",
 		"--target-address", "0xabcdef1234567890abcdef1234567890abcdef12",
 		"--selector", "0x1A2B3C4D",
 		"--network", "holesky",
@@ -102,7 +102,7 @@ func TestCanCallCmd_InvalidSelector(t *testing.T) {
 		"TestCanCallCmd_InvalidSelector",
 		"can-call",
 		"--account-address", "0x1234567890abcdef1234567890abcdef12345678",
-		"--caller-address", "0x9876543210fedcba9876543210fedcba98765432",
+		"--appointee-address", "0x9876543210fedcba9876543210fedcba98765432",
 		"--target-address", "0xabcdef1234567890abcdef1234567890abcdef12",
 		"--selector", "incorrect-format",
 		"--permission-controller-address", "0xe4dB7125ef7a9D99F809B6b7788f75c8D84d8455",
@@ -117,7 +117,7 @@ func TestCanCallCmd_InvalidSelector(t *testing.T) {
 		"TestCanCallCmd_InvalidSelector",
 		"can-call",
 		"--account-address", "0x1234567890abcdef1234567890abcdef12345678",
-		"--caller-address", "0x9876543210fedcba9876543210fedcba98765432",
+		"--appointee-address", "0x9876543210fedcba9876543210fedcba98765432",
 		"--target-address", "0xabcdef1234567890abcdef1234567890abcdef12",
 		"--selector", "0xincorrect-format",
 		"--permission-controller-address", "0xe4dB7125ef7a9D99F809B6b7788f75c8D84d8455",
@@ -129,9 +129,9 @@ func TestCanCallCmd_InvalidSelector(t *testing.T) {
 	assert.Contains(t, err.Error(), "selector must be a 4-byte hex string prefixed with '0x'")
 }
 
-func generateMockReader() func(logger logging.Logger, config *canCallConfig) (UserCanCallReader, error) {
-	return func(logger logging.Logger, config *canCallConfig) (UserCanCallReader, error) {
+func generateMockReader() func(logger logging.Logger, config *canCallConfig) (CanCallReader, error) {
+	return func(logger logging.Logger, config *canCallConfig) (CanCallReader, error) {
 		mockReader := newMockElChainReader()
-		return UserCanCallReader(&mockReader), nil
+		return CanCallReader(&mockReader), nil
 	}
 }

pkg/user/appointee/flags.go

@@ -15,12 +15,6 @@ var (
 		Usage:   "The Ethereum address of the user. Example: --appointee-address \"0x...\"",
 		EnvVars: []string{"APPOINTEE_ADDRESS"},
 	}
-	CallerAddressFlag = cli.StringFlag{
-		Name:    "caller-address",
-		Aliases: []string{"ca"},
-		Usage:   "The Ethereum address of the caller. Example: --caller-address \"0x...\"",
-		EnvVars: []string{"CALLER_ADDRESS"},
-	}
 	SelectorFlag = cli.StringFlag{
 		Name:    "selector",
 		Aliases: []string{"s"},