feat(appchain): load subscriber genesis, ibc

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

@@ -26,7 +26,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 +101,7 @@ 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 ];
 }

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 string slash_acks = 3;
+}

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

@@ -21,3 +21,8 @@ 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;
+}

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 ];
+}

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

@@ -0,0 +1,26 @@
+syntax = "proto3";
+
+package exocore.appchain.subscriber.v1;
+
+import "cosmos_proto/cosmos.proto";
+import "gogoproto/gogo.proto";
+import "google/protobuf/any.proto";
+
+option go_package = "github.com/ExocoreNetwork/exocore/x/appchain/subscriber/types";
+
+// SubscriberChainValidator is a validator structure on the subscriber chain.
+// The name is verbose intentionally.
+message SubscriberChainValidator {
+  // 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\""
+  ];
+}
+

testutil/utils.go

@@ -238,7 +238,7 @@ func (suite *BaseTestSuite) SetupWithGenesisValSet(genAccs []authtypes.GenesisAc
 	suite.Require().NotNil(pubKey)
 	pubKey2 := testutiltx.GenerateConsensusKey()
 	suite.Require().NotNil(pubKey2)
-	chainIDWithoutRevision := avstypes.ChainIDWithoutRevision(utils.DefaultChainID)
+	chainIDWithoutRevision := utils.ChainIDWithoutRevision(utils.DefaultChainID)
 	operatorConsKeys := []operatortypes.OperatorConsKeyRecord{
 		{
 			OperatorAddress: operator1.String(),

utils/utils.go

@@ -7,6 +7,8 @@
 
 	ibcclienttypes "github.com/cosmos/ibc-go/v7/modules/core/02-client/types"
 
+	abci "github.com/cometbft/cometbft/abci/types"
+
 	"github.com/evmos/evmos/v16/crypto/ethsecp256k1"
 	"golang.org/x/exp/constraints"
 	"golang.org/x/xerrors"
@@ -210,3 +212,53 @@
 	}
 	return sortedOperatorAddrs, sortedPubKeys, sortedPowers
 }
+
+// AccumulateChanges accumulates the current and new validator updates and returns
+// a list of unique validator updates. The list is sorted by power in descending order.
+func AccumulateChanges(
+	currentChanges, newChanges []abci.ValidatorUpdate,
+) []abci.ValidatorUpdate {
+	// get only unique updates
+	m := make(map[string]abci.ValidatorUpdate)
+	for _, change := range currentChanges {
+		m[change.PubKey.String()] = change
+	}
+	for _, change := range newChanges {
+		m[change.PubKey.String()] = change
+	}
+
+	// convert to list
+	out := make([]abci.ValidatorUpdate, 0, len(m))
+	for _, update := range m {
+		out = append(out, update)
+	}
+
+	// The list of tendermint updates should hash the same across all consensus nodes
+	// that means it is necessary to sort for determinism.
+	sort.Slice(out, func(i, j int) bool {
+		if out[i].Power != out[j].Power {
+			return out[i].Power > out[j].Power
+		}
+		return out[i].PubKey.String() > out[j].PubKey.String()
+	})
+
+	return out
+}
+
+// AppendMany appends a variable number of byte slices together
+func AppendMany(slices ...[]byte) (out []byte) {
+	for _, slice := range slices {
+		out = append(out, slice...)
+	}
+	return out
+}
+
+// ChainIDWithoutRevision returns the chainID without the revision number.
+// For example, "exocoretestnet_233-1" returns "exocoretestnet_233".
+func ChainIDWithoutRevision(chainID string) string {
+	if !ibcclienttypes.IsRevisionFormat(chainID) {
+		return chainID
+	}
+	splitStr := strings.Split(chainID, "-")
+	return splitStr[0]
+}

x/appchain/common/types/errors.go

@@ -0,0 +1,36 @@
+package types
+
+import (
+	errorsmod "cosmossdk.io/errors"
+)
+
+var (
+	ErrInvalidChannelFlow = errorsmod.Register(
+		ModuleName, 2,
+		"invalid message sent to channel end",
+	)
+	ErrDuplicateChannel = errorsmod.Register(
+		ModuleName, 3,
+		"channel already exists",
+	)
+	ErrInvalidVersion = errorsmod.Register(
+		ModuleName, 4,
+		"invalid version",
+	)
+	ErrInvalidHandshakeMetadata = errorsmod.Register(
+		ModuleName, 5,
+		"invalid handshake metadata",
+	)
+	ErrChannelNotFound = errorsmod.Register(
+		ModuleName, 6,
+		"channel not found",
+	)
+	ErrClientNotFound = errorsmod.Register(
+		ModuleName, 7,
+		"client not found",
+	)
+	ErrInvalidPacketData = errorsmod.Register(
+		ModuleName, 8,
+		"invalid packet data (but successfully unmarshalled)",
+	)
+)

x/appchain/common/types/events.go

@@ -1,5 +1,12 @@
 package types
 
 const (
-	AttributeChainID = "chain_id"
+	AttributeChainID       = "chain_id"
+	AttributeKeyAckSuccess = "success"
+	AttributeKeyAck        = "acknowledgement"
+	AttributeKeyAckError   = "ack_error"
+
+	EventTypeChannelEstablished = "channel_established"
+	EventTypePacket             = "common_packet"
+	EventTypeTimeout            = "common_timeout"
 )