Initial commit

.github/workflows/actions.yaml

@@ -0,0 +1,38 @@
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - 'master'
+      - 'main'
+
+env:
+  CI_JOB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+jobs:
+  converge:
+    name: Converge
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Install werf
+        uses: werf/actions/[email protected]
+
+      - name: Log in to registry
+        # This is where you will update the personal access token to GITHUB_TOKEN
+        run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u $ --password-stdin
+
+      - name: Run echo
+        run: |
+          werf version
+          docker version
+          echo $GITHUB_REPOSITORY
+          echo $GITHUB_SHA
+      - name: Run Build
+        run: |
+          . $(werf ci-env github --as-file)
+          werf export service --tag ghcr.io/$GITHUB_REPOSITORY:$GITHUB_SHA

.github/workflows/code-review.yaml

@@ -0,0 +1,22 @@
+on:
+  pull_request:
+
+permissions:
+  checks: write
+  contents: read
+  pull-requests: write
+
+jobs:
+  lint:
+    name: code-review
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: golangci-lint
+        uses: reviewdog/action-golangci-lint@v2
+        with:
+          reporter: github-pr-review
+          cache: false

.github/workflows/gh-pages.yaml

@@ -0,0 +1,34 @@
+# Builds the docs and deploys to GitHub pages
+#
+# https://github.com/actions/setup-node
+# Using https://github.com/marketplace/actions/deploy-to-github-pages
+name: Deploy to Github pages
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+      - master
+
+jobs:
+  deploy_pages:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - run: |
+          cd ./docs
+          npm install
+          npm run build
+
+      - run: touch docs/.nojekyll
+      - name: Deploy docs 🚀
+        uses: JamesIves/github-pages-deploy-action@releases/v3
+        with:
+          BRANCH: gh-pages # The branch the action should deploy to.
+          FOLDER: docs/web_deploy # The folder the action should deploy.

.github/workflows/tag.yaml

@@ -0,0 +1,37 @@
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+env:
+  CI_JOB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+jobs:
+  converge:
+    name: Converge
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Install werf
+        uses: werf/actions/[email protected]
+
+      - name: Log in to registry
+        # This is where you will update the personal access token to GITHUB_TOKEN
+        run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u $ --password-stdin
+
+      - name: Run echo
+        run: |
+          werf version
+          docker version
+          echo $GITHUB_REPOSITORY
+          echo $GITHUB_REF_NAME
+      - name: Run Build
+        run: |
+          . $(werf ci-env github --as-file)
+          werf export service --tag ghcr.io/$GITHUB_REPOSITORY:$GITHUB_REF_NAME

.gitignore

@@ -0,0 +1,6 @@
+.vscode/
+.idea/
+config.*.yaml
+docs/node_modules
+docs/web_deploy
+vendor/

.golangci.yml

@@ -0,0 +1,35 @@
+linters:
+  enable:
+    - asciicheck
+    - bodyclose
+    - dogsled
+    - dupl
+    - errcheck
+    - exportloopref
+    - goconst
+    - gofmt
+    - goimports
+    - revive
+    - gosimple
+    - govet
+    - ineffassign
+    - misspell
+    - nakedret
+    - nolintlint
+    - prealloc
+    - staticcheck
+    - stylecheck
+    - typecheck
+    - unconvert
+    - unused
+
+issues:
+  max-same-issues: 50
+
+linters-settings:
+  dogsled:
+    max-blank-identifiers: 3
+  golint:
+    min-confidence: 0
+  maligned:
+    suggest-new: true

Dockerfile

@@ -0,0 +1,17 @@
+FROM golang:1.22-alpine as buildbase
+
+RUN apk add git build-base
+
+WORKDIR /go/src/github.com/rarimo/voting-relayer
+COPY vendor .
+COPY . .
+
+RUN GOOS=linux go build  -o /usr/local/bin/voting-relayer /go/src/github.com/rarimo/voting-relayer
+
+
+FROM alpine:3.9
+
+COPY --from=buildbase /usr/local/bin/voting-relayer /usr/local/bin/voting-relayer
+RUN apk add --no-cache ca-certificates
+
+ENTRYPOINT ["voting-relayer"]

README.md

@@ -0,0 +1,90 @@
+# voting-relayer
+
+## Description
+
+Relayer service that makes calls to the smart contracts. Now it is used to work with such endpoints:
+  - `/integrations/voting-relayer/v1/register` - it takes calldata in hex encoided format from Rarime mobile applications and makes call to the smart contract.
+
+    Request body example:
+    ```json
+    {
+      "data": {
+        "tx_data": "hex_encoded_call_data",
+        "destination": "contract_address,optional"
+      }
+    }
+    ```
+
+## Install
+
+  ```
+  git clone github.com/rarimo/voting-relayer
+  cd voting-relayer
+  go build main.go
+  export KV_VIPER_FILE=./config.yaml
+  ./main run service
+  ```
+
+## Documentation
+
+We do use openapi:json standard for API. We use swagger for documenting our API.
+
+To open online documentation, go to [swagger editor](http://localhost:8080/swagger-editor/) here is how you can start it
+```
+  cd docs
+  npm install
+  npm start
+```
+To build documentation use `npm run build` command,
+that will create open-api documentation in `web_deploy` folder.
+
+To generate resources for Go models run `./generate.sh` script in root folder.
+use `./generate.sh --help` to see all available options.
+
+Note: if you are using Gitlab for building project `docs/spec/paths` folder must not be
+empty, otherwise only `Build and Publish` job will be passed.  
+
+## Config
+```yaml
+  network:
+    rpc: "" # (url) RPC API endpoint | required
+    registration: "" # (hex) target contract address | required
+    private_key: "" # (hex without 0x) ECDSA secp256k1 private key for sign transactions
+    vault_address: "http://127.0.0.1:8200" # (url) vault address
+    vault_mount_path: "secret_data" # (string)
+    whitelist: # (list of hex addresses) specify which contracts can be passed in `destination` field in request
+      - "0x123...123"
+      - "0x123...123"
+```
+ENV
+```
+  VAULT_TOKEN (will be cleared after start service)
+```
+There must be specified or private key, or vault address and path. If specified both, then will be used private_key from config.
+
+## Running from docker 
+
+Make sure that docker installed.
+
+use `docker run ` with `-p 8080:80` to expose port 80 to 8080
+
+  ```
+  docker build -t github.com/rarimo/voting-relayer .
+  docker run -e KV_VIPER_FILE=/config.yaml github.com/rarimo/voting-relayer
+  ```
+
+## Running from Source
+
+* Set up environment value with config file path `KV_VIPER_FILE=./config.yaml`
+* Provide valid config file
+* Launch the service with `run service` command
+
+
+
+### Third-party services
+
+
+## Contact
+
+Responsible 
+The primary contact for this project is  [//]: # (TODO: place link to your telegram and email)

config.yaml

@@ -0,0 +1,29 @@
+network:
+  rpc: ""
+  registration: ""
+  lightweight_state: ""
+  private_key: ""
+  vault_address: "https://127.0.0.1:8200"
+  vault_mount_path: "secret_data"
+  whitelist: 
+    - 0x123...123
+    - 0x123...123
+    - 0x123...123
+    - 0x123...123
+    - 0x123...123
+    - 0x123...123
+    - 0x123...123
+
+log:
+  level: debug
+  disable_sentry: true
+
+listener:
+  addr: :8000
+
+cop:
+  disabled: true
+  endpoint: "http://..."
+  upstream: "http://..."
+  service_name: voting-relayer
+  service_port: 80

docs/.redoclyrc

@@ -0,0 +1,9 @@
+
+apiTitle: voting-relayer
+splitSpec: true
+codeSamples: false
+swaggerUI: true
+travis: true
+repo: tokend/notifications/notifications-router-svc
+oasVersion: 1.0.0
+

docs/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Distributed Lab
+
+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.