fix config and add ci

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,32 @@
+<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
+v                               ✰  Thanks for creating a PR! ✰    
+v    Before smashing the submit button please review the checkboxes.
+v    If a checkbox is n/a - please still include it but + a little note why
+☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > >  -->
+
+Closes: #XXX
+
+## Description
+
+<!-- Add a description of the changes that this PR introduces and the files that
+are the most critical to review.
+-->
+
+______
+
+For contributor use:
+
+- [ ] Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
+- [ ] Wrote unit
+- [ ] Updated relevant documentation (`docs/`)
+- [ ] Added  relevant `godoc` [comments](https://blog.golang.org/godoc-documenting-go-code).
+- [ ] Added a relevant changelog entry to the `Unreleased` section in `CHANGELOG.md`
+- [ ] Re-reviewed `Files changed` in the Github PR explorer
+
+______
+
+For admin use:
+
+- [ ] Added appropriate labels to PR (ex. `WIP`, `R4R`, `docs`, etc)
+- [ ] Reviewers assigned
+- [ ] Squashed all commits, uses message "Merge pull request #XYZ: [title]"

.github/workflows/build.yml

@@ -0,0 +1,34 @@
+name: Build
+on:
+  pull_request:
+    branches:
+      - main
+      - dev
+
+jobs:
+  cleanup-runs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: rokroskar/workflow-run-cleanup-action@master
+        env:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+    if: "!startsWith(github.ref, 'refs/tags/') && github.ref != 'refs/heads/main'"
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+        with:
+          go-version: 1.21
+          check-latest: true
+      - uses: technote-space/[email protected]
+        id: git_diff
+        with:
+          PATTERNS: |
+            **/**.go
+            go.mod
+            go.sum
+      - run: |
+          make build
+        if: env.GIT_DIFF

.github/workflows/docker-build.yml

@@ -0,0 +1,65 @@
+name: Build docker images 
+
+on:
+  push:
+    branches:
+      - "main"
+      - "dev"
+    tags:
+      - "v*.*.*"
+  pull_request:
+    branches:
+      - "main"
+      - "dev"
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Git fetch everything
+        run: git fetch --prune --unshallow
+      - 
+        name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          # list of Docker images to use as base name for tags
+          images: |
+            ghcr.io/${{ github.repository }}
+
+          # generate Docker tags based on the following events/attributes
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=sha 
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - 
+        name: Login to GHCR
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      -
+        name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          platforms: linux/amd64, linux/arm64
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/lint.yml

@@ -0,0 +1,54 @@
+name: Lint
+# Lint runs golangci-lint over the entire ethermint repository This workflow is
+# run on every pull request and push to main The `golangci` will pass without
+# running if no *.{go, mod, sum} files have been changed.
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - dev
+jobs:
+  golangci:
+    name: Run golangci-lint
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      # Required: setup-go, for all versions v3.0.0+ of golangci-lint
+      - uses: actions/setup-go@v4
+        with:
+          go-version: 1.21
+          check-latest: true
+      - uses: actions/checkout@v3
+      - uses: technote-space/[email protected]
+        with:
+          PATTERNS: |
+            **/**.go
+            go.mod
+            go.sum
+      - uses: golangci/[email protected]
+        with:
+          # Required: the version of golangci-lint is required and must be specified without patch version: we always use the latest patch version.
+          version: latest
+          args: --timeout 10m
+          github-token: ${{ secrets.github_token }}
+        # Check only if there are differences in the source code
+        if: env.GIT_DIFF
+  markdown-lint:
+    name: Run markdown-lint
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/checkout@v3
+      - uses: technote-space/[email protected]
+        with:
+          PATTERNS: |
+            docs/**/*.md
+            README.md
+      - uses: nosborn/[email protected]
+        with:
+          files: .
+          config_file: .markdownlint.yml
+          ignore_path: .markdownlintignore
+        # Check only if there are differences in the source code
+        if: env.GIT_DIFF

.github/workflows/markdown-links.yml

@@ -0,0 +1,30 @@
+name: Check Markdown links
+on: 
+  pull_request:
+    paths:
+      - '**.md'
+  push:
+    branches:
+      - main
+      - dev
+    paths:
+      - '**.md'
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: technote-space/[email protected]
+        id: git_diff
+        with:
+          PATTERNS: |
+            **/**.md
+      - uses: gaurav-nelson/github-action-markdown-link-check@master
+        with:
+          folder-path: "docs"
+          check-modified-files-only: "yes"
+          use-quiet-mode: "yes"
+          base-branch: "dev"
+          config-file: "mlc_config.json"
+        if: env.GIT_DIFF

.github/workflows/proto.yml

@@ -0,0 +1,28 @@
+name: Protobuf
+# Protobuf runs buf (https://buf.build/) lint and check-breakage
+# This workflow is only run when a .proto file has been changed
+on:
+  pull_request:
+    paths:
+      - "proto/**"
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v3
+      - uses: bufbuild/[email protected]
+      - uses: bufbuild/buf-lint-action@v1
+        with:
+          input: "proto"
+
+  break-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: bufbuild/[email protected]
+      - uses: bufbuild/buf-breaking-action@v1
+        with:
+          input: "proto"
+          against: "https://github.com/${{ github.repository }}.git#branch=${{ github.event.pull_request.base.ref }},ref=HEAD~1,subdir=proto"

.golangci.yml

@@ -0,0 +1,75 @@
+run:
+  tests: false
+  # timeout for analysis, e.g. 30s, 5m, default is 1m
+  # timeout: 5m
+
+linters:
+  enable:
+    - bodyclose
+    # - depguard
+    - dogsled
+    - dupl
+    - errcheck
+    - goconst
+    - gocritic
+    - gofumpt
+    - revive
+    - gosec
+    - gosimple
+    - govet
+    - ineffassign
+    - lll
+    - misspell
+    - nakedret
+    - prealloc
+    - exportloopref
+    - staticcheck
+    - stylecheck
+    - typecheck
+    - unconvert
+    - unparam
+    - unused
+    - nolintlint
+    - asciicheck
+    - exportloopref
+    - gofumpt
+    - gomodguard
+    - whitespace
+
+issues:
+  exclude-rules:
+    - path: _test\.go
+      linters:
+        - gosec
+    - linters:
+        - lll
+      source: "https://"
+  max-same-issues: 50
+
+linters-settings:
+  lll:
+    line-length: 200
+  dogsled:
+    max-blank-identifiers: 3
+  golint:
+    min-confidence: 0
+  maligned:
+    suggest-new: true
+  misspell:
+    locale: US
+  nolintlint:
+    allow-unused: false
+    allow-leading-space: true
+    require-explanation: false
+    require-specific: false
+  gofumpt:
+    lang-version: "1.21"
+  gomodguard:
+    blocked:
+      versions: # List of blocked module version constraints
+        - https://github.com/etcd-io/etcd:                            # Blocked module with version constraint
+            version: ">= 3.4.10 || ~3.3.23"                           # Version constraint, see https://github.com/Masterminds/semver#basic-comparisons
+            reason: "CVE-2020-15114; CVE-2020-15136; CVE-2020-15115"  # Reason why the version constraint exists. (Optional)
+        - https://github.com/dgrijalva/jwt-go:                      # Blocked module with version constraint
+            version: ">= 4.0.0-preview1"                           # Version constraint, see https://github.com/Masterminds/semver#basic-comparisons
+            reason: "CVE-2020-26160"  # Reason why the version constraint exists. (Optional)

.markdownlint.yml

@@ -0,0 +1,21 @@
+"default": true
+"MD001": false
+"MD004": false
+"MD007":
+  "indent": 4
+"MD013": false
+"MD024":
+  "siblings_only": true
+"MD025": false
+"MD026":
+  "punctuation": ".;:"
+"MD029": false
+"MD033": false
+"MD034": false
+"MD036": false
+"MD040": false
+"MD041": false
+"MD051": false
+"MD049":
+  "style": "asterisk"
+"no-hard-tabs": false

.markdownlintignore

@@ -0,0 +1,3 @@
+CHANGELOG.md
+docs/api/proto-docs.md
+docs/node_modules

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 b²network
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.