feat: add gravity support for multi chain targets (#1174)

# Related Github tickets

- VolumeFi#1636

# Background

This change adds Gravity support for more than one remote chain by
contextualising stored data on Paloma with a chain reference ID. It also
adds the needed changes to the genesis as well as CLI commands.

# Testing completed

- [x] test coverage exists or has been added/updated
- [x] tested in a private testnet

# Breaking changes

- [x] I have checked my code for breaking changes
- [x] If there are breaking changes, there is a supporting migration.

Dockerfile

@@ -1,11 +1,10 @@
 ###########################
 ####     Base image    ####
 ###########################
-FROM golang:1.21-buster AS base
+FROM golang:1.22-buster AS base
 
 # TODO add non-root user
-
-MAINTAINER Matija Martinic <[email protected]>
+LABEL org.opencontainers.image.authors="[email protected]"
 WORKDIR /app
 
 ###########################
@@ -14,17 +13,17 @@ WORKDIR /app
 FROM base AS builder
 COPY . /app
 RUN \
-	--mount=type=cache,target=/go/pkg/mod \
-	--mount=type=cache,target=/root/.cache/go-build \
-	cd /app && go build -o /palomad ./cmd/palomad
-
+  --mount=type=cache,target=/go/pkg/mod \
+   --mount=type=cache,target=/root/.cache/go-build \
+   cd /app && go build -o /palomad ./cmd/palomad
+  
 #################################
 ####    Local chain setup    ####
 #################################
 FROM ubuntu AS setup-chain-locally
 RUN apt-get update && \
-	apt-get install -y jq
-COPY --from=builder /palomad /palomad
+  apt-get install -y jq
+  OPY --from=builder /palomad /palomad
 COPY --from=builder /app/scripts/setup-chain-validator.sh /app/scripts/setup-chain-validator.sh
 RUN PALOMA_CMD="/palomad" /app/scripts/setup-chain-validator.sh
 
@@ -46,7 +45,7 @@ CMD ["air"]
 FROM ubuntu AS local-testnet
 ENTRYPOINT ["/palomad"]
 COPY --from=builder /palomad /palomad
- 
+
 
 ###########################
 ####     Release       ####

proto/palomachain/paloma/gravity/genesis.proto

@@ -14,7 +14,7 @@ option go_package = "github.com/palomachain/paloma/x/gravity/types";
 // module
 message GenesisState {
   Params params = 1;
-  GravityNonces gravity_nonces = 2 [ (gogoproto.nullable) = false ];
+  repeated GravityNonces gravity_nonces = 2 [ (gogoproto.nullable) = false ];
   repeated OutgoingTxBatch batches = 3 [ (gogoproto.nullable) = false ];
   repeated MsgConfirmBatch batch_confirms = 4 [ (gogoproto.nullable) = false ];
   repeated Attestation attestations = 7 [ (gogoproto.nullable) = false ];
@@ -38,4 +38,6 @@ message GravityNonces {
   // the last batch id from the Gravity batch pool, this prevents ID duplication
   // during chain upgrades
   uint64 last_batch_id = 4;
-}
+  // the reference id of the remote chain this data applies to.
+  string chain_reference_id = 5;
+}

proto/palomachain/paloma/gravity/query.proto

@@ -80,8 +80,13 @@ message QueryBatchConfirmsResponse {
   repeated MsgConfirmBatch confirms = 1 [ (gogoproto.nullable) = false ];
 }
 
-message QueryLastEventNonceRequest {}
-message QueryLastEventNonceByAddrRequest { string address = 1; }
+message QueryLastEventNonceRequest { 
+  string chain_reference_id = 1;
+}
+message QueryLastEventNonceByAddrRequest { 
+  string address = 1; 
+  string chain_reference_id = 2;
+}
 message QueryLastEventNonceResponse { uint64 event_nonce = 1; }
 
 message QueryERC20ToDenomRequest {
@@ -101,10 +106,10 @@ message QueryDenomToERC20Response { string erc20 = 1; }
 // actual Ethereum block height significantly due to 1. Ethereum Finality and
 //  2. Consensus mirroring the state on Ethereum
 message QueryLastObservedEthBlockRequest {
-  // indicates whether to search for store data using the old Gravity v1 key
-  // "LastObservedEthereumBlockHeightKey" Note that queries before the Mercury
-  // upgrade at height 1282013 must set this to true
-  bool use_v1_key = 1;
+  reserved 1;
+  reserved "use_v1_key";
+
+  string chain_reference_id = 2;
 }
 message QueryLastObservedEthBlockResponse {
   // a response of 0 indicates that no Ethereum events have been observed, and
@@ -117,10 +122,10 @@ message QueryLastObservedEthBlockResponse {
 // likely to lag the last executed event a little due to 1. Ethereum Finality
 // and 2. Consensus mirroring the Ethereum state
 message QueryLastObservedEthNonceRequest {
-  // indicates whether to search for store data using the old Gravity v1 key
-  // "LastObservedEventNonceKey" Note that queries before the Mercury upgrade at
-  // height 1282013 must set this to true
-  bool use_v1_key = 1;
+  reserved 1;
+  reserved "use_v1_key";
+
+  string chain_reference_id = 2;
 }
 message QueryLastObservedEthNonceResponse {
   // a response of 0 indicates that no Ethereum events have been observed, and
@@ -136,6 +141,9 @@ message QueryLastObservedEthNonceResponse {
 // height. Note, that an attestation will be returned if it matches ANY of the
 // filter query parameters provided.
 message QueryAttestationsRequest {
+  reserved 6;
+  reserved "use_v1_key";
+
   // limit defines how many attestations to limit in the response.
   uint64 limit = 1;
   // order_by provides ordering of atteststions by nonce in the response. Either
@@ -148,10 +156,8 @@ message QueryAttestationsRequest {
   uint64 nonce = 4;
   // height allows filtering attestations by Ethereum claim height.
   uint64 height = 5;
-  // indicates whether to search for store data using the old Gravity v1 key
-  // "OracleAttestationKey" Note that queries before the Mercury upgrade at
-  // height 1282013 must set this to true
-  bool use_v1_key = 6;
+  // reference id of remote chain for which to query.
+  string chain_reference_id = 7;
 }
 
 message QueryAttestationsResponse {

x/evm/keeper/attest_test.go

@@ -84,7 +84,7 @@ var _ = g.Describe("attest router", func() {
 		consensukeeper = ms.ConsensusKeeper
 		q = consensusmocks.NewQueuer(t)
 		isGoodcase = true
-		ms.GravityKeeper.On("GetLastObservedEventNonce", mock.Anything).Return(uint64(100), nil).Maybe()
+		ms.GravityKeeper.On("GetLastObservedEventNonce", mock.Anything, mock.Anything).Return(uint64(100), nil).Maybe()
 	})
 
 	g.BeforeEach(func() {

x/evm/keeper/keeper_test.go

@@ -60,12 +60,12 @@ func buildKeeper(t *testing.T) (*Keeper, sdk.Context, mockedServices) {
 	// test-chain mocks
 	mockServices.ValsetKeeper.On("GetCurrentSnapshot", mock.Anything).Return(unpublishedSnapshot, nil)
 	mockServices.ConsensusKeeper.On("PutMessageInQueue", mock.Anything, mock.Anything, mock.Anything, mock.Anything).Return(uint64(0), nil)
-	mockServices.GravityKeeper.On("GetLastObservedEventNonce", mock.Anything).Return(uint64(100), nil)
+	mockServices.GravityKeeper.On("GetLastObservedEventNonce", mock.Anything, mock.Anything).Return(uint64(100), nil)
 
 	// invalid-test-chain mocks
 	mockServices.ValsetKeeper.On("GetCurrentSnapshot", mock.Anything).Return(unpublishedSnapshot, nil)
 	mockServices.ConsensusKeeper.On("PutMessageInQueue", mock.Anything, mock.Anything, mock.Anything, mock.Anything).Return(uint64(0), nil)
-	mockServices.GravityKeeper.On("GetLastObservedEventNonce", mock.Anything).Return(uint64(100), nil)
+	mockServices.GravityKeeper.On("GetLastObservedEventNonce", mock.Anything, mock.Anything).Return(uint64(100), nil)
 
 	// Add 2 new chains for our tests to use
 	err := k.AddSupportForNewChain(

x/evm/keeper/msg_server_remove_smart_contract_deployment_test.go

@@ -30,7 +30,7 @@ func addDeploymentToKeeper(t *testing.T, ctx sdk.Context, k *Keeper, mockService
 	// test-chain mocks
 	mockServices.ValsetKeeper.On("GetCurrentSnapshot", mock.Anything).Return(unpublishedSnapshot, nil)
 	mockServices.ConsensusKeeper.On("PutMessageInQueue", mock.Anything, mock.Anything, mock.Anything, mock.Anything).Return(uint64(10), nil)
-	mockServices.GravityKeeper.On("GetLastObservedEventNonce", mock.Anything).Return(uint64(100), nil)
+	mockServices.GravityKeeper.On("GetLastObservedEventNonce", mock.Anything, mock.Anything).Return(uint64(100), nil)
 
 	// Add a new chains for our test to use
 	err := k.AddSupportForNewChain(

x/evm/keeper/smart_contract_deployment.go

@@ -248,7 +248,7 @@ func (k Keeper) deploySmartContractToChain(ctx context.Context, chainInfo *types
 	}
 	uniqueID := generateSmartContractID(ctx)
 	k.createSmartContractDeployment(ctx, smartContract, chainInfo, uniqueID[:])
-	lastEventNonce, err := k.Gravity.GetLastObservedEventNonce(ctx)
+	lastEventNonce, err := k.Gravity.GetLastObservedEventNonce(ctx, chainInfo.GetChainReferenceID())
 	if err != nil {
 		return fmt.Errorf("failed to get last observed event nonce: %w", err)
 	}

x/evm/types/expected_keepers.go

@@ -57,6 +57,6 @@ type ERC20Record interface {
 
 //go:generate mockery --name=GravityKeeper
 type GravityKeeper interface {
-	GetLastObservedEventNonce(ctx context.Context) (uint64, error)
+	GetLastObservedEventNonce(ctx context.Context, chainReferenceID string) (uint64, error)
 	CastAllERC20ToDenoms(ctx context.Context) ([]ERC20Record, error)
 }

x/gravity/abci.go

@@ -5,30 +5,41 @@ import (
 
 	sdkerrors "cosmossdk.io/errors"
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/palomachain/paloma/util/liblog"
 	"github.com/palomachain/paloma/x/gravity/keeper"
 	log "github.com/sirupsen/logrus"
 )
 
 // EndBlocker is called at the end of every block
 func EndBlocker(ctx context.Context, k keeper.Keeper) {
+	defer func() {
+		if r := recover(); r != nil {
+			liblog.FromSDKLogger(k.Logger(ctx)).
+				WithFields("original-error", r).
+				Warn("Recovered panic.")
+		}
+	}()
 	// slashing(ctx, k)
+	chains := k.GetChainsWithTokens(ctx)
 
 	err := createBatch(ctx, k)
 	if err != nil {
 		log.Error(err)
 	}
 
-	err = attestationTally(ctx, k)
-	if err != nil {
-		log.Error(err)
-	}
+	for _, v := range chains {
+		err = attestationTally(ctx, k, v)
+		if err != nil {
+			log.Error(err)
+		}
 
-	err = cleanupTimedOutBatches(ctx, k)
-	if err != nil {
-		log.Error(err)
+		err = pruneAttestations(ctx, k, v)
+		if err != nil {
+			log.Error(err)
+		}
 	}
 
-	err = pruneAttestations(ctx, k)
+	err = cleanupTimedOutBatches(ctx, k)
 	if err != nil {
 		log.Error(err)
 	}
@@ -60,8 +71,8 @@ func createBatch(ctx context.Context, k keeper.Keeper) error {
 // Iterate over all attestations currently being voted on in order of nonce and
 // "Observe" those who have passed the threshold. Break the loop once we see
 // an attestation that has not passed the threshold
-func attestationTally(ctx context.Context, k keeper.Keeper) error {
-	attmap, keys, err := k.GetAttestationMapping(ctx)
+func attestationTally(ctx context.Context, k keeper.Keeper, chainReferenceID string) error {
+	attmap, keys, err := k.GetAttestationMapping(ctx, chainReferenceID)
 	if err != nil {
 		return err
 	}
@@ -90,7 +101,7 @@ func attestationTally(ctx context.Context, k keeper.Keeper) error {
 			// we skip the other attestations and move on to the next nonce again.
 			// If no attestation becomes observed, when we get to the next nonce, every attestation in
 			// it will be skipped. The same will happen for every nonce after that.
-			lastEventNonce, err := k.GetLastObservedEventNonce(ctx)
+			lastEventNonce, err := k.GetLastObservedEventNonce(ctx, chainReferenceID)
 			if err != nil {
 				return err
 			}
@@ -130,8 +141,8 @@ func cleanupTimedOutBatches(ctx context.Context, k keeper.Keeper) error {
 // use. This could be combined with create attestation and save some computation
 // but (A) pruning keeps the iteration small in the first place and (B) there is
 // already enough nuance in the other handler that it's best not to complicate it further
-func pruneAttestations(ctx context.Context, k keeper.Keeper) error {
-	attmap, keys, err := k.GetAttestationMapping(ctx)
+func pruneAttestations(ctx context.Context, k keeper.Keeper, chainReferenceID string) error {
+	attmap, keys, err := k.GetAttestationMapping(ctx, chainReferenceID)
 	if err != nil {
 		return err
 	}
@@ -140,7 +151,7 @@ func pruneAttestations(ctx context.Context, k keeper.Keeper) error {
 	// minus some buffer value. This buffer value is purely to allow
 	// frontends and other UI components to view recent oracle history
 	const eventsToKeep = 1000
-	lastNonce, err := k.GetLastObservedEventNonce(ctx)
+	lastNonce, err := k.GetLastObservedEventNonce(ctx, chainReferenceID)
 	if err != nil {
 		return err
 	}
@@ -162,7 +173,7 @@ func pruneAttestations(ctx context.Context, k keeper.Keeper) error {
 		for _, att := range attmap[nonce] {
 			// delete all before the cutoff
 			if nonce < cutoff {
-				err := k.DeleteAttestation(ctx, att)
+				err := k.DeleteAttestation(ctx, chainReferenceID, att)
 				if err != nil {
 					return err
 				}

x/gravity/abci_test.go

@@ -163,7 +163,7 @@ func TestBatchTimeout(t *testing.T) {
 	require.NoError(t, err1)
 	require.Equal(t, b1.BatchTimeout, uint64(1693425290))
 
-	pk.SetLastObservedEthereumBlockHeight(ctx, 500)
+	pk.SetLastObservedEthereumBlockHeight(ctx, "test-chain", 500)
 
 	// create another batch
 	b2, err2 := pk.BuildOutgoingTXBatch(ctx, "test-chain", *tokenContract, 2)