Tezosconnector base

.dockerignore

@@ -0,0 +1,3 @@
+# IDE configs
+.vscode
+.idea

.github/workflows/go.yml

@@ -0,0 +1,24 @@
+name: Go
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.19
+
+      - name: Build and Test
+        run: make

.gitignore

@@ -0,0 +1,10 @@
+**/*.jar
+firefly-tezosconnect
+coverage.txt
+**/debug.test
+.DS_Store
+__debug*
+.leveldb
+.vscode/*.log
+*.iml
+.idea/

.golangci.yml

@@ -0,0 +1,35 @@
+run:
+  tests: false
+  skip-dirs:
+    - "mocks"
+linters-settings:
+  gocritic:
+    enabled-checks: []
+    disabled-checks:
+      - regexpMust
+linters:
+  disable-all: true
+  enable:
+    - bodyclose
+    - depguard
+    - dogsled
+    - errcheck
+    - goconst
+    - gocritic
+    - gocyclo
+    - gofmt
+    - goimports
+    - goprintffuncname
+    - gosec
+    - gosimple
+    - govet
+    - ineffassign
+    - misspell
+    - nakedret
+    - revive
+    - staticcheck
+    - stylecheck
+    - typecheck
+    - unconvert
+    - unparam
+    - unused

.vscode/launch.json

@@ -0,0 +1,22 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Run tezosconnect",
+            "type": "go",
+            "request": "launch",
+            "mode": "auto",
+            "program": "${workspaceFolder}/tezosconnect/main.go",
+            "args": [
+              "-f",
+              "${workspaceFolder}/tezosconnect_config.yml"
+            ],
+            "env": {
+              "FIREFLY_PERSISTENCE_LEVELDB_PATH": "${workspaceFolder}/.leveldb"
+            }
+          }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,54 @@
+{
+    "go.formatFlags": [
+      "-s"
+    ],
+    "go.lintTool": "golangci-lint",
+    "cSpell.words": [
+      "btcec",
+      "bytecode",
+      "ccache",
+      "Debugf",
+      "dklen",
+      "ethsigner",
+      "ethtypes",
+      "tezosconnect",
+      "ffcapi",
+      "ffconnector",
+      "ffconnectormocks",
+      "FFCPI",
+      "ffcserver",
+      "ffcservermocks",
+      "ffresty",
+      "fftm",
+      "fftypes",
+      "GJSON",
+      "httpserver",
+      "hyperledger",
+      "Infof",
+      "jsonrpcmocks",
+      "Kaleido",
+      "kdfparams",
+      "Keccak",
+      "keystorev",
+      "logrus",
+      "Nowarn",
+      "policyengine",
+      "policyengines",
+      "resty",
+      "rpcbackendmocks",
+      "secp",
+      "signerconfig",
+      "signermsgs",
+      "sigs",
+      "stretchr",
+      "Tracef",
+      "ufixed",
+      "unmarshalled",
+      "unmarshalling",
+      "Vyper",
+      "Warnf",
+      "wsclient"
+    ],
+    "go.testTimeout": "10s"
+  }
+

Dockerfile

@@ -0,0 +1,23 @@
+FROM golang:1.19-buster AS builder
+ARG BUILD_VERSION
+ENV BUILD_VERSION=${BUILD_VERSION}
+ADD . /tezosconnect
+WORKDIR /tezosconnect
+RUN make
+
+# Copy the migrations from FFTM down into our local migrations directory
+RUN DB_MIGRATIONS_DIR=$(go list -f '{{.Dir}}' github.com/hyperledger/firefly-transaction-manager/pkg/ffcapi | sed 's|pkg/ffcapi|db|') \
+ && cp -R $DB_MIGRATIONS_DIR db
+
+FROM debian:buster-slim
+WORKDIR /tezosconnect
+RUN apt update -y \
+ && apt install -y curl jq \
+ && rm -rf /var/lib/apt/lists/* \
+ && curl -sL "https://github.com/golang-migrate/migrate/releases/download/$(curl -sL https://api.github.com/repos/golang-migrate/migrate/releases/latest | jq -r '.name')/migrate.linux-amd64.tar.gz" | tar xz \
+ && chmod +x ./migrate \
+ && mv ./migrate /usr/bin/migrate
+COPY --from=builder /tezosconnect/firefly-tezosconnect /usr/bin/tezosconnect
+COPY --from=builder /tezosconnect/db/ /tezosconnect/db/
+
+ENTRYPOINT [ "/usr/bin/tezosconnect" ]

Makefile

@@ -0,0 +1,47 @@
+VGO=go
+GOFILES := $(shell find cmd internal -name '*.go' -print)
+GOBIN := $(shell $(VGO) env GOPATH)/bin
+LINT := $(GOBIN)/golangci-lint
+MOCKERY := $(GOBIN)/mockery
+
+.DELETE_ON_ERROR:
+
+all: build test go-mod-tidy
+test: deps
+		$(VGO) test ./internal/... ./cmd/... -cover -coverprofile=coverage.txt -covermode=atomic -timeout=30s
+coverage.html:
+		$(VGO) tool cover -html=coverage.txt
+coverage: test coverage.html
+lint: ${LINT}
+		$(LINT) run -v --timeout 5m
+${MOCKERY}:
+		$(VGO) install github.com/vektra/mockery/[email protected]
+${LINT}:
+		$(VGO) install github.com/golangci/golangci-lint/cmd/[email protected]
+mockpaths:
+		$(eval FFTM_PATH := $(shell $(VGO) list -f '{{.Dir}}' github.com/hyperledger/firefly-transaction-manager/pkg/fftm))
+		$(eval TEZOS_CLIENT_PATH := $(shell $(VGO) list -f '{{.Dir}}' blockwatch.cc/tzgo/rpc))
+
+define makemock
+mocks: mocks-$(strip $(1))-$(strip $(2))
+mocks-$(strip $(1))-$(strip $(2)): ${MOCKERY} mockpaths
+	${MOCKERY} --case underscore --dir $(1) --name $(2) --outpkg $(3) --output mocks/$(strip $(3))
+endef
+
+$(eval $(call makemock, $$(FFTM_PATH), Manager, fftmmocks))
+$(eval $(call makemock, $$(TEZOS_CLIENT_PATH), RpcClient, tzrpcbackendmocks))
+
+firefly-tezosconnect: ${GOFILES}
+		$(VGO) build -o ./firefly-tezosconnect -ldflags "-X main.buildDate=`date -u +\"%Y-%m-%dT%H:%M:%SZ\"` -X main.buildVersion=$(BUILD_VERSION)" -tags=prod -v ./tezosconnect
+go-mod-tidy: .ALWAYS
+		$(VGO) mod tidy
+build: firefly-tezosconnect
+.ALWAYS: ;
+clean:
+		$(VGO) clean
+deps:
+		$(VGO) get ./tezosconnect
+reference:
+		$(VGO) test ./cmd -timeout=10s -tags docs
+docker:
+		docker build --build-arg BUILD_VERSION=${BUILD_VERSION} ${DOCKER_ARGS} -t hyperledger/firefly-tezosconnect .

README.md

@@ -0,0 +1,50 @@
+# Hyperledger FireFly Tezos Connector
+
+This repo provides a reference implementation of the FireFly Connector API (FFCAPI)
+for Tezos blockchain.
+
+See the [Hyperledger Firefly Documentation](https://hyperledger.github.io/firefly/overview/public_vs_permissioned.html#firefly-architecture-for-public-chains)
+and the [FireFly Transaction Manager](https://github.com/hyperledger/firefly-transaction-manager) repository for
+more information.
+
+# License
+
+Apache 2.0
+
+## Transaction signing
+
+Tezosconnect leverages remote transaction signing through a powerful 'signatory' service, offering compatibility with multiple key management solutions. With the flexibility to use AWS KMS, Azure KMS, GCP KMS, Yubi HSM, etc. for transaction signing, you can secure your blockchain transactions efficiently and conveniently.
+
+More info at: https://signatory.io/
+
+## Configuration
+
+For a full list of configuration options see [config.md](./config.md)
+
+## Example configuration
+
+```yaml
+connector:
+  blockchain:
+    rpc: https://rpc.ghost.tzstats.com
+    network: ghostnet
+    signatory: http://localhost:6732
+```
+
+## Blockchain node compatibility
+
+For Tezos connector to function properly, you should check the blockchain node supports the following RPC Methods:
+
+### Chains
+- `GET /chains/<chain_id>/blocks/<block_id>/hash`
+- `GET /chains/<chain_id>/blocks/<block_id>/operations/<list_offset>`
+- `GET /chains/<chain_id>/blocks/<block_id>/operations/<list_offset>/<operation_offset>`
+- `POST /chains/<chain_id>/blocks/<block_id>/helpers/forge/operations`
+- `POST /chains/<chain_id>/blocks/<block_id>/helpers/scripts/simulate_operation`
+- `POST /chains/<chain_id>/blocks/<block_id>/helpers/scripts/run_operation`
+
+### Block monitoring
+- `GET /monitor/heads/<chain_id>`
+
+### Injection
+- `POST /injection/operation`

cmd/config.go

@@ -0,0 +1,24 @@
+package cmd
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/hyperledger/firefly-common/pkg/config"
+	"github.com/spf13/cobra"
+)
+
+func configCommand() *cobra.Command {
+	versionCmd := &cobra.Command{
+		Use:   "docs",
+		Short: "Prints the config info as markdown",
+		Long:  "",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			InitConfig()
+			b, err := config.GenerateConfigMarkdown(context.Background(), "", config.GetKnownKeys())
+			fmt.Println(string(b))
+			return err
+		},
+	}
+	return versionCmd
+}

cmd/config_docs_generate_test.go

@@ -0,0 +1,27 @@
+//go:build docs
+// +build docs
+
+package cmd
+
+import (
+	"context"
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/hyperledger/firefly-common/pkg/config"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestGenerateConfigDocs(t *testing.T) {
+	// Initialize config of all plugins
+	InitConfig()
+	f, err := os.Create(filepath.Join("..", "config.md"))
+	assert.NoError(t, err)
+	generatedConfig, err := config.GenerateConfigMarkdown(context.Background(), "", config.GetKnownKeys())
+	assert.NoError(t, err)
+	_, err = f.Write(generatedConfig)
+	assert.NoError(t, err)
+	err = f.Close()
+	assert.NoError(t, err)
+}

cmd/config_docs_test.go

@@ -0,0 +1,30 @@
+//go:build !docs
+// +build !docs
+
+package cmd
+
+import (
+	"context"
+	"crypto/sha1"
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/hyperledger/firefly-common/pkg/config"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestConfigDocsUpToDate(t *testing.T) {
+	// Initialize config of all plugins
+	InitConfig()
+	generatedConfig, err := config.GenerateConfigMarkdown(context.Background(), "", config.GetKnownKeys())
+	assert.NoError(t, err)
+	configOnDisk, err := os.ReadFile(filepath.Join("..", "config.md"))
+	assert.NoError(t, err)
+
+	generatedConfigHash := sha1.New()
+	generatedConfigHash.Write(generatedConfig)
+	configOnDiskHash := sha1.New()
+	configOnDiskHash.Write(configOnDisk)
+	assert.Equal(t, configOnDiskHash.Sum(nil), generatedConfigHash.Sum(nil), "The config reference docs generated by the code did not match the config.md file in git. Did you forget to run `make docs`?")
+}

cmd/config_test.go

@@ -0,0 +1,14 @@
+package cmd
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestConfigMarkdown(t *testing.T) {
+	rootCmd.SetArgs([]string{"docs"})
+	defer rootCmd.SetArgs([]string{})
+	err := rootCmd.Execute()
+	assert.NoError(t, err)
+}