Merge pull request #73 from unattended-backpack/dev

feat: devops refactor

Author: TimTinkers

.actrc

@@ -0,0 +1,8 @@
+# This is an act configuration to test GitHub Actions locally.
+# See docs/WORKFLOW_TESTING.md for more details.
+
+# Use minimal Ubuntu image for self-hosted runners (authenticate job).
+# The release job uses its own explicit container specification.
+# Pinned to specific digest for supply-chain security.
+-P self-hosted=catthehacker/ubuntu@sha256:421db41052a1c9eb3c62668e04cbfbd353855619a9771657d9a8a370655db04a
+-P actions-runner=catthehacker/ubuntu@sha256:421db41052a1c9eb3c62668e04cbfbd353855619a9771657d9a8a370655db04a

.env.example

@@ -1,34 +1,105 @@
-###############################################################################
-#                             ↓ REQUIRED ALWAYS↓                              #
-###############################################################################
-
-### Used in Magister (Vast.ai wrapper) and Hierophant
-# Publically reachable ip of the machine this docker setup is running on.
-# Used by remotely hosted vast.ai Contemplants to communicate to the Hierophant at this ip.  
-# Also used by Magister to make Hierophant aware of it.
-# Used in Hierophant to advertise where to upload artifacts.
-THIS_IP=
-
-### Used in Magister (Vast.ai wrapper)
-# Make a vast.ai account, load it with some funds, and get an api key.
-# This is to allow for easy allocation and deallocation of worker nodes for the
-# Hierophant prover network.  Each vast.ai instance only cost 0.3 - 0.6 $/hour
-VAST_API_KEY=
-
-###############################################################################
-#                               ↓ DEFAULTS ↓                                  #
-###############################################################################
-# Only modify this section if you know what you're doing
-
-### Used in Magister (Vast.ai wrapper)
-# number of provers (Contemplant instances) running on vast.ai
-# This will impact your vast.ai bill.
-NUMBER_PROVERS=1
-# This is a vast.ai template that contains a `contemplant` binary.  Vast.ai instances run using this template.
-# When a new Contemplant template is pushed to Vast.ai make sure to copy the new template hash from the Vast UI and add it here.
-VAST_TEMPLATE_HASH=1878058a3fab0d314a768287dc41c456
-
-PORT__HIEROPHANT_GRPC=9000
-PORT__HIEROPHANT_HTTP=9010
-PORT__MAGISTER_HTTP=8555
+# Example environment configuration.
+# Copy this file to .env and adjust as needed.
+# Environment variables override values in hierophant.toml and contemplant.toml.
 
+# Hierophant Configuration
+# ========================
+
+# OPTIONAL: Port for gRPC service (default: 9000).
+# GRPC_PORT=9000
+
+# OPTIONAL: Port for HTTP and WebSocket service (default: 9010).
+# HTTP_PORT=9010
+
+# OPTIONAL: Timeout in seconds for worker responses (default: 30).
+# How long to wait for a response from a worker before evicting them.
+# WORKER_RESPONSE_TIMEOUT_SECS=30
+
+# OPTIONAL: Publicly reachable address of this Hierophant for artifact uploads.
+# This is used by clients to upload program inputs and download proofs.
+# THIS_HIEROPHANT_IP=
+
+# OPTIONAL: Public key for signing messages (default: zero address).
+# Key pair used for signing messages to the client and retrieving nonces.
+# PUB_KEY=0x0000000000000000000000000000000000000000
+
+# OPTIONAL: Create mock proofs instead of real proofs (default: false).
+# Witness generation still happens, but proof generation is skipped.
+# MOCK_MODE=false
+
+# OPTIONAL: Directory for storing artifacts on disk (default: "artifacts").
+# ARTIFACT_STORE_DIRECTORY=artifacts
+
+# OPTIONAL: Maximum number of stdin artifacts stored (default: 50).
+# Artifacts can be large, so we limit how many are stored on disk.
+# MAX_STDIN_ARTIFACTS_STORED=50
+
+# OPTIONAL: Maximum number of proof artifacts stored (default: 10).
+# MAX_PROOF_ARTIFACTS_STORED=10
+
+# Worker Registry Settings
+# -------------------------
+# These settings control when workers are evicted.
+
+# OPTIONAL: Number of strikes before eviction (default: 3).
+# Workers get strikes when they fail to respond to requests.
+# MAX_WORKER_STRIKES=3
+
+# OPTIONAL: Maximum seconds between heartbeats before eviction (default: 180).
+# Workers must send heartbeats regularly to stay registered.
+# MAX_WORKER_HEARTBEAT_INTERVAL_SECS=180
+
+# OPTIONAL: Maximum minutes a worker can spend on a proof (default: 300).
+# Workers taking longer than this are considered dead and evicted.
+# PROOF_TIMEOUT_MINS=300
+
+# OPTIONAL: Minutes between required progress updates (default: 0).
+# Workers must show at least 1% progress every N minutes or be evicted.
+# Set to 0 to disable progress checking.
+# WORKER_REQUIRED_PROGRESS_INTERVAL_MINS=0
+
+# OPTIONAL: Maximum minutes for execution report phase (default: 45).
+# Time allowed for execution report before proof generation starts.
+# WORKER_MAX_EXECUTION_REPORT_MINS=45
+
+# Contemplant Configuration
+# ==========================
+
+# OPTIONAL: WebSocket address of the Hierophant to connect to.
+# Format: ws://[host]:[port]/ws where port is the Hierophant HTTP port.
+# HIEROPHANT_WS_ADDRESS=ws://127.0.0.1:9010/ws
+
+# OPTIONAL: Human-readable name for this Contemplant (default: from names.txt).
+# CONTEMPLANT_NAME=
+
+# OPTIONAL: Prover type - "cpu" or "cuda" (default: "cpu").
+# CPU proving is slower but doesn't require a GPU.
+# PROVER_TYPE=cpu
+
+# OPTIONAL: Moongate CUDA prover endpoint (default: none).
+# Only used when prover_type is "cuda". If not set, Contemplant will spin up
+# a moongate-server Docker container automatically.
+# MOONGATE_ENDPOINT=
+
+# OPTIONAL: Heartbeat interval in seconds (default: 30).
+# How often to tell Hierophant that this Contemplant is still alive.
+# HEARTBEAT_INTERVAL_SECONDS=30
+
+# OPTIONAL: Maximum number of finished proofs stored in memory (default: 2).
+# MAX_PROOFS_STORED=2
+
+# OPTIONAL: Magister drop endpoint (default: none).
+# Endpoint to notify when this Contemplant should be dropped from its Magister.
+# Only set if this Contemplant is managed by a Magister.
+# MAGISTER_DROP_ENDPOINT=
+
+# Assessor Settings
+# -----------------
+# These settings control proof progress monitoring.
+
+# OPTIONAL: Path to log file for progress tracking (default: "./moongate.log").
+# MOONGATE_LOG_PATH=./moongate.log
+
+# OPTIONAL: Log polling interval in milliseconds (default: 2000).
+# How frequently to check the moongate log file for progress updates.
+# WATCHER_POLLING_INTERVAL_MS=2000

.env.maintainer

@@ -0,0 +1,21 @@
+# This file is updated by the maintaining team as keys or details change. You
+# should not need to manually adjust it. If you wish to override it, there are
+# instructions in the README file.
+
+# The name of the Hierophant Docker image.
+HIEROPHANT_NAME=hierophant
+
+# The name of the Contemplant Docker image.
+CONTEMPLANT_NAME=contemplant
+
+# The image to use for building this project.
+BUILD_IMAGE=unattended/petros:latest
+
+# The runtime image to use for the final container.
+RUNTIME_IMAGE=debian:trixie-slim@sha256:66b37a5078a77098bfc80175fb5eb881a3196809242fd295b25502854e12cbec
+
+# The URL where large, specifically-vendored binaries are downloaded from.
+VENDOR_BASE_URL=https://sigil-attic.nyc3.digitaloceanspaces.com/sigil-tarballs
+
+# The SP1 circuits version to use in the build.
+CIRCUITS_VERSION=v5.0.0

.github/pull_request_template.md

@@ -0,0 +1,20 @@
+## Description
+<!-- Describe your changes in detail -->
+
+## Breaking Changes
+<!-- List any breaking changes. Delete this section if none. -->
+
+## Bug Fixes  
+<!-- List bug fixes. Delete this section if none. -->
+
+## Features
+<!-- List new features. Delete this section if none. -->
+
+## Checklist
+- [ ] I confirm all tests pass (`make test`)
+- [ ] I confirm any manual testing is completed
+- [ ] I updated any relevant documentation
+- [ ] My code follows style guidelines
+
+---
+*Note to maintainers: Sections above will be included in the release notes. You can edit this PR description before merging to improve the release notes.*