implement whitelist feature for AVS

ExocoreNetwork · Dec 6, 2024 · 7e89c4a · 7e89c4a
1 parent 27a99e2
commit 7e89c4a
Show file tree

Hide file tree

Showing 11 changed files with 278 additions and 141 deletions.
diff --git a/precompiles/avs/IAVSManager.sol b/precompiles/avs/IAVSManager.sol
@@ -49,6 +49,7 @@ interface IAVSManager {
     /// @param slashAddr The slash address of AVS.
     /// @param rewardAddr The reward address of AVS.
     /// @param avsOwnerAddress The owners who have permission for AVS.
+    /// @param whitelistAddress The whitelist address of the operator.
     /// @param assetIds The basic asset information of AVS.
     /// @param avsUnbondingPeriod The unbonding duration of AVS.
     /// @param minSelfDelegation The minimum delegation amount for an operator.
@@ -65,6 +66,7 @@ interface IAVSManager {
         address slashAddr,
         address rewardAddr,
         string[] memory avsOwnerAddress,
+        string[] memory whitelistAddress,
         string[] memory assetIds,
         uint64 avsUnbondingPeriod,
         uint64 minSelfDelegation,
@@ -80,6 +82,7 @@ interface IAVSManager {
     /// @param slashAddr The slash address of AVS.
     /// @param rewardAddr The reward address of AVS.
     /// @param avsOwnerAddress The owners who have permission for AVS.
+    /// @param whitelistAddress The whitelist address of the operator.
     /// @param assetIds The basic asset information of AVS.
     /// @param avsUnbondingPeriod The unbonding duration of AVS.
     /// @param minSelfDelegation The minimum delegation amount for an operator.
@@ -96,6 +99,7 @@ interface IAVSManager {
         address slashAddr,
         address rewardAddr,
         string[] memory avsOwnerAddress,
+        string[] memory whitelistAddress,
         string[] memory assetIds,
         uint64 avsUnbondingPeriod,
         uint64 minSelfDelegation,

diff --git a/precompiles/avs/abi.json b/precompiles/avs/abi.json
@@ -646,6 +646,11 @@
 				"name": "avsOwnerAddress",
 				"type": "string[]"
 			},
+			{
+				"internalType": "string[]",
+				"name": "whitelistAddress",
+				"type": "string[]"
+			},
 			{
 				"internalType": "string[]",
 				"name": "assetIds",
@@ -778,6 +783,11 @@
 				"name": "avsOwnerAddress",
 				"type": "string[]"
 			},
+			{
+				"internalType": "string[]",
+				"name": "whitelistAddress",
+				"type": "string[]"
+			},
 			{
 				"internalType": "string[]",
 				"name": "assetIds",

diff --git a/precompiles/avs/types.go b/precompiles/avs/types.go
@@ -68,38 +68,51 @@ func (p Precompile) GetAVSParamsFromInputs(_ sdk.Context, args []interface{}) (*
 		exoAddresses[i] = accAddr.String()
 	}
 	avsParams.AvsOwnerAddress = exoAddresses
-
+	// bech32
+	whitelistAddress, ok := args[7].([]string)
+	if !ok || whitelistAddress == nil {
+		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 7, "[]string", whitelistAddress)
+	}
+	exoWhiteAddresses := make([]string, len(whitelistAddress))
+	for i, addr := range whitelistAddress {
+		accAddr, err := sdk.AccAddressFromBech32(addr)
+		if err != nil {
+			return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 7, "[]string", whitelistAddress)
+		}
+		exoAddresses[i] = accAddr.String()
+	}
+	avsParams.WhitelistAddress = exoWhiteAddresses
 	// string, since it is the address_id representation
-	assetID, ok := args[7].([]string)
+	assetID, ok := args[8].([]string)
 	if !ok || len(assetID) == 0 {
-		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 7, "[]string", assetID)
+		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 8, "[]string", assetID)
 	}
 	avsParams.AssetID = assetID
 
-	unbondingPeriod, ok := args[8].(uint64)
+	unbondingPeriod, ok := args[9].(uint64)
 	if !ok || unbondingPeriod == 0 {
-		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 8, "uint64", unbondingPeriod)
+		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 9, "uint64", unbondingPeriod)
 	}
 	avsParams.UnbondingPeriod = unbondingPeriod
 
-	minSelfDelegation, ok := args[9].(uint64)
+	minSelfDelegation, ok := args[10].(uint64)
 	if !ok {
-		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 9, "uint64", minSelfDelegation)
+		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 10, "uint64", minSelfDelegation)
 	}
 	avsParams.MinSelfDelegation = minSelfDelegation
 
-	epochIdentifier, ok := args[10].(string)
+	epochIdentifier, ok := args[11].(string)
 	if !ok || epochIdentifier == "" {
-		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 10, "string", epochIdentifier)
+		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 11, "string", epochIdentifier)
 	}
 	avsParams.EpochIdentifier = epochIdentifier
 
 	// The parameters below are used when creating tasks, to ensure that the minimum criteria are met by the set
 	// of operators.
 
-	taskParam, ok := args[11].([]uint64)
+	taskParam, ok := args[12].([]uint64)
 	if !ok || taskParam == nil || len(taskParam) != 4 {
-		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 11, "[]string", taskParam)
+		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 12, "[]string", taskParam)
 	}
 	minOptInOperators := taskParam[0]
 	avsParams.MinOptInOperators = minOptInOperators
@@ -166,43 +179,56 @@ func (p Precompile) GetAVSParamsFromUpdateInputs(_ sdk.Context, args []interface
 	for i, addr := range avsOwnerAddress {
 		accAddr, err := sdk.AccAddressFromBech32(addr)
 		if err != nil {
-			return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 7, "[]string", avsOwnerAddress)
+			return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 6, "[]string", avsOwnerAddress)
 		}
 		exoAddresses[i] = accAddr.String()
 	}
 	avsParams.AvsOwnerAddress = exoAddresses
-
+	// bech32
+	whitelistAddress, ok := args[7].([]string)
+	if !ok || whitelistAddress == nil {
+		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 7, "[]string", whitelistAddress)
+	}
+	exoWhiteAddresses := make([]string, len(whitelistAddress))
+	for i, addr := range whitelistAddress {
+		accAddr, err := sdk.AccAddressFromBech32(addr)
+		if err != nil {
+			return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 7, "[]string", whitelistAddress)
+		}
+		exoAddresses[i] = accAddr.String()
+	}
+	avsParams.WhitelistAddress = exoWhiteAddresses
 	// string, since it is the address_id representation
-	assetID, ok := args[7].([]string)
+	assetID, ok := args[8].([]string)
 	if !ok {
-		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 7, "[]string", assetID)
+		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 8, "[]string", assetID)
 	}
 	avsParams.AssetID = assetID
 
-	unbondingPeriod, ok := args[8].(uint64)
+	unbondingPeriod, ok := args[9].(uint64)
 	if !ok {
-		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 8, "uint64", unbondingPeriod)
+		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 9, "uint64", unbondingPeriod)
 	}
 	avsParams.UnbondingPeriod = unbondingPeriod
 
-	minSelfDelegation, ok := args[9].(uint64)
+	minSelfDelegation, ok := args[10].(uint64)
 	if !ok {
-		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 9, "uint64", minSelfDelegation)
+		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 10, "uint64", minSelfDelegation)
 	}
 	avsParams.MinSelfDelegation = minSelfDelegation
 
-	epochIdentifier, ok := args[10].(string)
+	epochIdentifier, ok := args[11].(string)
 	if !ok {
-		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 10, "string", epochIdentifier)
+		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 11, "string", epochIdentifier)
 	}
 	avsParams.EpochIdentifier = epochIdentifier
 
 	// The parameters below are used when creating tasks, to ensure that the minimum criteria are met by the set
 	// of operators.
 
-	taskParam, ok := args[11].([]uint64)
+	taskParam, ok := args[12].([]uint64)
 	if !ok || taskParam == nil || len(taskParam) != 4 {
-		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 11, "[]string", taskParam)
+		return nil, fmt.Errorf(exocmn.ErrContractInputParaOrType, 12, "[]string", taskParam)
 	}
 	minOptInOperators := taskParam[0]
 	avsParams.MinOptInOperators = minOptInOperators

diff --git a/proto/exocore/avs/v1/tx.proto b/proto/exocore/avs/v1/tx.proto
@@ -52,9 +52,10 @@ message AVSInfo {
     (gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec",
     (gogoproto.nullable) = false
   ];
-
   // asset_reward_commission_epoch_basis is the avs reward distribution based on asset per eopch end.
   map<string, int64> asset_reward_amount_epoch_basis = 18;
+  // whitelist_address are the bech32 addresses ,whitelist address of supported operators
+  repeated string whitelist_address = 19;
 }
 
 // Status and proof of each operator

diff --git a/x/avs/keeper/avs.go b/x/avs/keeper/avs.go
@@ -1,14 +1,14 @@
 package keeper
 
 import (
+	errorsmod "cosmossdk.io/errors"
+	sdkmath "cosmossdk.io/math"
 	"fmt"
 	"math/big"
+	"slices"
 	"strconv"
 	"strings"
 
-	errorsmod "cosmossdk.io/errors"
-	sdkmath "cosmossdk.io/math"
-
 	"github.com/ExocoreNetwork/exocore/x/avs/types"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/evmos/evmos/v16/x/evm/statedb"
@@ -224,3 +224,23 @@ func (k *Keeper) GetAllChainIDInfos(ctx sdk.Context) ([]types.ChainIDInfo, error
 	}
 	return ret, nil
 }
+
+// IsWhitelisted check if operator is in the whitelist
+func (k *Keeper) IsWhitelisted(ctx sdk.Context, avsAddr, operatorAddr string) (bool, error) {
+	avsInfo, err := k.GetAVSInfo(ctx, avsAddr)
+	if err != nil {
+		return false, errorsmod.Wrap(err, fmt.Sprintf("IsWhitelisted: key is %s", avsAddr))
+	}
+	_, err = sdk.AccAddressFromBech32(operatorAddr)
+	if err != nil {
+		return false, errorsmod.Wrap(err, "IsWhitelisted: error occurred when parse acc address from Bech32")
+	}
+	// Currently avs has no whitelist set and any operator can optin
+	if len(avsInfo.Info.WhitelistAddress) == 0 {
+		return true, nil
+	}
+	if !slices.Contains(avsInfo.Info.WhitelistAddress, operatorAddr) {
+		return false, errorsmod.Wrap(err, "not in the whitelist address of supported operators")
+	}
+	return true, nil
+}
diff --git a/x/avs/keeper/avs_test.go b/x/avs/keeper/avs_test.go
@@ -23,6 +23,8 @@ func (suite *AVSTestSuite) TestAVS() {
 	avsAddress := suite.avsAddress
 	avsOwnerAddress := []string{"exo13h6xg79g82e2g2vhjwg7j4r2z2hlncelwutkjr", "exo13h6xg79g82e2g2vhjwg7j4r2z2hlncelwutkj1", "exo13h6xg79g82e2g2vhjwg7j4r2z2hlncelwutkj2"}
 	assetID := suite.AssetIDs
+	operatorAddress := sdk.AccAddress(utiltx.GenerateAddress().Bytes()).String()
+
 	avs := &types.AVSInfo{
 		Name:                avsName,
 		AvsAddress:          avsAddress.String(),
@@ -38,11 +40,15 @@ func (suite *AVSTestSuite) TestAVS() {
 		AvsSlash:            sdk.MustNewDecFromStr("0.001"),
 		AvsReward:           sdk.MustNewDecFromStr("0.002"),
 		TaskAddr:            "exo13h6xg79g82e2g2vhjwg7j4r2z2hlncelwutkjr",
+		WhitelistAddress:    []string{operatorAddress},
 	}
 
 	err := suite.App.AVSManagerKeeper.SetAVSInfo(suite.Ctx, avs)
 	suite.NoError(err)
 
+	whitelisted, err := suite.App.AVSManagerKeeper.IsWhitelisted(suite.Ctx, avsAddress.String(), operatorAddress)
+	suite.NoError(err)
+	suite.Equal(whitelisted, true)
 	info, err := suite.App.AVSManagerKeeper.GetAVSInfo(suite.Ctx, avsAddress.String())
 
 	suite.NoError(err)

diff --git a/x/avs/keeper/keeper.go b/x/avs/keeper/keeper.go
@@ -129,7 +129,8 @@ func (k Keeper) UpdateAVSInfo(ctx sdk.Context, params *types.AVSRegisterOrDeregi
 			// #nosec G115
 			AvsSlash: sdk.NewDecWithPrec(int64(params.AvsSlash), 2),
 			// #nosec G115
-			AvsReward: sdk.NewDecWithPrec(int64(params.AvsReward), 2),
+			AvsReward:        sdk.NewDecWithPrec(int64(params.AvsReward), 2),
+			WhitelistAddress: params.WhitelistAddress,
 		}
 
 		return k.SetAVSInfo(ctx, avs)
@@ -185,6 +186,9 @@ func (k Keeper) UpdateAVSInfo(ctx sdk.Context, params *types.AVSRegisterOrDeregi
 		if params.AvsOwnerAddress != nil {
 			avs.AvsOwnerAddress = params.AvsOwnerAddress
 		}
+		if params.WhitelistAddress != nil {
+			avs.WhitelistAddress = params.WhitelistAddress
+		}
 		if params.AssetID != nil {
 			avs.AssetIDs = params.AssetID
 			if err := k.ValidateAssetIDs(ctx, params.AssetID); err != nil {