[CT-1259] account plus module code cleanup

dydxprotocol · Sep 30, 2024 · 419dc00 · 419dc00
1 parent 3adc282
commit 419dc00
Show file tree

Hide file tree

Showing 23 changed files with 189 additions and 173 deletions.
diff --git a/protocol/app/app.go b/protocol/app/app.go
@@ -1232,7 +1232,7 @@ func New(
 
 	// Initialize authenticators
 	app.AuthenticatorManager = authenticator.NewAuthenticatorManager()
-	app.AuthenticatorManager.InitializeAuthenticators([]authenticator.Authenticator{
+	app.AuthenticatorManager.InitializeAuthenticators([]accountplusmoduletypes.Authenticator{
 		authenticator.NewSignatureVerification(app.AccountKeeper),
 	})
 	app.AccountPlusKeeper = *accountplusmodulekeeper.NewKeeper(

diff --git a/protocol/x/accountplus/ante/ante.go b/protocol/x/accountplus/ante/ante.go
@@ -15,7 +15,6 @@ import (
 	txsigning "cosmossdk.io/x/tx/signing"
 
 	"github.com/dydxprotocol/v4-chain/protocol/lib/metrics"
-	"github.com/dydxprotocol/v4-chain/protocol/x/accountplus/authenticator"
 	"github.com/dydxprotocol/v4-chain/protocol/x/accountplus/keeper"
 	"github.com/dydxprotocol/v4-chain/protocol/x/accountplus/lib"
 	"github.com/dydxprotocol/v4-chain/protocol/x/accountplus/types"
@@ -133,7 +132,7 @@ func (ad AuthenticatorDecorator) AnteHandle(
 		}
 
 		// Generate the authentication request data
-		authenticationRequest, err := authenticator.GenerateAuthenticationRequest(
+		authenticationRequest, err := lib.GenerateAuthenticationRequest(
 			ctx,
 			ad.cdc,
 			ad.accountKeeper,

diff --git a/protocol/x/accountplus/authenticator/all_of.go b/protocol/x/accountplus/authenticator/all_of.go
@@ -6,28 +6,29 @@ import (
 	errorsmod "cosmossdk.io/errors"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+	"github.com/dydxprotocol/v4-chain/protocol/x/accountplus/types"
 )
 
 type AllOf struct {
-	SubAuthenticators   []Authenticator
+	SubAuthenticators   []types.Authenticator
 	am                  *AuthenticatorManager
 	signatureAssignment SignatureAssignment
 }
 
-var _ Authenticator = &AllOf{}
+var _ types.Authenticator = &AllOf{}
 
 func NewAllOf(am *AuthenticatorManager) AllOf {
 	return AllOf{
 		am:                  am,
-		SubAuthenticators:   []Authenticator{},
+		SubAuthenticators:   []types.Authenticator{},
 		signatureAssignment: Single,
 	}
 }
 
 func NewPartitionedAllOf(am *AuthenticatorManager) AllOf {
 	return AllOf{
 		am:                  am,
-		SubAuthenticators:   []Authenticator{},
+		SubAuthenticators:   []types.Authenticator{},
 		signatureAssignment: Partitioned,
 	}
 }
@@ -47,7 +48,7 @@ func (aoa AllOf) StaticGas() uint64 {
 	return totalGas
 }
 
-func (aoa AllOf) Initialize(config []byte) (Authenticator, error) {
+func (aoa AllOf) Initialize(config []byte) (types.Authenticator, error) {
 	var initDatas []SubAuthenticatorInitData
 	if err := json.Unmarshal(config, &initDatas); err != nil {
 		return nil, errorsmod.Wrap(err, "failed to parse sub-authenticators initialization data")
@@ -74,7 +75,7 @@ func (aoa AllOf) Initialize(config []byte) (Authenticator, error) {
 	return aoa, nil
 }
 
-func (aoa AllOf) Authenticate(ctx sdk.Context, request AuthenticationRequest) error {
+func (aoa AllOf) Authenticate(ctx sdk.Context, request types.AuthenticationRequest) error {
 	if len(aoa.SubAuthenticators) == 0 {
 		return errorsmod.Wrap(sdkerrors.ErrInvalidRequest, "no sub-authenticators provided")
 	}
@@ -104,11 +105,11 @@ func (aoa AllOf) Authenticate(ctx sdk.Context, request AuthenticationRequest) er
 	return nil
 }
 
-func (aoa AllOf) Track(ctx sdk.Context, request AuthenticationRequest) error {
+func (aoa AllOf) Track(ctx sdk.Context, request types.AuthenticationRequest) error {
 	return subTrack(ctx, request, aoa.SubAuthenticators)
 }
 
-func (aoa AllOf) ConfirmExecution(ctx sdk.Context, request AuthenticationRequest) error {
+func (aoa AllOf) ConfirmExecution(ctx sdk.Context, request types.AuthenticationRequest) error {
 	var signatures [][]byte
 	var err error
 	if aoa.signatureAssignment == Partitioned {

diff --git a/protocol/x/accountplus/authenticator/any_of.go b/protocol/x/accountplus/authenticator/any_of.go
@@ -9,6 +9,7 @@ import (
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+	"github.com/dydxprotocol/v4-chain/protocol/x/accountplus/types"
 )
 
 type SignatureAssignment string
@@ -19,25 +20,25 @@ const (
 )
 
 type AnyOf struct {
-	SubAuthenticators   []Authenticator
+	SubAuthenticators   []types.Authenticator
 	am                  *AuthenticatorManager
 	signatureAssignment SignatureAssignment
 }
 
-var _ Authenticator = &AnyOf{}
+var _ types.Authenticator = &AnyOf{}
 
 func NewAnyOf(am *AuthenticatorManager) AnyOf {
 	return AnyOf{
 		am:                  am,
-		SubAuthenticators:   []Authenticator{},
+		SubAuthenticators:   []types.Authenticator{},
 		signatureAssignment: Single,
 	}
 }
 
 func NewPartitionedAnyOf(am *AuthenticatorManager) AnyOf {
 	return AnyOf{
 		am:                  am,
-		SubAuthenticators:   []Authenticator{},
+		SubAuthenticators:   []types.Authenticator{},
 		signatureAssignment: Partitioned,
 	}
 }
@@ -57,7 +58,7 @@ func (aoa AnyOf) StaticGas() uint64 {
 	return totalGas
 }
 
-func (aoa AnyOf) Initialize(config []byte) (Authenticator, error) {
+func (aoa AnyOf) Initialize(config []byte) (types.Authenticator, error) {
 	// Decode the initialization data for each sub-authenticator
 	var initDatas []SubAuthenticatorInitData
 	if err := json.Unmarshal(config, &initDatas); err != nil {
@@ -86,7 +87,7 @@ func (aoa AnyOf) Initialize(config []byte) (Authenticator, error) {
 	return aoa, nil
 }
 
-func (aoa AnyOf) Authenticate(ctx sdk.Context, request AuthenticationRequest) error {
+func (aoa AnyOf) Authenticate(ctx sdk.Context, request types.AuthenticationRequest) error {
 	if len(aoa.SubAuthenticators) == 0 {
 		return errorsmod.Wrap(sdkerrors.ErrInvalidRequest, "no sub-authenticators provided")
 	}
@@ -134,13 +135,13 @@ func (aoa AnyOf) Authenticate(ctx sdk.Context, request AuthenticationRequest) er
 	return nil
 }
 
-func (aoa AnyOf) Track(ctx sdk.Context, request AuthenticationRequest) error {
+func (aoa AnyOf) Track(ctx sdk.Context, request types.AuthenticationRequest) error {
 	return subTrack(ctx, request, aoa.SubAuthenticators)
 }
 
 // ConfirmExecution is called on all sub-authenticators, but only the changes
 // made by the authenticator that succeeds are written.
-func (aoa AnyOf) ConfirmExecution(ctx sdk.Context, request AuthenticationRequest) error {
+func (aoa AnyOf) ConfirmExecution(ctx sdk.Context, request types.AuthenticationRequest) error {
 	var signatures [][]byte
 	var err error
 

diff --git a/protocol/x/accountplus/authenticator/clob_pair_id_filter.go b/protocol/x/accountplus/authenticator/clob_pair_id_filter.go
@@ -7,10 +7,11 @@ import (
 	errorsmod "cosmossdk.io/errors"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+	"github.com/dydxprotocol/v4-chain/protocol/x/accountplus/types"
 	clobtypes "github.com/dydxprotocol/v4-chain/protocol/x/clob/types"
 )
 
-var _ Authenticator = &ClobPairIdFilter{}
+var _ types.Authenticator = &ClobPairIdFilter{}
 
 // ClobPairIdFilter filters incoming messages based on a whitelist of clob pair ids.
 // It ensures that only messages with whitelisted clob pair ids are allowed.
@@ -35,7 +36,7 @@ func (m ClobPairIdFilter) StaticGas() uint64 {
 
 // Initialize sets up the authenticator with the given configuration,
 // which should be a list of clob pair ids separated by a predefined separator.
-func (m ClobPairIdFilter) Initialize(config []byte) (Authenticator, error) {
+func (m ClobPairIdFilter) Initialize(config []byte) (types.Authenticator, error) {
 	strSlice := strings.Split(string(config), SEPARATOR)
 
 	m.whitelist = make(map[uint32]struct{})
@@ -50,12 +51,12 @@ func (m ClobPairIdFilter) Initialize(config []byte) (Authenticator, error) {
 }
 
 // Track is a no-op in this implementation but can be used to track message handling.
-func (m ClobPairIdFilter) Track(ctx sdk.Context, request AuthenticationRequest) error {
+func (m ClobPairIdFilter) Track(ctx sdk.Context, request types.AuthenticationRequest) error {
 	return nil
 }
 
 // Authenticate checks if the message's clob pair ids are in the whitelist.
-func (m ClobPairIdFilter) Authenticate(ctx sdk.Context, request AuthenticationRequest) error {
+func (m ClobPairIdFilter) Authenticate(ctx sdk.Context, request types.AuthenticationRequest) error {
 	// Collect the clob pair ids from the request.
 	requestOrderIds := make([]uint32, 0)
 	switch msg := request.Msg.(type) {
@@ -87,7 +88,7 @@ func (m ClobPairIdFilter) Authenticate(ctx sdk.Context, request AuthenticationRe
 }
 
 // ConfirmExecution confirms the execution of a message. Currently, it always confirms.
-func (m ClobPairIdFilter) ConfirmExecution(ctx sdk.Context, request AuthenticationRequest) error {
+func (m ClobPairIdFilter) ConfirmExecution(ctx sdk.Context, request types.AuthenticationRequest) error {
 	return nil
 }
 

diff --git a/protocol/x/accountplus/authenticator/clob_pair_id_filter_test.go b/protocol/x/accountplus/authenticator/clob_pair_id_filter_test.go
@@ -10,6 +10,7 @@ import (
 	"github.com/dydxprotocol/v4-chain/protocol/testutil/constants"
 
 	"github.com/dydxprotocol/v4-chain/protocol/x/accountplus/authenticator"
+	"github.com/dydxprotocol/v4-chain/protocol/x/accountplus/lib"
 
 	"github.com/stretchr/testify/suite"
 )
@@ -84,7 +85,7 @@ func (s *ClobPairIdFilterTest) TestFilter() {
 			sigModeHandler := s.EncodingConfig.TxConfig.SignModeHandler()
 			tx, err := s.GenSimpleTx([]sdk.Msg{tt.msg}, []cryptotypes.PrivKey{s.TestPrivKeys[0]})
 			s.Require().NoError(err)
-			request, err := authenticator.GenerateAuthenticationRequest(
+			request, err := lib.GenerateAuthenticationRequest(
 				s.Ctx,
 				s.tApp.App.AppCodec(),
 				ak,

diff --git a/protocol/x/accountplus/authenticator/composite.go b/protocol/x/accountplus/authenticator/composite.go
@@ -7,6 +7,7 @@ import (
 	errorsmod "cosmossdk.io/errors"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+	"github.com/dydxprotocol/v4-chain/protocol/x/accountplus/types"
 )
 
 type SubAuthenticatorInitData struct {
@@ -16,8 +17,8 @@ type SubAuthenticatorInitData struct {
 
 func subTrack(
 	ctx sdk.Context,
-	request AuthenticationRequest,
-	subAuthenticators []Authenticator,
+	request types.AuthenticationRequest,
+	subAuthenticators []types.Authenticator,
 ) error {
 	baseId := request.AuthenticatorId
 	for id, auth := range subAuthenticators {