mirror of
https://github.com/logos-blockchain/logos-blockchain-testing.git
synced 2026-01-02 21:33:07 +00:00
458 lines
27 KiB
HTML
458 lines
27 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="light" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Prerequisites & Setup - Logos Blockchain Testing Framework Book</title>
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#ffffff">
|
|
|
|
<link rel="icon" href="favicon.svg">
|
|
<link rel="shortcut icon" href="favicon.png">
|
|
<link rel="stylesheet" href="css/variables.css">
|
|
<link rel="stylesheet" href="css/general.css">
|
|
<link rel="stylesheet" href="css/chrome.css">
|
|
<link rel="stylesheet" href="css/print.css" media="print">
|
|
|
|
<!-- Fonts -->
|
|
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
|
|
<link rel="stylesheet" href="fonts/fonts.css">
|
|
|
|
<!-- Highlight.js Stylesheets -->
|
|
<link rel="stylesheet" href="highlight.css">
|
|
<link rel="stylesheet" href="tomorrow-night.css">
|
|
<link rel="stylesheet" href="ayu-highlight.css">
|
|
|
|
<!-- Custom theme stylesheets -->
|
|
|
|
</head>
|
|
<body class="sidebar-visible no-js">
|
|
<div id="body-container">
|
|
<!-- Provide site root to javascript -->
|
|
<script>
|
|
var path_to_root = "";
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
|
|
</script>
|
|
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|
<script>
|
|
try {
|
|
var theme = localStorage.getItem('mdbook-theme');
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
|
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|
}
|
|
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|
}
|
|
} catch (e) { }
|
|
</script>
|
|
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|
<script>
|
|
var theme;
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|
var html = document.querySelector('html');
|
|
html.classList.remove('light')
|
|
html.classList.add(theme);
|
|
var body = document.querySelector('body');
|
|
body.classList.remove('no-js')
|
|
body.classList.add('js');
|
|
</script>
|
|
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script>
|
|
var body = document.querySelector('body');
|
|
var sidebar = null;
|
|
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
|
if (document.body.clientWidth >= 1080) {
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|
sidebar = sidebar || 'visible';
|
|
} else {
|
|
sidebar = 'hidden';
|
|
}
|
|
sidebar_toggle.checked = sidebar === 'visible';
|
|
body.classList.remove('sidebar-visible');
|
|
body.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<div class="sidebar-scrollbox">
|
|
<ol class="chapter"><li class="chapter-item expanded "><a href="project-context-primer.html"><strong aria-hidden="true">1.</strong> Project Context Primer</a></li><li class="chapter-item expanded "><a href="what-you-will-learn.html"><strong aria-hidden="true">2.</strong> What You Will Learn</a></li><li class="chapter-item expanded "><a href="quickstart.html"><strong aria-hidden="true">3.</strong> Quickstart</a></li><li class="chapter-item expanded "><a href="part-i.html"><strong aria-hidden="true">4.</strong> Part I — Foundations</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="introduction.html"><strong aria-hidden="true">4.1.</strong> Introduction</a></li><li class="chapter-item expanded "><a href="architecture-overview.html"><strong aria-hidden="true">4.2.</strong> Architecture Overview</a></li><li class="chapter-item expanded "><a href="testing-philosophy.html"><strong aria-hidden="true">4.3.</strong> Testing Philosophy</a></li><li class="chapter-item expanded "><a href="scenario-lifecycle.html"><strong aria-hidden="true">4.4.</strong> Scenario Lifecycle</a></li><li class="chapter-item expanded "><a href="design-rationale.html"><strong aria-hidden="true">4.5.</strong> Design Rationale</a></li></ol></li><li class="chapter-item expanded "><a href="part-ii.html"><strong aria-hidden="true">5.</strong> Part II — User Guide</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="workspace-layout.html"><strong aria-hidden="true">5.1.</strong> Workspace Layout</a></li><li class="chapter-item expanded "><a href="annotated-tree.html"><strong aria-hidden="true">5.2.</strong> Annotated Tree</a></li><li class="chapter-item expanded "><a href="authoring-scenarios.html"><strong aria-hidden="true">5.3.</strong> Authoring Scenarios</a></li><li class="chapter-item expanded "><a href="workloads.html"><strong aria-hidden="true">5.4.</strong> Core Content: Workloads & Expectations</a></li><li class="chapter-item expanded "><a href="scenario-builder-ext-patterns.html"><strong aria-hidden="true">5.5.</strong> Core Content: ScenarioBuilderExt Patterns</a></li><li class="chapter-item expanded "><a href="best-practices.html"><strong aria-hidden="true">5.6.</strong> Best Practices</a></li><li class="chapter-item expanded "><a href="usage-patterns.html"><strong aria-hidden="true">5.7.</strong> Usage Patterns</a></li><li class="chapter-item expanded "><a href="examples.html"><strong aria-hidden="true">5.8.</strong> Examples</a></li><li class="chapter-item expanded "><a href="examples-advanced.html"><strong aria-hidden="true">5.9.</strong> Advanced & Artificial Examples</a></li><li class="chapter-item expanded "><a href="cucumber-bdd.html"><strong aria-hidden="true">5.10.</strong> Cucumber/BDD Interface</a></li><li class="chapter-item expanded "><a href="running-scenarios.html"><strong aria-hidden="true">5.11.</strong> Running Scenarios</a></li><li class="chapter-item expanded "><a href="runners.html"><strong aria-hidden="true">5.12.</strong> Runners</a></li><li class="chapter-item expanded "><a href="node-control.html"><strong aria-hidden="true">5.13.</strong> RunContext: BlockFeed & Node Control</a></li><li class="chapter-item expanded "><a href="chaos.html"><strong aria-hidden="true">5.14.</strong> Chaos Workloads</a></li><li class="chapter-item expanded "><a href="topology-chaos.html"><strong aria-hidden="true">5.15.</strong> Topology & Chaos Patterns</a></li></ol></li><li class="chapter-item expanded "><a href="part-iii.html"><strong aria-hidden="true">6.</strong> Part III — Developer Reference</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="scenario-model.html"><strong aria-hidden="true">6.1.</strong> Scenario Model (Developer Level)</a></li><li class="chapter-item expanded "><a href="api-levels.html"><strong aria-hidden="true">6.2.</strong> API Levels: Builder DSL vs. Direct</a></li><li class="chapter-item expanded "><a href="extending.html"><strong aria-hidden="true">6.3.</strong> Extending the Framework</a></li><li class="chapter-item expanded "><a href="custom-workload-example.html"><strong aria-hidden="true">6.4.</strong> Example: New Workload & Expectation (Rust)</a></li><li class="chapter-item expanded "><a href="internal-crate-reference.html"><strong aria-hidden="true">6.5.</strong> Internal Crate Reference</a></li></ol></li><li class="chapter-item expanded "><a href="part-iv.html"><strong aria-hidden="true">7.</strong> Part IV — Operations & Deployment</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="operations-overview.html"><strong aria-hidden="true">7.1.</strong> Overview</a></li><li class="chapter-item expanded "><a href="prerequisites.html" class="active"><strong aria-hidden="true">7.2.</strong> Prerequisites & Setup</a></li><li class="chapter-item expanded "><a href="running-examples.html"><strong aria-hidden="true">7.3.</strong> Running Examples</a></li><li class="chapter-item expanded "><a href="ci-integration.html"><strong aria-hidden="true">7.4.</strong> CI Integration</a></li><li class="chapter-item expanded "><a href="environment-variables.html"><strong aria-hidden="true">7.5.</strong> Environment Variables</a></li><li class="chapter-item expanded "><a href="logging-observability.html"><strong aria-hidden="true">7.6.</strong> Logging & Observability</a></li></ol></li><li class="chapter-item expanded "><a href="part-v.html"><strong aria-hidden="true">8.</strong> Part V — Appendix</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="dsl-cheat-sheet.html"><strong aria-hidden="true">8.1.</strong> Builder API Quick Reference</a></li><li class="chapter-item expanded "><a href="troubleshooting.html"><strong aria-hidden="true">8.2.</strong> Troubleshooting Scenarios</a></li><li class="chapter-item expanded "><a href="faq.html"><strong aria-hidden="true">8.3.</strong> FAQ</a></li><li class="chapter-item expanded "><a href="glossary.html"><strong aria-hidden="true">8.4.</strong> Glossary</a></li></ol></li></ol>
|
|
</div>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
|
<div class="sidebar-resize-indicator"></div>
|
|
</div>
|
|
</nav>
|
|
|
|
<!-- Track and set sidebar scroll position -->
|
|
<script>
|
|
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
|
|
sidebarScrollbox.addEventListener('click', function(e) {
|
|
if (e.target.tagName === 'A') {
|
|
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
|
|
}
|
|
}, { passive: true });
|
|
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
|
|
sessionStorage.removeItem('sidebar-scroll');
|
|
if (sidebarScrollTop) {
|
|
// preserve sidebar scroll position when navigating via links within sidebar
|
|
sidebarScrollbox.scrollTop = sidebarScrollTop;
|
|
} else {
|
|
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
|
|
var activeSection = document.querySelector('#sidebar .active');
|
|
if (activeSection) {
|
|
activeSection.scrollIntoView({ block: 'center' });
|
|
}
|
|
}
|
|
</script>
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
<div class="page">
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|
<div id="menu-bar" class="menu-bar sticky">
|
|
<div class="left-buttons">
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</label>
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|
<i class="fa fa-paint-brush"></i>
|
|
</button>
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|
</ul>
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
|
<i class="fa fa-search"></i>
|
|
</button>
|
|
</div>
|
|
|
|
<h1 class="menu-title">Logos Blockchain Testing Framework Book</h1>
|
|
|
|
<div class="right-buttons">
|
|
<a href="print.html" title="Print this book" aria-label="Print this book">
|
|
<i id="print-button" class="fa fa-print"></i>
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|
</form>
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|
<ul id="searchresults">
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|
<script>
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|
});
|
|
</script>
|
|
|
|
<div id="content" class="content">
|
|
<main>
|
|
<h1 id="prerequisites--setup"><a class="header" href="#prerequisites--setup">Prerequisites & Setup</a></h1>
|
|
<p>This page covers everything you need before running your first scenario.</p>
|
|
<h2 id="required-files"><a class="header" href="#required-files">Required Files</a></h2>
|
|
<h3 id="versionsenv-required"><a class="header" href="#versionsenv-required"><code>versions.env</code> (Required)</a></h3>
|
|
<p>All helper scripts require a <code>versions.env</code> file at the repository root:</p>
|
|
<pre><code class="language-bash">VERSION=v0.3.1
|
|
NOMOS_NODE_REV=abc123def456789
|
|
NOMOS_BUNDLE_VERSION=v1
|
|
</code></pre>
|
|
<p><strong>What it defines:</strong></p>
|
|
<ul>
|
|
<li><code>VERSION</code> — Circuit release tag for KZG parameters</li>
|
|
<li><code>NOMOS_NODE_REV</code> — Git revision of nomos-node to build/fetch</li>
|
|
<li><code>NOMOS_BUNDLE_VERSION</code> — Bundle schema version</li>
|
|
</ul>
|
|
<p><strong>Where it's used:</strong></p>
|
|
<ul>
|
|
<li><code>scripts/run/run-examples.sh</code></li>
|
|
<li><code>scripts/build/build-bundle.sh</code></li>
|
|
<li><code>scripts/setup/setup-nomos-circuits.sh</code></li>
|
|
<li>CI workflows</li>
|
|
</ul>
|
|
<p><strong>Error if missing:</strong></p>
|
|
<pre><code class="language-text">ERROR: versions.env not found at repository root
|
|
This file is required and should define:
|
|
VERSION=<circuit release tag>
|
|
NOMOS_NODE_REV=<nomos-node git revision>
|
|
NOMOS_BUNDLE_VERSION=<bundle schema version>
|
|
</code></pre>
|
|
<p><strong>Fix:</strong> Ensure you're in the repository root. The file should already exist in the checked-out repo.</p>
|
|
<h2 id="node-binaries"><a class="header" href="#node-binaries">Node Binaries</a></h2>
|
|
<p>Scenarios need compiled <code>nomos-node</code> and <code>nomos-executor</code> binaries.</p>
|
|
<h3 id="option-1-use-helper-scripts-recommended"><a class="header" href="#option-1-use-helper-scripts-recommended">Option 1: Use Helper Scripts (Recommended)</a></h3>
|
|
<pre><code class="language-bash">scripts/run/run-examples.sh -t 60 -v 3 -e 1 host
|
|
</code></pre>
|
|
<p>This automatically:</p>
|
|
<ul>
|
|
<li>Clones/updates nomos-node checkout</li>
|
|
<li>Builds required binaries</li>
|
|
<li>Sets <code>NOMOS_NODE_BIN</code> / <code>NOMOS_EXECUTOR_BIN</code></li>
|
|
</ul>
|
|
<h3 id="option-2-manual-build"><a class="header" href="#option-2-manual-build">Option 2: Manual Build</a></h3>
|
|
<p>If you have a sibling <code>nomos-node</code> checkout:</p>
|
|
<pre><code class="language-bash">cd ../nomos-node
|
|
cargo build --release --bin nomos-node --bin nomos-executor
|
|
|
|
# Set environment variables
|
|
export NOMOS_NODE_BIN=$PWD/target/release/nomos-node
|
|
export NOMOS_EXECUTOR_BIN=$PWD/target/release/nomos-executor
|
|
|
|
# Return to testing framework
|
|
cd ../nomos-testing
|
|
</code></pre>
|
|
<h3 id="option-3-prebuilt-bundles-ci"><a class="header" href="#option-3-prebuilt-bundles-ci">Option 3: Prebuilt Bundles (CI)</a></h3>
|
|
<p>CI workflows use prebuilt artifacts:</p>
|
|
<pre><code class="language-yaml">- name: Download nomos binaries
|
|
uses: actions/download-artifact@v3
|
|
with:
|
|
name: nomos-binaries-linux
|
|
path: .tmp/
|
|
|
|
- name: Extract bundle
|
|
run: |
|
|
tar -xzf .tmp/nomos-binaries-linux-*.tar.gz -C .tmp/
|
|
export NOMOS_NODE_BIN=$PWD/.tmp/nomos-node
|
|
export NOMOS_EXECUTOR_BIN=$PWD/.tmp/nomos-executor
|
|
</code></pre>
|
|
<h2 id="circuit-assets-kzg-parameters"><a class="header" href="#circuit-assets-kzg-parameters">Circuit Assets (KZG Parameters)</a></h2>
|
|
<p>Data Availability (DA) workloads require KZG cryptographic parameters.</p>
|
|
<h3 id="asset-location"><a class="header" href="#asset-location">Asset Location</a></h3>
|
|
<p><strong>Default path:</strong> <code>testing-framework/assets/stack/kzgrs_test_params/kzgrs_test_params</code></p>
|
|
<p>Note: The directory <code>kzgrs_test_params/</code> contains a file named <code>kzgrs_test_params</code>. This is the proving key file (~120MB).</p>
|
|
<p><strong>Container path (compose/k8s):</strong> <code>/kzgrs_test_params/kzgrs_test_params</code></p>
|
|
<h3 id="getting-assets"><a class="header" href="#getting-assets">Getting Assets</a></h3>
|
|
<p><strong>Option 1: Use helper script</strong> (recommended):</p>
|
|
<pre><code class="language-bash"># Fetch circuits
|
|
scripts/setup/setup-nomos-circuits.sh v0.3.1 /tmp/nomos-circuits
|
|
|
|
# Copy to default location
|
|
mkdir -p testing-framework/assets/stack/kzgrs_test_params
|
|
cp -r /tmp/nomos-circuits/* testing-framework/assets/stack/kzgrs_test_params/
|
|
|
|
# Verify (should be ~120MB)
|
|
ls -lh testing-framework/assets/stack/kzgrs_test_params/kzgrs_test_params
|
|
</code></pre>
|
|
<p><strong>Option 2: Let <code>run-examples.sh</code> handle it</strong>:</p>
|
|
<pre><code class="language-bash">scripts/run/run-examples.sh -t 60 -v 3 -e 1 host
|
|
</code></pre>
|
|
<p>This automatically fetches and places assets.</p>
|
|
<h3 id="override-path"><a class="header" href="#override-path">Override Path</a></h3>
|
|
<p>Set <code>NOMOS_KZGRS_PARAMS_PATH</code> to use a custom location:</p>
|
|
<pre><code class="language-bash">NOMOS_KZGRS_PARAMS_PATH=/custom/path/to/kzgrs_test_params \
|
|
cargo run -p runner-examples --bin local_runner
|
|
</code></pre>
|
|
<h3 id="when-are-assets-needed"><a class="header" href="#when-are-assets-needed">When Are Assets Needed?</a></h3>
|
|
<div class="table-wrapper"><table><thead><tr><th>Runner</th><th>When Required</th></tr></thead><tbody>
|
|
<tr><td><strong>Host (local)</strong></td><td>Always (for DA workloads)</td></tr>
|
|
<tr><td><strong>Compose</strong></td><td>During image build (baked into image)</td></tr>
|
|
<tr><td><strong>K8s</strong></td><td>During image build + mounted via hostPath</td></tr>
|
|
</tbody></table>
|
|
</div>
|
|
<p><strong>Error without assets:</strong></p>
|
|
<pre><code class="language-text">Error: Custom { kind: NotFound, error: "Circuit file not found at: testing-framework/assets/stack/kzgrs_test_params/kzgrs_test_params" }
|
|
</code></pre>
|
|
<h2 id="platform-requirements"><a class="header" href="#platform-requirements">Platform Requirements</a></h2>
|
|
<h3 id="host-runner-local-processes"><a class="header" href="#host-runner-local-processes">Host Runner (Local Processes)</a></h3>
|
|
<p><strong>Requires:</strong></p>
|
|
<ul>
|
|
<li>Rust nightly toolchain</li>
|
|
<li>Node binaries built</li>
|
|
<li>KZG circuit assets (for DA workloads)</li>
|
|
<li>Available ports (18080+, 3100+, etc.)</li>
|
|
</ul>
|
|
<p><strong>No Docker required.</strong></p>
|
|
<p><strong>Best for:</strong></p>
|
|
<ul>
|
|
<li>Quick iteration</li>
|
|
<li>Development</li>
|
|
<li>Smoke tests</li>
|
|
</ul>
|
|
<h3 id="compose-runner-docker-compose"><a class="header" href="#compose-runner-docker-compose">Compose Runner (Docker Compose)</a></h3>
|
|
<p><strong>Requires:</strong></p>
|
|
<ul>
|
|
<li>Docker daemon running</li>
|
|
<li>Docker image built: <code>logos-blockchain-testing:local</code></li>
|
|
<li>KZG assets baked into image</li>
|
|
<li>Docker Desktop (macOS) or Docker Engine (Linux)</li>
|
|
</ul>
|
|
<p><strong>Platform notes (macOS / Apple silicon):</strong></p>
|
|
<ul>
|
|
<li>Prefer <code>NOMOS_BUNDLE_DOCKER_PLATFORM=linux/arm64</code> for native performance</li>
|
|
<li>Use <code>linux/amd64</code> only if targeting amd64 environments (slower via emulation)</li>
|
|
</ul>
|
|
<p><strong>Best for:</strong></p>
|
|
<ul>
|
|
<li>Reproducible environments</li>
|
|
<li>CI testing</li>
|
|
<li>Chaos workloads (node control support)</li>
|
|
</ul>
|
|
<h3 id="k8s-runner-kubernetes"><a class="header" href="#k8s-runner-kubernetes">K8s Runner (Kubernetes)</a></h3>
|
|
<p><strong>Requires:</strong></p>
|
|
<ul>
|
|
<li>Kubernetes cluster (Docker Desktop K8s, minikube, kind, or remote)</li>
|
|
<li><code>kubectl</code> configured</li>
|
|
<li>Docker image built and loaded/pushed</li>
|
|
<li>KZG assets baked into image + mounted via hostPath</li>
|
|
</ul>
|
|
<p><strong>Local cluster setup:</strong></p>
|
|
<pre><code class="language-bash"># Docker Desktop: Enable Kubernetes in settings
|
|
|
|
# OR: Use kind
|
|
kind create cluster
|
|
kind load docker-image logos-blockchain-testing:local
|
|
|
|
# OR: Use minikube
|
|
minikube start
|
|
minikube image load logos-blockchain-testing:local
|
|
</code></pre>
|
|
<p><strong>Remote cluster:</strong> Push image to registry and set <code>NOMOS_TESTNET_IMAGE</code>.</p>
|
|
<p><strong>Best for:</strong></p>
|
|
<ul>
|
|
<li>Production-like testing</li>
|
|
<li>Resource isolation</li>
|
|
<li>Large topologies</li>
|
|
</ul>
|
|
<h2 id="critical-environment-variable"><a class="header" href="#critical-environment-variable">Critical Environment Variable</a></h2>
|
|
<p><strong><code>POL_PROOF_DEV_MODE=true</code> is REQUIRED for ALL runners!</strong></p>
|
|
<p>Without this, proof generation uses expensive Groth16 proving, causing:</p>
|
|
<ul>
|
|
<li>Tests "hang" for minutes</li>
|
|
<li>CPU spikes to 100%</li>
|
|
<li>Timeouts and failures</li>
|
|
</ul>
|
|
<p><strong>Always set:</strong></p>
|
|
<pre><code class="language-bash">POL_PROOF_DEV_MODE=true cargo run -p runner-examples --bin local_runner
|
|
POL_PROOF_DEV_MODE=true scripts/run/run-examples.sh -t 60 -v 3 -e 1 compose
|
|
# etc.
|
|
</code></pre>
|
|
<p><strong>Or add to your shell profile:</strong></p>
|
|
<pre><code class="language-bash"># ~/.bashrc or ~/.zshrc
|
|
export POL_PROOF_DEV_MODE=true
|
|
</code></pre>
|
|
<h2 id="quick-setup-check"><a class="header" href="#quick-setup-check">Quick Setup Check</a></h2>
|
|
<p>Run this checklist before your first scenario:</p>
|
|
<pre><code class="language-bash"># 1. Verify versions.env exists
|
|
cat versions.env
|
|
|
|
# 2. Check circuit assets (for DA workloads)
|
|
ls -lh testing-framework/assets/stack/kzgrs_test_params/kzgrs_test_params
|
|
|
|
# 3. Verify POL_PROOF_DEV_MODE is set
|
|
echo $POL_PROOF_DEV_MODE # Should print: true
|
|
|
|
# 4. For compose/k8s: verify Docker is running
|
|
docker ps
|
|
|
|
# 5. For compose/k8s: verify image exists
|
|
docker images | grep logos-blockchain-testing
|
|
|
|
# 6. For host runner: verify node binaries (if not using scripts)
|
|
$NOMOS_NODE_BIN --version
|
|
$NOMOS_EXECUTOR_BIN --version
|
|
</code></pre>
|
|
<h2 id="recommended-use-helper-scripts"><a class="header" href="#recommended-use-helper-scripts">Recommended: Use Helper Scripts</a></h2>
|
|
<p>The easiest path is to let the helper scripts handle everything:</p>
|
|
<pre><code class="language-bash"># Host runner
|
|
scripts/run/run-examples.sh -t 60 -v 3 -e 1 host
|
|
|
|
# Compose runner
|
|
scripts/run/run-examples.sh -t 60 -v 3 -e 1 compose
|
|
|
|
# K8s runner
|
|
scripts/run/run-examples.sh -t 60 -v 3 -e 1 k8s
|
|
</code></pre>
|
|
<p>These scripts:</p>
|
|
<ul>
|
|
<li>Verify <code>versions.env</code> exists</li>
|
|
<li>Clone/build nomos-node if needed</li>
|
|
<li>Fetch circuit assets if missing</li>
|
|
<li>Build Docker images (compose/k8s)</li>
|
|
<li>Load images into cluster (k8s)</li>
|
|
<li>Run the scenario with proper environment</li>
|
|
</ul>
|
|
<p><strong>Next Steps:</strong></p>
|
|
<ul>
|
|
<li><a href="running-examples.html">Running Examples</a> — Learn how to run scenarios</li>
|
|
<li><a href="environment-variables.html">Environment Variables</a> — Full variable reference</li>
|
|
<li><a href="troubleshooting.html">Troubleshooting</a> — Common issues and fixes</li>
|
|
</ul>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="operations-overview.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="running-examples.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
<div style="clear: both"></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|
<a rel="prev" href="operations-overview.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="running-examples.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
window.playground_copyable = true;
|
|
</script>
|
|
|
|
|
|
<script src="elasticlunr.min.js"></script>
|
|
<script src="mark.min.js"></script>
|
|
<script src="searcher.js"></script>
|
|
|
|
<script src="clipboard.min.js"></script>
|
|
<script src="highlight.js"></script>
|
|
<script src="book.js"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
<script src="theme/mermaid-init.js"></script>
|
|
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|