@blinklabs/dingo 0.6.0 → 0.8.0

package/.dingo/blob/KEYREGISTRY

@@ -0,0 +1,2 @@
+��
+��-��G)�+��Hello Badger

package/.github/workflows/golangci-lint.yml

@@ -20,4 +20,4 @@ jobs:
         with:
           go-version: 1.23.x
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v7
+        uses: golangci/golangci-lint-action@v8

package/.github/workflows/publish.yml

@@ -87,13 +87,7 @@ jobs:
         if: startsWith(github.ref, 'refs/tags/')
         run: |
           _filename=${{ env.APPLICATION_NAME }}-${{ env.RELEASE_TAG }}-${{ matrix.os }}-${{ matrix.arch }}.tar.gz
-          if [[ "${{ matrix.os }}" != "darwin" ]]; then
-            tar czf ${_filename} ${{ env.APPLICATION_NAME }}
-          fi
-          if [[ "${{ matrix.os }}" == "darwin" ]]; then
-            _filename=${{ env.APPLICATION_NAME }}-${{ env.RELEASE_TAG }}-${{ matrix.os }}-${{ matrix.arch }}.zip
-            zip -r ${_filename} ${{ env.APPLICATION_NAME }}
-          fi
+          tar czf ${_filename} ${{ env.APPLICATION_NAME }}
           curl \
             -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
             -H "Content-Type: application/octet-stream" \

package/README.md

@@ -19,9 +19,10 @@
 
 ## Running
 
-Dingo does not support a configuration file of its own and uses environment
+Dingo supports configuration via both a YAML config file (`dingo.yaml`) and uses environment
 variables to modify its own behavior.
 
+A sample configuration file is provided at `dingo.yaml.example`.You can copy and edit this file to configure Dingo for your local or production environment:
 This behavior can be changed via the following environment variables:
 
 - `CARDANO_BIND_ADDR`

package/dingo.yaml.example

@@ -0,0 +1,53 @@
+# Example config file for dingo
+# The values shown below correspond to the in-code defaults
+
+# Public bind address for the Dingo server
+bindAddr: "0.0.0.0"
+
+# Path to the Cardano node configuration file
+#
+# Can be overridden with the config environment variable
+cardanoConfig: "./config/cardano/preview/config.json"
+
+# A directory which contains the ledger database files
+databasePath: ".dingo"
+
+# Path to the UNIX domain socket file used by the server
+socketPath: "dingo.socket"
+
+# Name of the Cardano network
+network: "preview"
+
+# TLS certificate file path (for HTTPS)
+#
+# Can be overridden with the TLS_CERT_FILE_PATH environment variable
+tlsCertFilePath: ""
+
+# TLS key file path (for HTTPS)
+#
+# Can be overridden with the TLS_KEY_FILE_PATH environment variable
+tlsKeyFilePath: ""
+
+# Path to the topology configuration file for Cardano node
+topology: ""
+
+# TCP port to bind for Prometheus metrics endpoint
+metricsPort: 12798
+
+# Internal/private address to bind for listening for Ouroboros NtC
+privateBindAddr: "127.0.0.1"
+
+# TCP port to bind for listening for Ouroboros NtC
+privatePort: 3002
+
+# TCP port to bind for listening for Ouroboros NtN
+#
+# Can be overridden with the port environment variable
+relayPort: 3001
+
+# TCP port to bind for listening for UTxO RPC
+utxorpcPort: 9090
+
+# Ignore prior chain history and start from current tip (default: false)
+# This is experimental and may break — use with caution
+intersectTip: false

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@blinklabs/dingo",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "Dingo is a Cardano blockchain data node",
   "main": "index.js",
+  "bin": "dingo",
   "scripts": {
     "postinstall": "golang-npm install",
-    "preuninstall": "golang-npm uninstall",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "preuninstall": "golang-npm uninstall"
   },
   "repository": {
     "type": "git",
@@ -23,11 +23,11 @@
   },
   "homepage": "https://github.com/blinklabs-io/dingo#readme",
   "dependencies": {
-    "golang-npm": "^0.0.5"
+    "golang-npm": "^0.0.6"
   },
   "goBinary": {
     "name": "dingo",
     "path": "./bin",
-    "url": "https://github.com/blinklabs-io/dingo/releases/download/v{{version}}/dingo-{{version}}-{{platform}}-{{arch}}.tar.gz"
+    "url": "https://github.com/blinklabs-io/dingo/releases/download/v{{version}}/dingo-v{{version}}-{{platform}}-{{arch}}.tar.gz"
   }
 }

package/Dockerfile

@@ -1,25 +0,0 @@
-FROM ghcr.io/blinklabs-io/go:1.24.2-1 AS build
-
-WORKDIR /code
-COPY go.* .
-RUN go mod download
-COPY . .
-RUN make build
-
-FROM ghcr.io/blinklabs-io/cardano-configs:20250213-1 AS cardano-configs
-FROM ghcr.io/blinklabs-io/txtop:0.12.3 AS txtop
-
-FROM debian:bookworm-slim AS dingo
-COPY --from=build /code/dingo /bin/
-COPY --from=cardano-configs /config/ /opt/cardano/config/
-COPY --from=txtop /bin/txtop /usr/local/bin/
-ENV CARDANO_CONFIG=/opt/cardano/config/preview/config.json
-ENV CARDANO_NETWORK=preview
-# Create database dir owned by container user
-VOLUME /data/db
-ENV CARDANO_DATABASE_PATH=/data/db
-# Create socket dir owned by container user
-VOLUME /ipc
-ENV CARDANO_NODE_SOCKET_PATH=/ipc/dingo.socket
-ENV CARDANO_SOCKET_PATH=/ipc/dingo.socket
-ENTRYPOINT ["dingo"]

package/Makefile

@@ -1,53 +0,0 @@
-# Determine root directory
-ROOT_DIR=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
-
-# Gather all .go files for use in dependencies below
-GO_FILES=$(shell find $(ROOT_DIR) -name '*.go')
-
-# Gather list of expected binaries
-BINARIES=$(shell cd $(ROOT_DIR)/cmd && ls -1 | grep -v ^common)
-
-# Extract Go module name from go.mod
-GOMODULE=$(shell grep ^module $(ROOT_DIR)/go.mod | awk '{ print $$2 }')
-
-# Set version strings based on git tag and current ref
-GO_LDFLAGS=-ldflags "-s -w -X '$(GOMODULE)/internal/version.Version=$(shell git describe --tags --exact-match 2>/dev/null)' -X '$(GOMODULE)/internal/version.CommitHash=$(shell git rev-parse --short HEAD)'"
-
-.PHONY: build mod-tidy clean format golines test
-
-# Alias for building program binary
-build: $(BINARIES)
-
-# Builds and installs binary in ~/.local/bin
-install: build
-	mkdir -p $(HOME)/.local/bin
-	mv $(BINARIES) $(HOME)/.local/bin
-
-uninstall:
-	rm -f $(HOME)/.local/bin/$(BINARIES)
-
-mod-tidy:
-	# Needed to fetch new dependencies and add them to go.mod
-	go mod tidy
-
-clean:
-	rm -f $(BINARIES)
-
-format:
-	go fmt ./...
-	gofmt -s -w $(GO_FILES)
-
-golines:
-	golines -w --ignore-generated --chain-split-dots --max-len=80 --reformat-tags .
-
-test: mod-tidy
-	go test -v -race ./...
-
-# Build our program binaries
-# Depends on GO_FILES to determine when rebuild is needed
-$(BINARIES): mod-tidy $(GO_FILES)
-	CGO_ENABLED=0 \
-	go build \
-		$(GO_LDFLAGS) \
-		-o $(@) \
-		./cmd/$(@)

package/blockfetch.go

@@ -1,144 +0,0 @@
-// Copyright 2024 Blink Labs Software
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//     http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-
-package dingo
-
-import (
-	"fmt"
-	"time"
-
-	"github.com/blinklabs-io/dingo/event"
-	"github.com/blinklabs-io/dingo/ledger"
-	ouroboros "github.com/blinklabs-io/gouroboros"
-	gledger "github.com/blinklabs-io/gouroboros/ledger"
-	"github.com/blinklabs-io/gouroboros/protocol/blockfetch"
-	ocommon "github.com/blinklabs-io/gouroboros/protocol/common"
-)
-
-func (n *Node) blockfetchServerConnOpts() []blockfetch.BlockFetchOptionFunc {
-	return []blockfetch.BlockFetchOptionFunc{
-		blockfetch.WithRequestRangeFunc(n.blockfetchServerRequestRange),
-	}
-}
-
-func (n *Node) blockfetchClientConnOpts() []blockfetch.BlockFetchOptionFunc {
-	return []blockfetch.BlockFetchOptionFunc{
-		blockfetch.WithBlockFunc(n.blockfetchClientBlock),
-		blockfetch.WithBatchDoneFunc(n.blockfetchClientBatchDone),
-		blockfetch.WithBatchStartTimeout(2 * time.Second),
-		blockfetch.WithBlockTimeout(2 * time.Second),
-		// Set the recv queue size to 2x our block batch size
-		blockfetch.WithRecvQueueSize(1000),
-	}
-}
-
-func (n *Node) blockfetchServerRequestRange(
-	ctx blockfetch.CallbackContext,
-	start ocommon.Point,
-	end ocommon.Point,
-) error {
-	// TODO: check if we have requested block range available and send NoBlocks if not (#397)
-	chainIter, err := n.ledgerState.GetChainFromPoint(start, true)
-	if err != nil {
-		return err
-	}
-	// Start async process to send requested block range
-	go func() {
-		if err := ctx.Server.StartBatch(); err != nil {
-			return
-		}
-		for {
-			next, _ := chainIter.Next(false)
-			if next == nil {
-				break
-			}
-			if next.Block.Slot > end.Slot {
-				break
-			}
-			blockBytes := next.Block.Cbor[:]
-			err := ctx.Server.Block(
-				next.Block.Type,
-				blockBytes,
-			)
-			if err != nil {
-				// TODO: push this error somewhere (#398)
-				return
-			}
-			// Make sure we don't hang waiting for the next block if we've already hit the end
-			if next.Block.Slot == end.Slot {
-				break
-			}
-		}
-		if err := ctx.Server.BatchDone(); err != nil {
-			return
-		}
-	}()
-	return nil
-}
-
-// blockfetchClientRequestRange is called by the ledger when it needs to request a range of block bodies
-func (n *Node) blockfetchClientRequestRange(
-	connId ouroboros.ConnectionId,
-	start ocommon.Point,
-	end ocommon.Point,
-) error {
-	conn := n.connManager.GetConnectionById(connId)
-	if conn == nil {
-		return fmt.Errorf("failed to lookup connection ID: %s", connId.String())
-	}
-	if err := conn.BlockFetch().Client.GetBlockRange(start, end); err != nil {
-		return err
-	}
-	return nil
-}
-
-func (n *Node) blockfetchClientBlock(
-	ctx blockfetch.CallbackContext,
-	blockType uint,
-	block gledger.Block,
-) error {
-	// Generate event
-	n.eventBus.Publish(
-		ledger.BlockfetchEventType,
-		event.NewEvent(
-			ledger.BlockfetchEventType,
-			ledger.BlockfetchEvent{
-				Point: ocommon.NewPoint(
-					block.SlotNumber(),
-					block.Hash().Bytes(),
-				),
-				Type:  blockType,
-				Block: block,
-			},
-		),
-	)
-	return nil
-}
-
-func (n *Node) blockfetchClientBatchDone(
-	ctx blockfetch.CallbackContext,
-) error {
-	// Generate event
-	n.eventBus.Publish(
-		ledger.BlockfetchEventType,
-		event.NewEvent(
-			ledger.BlockfetchEventType,
-			ledger.BlockfetchEvent{
-				ConnectionId: ctx.ConnectionId,
-				BatchDone:    true,
-			},
-		),
-	)
-	return nil
-}