Add x/escrow

.github/workflows/module.yml

@@ -0,0 +1,81 @@
+name: Check Module
+on:
+  workflow_call:
+    inputs:
+      name:
+        required: true
+        type: string
+      timeout-minutes:
+        required: false
+        type: number
+        default: 30
+    secrets:
+      sonar-token:
+        required: true
+env:
+  target: x-${{ inputs.name }}
+  path: x/${{ inputs.name }}
+jobs:
+  go-lint:
+    name: go lint
+    runs-on: ubuntu-latest
+    timeout-minutes: ${{ inputs.timeout-minutes }}
+    steps:
+    - uses: actions/checkout@v4
+    - name: Configure
+      run: cmake -S . -B build -D USE_DOCKER=ON -D UID=$(id -u) -D GID=$(id -g) -D FIX_IS_ERROR=ON
+    - name: Lint
+      run: cmake --build build --target go_lint_${{ env.target }}
+  go-build:
+    name: go build
+    runs-on: ubuntu-latest
+    timeout-minutes: ${{ inputs.timeout-minutes }}
+    steps:
+    - uses: actions/checkout@v4
+    - name: Configure
+      run: cmake -S . -B build -D USE_DOCKER=ON -D UID=$(id -u) -D GID=$(id -g) -D FIX_IS_ERROR=ON
+    - name: Build
+      run: cmake --build build --target go_build_${{ env.target }}
+  go-test:
+    name: go test
+    runs-on: ubuntu-latest
+    timeout-minutes: ${{ inputs.timeout-minutes }}
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+    - name: Configure
+      run: cmake -S . -B build -D USE_DOCKER=ON -D UID=$(id -u) -D GID=$(id -g) -D FIX_IS_ERROR=ON
+    - name: Install builders
+      run: cmake --build build --target install_builders
+    - name: Test
+      run: |
+        VERBOSE=1 ctest --test-dir build --output-on-failure --stop-on-failure -R ${{ env.target }}
+        mv build/${{ env.path }}/docker/${{ env.path }}/cover.out ${{ env.path }}/
+    - name: SonarCloud Scan
+      uses: SonarSource/sonarcloud-github-action@master
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+        SONAR_TOKEN: ${{ secrets.sonar-token }}
+      with:
+        projectBaseDir: ${{ env.path }}/
+  buf-format:
+    name: buf format
+    runs-on: ubuntu-latest
+    timeout-minutes: ${{ inputs.timeout-minutes }}
+    steps:
+    - uses: actions/checkout@v4
+    - name: Configure
+      run: cmake -S . -B build -D USE_DOCKER=ON -D UID=$(id -u) -D GID=$(id -g) -D FIX_IS_ERROR=ON
+    - name: Lint
+      run: cmake --build build --target buf_format_${{ env.target }}
+  buf-lint:
+    name: buf lint
+    runs-on: ubuntu-latest
+    timeout-minutes: ${{ inputs.timeout-minutes }}
+    steps:
+    - uses: actions/checkout@v4
+    - name: Configure
+      run: cmake -S . -B build -D USE_DOCKER=ON -D UID=$(id -u) -D GID=$(id -g) -D FIX_IS_ERROR=ON
+    - name: Lint
+      run: cmake --build build --target buf_lint_${{ env.target }}

.github/workflows/modules.yml

@@ -0,0 +1,21 @@
+name: Check Modules
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+jobs:
+  check-modules:
+    name: x-${{ matrix.name }}
+    strategy:
+      matrix:
+        include:
+        - name: test
+          sonar-token: SONAR_TOKEN_X_TEST
+        - name: escrow
+          sonar-token: SONAR_TOKEN_X_ESCROW
+    uses: ./.github/workflows/module.yml
+    with:
+      name: ${{ matrix.name }}
+    secrets:
+      sonar-token: ${{ secrets[matrix.sonar-token] }}

.gitignore

@@ -13,3 +13,6 @@
 
 # Dependency directories (remove the comment below to include it)
 # vendor/
+
+# Build
+/build

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+
+- Add x/escrow prototype (#2).
+- Add x/test prototype (#2).

CMakeLists.txt

@@ -0,0 +1,17 @@
+cmake_minimum_required(VERSION 3.25.1)
+
+option(CMAKE_COLOR_DIAGNOSTICS
+  "Enable/Disable color output during build.")
+
+project(andromeda
+  LANGUAGES NONE
+)
+enable_testing()
+
+add_subdirectory(builders)
+
+add_subdirectory(app)
+add_subdirectory(cmd/and)
+
+add_subdirectory(x/escrow)
+add_subdirectory(x/test)

README.md

@@ -1 +1,4 @@
-# andromeda
+# andromeda
+
+This project provides several [modules](x/README.md) based on
+[Cosmos SDK](https://github.com/cosmos/cosmos-sdk).

app/.golangci.yaml

@@ -0,0 +1,38 @@
+run:
+  timeout: 5m
+linters:
+  enable:
+  - depguard
+  - dogsled
+  - exportloopref
+  - goconst
+  - gocritic
+  - gofumpt
+  - gosec
+  - misspell
+  - nakedret
+  - nolintlint
+  - revive
+  - stylecheck
+  - unconvert
+
+linters-settings:
+  gci:
+    custom-order: true
+    sections:
+    - standard
+    - default
+    - prefix(cosmossdk.io)
+    - prefix(github.com/cosmos/cosmos-sdk)
+    - prefix(github.com/0tech/andromeda)
+  depguard:
+    rules:
+      all:
+        allow:
+        - $gostd
+        - github.com/stretchr/testify
+        - github.com/cometbft/cometbft
+        - cosmossdk.io
+        - github.com/cosmos/cosmos-db
+        - github.com/cosmos/cosmos-sdk
+        - github.com/0tech/andromeda

app/CMakeLists.txt

@@ -0,0 +1,8 @@
+project(app
+  LANGUAGES NONE
+)
+
+add_go_tidy()
+add_go_lint()
+add_go_build()
+add_go_test()

app/abci.go

@@ -0,0 +1,84 @@
+package app
+
+import (
+	"bytes"
+	"crypto/rand"
+	"encoding/json"
+	"fmt"
+
+	abci "github.com/cometbft/cometbft/abci/types"
+
+	"github.com/cosmos/cosmos-sdk/baseapp"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+)
+
+type (
+	// VoteExtensionHandler defines a dummy vote extension handler for SimApp.
+	//
+	// NOTE: This implementation is solely used for testing purposes. DO NOT use
+	// in a production application!
+	VoteExtensionHandler struct{}
+
+	// VoteExtension defines the structure used to create a dummy vote extension.
+	VoteExtension struct {
+		Hash   []byte
+		Height int64
+		Data   []byte
+	}
+)
+
+func NewVoteExtensionHandler() *VoteExtensionHandler {
+	return &VoteExtensionHandler{}
+}
+
+func (h *VoteExtensionHandler) SetHandlers(bApp *baseapp.BaseApp) {
+	bApp.SetExtendVoteHandler(h.ExtendVote())
+	bApp.SetVerifyVoteExtensionHandler(h.VerifyVoteExtension())
+}
+
+func (h *VoteExtensionHandler) ExtendVote() sdk.ExtendVoteHandler {
+	return func(_ sdk.Context, req *abci.RequestExtendVote) (*abci.ResponseExtendVote, error) {
+		buf := make([]byte, 1024)
+
+		_, err := rand.Read(buf)
+		if err != nil {
+			return nil, fmt.Errorf("failed to generate random vote extension data: %w", err)
+		}
+
+		ve := VoteExtension{
+			Hash:   req.Hash,
+			Height: req.Height,
+			Data:   buf,
+		}
+
+		bz, err := json.Marshal(ve)
+		if err != nil {
+			return nil, fmt.Errorf("failed to encode vote extension: %w", err)
+		}
+
+		return &abci.ResponseExtendVote{VoteExtension: bz}, nil
+	}
+}
+
+func (h *VoteExtensionHandler) VerifyVoteExtension() sdk.VerifyVoteExtensionHandler {
+	return func(ctx sdk.Context, req *abci.RequestVerifyVoteExtension) (*abci.ResponseVerifyVoteExtension, error) {
+		var ve VoteExtension
+
+		if err := json.Unmarshal(req.VoteExtension, &ve); err != nil {
+			return &abci.ResponseVerifyVoteExtension{Status: abci.ResponseVerifyVoteExtension_REJECT}, nil
+		}
+
+		switch {
+		case req.Height != ve.Height:
+			return &abci.ResponseVerifyVoteExtension{Status: abci.ResponseVerifyVoteExtension_REJECT}, nil
+
+		case !bytes.Equal(req.Hash, ve.Hash):
+			return &abci.ResponseVerifyVoteExtension{Status: abci.ResponseVerifyVoteExtension_REJECT}, nil
+
+		case len(ve.Data) != 1024:
+			return &abci.ResponseVerifyVoteExtension{Status: abci.ResponseVerifyVoteExtension_REJECT}, nil
+		}
+
+		return &abci.ResponseVerifyVoteExtension{Status: abci.ResponseVerifyVoteExtension_ACCEPT}, nil
+	}
+}