Merge pull request #590 from neutron-org/fix/import-export-tokenfacto…

…ry-hooks Fix: import/export tokenfactory hooks
neutron-org · Jun 20, 2024 · a73edfc · a73edfc
2 parents 28b1d2c + 033aefc
commit a73edfc
Show file tree

Hide file tree

Showing 7 changed files with 150 additions and 39 deletions.
diff --git a/proto/osmosis/tokenfactory/v1beta1/genesis.proto b/proto/osmosis/tokenfactory/v1beta1/genesis.proto
@@ -29,4 +29,6 @@ message GenesisDenom {
     (gogoproto.moretags) = "yaml:\"authority_metadata\"",
     (gogoproto.nullable) = false
   ];
+
+  string hook_contract_address = 3 [(gogoproto.nullable) = true];
 }
diff --git a/x/tokenfactory/keeper/genesis.go b/x/tokenfactory/keeper/genesis.go
@@ -24,14 +24,26 @@ func (k Keeper) InitGenesis(ctx sdk.Context, genState types.GenesisState) {
 		if err != nil {
 			panic(err)
 		}
+
 		err = k.createDenomAfterValidation(ctx, creator, genDenom.GetDenom())
 		if err != nil {
 			panic(err)
 		}
+
 		err = k.setAuthorityMetadata(ctx, genDenom.GetDenom(), genDenom.GetAuthorityMetadata())
 		if err != nil {
 			panic(err)
 		}
+
+		if _, err := sdk.AccAddressFromBech32(genDenom.HookContractAddress); genDenom.HookContractAddress != "" && err != nil {
+			panic(err)
+		}
+
+		if genDenom.HookContractAddress != "" {
+			if err := k.setBeforeSendHook(ctx, genDenom.Denom, genDenom.HookContractAddress); err != nil {
+				panic(err)
+			}
+		}
 	}
 }
 
@@ -43,14 +55,17 @@ func (k Keeper) ExportGenesis(ctx sdk.Context) *types.GenesisState {
 	for ; iterator.Valid(); iterator.Next() {
 		denom := string(iterator.Value())
 
+		contractHook := k.GetBeforeSendHook(ctx, denom)
+
 		authorityMetadata, err := k.GetAuthorityMetadata(ctx, denom)
 		if err != nil {
 			panic(err)
 		}
 
 		genDenoms = append(genDenoms, types.GenesisDenom{
-			Denom:             denom,
-			AuthorityMetadata: authorityMetadata,
+			Denom:               denom,
+			AuthorityMetadata:   authorityMetadata,
+			HookContractAddress: contractHook,
 		})
 	}
 

diff --git a/x/tokenfactory/keeper/genesis_test.go b/x/tokenfactory/keeper/genesis_test.go
@@ -14,6 +14,7 @@ func (suite *KeeperTestSuite) TestGenesis() {
 				AuthorityMetadata: types.DenomAuthorityMetadata{
 					Admin: "neutron1m9l358xunhhwds0568za49mzhvuxx9ux8xafx2",
 				},
+				HookContractAddress: "",
 			},
 			{
 				Denom: "factory/neutron1m9l358xunhhwds0568za49mzhvuxx9ux8xafx2/diff-admin",
@@ -26,6 +27,7 @@ func (suite *KeeperTestSuite) TestGenesis() {
 				AuthorityMetadata: types.DenomAuthorityMetadata{
 					Admin: "neutron1m9l358xunhhwds0568za49mzhvuxx9ux8xafx2",
 				},
+				HookContractAddress: "neutron1m9l358xunhhwds0568za49mzhvuxx9ux8xafx2",
 			},
 		},
 	}

diff --git a/x/tokenfactory/types/errors.go b/x/tokenfactory/types/errors.go
@@ -8,15 +8,16 @@ import (
 
 // x/tokenfactory module sentinel errors
 var (
-	ErrDenomExists              = errorsmod.Register(ModuleName, 2, "attempting to create a denom that already exists (has bank metadata)")
-	ErrUnauthorized             = errorsmod.Register(ModuleName, 3, "unauthorized account")
-	ErrInvalidDenom             = errorsmod.Register(ModuleName, 4, "invalid denom")
-	ErrInvalidCreator           = errorsmod.Register(ModuleName, 5, "invalid creator")
-	ErrInvalidAuthorityMetadata = errorsmod.Register(ModuleName, 6, "invalid authority metadata")
-	ErrInvalidGenesis           = errorsmod.Register(ModuleName, 7, "invalid genesis")
-	ErrSubdenomTooLong          = errorsmod.Register(ModuleName, 8, fmt.Sprintf("subdenom too long, max length is %d bytes", MaxSubdenomLength))
-	ErrCreatorTooLong           = errorsmod.Register(ModuleName, 9, fmt.Sprintf("creator too long, max length is %d bytes", MaxCreatorLength))
-	ErrDenomDoesNotExist        = errorsmod.Register(ModuleName, 10, "denom does not exist")
-	ErrBurnFromModuleAccount    = errorsmod.Register(ModuleName, 11, "burning from Module Account is not allowed")
-	ErrTrackBeforeSendOutOfGas  = errorsmod.Register(ModuleName, 12, "gas meter hit maximum limit")
+	ErrDenomExists                = errorsmod.Register(ModuleName, 2, "attempting to create a denom that already exists (has bank metadata)")
+	ErrUnauthorized               = errorsmod.Register(ModuleName, 3, "unauthorized account")
+	ErrInvalidDenom               = errorsmod.Register(ModuleName, 4, "invalid denom")
+	ErrInvalidCreator             = errorsmod.Register(ModuleName, 5, "invalid creator")
+	ErrInvalidAuthorityMetadata   = errorsmod.Register(ModuleName, 6, "invalid authority metadata")
+	ErrInvalidGenesis             = errorsmod.Register(ModuleName, 7, "invalid genesis")
+	ErrSubdenomTooLong            = errorsmod.Register(ModuleName, 8, fmt.Sprintf("subdenom too long, max length is %d bytes", MaxSubdenomLength))
+	ErrCreatorTooLong             = errorsmod.Register(ModuleName, 9, fmt.Sprintf("creator too long, max length is %d bytes", MaxCreatorLength))
+	ErrDenomDoesNotExist          = errorsmod.Register(ModuleName, 10, "denom does not exist")
+	ErrBurnFromModuleAccount      = errorsmod.Register(ModuleName, 11, "burning from Module Account is not allowed")
+	ErrTrackBeforeSendOutOfGas    = errorsmod.Register(ModuleName, 12, "gas meter hit maximum limit")
+	ErrInvalidHookContractAddress = errorsmod.Register(ModuleName, 13, "invalid hook contract address")
 )
diff --git a/x/tokenfactory/types/genesis.go b/x/tokenfactory/types/genesis.go
@@ -43,6 +43,10 @@ func (gs GenesisState) Validate() error {
 				return errorsmod.Wrapf(ErrInvalidAuthorityMetadata, "Invalid admin address (%s)", err)
 			}
 		}
+
+		if _, err := sdk.AccAddressFromBech32(denom.HookContractAddress); denom.HookContractAddress != "" && err != nil {
+			return errorsmod.Wrapf(ErrInvalidHookContractAddress, "Invalid hook contract address (%s)", err)
+		}
 	}
 
 	return nil

diff --git a/x/tokenfactory/types/genesis.pb.go b/x/tokenfactory/types/genesis.pb.go
diff --git a/x/tokenfactory/types/genesis_test.go b/x/tokenfactory/types/genesis_test.go
@@ -130,6 +130,36 @@ func TestGenesisState_Validate(t *testing.T) {
 			},
 			valid: false,
 		},
+		{
+			desc: "empty hook address",
+			genState: &types.GenesisState{
+				FactoryDenoms: []types.GenesisDenom{
+					{
+						Denom: "factory/neutron1m9l358xunhhwds0568za49mzhvuxx9ux8xafx2/bitcoin",
+						AuthorityMetadata: types.DenomAuthorityMetadata{
+							Admin: "neutron1m9l358xunhhwds0568za49mzhvuxx9ux8xafx2",
+						},
+						HookContractAddress: "",
+					},
+				},
+			},
+			valid: true,
+		},
+		{
+			desc: "invalid hook address",
+			genState: &types.GenesisState{
+				FactoryDenoms: []types.GenesisDenom{
+					{
+						Denom: "factory/neutron1m9l358xunhhwds0568za49mzhvuxx9ux8xafx2/bitcoin",
+						AuthorityMetadata: types.DenomAuthorityMetadata{
+							Admin: "neutron1m9l358xunhhwds0568za49mzhvuxx9ux8xafx2",
+						},
+						HookContractAddress: "sfsdfsdfsdfs",
+					},
+				},
+			},
+			valid: false,
+		},
 	} {
 		t.Run(tc.desc, func(t *testing.T) {
 			err := tc.genState.Validate()