@blinklabs/dingo 0.7.0 → 0.8.1

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,8 +1,9 @@
 {
   "name": "@blinklabs/dingo",
-  "version": "0.7.0",
+  "version": "0.8.1",
   "description": "Dingo is a Cardano blockchain data node",
   "main": "index.js",
+  "bin": "dingo",
   "scripts": {
     "postinstall": "golang-npm install",
     "preuninstall": "golang-npm uninstall"
@@ -22,7 +23,6 @@
   },
   "homepage": "https://github.com/blinklabs-io/dingo#readme",
   "dependencies": {
-    "dingo": "^0.0.18",
     "golang-npm": "^0.0.6"
   },
   "goBinary": {

package/.github/CODEOWNERS

@@ -1,5 +0,0 @@
-# Blink Labs
-#
-* @blinklabs-io/core
-*.md @blinklabs-io/core @blinklabs-io/docs @blinklabs-io/pms
-LICENSE @blinklabs-io/core @blinklabs-io/pms

package/.github/dependabot.yml

@@ -1,19 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
-version: 2
-updates:
-  - package-ecosystem: "docker"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-  - package-ecosystem: "gomod"
-    directory: "/"
-    schedule:
-      interval: "weekly"

package/.github/dingo.md

@@ -1,56 +0,0 @@
-```
-                                                                                                                                                      
-                                                                                                                                                      
-                                                                                                                 ==                                   
-                                                                                                           ===*******+==+                             
-                                                                                                        ==+*************+==                           
-                                                                                               ====   ==*******++++*******+==                         
-                                                                                          ===++****+++=+****===    ==+******==                        
-                  @%@@                                                                 ==+**************+++=         =+******+=                       
-                @#-----*#%@@                                                         ==+******************+=          =*******==                      
-              @#--=%%%+=-----*#%@                                                  ==+*********************+==        =********==                     
-            @%=-=%%%%%%%%%%%+=--+                                                 ==************************+=#      =+**##%%%#+=                     
-           %*--#%%%%%%%%%%%%--=-=@                             -===             -=+**************************+=      =#@@@@@@@@%=                     
-         %*--=%%%%%%%%%%%%=--%%+-%@    ======                 ==*#+=           ==*****************************==   ==#@@@@@@@@@%=                     
-        %---+%%%%%%%%%%%#--*%%%*--@   =+%%#*===             -=*#@@#*=         =+******************************+=   =*@@@@@@@@@@%=                     
-        @-------==#%%%%=-=%%%%%%--#   =+%@@#**+=           ==*%@@@@*==      +=+*******************************+=  =+@@@@@@@@@@@+=                     
-        @%-+%%%%#=-----=%%%%%%%%+-#   =+#%%@%***===       ==#%@@%@%#*=     ==*********************************+= ==@@@@@@@@@@@#==                     
-         %=-%%%%%%%%%--#%%%%%%%%#--@   =#==%+%#***+=     =+#@@%%=%##*+=   =+**********************************+= =#@@@@@@@@@@@+=                      
-         @=-+%%%%%%%%#-*%%%%%%%%%--#   =*=#=#+@#****=====+%%@+#=*-#%**= ==+***********************************== =@@@@@@@@@@%+=                       
-         @%+##%=-=%%%%--%%%%%%%+--*@   =+%-----#%********%@%=-=-#-#%**===*************************************= =#@@@@@@@@#+==                        
-         @*--+--+@%%%%=-*%%%%*--+@     ==#=---=***********#=------%#**=+*************************************+= =#@@@@%*===                           
-        @*-*++%-+%%%%%#-+%%#--+%        =*+-+****************+----@***++*************************************=  =%@%#===                              
-       @+-#%++=-*-+##%%--%=-=@@         ==%********************+-=%***++**************************+*********==  =%#==                                 
-       +-%*%%--#%++--------*@            =*##********************%#***++*************************=+*********=   =+=        @@%###=-=%@                
-       %---+-=%     @@@+=+@             ==#%%#*********#%%%%%%#*******++************************==*********=    == @@%%##=------===--*@               
-        @--=%@                          ==+  +#*******%=   -%%#*******++**********************+===***###**+=      @+----==+%%%%%%%%%=--%@             
-       %*--%@                    @%%%@@ =*  # ******#    #* .%********++*********************+= +=#%-----%= @%*-%%%----%%%%%%%%%%%%%%%---%            
-     @%-----+@                  #------=++     ****-        .#********++********************+= @%---+%%----==-+%--*-*%--=%%%%%%%%%%%%%%#--#           
-     @=-%%%*-+@           @*==%@---=@@%=****+**#%#***+     +**%@%%#***++*******************+=  #-#%%**%#-------+@%--%%%*--#%%%%%%%%%%%%%%=-=%         
-      @==@ @%#*@@@      %*-=#------#@ =*****#%@@%#*********#%@@@@@@%**++******************==   #---+*=---%@@%-=+@+-+%%%%%=-+%%%%%%%%%%%%%%*--#@       
-       %-=@@=-------=++%=-#@#---@%#--=***%%@@@@%*********%%@@@*===#@%*=*******##%#******==-#+-==----=###==   @#-%--%%%%%%%+--#%%%%%%%%%%%#+=--+       
-       @#=#=-*-=%%%##+#-=#-#%--#    ++%@@%@@@@@%%*****%%@@@@@*:%# =@@++*****%*-----++%#=  *-++--=%=*****==     @+-*%%%%%%%%%--=%%#++=------+=-*       
-        @+--%%=-+%%%%%*-#%=*-=%     =**        *@@@@@@@@@@@@*=%  -*@%=****#+--+%%%*+----=+*#@#+=-%=*****==     %--%%%%%%%%%%%#-----+**%%%%%%-=@       
-       %=-+%%%%--%%%%%#-----#@      ==%        *@%@@@%@@@@@*+ -.=*@#=***#*--*%%%%%%%%%%#*=--=@*-#@=*****==    @*-*%%%%%%%%%%%+-=%%%%%%%%%%%=-#        
-     @#--*%%%%%*-=%%%%--#@%+-@       ==#.  -%@@%@@@@@@@@%#=- :=#@#++**##--+%%%%%%%%%%%%%*----%-+@ =+****==    @=-+%%%%%%%%%%%=-%%%%%%%%%%%#--@        
-    @+-=%%%%%%%%=-%%%%@%%%%*-=@       #=+%**#@@@@@@@@%#==+-+%@%*==**##--+%%%%%%%%%%%%%#--+%#-#+@  =+****==     @*--#%%%%%%%%*-+%%%%%%%%%%%+-%@        
-    @+-*%%%%%%%%#--%%%%%%%%%=-#         ===*#%*++++++=-%@@%=-#+ ==**#=----=##%%%%%%%#--=%%%#--%   =+****==       @=--%%%%%%%--%%%%%%%%%%%%-=%         
-     %=-%%%%%%%%%------+#%%%#--@            =========%=-#++@+-#==*####-+%%==----*%%--=%%%%%%--*   =+****==        @#--*%%%%#-*%%%%%%%%%%%+-*@         
-     @*-+%%%%%%*--%%%#===------*             ==*******#*-=%---*%*----%--%%%%%%%==---%%%%%%%%%-*@  =+****==          @+-=%%%--%%%%%%%%%%%%-=@          
-      @+-%%%%%=-=%%%%%%%%%%%+--@           ==+*******+=+%=-------=%#**+-+%%%%%%%%%-=%%%%%%%%%=-#==*%@%*===            #--**-=%%%%%#=------*           
-       %-=%%#--*%%%%%%%%%%%--+@           ==********==   @@@@=+-=-#*%%%-=%%%%%%%%%+-%%%%%%%%%=-+@@@@@@@%+=             %=-----------*%%%%@@           
-       @*-**--%%%%%%%%%%%#--%@          ==+*******==        =+#*------#--%%%%%%%%%+-=%%%%%%#--+%@@@@@@@@%+=             @%--*%%%@@@                   
-        %---+%%%%%%%%%%%=-=% ==+******+=+*******+==        =+***####+=+*-=%%%%%%%%%--%%%%#=-=#@@@%@@@@@@%+=                                           
-        @#------=++*%%%=-#@=+%@@@@@%#*********==:  ====  ==*******+==  %---=+#%%%%%+-%%#--=%%==++****++===                                            
-           @@@%##*=-----# =+@@@@@@@@@%******=====*#*****+=*******==     @%#*=----+*#--=-=%@      ===                                                  
-                    @@@@  =#@@@@@@@@@@#**+== =+%@@@@@@%********+==           @@%*+----=#@                       
-                          =+#@@%@@@@%#+===  ==%@@@@@@@@%*****+==                  @@%%@                                                               
-                            ==========      =#@@@@@@@@@@%**+==                                                                                        
-                                            ==+##%%%###+===                                                                                           
-                                                =====                                                                                                 
-                                                                                                                                                      
-                                                                                                                                                      
-
-```
-
-Created using https://itoa.hex.dance/

package/.github/workflows/ci-docker.yml

@@ -1,36 +0,0 @@
-name: Docker CI
-
-on:
-  pull_request:
-    branches: ['main']
-    paths: ['Dockerfile','cmd/**','docs/**','internal/**','go.*','.github/workflows/ci-docker.yml']
-
-env:
-  GHCR_IMAGE_NAME: ghcr.io/blinklabs-io/dingo
-
-permissions:
-  contents: read
-
-jobs:
-  docker:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: '0'
-      - name: qemu
-        uses: docker/setup-qemu-action@v3
-      - uses: docker/setup-buildx-action@v3
-      - id: meta
-        uses: docker/metadata-action@v5
-        with:
-          images: ${{ env.GHCR_IMAGE_NAME }}
-      - name: build
-        uses: docker/build-push-action@v6
-        with:
-          context: .
-          push: false
-          ### TODO: test multiple platforms
-          # platforms: linux/amd64,linux/arm64
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}

package/.github/workflows/conventional-commits.yml

@@ -1,17 +0,0 @@
-# The below is pulled from upstream and slightly modified
-# https://github.com/webiny/action-conventional-commits/blob/master/README.md#usage
-
-name: Conventional Commits
-
-on:
-  pull_request:
-
-jobs:
-  build:
-    name: Conventional Commits
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-    steps:
-      - uses: actions/checkout@v4
-      - uses: webiny/action-conventional-commits@v1.3.0

package/.github/workflows/go-test.yml

@@ -1,29 +0,0 @@
-name: go-test
-
-on:
-  push:
-    tags:
-      - v*
-    branches:
-      - main
-  pull_request:
-
-permissions:
-  contents: read
-
-jobs:
-  go-test:
-    name: go-test
-    strategy:
-      matrix:
-        go-version: [1.23.x, 1.24.x]
-        # We want to make sure that this builds on Linux and Darwin
-        platform: [ubuntu-latest, macos-latest]
-    runs-on: ${{ matrix.platform }}
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-go@v5
-        with:
-          go-version: ${{ matrix.go-version }}
-      - name: go-test
-        run: go test ./...

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

@@ -1,23 +0,0 @@
-name: golangci-lint
-on:
-  push:
-    tags:
-      - v*
-    branches:
-      - main
-  pull_request:
-
-permissions:
-  contents: read
-
-jobs:
-  golangci:
-    name: lint
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-go@v5
-        with:
-          go-version: 1.23.x
-      - name: golangci-lint
-        uses: golangci/golangci-lint-action@v7

package/.github/workflows/publish.yml

@@ -1,207 +0,0 @@
-name: publish
-
-on:
-  push:
-    branches: ['main']
-    tags:
-      - 'v*.*.*'
-
-concurrency: ${{ github.ref }}
-
-env:
-  APPLICATION_NAME: 'dingo'
-
-jobs:
-  create-draft-release:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    outputs:
-      RELEASE_ID: ${{ steps.create-release.outputs.result }}
-    steps:
-      - run: "echo \"RELEASE_TAG=${GITHUB_REF#refs/tags/}\" >> $GITHUB_ENV"
-      - uses: actions/github-script@v7
-        id: create-release
-        if: startsWith(github.ref, 'refs/tags/')
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          result-encoding: string
-          script: |
-            try {
-              const response = await github.rest.repos.createRelease({
-                draft: true,
-                generate_release_notes: true,
-                name: process.env.RELEASE_TAG,
-                owner: context.repo.owner,
-                prerelease: false,
-                repo: context.repo.repo,
-                tag_name: process.env.RELEASE_TAG,
-              });
-
-              return response.data.id;
-            } catch (error) {
-              core.setFailed(error.message);
-            }
-
-  build-binaries:
-    strategy:
-      matrix:
-        include:
-          - runner: macos-latest
-            os: darwin
-            arch: arm64
-          - runner: ubuntu-latest
-            os: freebsd
-            arch: amd64
-          - runner: ubuntu-latest
-            os: freebsd
-            arch: arm64
-          - runner: ubuntu-latest
-            os: linux
-            arch: amd64
-          - runner: ubuntu-latest
-            os: linux
-            arch: arm64
-    runs-on: ${{ matrix.runner }}
-    needs: [create-draft-release]
-    permissions:
-      actions: write
-      attestations: write
-      checks: write
-      contents: write
-      id-token: write
-      packages: write
-      statuses: write
-    steps:
-      - name: Set RELEASE_TAG
-        run: "echo \"RELEASE_TAG=${GITHUB_REF#refs/tags/}\" >> $GITHUB_ENV"
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: '0'
-      - uses: actions/setup-go@v5
-        with:
-          go-version: 1.23.x
-      - name: Build binary
-        run: GOOS=${{ matrix.os }} GOARCH=${{ matrix.arch }} make build
-      - name: Upload release asset
-        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
-          curl \
-            -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
-            -H "Content-Type: application/octet-stream" \
-            --data-binary @${_filename} \
-            https://uploads.github.com/repos/${{ github.repository_owner }}/${{ env.APPLICATION_NAME }}/releases/${{ needs.create-draft-release.outputs.RELEASE_ID }}/assets?name=${_filename}
-      - name: Attest binary
-        if: startsWith(github.ref, 'refs/tags/')
-        uses: actions/attest-build-provenance@v2
-        with:
-          subject-path: '${{ env.APPLICATION_NAME }}'
-
-  build-images:
-    runs-on: ubuntu-latest
-    needs: [create-draft-release]
-    permissions:
-      actions: write
-      attestations: write
-      checks: write
-      contents: write
-      id-token: write
-      packages: write
-      statuses: write
-    steps:
-      - run: "echo \"RELEASE_TAG=${GITHUB_REF#refs/tags/}\" >> $GITHUB_ENV"
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: '0'
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-      - name: Login to Docker Hub
-        uses: docker/login-action@v3
-        with:
-          username: blinklabs
-          password: ${{ secrets.DOCKER_PASSWORD }} # uses token
-      - name: Login to GHCR
-        uses: docker/login-action@v3
-        with:
-          username: ${{ github.repository_owner }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-          registry: ghcr.io
-      - id: meta
-        uses: docker/metadata-action@v5
-        with:
-          images: |
-            blinklabs/dingo
-            ghcr.io/${{ github.repository }}
-          tags: |
-            # Only version, no revision
-            type=match,pattern=v(.*)-(.*),group=1
-            # branch
-            type=ref,event=branch
-            # semver
-            type=semver,pattern={{version}}
-      - name: Build images
-        id: push
-        uses: docker/build-push-action@v6
-        with:
-          outputs: "type=registry,push=true"
-          platforms: linux/amd64,linux/arm64
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
-      - name: Attest Docker Hub image
-        uses: actions/attest-build-provenance@v2
-        with:
-          subject-name: index.docker.io/blinklabs/dingo
-          subject-digest: ${{ steps.push.outputs.digest }}
-          push-to-registry: true
-      - name: Attest GHCR image
-        uses: actions/attest-build-provenance@v2
-        with:
-          subject-name: ghcr.io/${{ github.repository }}
-          subject-digest: ${{ steps.push.outputs.digest }}
-          push-to-registry: true
-      # Update Docker Hub from README
-      - name: Docker Hub Description
-        uses: peter-evans/dockerhub-description@v4
-        with:
-          username: blinklabs
-          password: ${{ secrets.DOCKER_PASSWORD }}
-          repository: blinklabs/${{ env.APPLICATION_NAME }}
-          readme-filepath: ./README.md
-          short-description: "Dingo is a Cardano blockchain data node"
-
-  finalize-release:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-    needs: [create-draft-release, build-binaries, build-images]
-    steps:
-      - uses: actions/github-script@v7
-        if: startsWith(github.ref, 'refs/tags/')
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          script: |
-            try {
-              await github.rest.repos.updateRelease({
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-                release_id: ${{ needs.create-draft-release.outputs.RELEASE_ID }},
-                draft: false,
-              });
-            } catch (error) {
-              core.setFailed(error.message);
-            }
-
-      # This updates the documentation on pkg.go.dev and the latest version available via the Go module proxy
-      - name: Pull new module version
-        if: startsWith(github.ref, 'refs/tags/')
-        uses: andrewslotin/go-proxy-pull-action@v1.3.0

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/$(@)