fix: update module structure (#56)

* update structure * feat: make proto gen * fix imports * update proto imports * fix: proto * update cli tests * add sims tests * fix: lint * fix: simulation tests * update sims workflow * fix: sims workflow * fix: sim tests * fix: sim tests * fix: sim tests * fix: build * WIP * fix specs path * add new line in makefile * fix: add working sims tests * fix lint * fix lint * update runism in workflow * add go bin path * remove notify failure & success * fix runsim issue * WIP * WIP * WIP * WIP * WIP * WIP * WIP * add non determinism workflow test * remove comments --------- Co-authored-by: saiteja <[email protected]>
vitwit · Oct 1, 2024 · 0f5b168 · 0f5b168
1 parent df8b31a
commit 0f5b168
Show file tree

Hide file tree

Showing 71 changed files with 1,367 additions and 360 deletions.
diff --git a/.github/workflows/sims.yml b/.github/workflows/sims.yml
@@ -0,0 +1,111 @@
+name: Sims
+# Sims workflow runs multiple types of simulations (nondeterminism, import-export, after-import, multi-seed-short)
+# This workflow will run on all Pull Requests, if a .go, .mod or .sum file have been changed
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ci-${{ github.ref }}-sims
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, 'skip-sims')"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "1.22"
+          check-latest: true
+      - run: make -C simapp build
+
+  install-runsim:
+    permissions:
+      contents: none
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "1.22"
+          check-latest: true
+      - name: Install runsim
+        run: go install github.com/cosmos/tools/cmd/[email protected]
+      - uses: actions/cache@v4
+        with:
+          path: ~/go/bin
+          key: ${{ runner.os }}-go-runsim-binary
+
+  test-sim-nondeterminism:
+    runs-on: ubuntu-latest
+    needs: [build]
+    timeout-minutes: 60
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "1.22"
+          check-latest: true
+      - uses: actions/cache@v4
+        with:
+          path: ~/go/bin
+          key: ${{ runner.os }}-go-runsim-binary
+      - name: test-sim-import-export
+        run: |
+          make test-sim-nondeterminism
+
+  test-sim-import-export:
+    runs-on: ubuntu-latest
+    needs: [build, install-runsim]
+    timeout-minutes: 60
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "1.22"
+          check-latest: true
+      - uses: actions/cache@v4
+        with:
+          path: ~/go/bin
+          key: ${{ runner.os }}-go-runsim-binary
+      - name: test-sim-import-export
+        run: |
+          make test-sim-import-export
+
+  test-sim-after-import:
+    runs-on: ubuntu-latest
+    needs: [build, install-runsim]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "1.22"
+          check-latest: true
+      - uses: actions/cache@v4
+        with:
+          path: ~/go/bin
+          key: ${{ runner.os }}-go-runsim-binary
+      - name: test-sim-after-import
+        run: |
+          make test-sim-after-import
+
+  test-sim-multi-seed-short:
+    runs-on: ubuntu-latest
+    needs: [build, install-runsim]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "1.22"
+          check-latest: true
+      - uses: actions/cache@v4
+        with:
+          path: ~/go/bin
+          key: ${{ runner.os }}-go-runsim-binary
+      - name: test-sim-multi-seed-short
+        run: |
+          make test-sim-multi-seed-short
diff --git a/Makefile b/Makefile
@@ -3,6 +3,8 @@
 DOCKER := $(shell which docker)
 
 export GO111MODULE = on
+SIMAPP = ./simapp/app/
+BINDIR ?= $(GOPATH)/bin
 
 ###############################################################################
 ###                                     e2e                                 ###
@@ -75,6 +77,7 @@ lint-fix:
 GO := go
 TARGET := cada
 BINDIR ?= $(GOPATH)/bin
+CURRENT_DIR = $(shell pwd)
 
 .PHONY: all build install clean
 
@@ -92,7 +95,6 @@ clean:
 	rm -f $(TARGET)
 
 
-
 ###############################################################################
 ###                                    testnet                              ###
 ###############################################################################
@@ -109,12 +111,21 @@ set-testnet-configs:
 ###                           Tests & Simulation                            ###
 ###############################################################################
 
+# make init-simapp initializes a single local node network
+# it is useful for testing and development
+# Usage: make install && make init-simapp && simd start
+# Warning: make init-simapp will remove all data in simapp home directory
+init-simapp:
+	./simapp/init-chain.sh
+
 test: test-unit
 test-all: test-unit test-ledger-mock test-race test-cover
 
 TEST_PACKAGES=./...
 TEST_TARGETS := test-unit test-unit-proto test-ledger-mock test-race test-ledger test-race
 
+include tools/Makefile
+
 # Test runs-specific rules. To add a new test target, just add
 # a new rule, customise ARGS or TEST_PACKAGES ad libitum, and
 # append the new rule to the TEST_TARGETS list.
@@ -140,3 +151,80 @@ else
 endif
 
 .PHONY: run-tests test test-all $(TEST_TARGETS)
+
+test-sim-nondeterminism:
+	@echo "Running non-determinism test..."
+	@cd ${CURRENT_DIR}/simapp/app && go test -mod=readonly -run TestAppStateDeterminism -Enabled=true \
+		-NumBlocks=20 -BlockSize=200 -Commit=true -Period=0 -v -timeout 24h
+
+test-sim-custom-genesis-fast:
+	@echo "Running custom genesis simulation..."
+	@echo "By default, ${HOME}/.cada/config/genesis.json will be used."
+	@cd ${CURRENT_DIR}/simapp/app && go test -mod=readonly -run TestFullAppSimulation -Genesis=${HOME}/.cada/config/genesis.json \
+		-Enabled=true -NumBlocks=100 -BlockSize=200 -Commit=true -Seed=99 -Period=5 -v -timeout 24h
+
+test-sim-import-export: runsim
+	@echo "Running application import/export simulation. This may take several minutes..."
+	@cd ${CURRENT_DIR}/simapp/app && $(BINDIR)/runsim -Jobs=4 -SimAppPkg=. -ExitOnFail 50 5 TestAppImportExport
+
+test-sim-after-import: runsim
+	@echo "Running application simulation-after-import. This may take several minutes..."
+	@cd ${CURRENT_DIR}/simapp/app && $(BINDIR)/runsim -Jobs=4 -SimAppPkg=. -ExitOnFail 50 5 TestAppSimulationAfterImport
+
+test-sim-custom-genesis-multi-seed: runsim
+	@echo "Running multi-seed custom genesis simulation..."
+	@echo "By default, ${HOME}/.cada/config/genesis.json will be used."
+	@cd ${CURRENT_DIR}/simapp/app && $(BINDIR)/runsim -Genesis=${HOME}/.cada/config/genesis.json -SimAppPkg=. -ExitOnFail 400 5 TestFullAppSimulation
+
+test-sim-multi-seed-long: runsim
+	@echo "Running long multi-seed application simulation. This may take awhile!"
+	@cd ${CURRENT_DIR}/simapp/app && $(BINDIR)/runsim -Jobs=4 -SimAppPkg=. -ExitOnFail 500 50 TestFullAppSimulation
+
+test-sim-multi-seed-short: runsim
+	@echo "Running short multi-seed application simulation. This may take awhile!"
+	@cd ${CURRENT_DIR}/simapp/app && $(BINDIR)/runsim -Jobs=4 -SimAppPkg=. -ExitOnFail 50 10 TestFullAppSimulation
+
+test-sim-benchmark-invariants:
+	@echo "Running simulation invariant benchmarks..."
+	cd ${CURRENT_DIR}/simapp/app && @go test -mod=readonly -benchmem -bench=BenchmarkInvariants -run=^$ \
+	-Enabled=true -NumBlocks=1000 -BlockSize=200 \
+	-Period=1 -Commit=true -Seed=57 -v -timeout 24h
+
+.PHONY: \
+test-sim-nondeterminism \
+test-sim-custom-genesis-fast \
+test-sim-import-export \
+test-sim-after-import \
+test-sim-custom-genesis-multi-seed \
+test-sim-multi-seed-short \
+test-sim-multi-seed-long \
+test-sim-benchmark-invariants
+
+SIM_NUM_BLOCKS ?= 500
+SIM_BLOCK_SIZE ?= 200
+SIM_COMMIT ?= true
+
+test-sim-benchmark:
+	@echo "Running application benchmark for numBlocks=$(SIM_NUM_BLOCKS), blockSize=$(SIM_BLOCK_SIZE). This may take awhile!"
+	@go test -mod=readonly -benchmem -run=^$$ $(APP) -bench ^BenchmarkFullAppSimulation$$  \
+		-Enabled=true -NumBlocks=$(SIM_NUM_BLOCKS) -BlockSize=$(SIM_BLOCK_SIZE) -Commit=$(SIM_COMMIT) -timeout 24h
+
+test-sim-profile:
+	@echo "Running application benchmark for numBlocks=$(SIM_NUM_BLOCKS), blockSize=$(SIM_BLOCK_SIZE). This may take awhile!"
+	@go test -mod=readonly -benchmem -run=^$$ $(APP) -bench ^BenchmarkFullAppSimulation$$ \
+		-Enabled=true -NumBlocks=$(SIM_NUM_BLOCKS) -BlockSize=$(SIM_BLOCK_SIZE) -Commit=$(SIM_COMMIT) -timeout 24h -cpuprofile cpu.out -memprofile mem.out
+
+.PHONY: test-sim-profile test-sim-benchmark
+
+test-cover:
+	@export VERSION=$(VERSION); bash -x scripts/test_cover.sh
+.PHONY: test-cover
+
+test-rosetta:
+	docker build -t rosetta-ci:latest -f contrib/rosetta/node/Dockerfile .
+	docker-compose -f contrib/rosetta/docker-compose.yaml up --abort-on-container-exit --exit-code-from test_rosetta --build
+.PHONY: test-rosetta
+
+benchmark:
+	@go test -mod=readonly -bench=. $(PACKAGES_NOSIMULATION)
+.PHONY: benchmark
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ CADA is a module designed to connect Cosmos sovereign chains with the Avail netw
 
 # Integration Guide
 
-To integrate the CADA module into your application, follow the steps outlined in the [integration guide](./integration_docs/README.md)
+To integrate the CADA module into your application, follow the steps outlined in the [integration guide](./x/cada/integration_docs/README.md)
 
 Note: Ensure that the Avail light client URL is correctly configured for the module to function as expected. For instructions on setup Avail locally, please refer to [this documentation](https://github.com/rollkit/avail-da?tab=readme-ov-file#avail-da).
 
@@ -31,6 +31,7 @@ These are main components in the workflow:
 The core functionality of the **CADA** module is integrated with and operates on the Cosmos blockchain.
 
 In the CADA module:
+
 - At each block interval, the `PreBlocker` ABCI method sends a request to the `Relayer`, specifying the range of block heights that are ready to be posted to the **Avail** Data Availability (DA) network.
 ![Data Submission](https://github.com/user-attachments/assets/fc4d23cc-f6bd-4210-8407-47a57adcc290)
 
@@ -40,6 +41,7 @@ In the CADA module:
 ![Vote Extension](https://github.com/user-attachments/assets/ea5b10ab-fb64-4ed0-8761-44675a852a01)
 
 ## 2. Relayer
+
 The **Relayer** facilitates communication between the Cosmos Chain, the Avail light client, and the Cosmos Provider.
 
 - **Data Submission**: The relayer is responsible for fetching block data from the Cosmos provider and posting it to the Avail light client via an HTTP request.
@@ -48,21 +50,21 @@ The **Relayer** facilitates communication between the Cosmos Chain, the Avail li
 - **Data Verification**: During verification, the relayer communicates with the Avail light client to confirm whether the data is truly available at the specified height.
 
 
-
 ## 3. Avail Light Node
+
 The **Avail Light Client** allows interaction with the Avail DA network without requiring a full node, and without having to trust remote peers. It leverages **Data Availability Sampling (DAS)**, which the light client performs on every newly created block.
 
 - The chain communicates with the Avail light client via the relayer during the data submission and data availability verification processes.
 
 Find more details about the Avail Light Client [here](https://docs.availproject.org/docs/operate-a-node/run-a-light-client/Overview).
 
 ## 4. Cosmos Provider
+
 The **Cosmos Provider** is responsible for fetching block data via RPC so that the data can be posted to Avail for availability checks.
 
 
 # Workflow
 
-
 - At each block interval, a request is sent from the `PreBlocker` ABCI method to the Keeper, specifying the range of block heights that are ready to be posted to the `Avail` DA network.
 - The range of block heights should be from `provenHeight + 1` to `min(provenHeight + MaxBlocksLimitForBlob, CurrentBlockHeight)`.
 

diff --git a/chainclient/broadcast_tx.go b/chainclient/broadcast_tx.go
@@ -12,7 +12,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/crypto/keyring"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
-	"github.com/vitwit/avail-da-module/types"
+	"github.com/vitwit/avail-da-module/x/cada/types"
 )
 
 // GetBinPath returns the path to the cada home directory within the user's home directory.

diff --git a/chainclient/create_client.go b/chainclient/create_client.go
@@ -23,8 +23,6 @@ const (
 	defaultGasLimit      = 300000
 )
 
-// var availdHomePath = xfilepath.JoinFromHome(xfilepath.Path("availsdk"))
-
 func NewClientCtx(kr keyring.Keyring, c *cometrpc.HTTP, chainID string,
 	cdc codec.BinaryCodec, homepath string, fromAddress sdk.AccAddress,
 ) client.Context {