chore: Rebase base onto dev

.circleci/config.yml

@@ -43,6 +43,7 @@ jobs:
           command: "go env"
       - go/load-cache:
           key: go-mod-v6-{{ checksum "go.sum" }}
+      - add_ssh_keys
       - go/mod-download
       - go/save-cache:
           key: go-mod-v6-{{ checksum "go.sum" }}
@@ -59,24 +60,118 @@ jobs:
           name: Run tests
           command: |
             make test
+
+  test_e2e_babylon:
+    machine:
+      image: ubuntu-2204:2024.01.1
+    resource_class: large
+    steps:
+      - go/install:
+          version: "1.21.4"
+      - checkout
+      - run:
+          name: Print Go environment
+          command: "go env"
+      - go/load-cache:
+          key: go-mod-v6-{{ checksum "go.sum" }}
+      - add_ssh_keys
+      - go/mod-download
+      - go/save-cache:
+          key: go-mod-v6-{{ checksum "go.sum" }}
+          path: "/home/circleci/.go_workspace/pkg/mod"
+      - run:
+          name: Run integration tests
+          command: |
+            make test-e2e-babylon
+
+  test_e2e_bcd:
+    machine:
+      image: ubuntu-2204:2024.01.1
+    resource_class: large
+    steps:
+      - go/install:
+          version: "1.21.4"
+      - checkout
+      - run:
+          name: Print Go environment
+          command: "go env"
+      - go/load-cache:
+          key: go-mod-v6-{{ checksum "go.sum" }}
+      - add_ssh_keys
+      - go/mod-download
+      - go/save-cache:
+          key: go-mod-v6-{{ checksum "go.sum" }}
+          path: "/home/circleci/.go_workspace/pkg/mod"
+      - run:
+          name: Run integration tests
+          command: |
+            make test-e2e-bcd
+
+  test_e2e_wasmd:
+    machine:
+      image: ubuntu-2204:2024.01.1
+    resource_class: large
+    steps:
+      - go/install:
+          version: "1.21.4"
+      - checkout
+      - run:
+          name: Print Go environment
+          command: "go env"
+      - go/load-cache:
+          key: go-mod-v6-{{ checksum "go.sum" }}
+      - add_ssh_keys
+      - go/mod-download
+      - go/save-cache:
+          key: go-mod-v6-{{ checksum "go.sum" }}
+          path: "/home/circleci/.go_workspace/pkg/mod"
+      - run:
+          name: Run integration tests
+          command: |
+            make test-e2e-wasmd
+
+  test_e2e_op:
+    machine:
+      image: ubuntu-2204:2024.01.1
+    resource_class: large
+    steps:
+      - go/install:
+          version: "1.21.4"
+      - checkout
+      - run:
+          name: Print Go environment
+          command: "go env"
+      - go/load-cache:
+          key: go-mod-v6-{{ checksum "go.sum" }}
+      - add_ssh_keys
+      - go/mod-download
+      - go/save-cache:
+          key: go-mod-v6-{{ checksum "go.sum" }}
+          path: "/home/circleci/.go_workspace/pkg/mod"
+      - run:
+          name: Download OP e2e devnet test data
+          command: |
+            make op-e2e-devnet
       - run:
           name: Run integration tests
           command: |
-            make test-e2e
+            make test-e2e-op
 
   build_docker:
     machine:
       image: ubuntu-2204:2024.01.1
       resource_class: large
     steps:
       - checkout
+      - add_ssh_keys
       - aws-ecr/build-image:
           push-image: false
           dockerfile: Dockerfile
           path: ./
           build-path: ./
           tag: "$CIRCLE_SHA1,$CIRCLE_TAG"
           repo: "$CIRCLE_PROJECT_REPONAME"
+          extra-build-args: "--secret id=sshKey,src=/home/circleci/.ssh/$DEPLOY_KEY_NAME"
       - run:
           name: Save Docker image to export it to workspace
           command: |
@@ -112,6 +207,10 @@ workflows:
     jobs:
       - check-mock-gen
       - build_lint_test
+      - test_e2e_babylon
+      - test_e2e_bcd
+      - test_e2e_wasmd
+      - test_e2e_op
       - build_docker:
           filters:
             tags:
@@ -126,3 +225,4 @@ workflows:
               only:
                 - main
                 - dev
+                - base/consumer-chain-support

.gitignore

@@ -13,6 +13,9 @@
 # Test binary, built with `go test -c`
 *.test
 
+# E2E test data
+devnet-data/
+
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 

.golangci.yml

@@ -0,0 +1,6 @@
+run:
+  build-tags: 
+    - e2e_op
+    - e2e_babylon
+    - e2e_bcd
+    - e2e_wasmd

Dockerfile

@@ -12,11 +12,15 @@ RUN apk add --no-cache --update openssh git make build-base linux-headers libc-d
                                 libzmq-static libsodium-static gcc
 
 
+RUN mkdir -p /root/.ssh && ssh-keyscan github.com >> /root/.ssh/known_hosts
+RUN git config --global url."[email protected]:".insteadOf "https://github.com/"
+ENV GOPRIVATE=github.com/babylonchain/*
+
 # Build
 WORKDIR /go/src/github.com/babylonchain/finality-provider
 # Cache dependencies
 COPY go.mod go.sum /go/src/github.com/babylonchain/finality-provider/
-RUN go mod download
+RUN --mount=type=secret,id=sshKey,target=/root/.ssh/id_rsa go mod download
 # Copy the rest of the files
 COPY ./ /go/src/github.com/babylonchain/finality-provider/
 

Makefile

@@ -2,6 +2,8 @@ BUILDDIR ?= $(CURDIR)/build
 TOOLS_DIR := tools
 
 BABYLON_PKG := github.com/babylonchain/babylon/cmd/babylond
+WASMD_PKG   := github.com/CosmWasm/wasmd/cmd/wasmd
+BCD_PKG     := github.com/babylonchain/babylon-sdk/demo/cmd/bcd
 
 GO_BIN := ${GOPATH}/bin
 BTCD_BIN := $(GO_BIN)/btcd
@@ -18,6 +20,11 @@ build_tags := $(BUILD_TAGS)
 build_args := $(BUILD_ARGS)
 
 PACKAGES_E2E=$(shell go list ./... | grep '/itest')
+# need to specify the full path to fix issue where logs won't stream to stdout
+# due to multiple packages found
+# context: https://github.com/golang/go/issues/24929
+PACKAGES_E2E_OP=$(shell go list -tags=e2e_op ./... | grep '/itest/opstackl2')
+PACKAGES_E2E_BCD=$(shell go list -tags=e2e_bcd ./... | grep '/itest/cosmwasm/bcd')
 
 ifeq ($(LINK_STATICALLY),true)
 	ldflags += -linkmode=external -extldflags "-Wl,-z,muldefs -static" -v
@@ -49,18 +56,68 @@ $(BUILDDIR)/:
 	mkdir -p $(BUILDDIR)/
 
 build-docker:
-	$(DOCKER) build --tag babylonchain/finality-provider -f Dockerfile \
+	$(DOCKER) build --secret id=sshKey,src=${BBN_PRIV_DEPLOY_KEY} --tag babylonchain/finality-provider -f Dockerfile \
 		$(shell git rev-parse --show-toplevel)
 
 .PHONY: build build-docker
 
+.PHONY: lint
+lint:
+	golangci-lint run
+
 .PHONY: test
 test:
 	go test ./...
 
-test-e2e:
-	cd $(TOOLS_DIR); go install -trimpath $(BABYLON_PKG)
-	go test -mod=readonly -timeout=25m -v $(PACKAGES_E2E) -count=1 --tags=e2e
+install-babylond:
+	cd $(TOOLS_DIR); \
+	go install -trimpath $(BABYLON_PKG)
+
+install-wasmd:
+	cd $(TOOLS_DIR); \
+	go install -trimpath $(WASMD_PKG)
+
+install-bcd:
+	cd $(TOOLS_DIR); \
+	go install -trimpath $(BCD_PKG)
+
+.PHONY: clean-e2e test-e2e test-e2e-babylon test-e2e-wasmd test-e2e-bcd test-e2e-op
+
+# Clean up environments by stopping processes and removing data directories
+clean-e2e:
+	@pids=$$(ps aux | grep -E 'babylond start|wasmd start|bcd start' | grep -v grep | awk '{print $$2}' | tr '\n' ' '); \
+	if [ -n "$$pids" ]; then \
+		echo $$pids | xargs kill; \
+		echo "Killed processes $$pids"; \
+	else \
+		echo "No processes to kill"; \
+	fi
+	rm -rf ~/.babylond ~/.wasmd ~/.bcd
+
+# Main test target that runs all e2e tests
+test-e2e: test-e2e-babylon test-e2e-wasmd test-e2e-bcd test-e2e-op
+
+test-e2e-babylon: clean-e2e install-babylond
+	@go test -mod=readonly -timeout=25m -v $(PACKAGES_E2E) -count=1 --tags=e2e_babylon
+
+test-e2e-bcd: clean-e2e install-babylond install-bcd
+	@go test -mod=readonly -timeout=25m -v $(PACKAGES_E2E_BCD) -count=1 --tags=e2e_bcd
+
+test-e2e-wasmd: clean-e2e install-babylond install-wasmd
+	@go test -mod=readonly -timeout=25m -v $(PACKAGES_E2E) -count=1 --tags=e2e_wasmd
+
+test-e2e-op: clean-e2e install-babylond
+	@go test -mod=readonly -timeout=25m -v $(PACKAGES_E2E_OP) -count=1 --tags=e2e_op
+
+DEVNET_REPO_URL := https://github.com/babylonchain/op-e2e-devnet
+TARGET_DIR := ./itest/opstackl2/devnet-data
+
+.PHONY: op-e2e-devnet
+op-e2e-devnet:
+	@rm -rf $(TARGET_DIR)
+	@mkdir -p $(TARGET_DIR)
+	@git clone $(DEVNET_REPO_URL) $(TARGET_DIR)
+	@echo "Devnet data downloaded to $(TARGET_DIR)"
 
 ###############################################################################
 ###                                Protobuf                                 ###
@@ -76,7 +133,7 @@ proto-gen:
 
 mock-gen:
 	mkdir -p $(MOCKS_DIR)
-	$(MOCKGEN_CMD) -source=clientcontroller/interface.go -package mocks -destination $(MOCKS_DIR)/babylon.go
+	$(MOCKGEN_CMD) -source=clientcontroller/api/interface.go -package mocks -destination $(MOCKS_DIR)/clientcontroller.go
 
 .PHONY: mock-gen
 

clientcontroller/interface.go → clientcontroller/api/interface.go

@@ -1,34 +1,37 @@
-package clientcontroller
+package api
 
 import (
-	"fmt"
-
 	"cosmossdk.io/math"
 	"github.com/btcsuite/btcd/btcec/v2"
 	"github.com/btcsuite/btcd/btcec/v2/schnorr"
-	"github.com/btcsuite/btcd/chaincfg"
-	"go.uber.org/zap"
 
-	finalitytypes "github.com/babylonchain/babylon/x/finality/types"
-	fpcfg "github.com/babylonchain/finality-provider/finality-provider/config"
 	"github.com/babylonchain/finality-provider/types"
 )
 
-const (
-	babylonConsumerChainName = "babylon"
-)
-
 type ClientController interface {
 	// RegisterFinalityProvider registers a finality provider to the consumer chain
 	// it returns tx hash and error. The address of the finality provider will be
 	// the signer of the msg.
 	RegisterFinalityProvider(
+		chainID string,
+		chainPk []byte,
 		fpPk *btcec.PublicKey,
 		pop []byte,
 		commission *math.LegacyDec,
 		description []byte,
 	) (*types.TxResponse, error)
 
+	// Note: the following queries are only for PoC
+
+	// QueryFinalityProviderSlashed queries if the finality provider is slashed
+	// Note: if the FP wants to get the information from the consumer chain directly, they should add this interface
+	// function in ConsumerController. (https://github.com/babylonchain/finality-provider/pull/335#discussion_r1606175344)
+	QueryFinalityProviderSlashed(fpPk *btcec.PublicKey) (bool, error)
+
+	Close() error
+}
+
+type ConsumerController interface {
 	// CommitPubRandList commits a list of EOTS public randomness the consumer chain
 	// it returns tx hash and error
 	CommitPubRandList(fpPk *btcec.PublicKey, startHeight uint64, numPubRand uint64, commitment []byte, sig *schnorr.Signature) (*types.TxResponse, error)
@@ -44,46 +47,28 @@ type ClientController interface {
 	// QueryFinalityProviderVotingPower queries the voting power of the finality provider at a given height
 	QueryFinalityProviderVotingPower(fpPk *btcec.PublicKey, blockHeight uint64) (uint64, error)
 
-	// QueryFinalityProviderSlashed queries if the finality provider is slashed
-	QueryFinalityProviderSlashed(fpPk *btcec.PublicKey) (bool, error)
-
-	// QueryLatestFinalizedBlocks returns the latest finalized blocks
-	QueryLatestFinalizedBlocks(count uint64) ([]*types.BlockInfo, error)
+	// QueryLatestFinalizedBlock returns the latest finalized block
+	// Note: nil will be returned if the finalized block does not exist
+	QueryLatestFinalizedBlock() (*types.BlockInfo, error)
 
-	// QueryLastCommittedPublicRand returns the last committed public randomness
-	QueryLastCommittedPublicRand(fpPk *btcec.PublicKey, count uint64) (map[uint64]*finalitytypes.PubRandCommitResponse, error)
+	// QueryLastPublicRandCommit returns the last committed public randomness
+	QueryLastPublicRandCommit(fpPk *btcec.PublicKey) (*types.PubRandCommit, error)
 
 	// QueryBlock queries the block at the given height
 	QueryBlock(height uint64) (*types.BlockInfo, error)
 
+	// QueryIsBlockFinalized queries if the block at the given height is finalized
+	QueryIsBlockFinalized(height uint64) (bool, error)
+
 	// QueryBlocks returns a list of blocks from startHeight to endHeight
 	QueryBlocks(startHeight, endHeight, limit uint64) ([]*types.BlockInfo, error)
 
-	// QueryBestBlock queries the tip block of the consumer chain
-	QueryBestBlock() (*types.BlockInfo, error)
+	// QueryLatestBlockHeight queries the tip block height of the consumer chain
+	QueryLatestBlockHeight() (uint64, error)
 
 	// QueryActivatedHeight returns the activated height of the consumer chain
 	// error will be returned if the consumer chain has not been activated
 	QueryActivatedHeight() (uint64, error)
 
 	Close() error
 }
-
-func NewClientController(chainName string, bbnConfig *fpcfg.BBNConfig, netParams *chaincfg.Params, logger *zap.Logger) (ClientController, error) {
-	var (
-		cc  ClientController
-		err error
-	)
-
-	switch chainName {
-	case babylonConsumerChainName:
-		cc, err = NewBabylonController(bbnConfig, netParams, logger)
-		if err != nil {
-			return nil, fmt.Errorf("failed to create Babylon rpc client: %w", err)
-		}
-	default:
-		return nil, fmt.Errorf("unsupported consumer chain")
-	}
-
-	return cc, err
-}