feat(appchain): add unit tests

app/app.go

@@ -204,6 +204,10 @@ import (
 	// Force-load the tracer engines to trigger registration due to Go-Ethereum v1.10.15 changes
 	_ "github.com/ethereum/go-ethereum/eth/tracers/js"
 	_ "github.com/ethereum/go-ethereum/eth/tracers/native"
+
+	"github.com/ExocoreNetwork/exocore/x/appchain/coordinator"
+	coordinatorkeeper "github.com/ExocoreNetwork/exocore/x/appchain/coordinator/keeper"
+	coordinatortypes "github.com/ExocoreNetwork/exocore/x/appchain/coordinator/types"
 )
 
 // Name defines the application binary name
@@ -274,6 +278,7 @@ var (
 		avs.AppModuleBasic{},
 		oracle.AppModuleBasic{},
 		distr.AppModuleBasic{},
+		coordinator.AppModuleBasic{},
 	)
 
 	// module account permissions
@@ -351,15 +356,16 @@ type ExocoreApp struct {
 	EpochsKeeper epochskeeper.Keeper
 
 	// exocore assets module keepers
-	AssetsKeeper     assetsKeeper.Keeper
-	DelegationKeeper delegationKeeper.Keeper
-	RewardKeeper     rewardKeeper.Keeper
-	OperatorKeeper   operatorKeeper.Keeper
-	ExoSlashKeeper   slashKeeper.Keeper
-	AVSManagerKeeper avsManagerKeeper.Keeper
-	OracleKeeper     oracleKeeper.Keeper
-	ExomintKeeper    exomintkeeper.Keeper
-	DistrKeeper      distrkeeper.Keeper
+	AssetsKeeper      assetsKeeper.Keeper
+	DelegationKeeper  delegationKeeper.Keeper
+	RewardKeeper      rewardKeeper.Keeper
+	OperatorKeeper    operatorKeeper.Keeper
+	ExoSlashKeeper    slashKeeper.Keeper
+	AVSManagerKeeper  avsManagerKeeper.Keeper
+	OracleKeeper      oracleKeeper.Keeper
+	ExomintKeeper     exomintkeeper.Keeper
+	DistrKeeper       distrkeeper.Keeper
+	CoordinatorKeeper coordinatorkeeper.Keeper
 
 	// the module manager
 	mm *module.Manager
@@ -445,6 +451,7 @@ func NewExocoreApp(
 		oracleTypes.StoreKey,
 		exominttypes.StoreKey,
 		distrtypes.StoreKey,
+		coordinatortypes.StoreKey,
 	)
 
 	tkeys := sdk.NewTransientStoreKeys(paramstypes.TStoreKey, evmtypes.TransientKey, feemarkettypes.TransientKey)
@@ -621,6 +628,7 @@ func NewExocoreApp(
 	scopedIBCKeeper := app.CapabilityKeeper.ScopeToModule(ibcexported.ModuleName)
 	scopedTransferKeeper := app.CapabilityKeeper.ScopeToModule(ibctransfertypes.ModuleName)
 	scopedICAHostKeeper := app.CapabilityKeeper.ScopeToModule(icahosttypes.SubModuleName)
+	scopedIBCProviderKeeper := app.CapabilityKeeper.ScopeToModule(coordinatortypes.ModuleName)
 	// Applications that wish to enforce statically created ScopedKeepers should call `Seal`
 	// after creating their scoped modules in `NewApp` with `ScopeToModule`
 	app.CapabilityKeeper.Seal()
@@ -787,22 +795,42 @@ func NewExocoreApp(
 
 	app.IBCKeeper.SetRouter(ibcRouter)
 
+	// we are the x/appchain coordinator chain, so we add the keeper, but
+	// it's added after IBC to allow communication between chains.
+	app.CoordinatorKeeper = coordinatorkeeper.NewKeeper(
+		appCodec, keys[coordinatortypes.StoreKey],
+		app.AVSManagerKeeper, app.EpochsKeeper, app.OperatorKeeper,
+		app.StakingKeeper, app.DelegationKeeper,
+		app.IBCKeeper.ClientKeeper, &app.IBCKeeper.PortKeeper,
+		scopedIBCProviderKeeper, app.IBCKeeper.ChannelKeeper,
+		app.IBCKeeper.ConnectionKeeper, app.AccountKeeper,
+	)
+
 	// set the hooks at the end, after all modules are instantiated.
 	(&app.OperatorKeeper).SetHooks(
-		app.StakingKeeper.OperatorHooks(),
+		operatorTypes.NewMultiOperatorHooks(
+			// the order is not super relevant because these functions are independent
+			app.StakingKeeper.OperatorHooks(),
+			app.CoordinatorKeeper.OperatorHooks(),
+		),
 	)
 
 	(&app.DelegationKeeper).SetHooks(
-		app.StakingKeeper.DelegationHooks(),
+		delegationTypes.NewMultiDelegationHooks(
+			// the order is not super relevant because these functions are independent
+			app.StakingKeeper.DelegationHooks(),
+			app.CoordinatorKeeper.DelegationHooks(),
+		),
 	)
 
 	(&app.EpochsKeeper).SetHooks(
 		epochstypes.NewMultiEpochHooks(
-			app.DistrKeeper.EpochsHooks(),      // come first for using the voting power of last epoch
-			app.OperatorKeeper.EpochsHooks(),   // must come before staking keeper so it can set the USD value
-			app.StakingKeeper.EpochsHooks(),    // at this point, the order is irrelevant.
-			app.ExomintKeeper.EpochsHooks(),    // however, this may change once we have distribution
-			app.AVSManagerKeeper.EpochsHooks(), // no-op for now
+			app.DistrKeeper.EpochsHooks(),       // come first for using the voting power of last epoch
+			app.OperatorKeeper.EpochsHooks(),    // must come before staking keeper so it can set the USD value
+			app.ExomintKeeper.EpochsHooks(),     // must happen after distribution but not relevant otherwise
+			app.StakingKeeper.EpochsHooks(),     // after operator == good
+			app.AVSManagerKeeper.EpochsHooks(),  // after operator == good
+			app.CoordinatorKeeper.EpochsHooks(), // after operator == good
 		),
 	)
 

precompiles/avs/avs_test.go

@@ -1,12 +1,13 @@
 package avs_test
 
 import (
+	"math/big"
+	"time"
+
 	"cosmossdk.io/math"
 	assetstypes "github.com/ExocoreNetwork/exocore/x/assets/types"
 	avskeeper "github.com/ExocoreNetwork/exocore/x/avs/keeper"
 	"github.com/ExocoreNetwork/exocore/x/avs/types"
-	"math/big"
-	"time"
 
 	sdkmath "cosmossdk.io/math"
 	operatorKeeper "github.com/ExocoreNetwork/exocore/x/operator/keeper"

proto/exocore/appchain/common/v1/common.proto

@@ -3,7 +3,9 @@ syntax = "proto3";
 package exocore.appchain.common.v1;
 
 import "amino/amino.proto";
+import "cosmos_proto/cosmos.proto";
 import "gogoproto/gogo.proto";
+import "google/protobuf/any.proto";
 import "google/protobuf/duration.proto";
 import "ibc/lightclients/tendermint/v1/tendermint.proto";
 import "tendermint/abci/types.proto";
@@ -26,7 +28,7 @@ message SubscriberParams {
   // the rewards from the subscriber to the coordinator. It is used in the event
   // that a channel between coordinator and subscriber exists prior to the
   // provision of security from Exocore to the appchain. Until a changeover
-  // process is implemented, it is currently unused. (TODO). The advantage
+  // process is implemented, it is currently unused (TODO). The advantage
   // of reusing a channel that was already in place is that the coin denomination
   // which contains a hash of the channel name will remain unchanged.
   string distribution_transmission_channel = 2;
@@ -101,7 +103,24 @@ message CoordinatorInfo {
   ibc.lightclients.tendermint.v1.ClientState client_state = 1;
   // consensus_state is the consensus state of the coordinator chain.
   ibc.lightclients.tendermint.v1.ConsensusState consensus_state = 2;
-  // initial_val_set is the initial validator set of the coordinator chain.
+  // initial_val_set is the initial validator set of the subscriber chain.
   repeated .tendermint.abci.ValidatorUpdate initial_val_set = 3
     [ (gogoproto.nullable) = false ];
+}
+
+// SubscriberValidator is a validator structure on the subscriber chain. It is stored
+// within the subscriber module, indexed by a prefix + consensus address, and
+// within the coordinator module, indexed by a prefix + chain id + consensus address.
+message SubscriberValidator {
+  // address, as derived from the consensus key. No correlation with the operator
+  // address on Exocore.
+  bytes cons_address = 1;
+  // power is the vote power of the validator
+  int64 power = 2;
+  // pubkey is the consensus public key of the validator, as a Protobuf Any.
+  // this type is chosen to match the x/staking/validator type.
+  google.protobuf.Any pubkey = 3 [
+    (cosmos_proto.accepts_interface) = "cosmos.crypto.PubKey",
+    (gogoproto.moretags) = "yaml:\"consensus_pubkey\""
+  ];
 }

proto/exocore/appchain/common/v1/wire.proto

@@ -0,0 +1,87 @@
+syntax = "proto3";
+
+package exocore.appchain.common.v1;
+
+import "cosmos/staking/v1beta1/staking.proto";
+import "gogoproto/gogo.proto";
+import "tendermint/abci/types.proto";
+
+option go_package = "github.com/ExocoreNetwork/exocore/x/appchain/common/types";
+
+// This file containts all of the information that is sent over the wire by either
+// the coordinator or each of the subcribers.
+
+message HandshakeMetadata {
+  // coordinator_fee_pool_addr is the address on the coordinator to which the 
+  // subscriber chain will send the fees proportionally and periodically.
+  string coordinator_fee_pool_addr = 1;
+  // version is the version of the appchain protocol
+  string version = 2;
+}
+
+// SlashPacketData  is sent from the subscriber chain to the coordinator chain
+// to request the slashing of a validator as a result of an infraction committed 
+// on the subscriber chain.
+message SlashPacketData {
+  // validator is the validator to be slashed
+  tendermint.abci.Validator validator = 1 [
+    (gogoproto.nullable) = false,
+    (gogoproto.moretags) = "yaml:\"validator\""
+  ];
+  // valset_update_id is the id of the validator set change during which
+  // the infraction was committed
+  uint64 valset_update_id = 2 [ (gogoproto.customname) = "ValsetUpdateID" ];
+  // infraction refers to the type of infraction committed
+  cosmos.staking.v1beta1.Infraction infraction = 3;
+}
+
+// VscMaturedPacketData is sent from the subscriber chain to the coordinator chain
+// to indicate that a VSC has matured and unbondings associated with that VSC
+// can now be released.
+message VscMaturedPacketData {
+  // valset_update_id is the id of the validator set change to mature.
+  uint64 valset_update_id = 1 [ (gogoproto.customname) = "ValsetUpdateID" ];
+}
+
+// SubscriberPacketData is the enum to identify the type of packet sent.
+enum SubscriberPacketDataType {
+  option (gogoproto.goproto_enum_prefix) = false;
+  // SUBSCRIBER_PACKET_DATA_TYPE_UNSPECIFIED is the default value
+  SUBSCRIBER_PACKET_DATA_TYPE_UNSPECIFIED = 0 [ (gogoproto.enumvalue_customname) = "UnspecifiedPacket" ];
+  // SUBSCRIBER_PACKET_DATA_TYPE_SLASH is the type of packet sent when a subscriber
+  // chain wants to request the slashing of a validator on the coordinator chain.
+  SUBSCRIBER_PACKET_DATA_TYPE_SLASH = 1 [ (gogoproto.enumvalue_customname) = "SlashPacket" ];
+  // SUBSCRIBER_PACKET_DATA_TYPE_VSC_MATURED is the type of packet sent when a subscriber
+  // chain wants to indicate that a VSC has matured and unbondings associated with
+  // that VSC can now be released.
+  SUBSCRIBER_PACKET_DATA_TYPE_VSC_MATURED = 2 [ (gogoproto.enumvalue_customname) = "VscMaturedPacket" ];
+}
+
+// SubscriberPacketData is a wrapped message that contains the type of packet
+// and the data associated with that packet.
+message SubscriberPacketData {
+  // type is the type of packet sent
+  SubscriberPacketDataType type = 1;
+  // data is the data associated with the packet
+  oneof data {
+    // slash_packet_data is the data associated with a SlashPacket
+    SlashPacketData slash_packet_data = 2;
+    // vsc_matured_packet_data is the data associated with a VscMaturedPacket
+    VscMaturedPacketData vsc_matured_packet_data = 3;
+  }
+}
+
+// ValidatorSetChangePacketData is sent from the coordinator chain to the subscriber chain
+// containing the new validator set and the id of the validator set change.
+message ValidatorSetChangePacketData {
+  // validator_updates is the edits to the existing validator set
+  repeated .tendermint.abci.ValidatorUpdate validator_updates = 1 [
+    (gogoproto.nullable) = false,
+    (gogoproto.moretags) = "yaml:\"validator_updates\""
+  ];
+  // valset_update_id is the id of the validator set change
+  uint64 valset_update_id = 2 [(gogoproto.customname) = "ValsetUpdateID"];
+  // slash_acks is the list of consensus addresses slashed on the coordinator chain,
+  // in response to such requests from the subscriber chain.
+  repeated bytes slash_acks = 3;
+}

proto/exocore/appchain/coordinator/v1/coordinator.proto

@@ -2,6 +2,7 @@ syntax = "proto3";
 
 package exocore.appchain.coordinator.v1;
 
+import "exocore/appchain/common/v1/wire.proto";
 import "exocore/appchain/coordinator/v1/tx.proto";
 import "gogoproto/gogo.proto";
 
@@ -21,3 +22,21 @@ message ChainIDs {
   repeated string list = 1;
 }
 
+// ConsensusAddresses is a list of consensus addresses.
+message ConsensusAddresses {
+  // list is the list of consensus addresses.
+  repeated bytes list = 1;
+}
+
+// ValidatorSetChangePackets is a helper structure to store a list of packets
+message ValidatorSetChangePackets {
+  // list is the list of packets to be sent to the subscriber chain.
+  repeated .exocore.appchain.common.v1.ValidatorSetChangePacketData list = 1
+  [(gogoproto.nullable) = false];
+}
+
+// UndelegationRecordKeys is a collection of undelegation record keys.
+message UndelegationRecordKeys {
+  // list is the list of undelegation record keys.
+  repeated bytes list = 1;
+}

proto/exocore/appchain/subscriber/v1/genesis.proto

@@ -4,11 +4,35 @@ package exocore.appchain.subscriber.v1;
 
 import "exocore/appchain/common/v1/common.proto";
 import "gogoproto/gogo.proto";
+import "google/protobuf/timestamp.proto";
 
 option go_package = "github.com/ExocoreNetwork/exocore/x/appchain/subscriber/types";
 
 // GenesisState is the genesis state for the appchain subscriber module.
 message GenesisState {
-  // Params is the parameters for the appchain subscriber module.
+  // The first two fields are word-for-word pulled from `common.proto`, to be
+  // filled by the coordinator module (or an export).
+  // params is the parameters for the appchain subscriber module.
   exocore.appchain.common.v1.SubscriberParams params = 1 [(gogoproto.nullable) = false];
+  // coordinator is the coordinator information for the subscriber.
+  exocore.appchain.common.v1.CoordinatorInfo coordinator = 2 [ (gogoproto.nullable) = false ];
+  // Below are the IBC parameters
+  // coordinator_client_id is the client id of the coordinator chain.
+  string coordinator_client_id = 3 [ (gogoproto.customname) = "CoordinatorClientID" ];
+  // coordinator_channel_id is the channel id of the coordinator chain.
+  string coordinator_channel_id = 4 [ (gogoproto.customname) = "CoordinatorChannelID" ];
+  // operational parameters that are to be exported can go here.
 }
+
+// MaturingVSCPacket represents a vsc packet that is maturing internal to the
+// subscriber module, where it has not yet relayed a VSCMatured packet back.
+// While it is technically feasible to store this just as a key in the state,
+// keeping it as a separate type allows exporting the genesis data.
+// The key used is prefix + time + vscId.
+message MaturingVSCPacket {
+  // vsc_id is the id of the VSC that is maturing.
+  uint64 vsc_id = 1 [ (gogoproto.customname) = "ValidatorSetChangeID" ];
+  // maturity_time is the time at which the VSC will mature.
+  google.protobuf.Timestamp maturity_time = 2
+      [ (gogoproto.stdtime) = true, (gogoproto.nullable) = false ];
+}