mirror of
https://github.com/logos-blockchain/logos-blockchain-testing.git
synced 2026-01-02 21:33:07 +00:00
438 lines
28 KiB
HTML
438 lines
28 KiB
HTML
<!DOCTYPE HTML>
|
||
<html lang="en" class="light" dir="ltr">
|
||
<head>
|
||
<!-- Book generated using mdBook -->
|
||
<meta charset="UTF-8">
|
||
<title>Quickstart - 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" class="active"><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"><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="quickstart"><a class="header" href="#quickstart">Quickstart</a></h1>
|
||
<p>Get a working example running quickly.</p>
|
||
<h2 id="prerequisites"><a class="header" href="#prerequisites">Prerequisites</a></h2>
|
||
<ul>
|
||
<li>Rust toolchain (nightly)</li>
|
||
<li>This repository cloned</li>
|
||
<li>Unix-like system (tested on Linux and macOS)</li>
|
||
<li>For Docker Compose examples: Docker daemon running</li>
|
||
<li>For Docker Desktop on Apple silicon (compose/k8s): set <code>NOMOS_BUNDLE_DOCKER_PLATFORM=linux/arm64</code> to avoid slow/fragile amd64 emulation builds</li>
|
||
<li><strong><code>versions.env</code> file</strong> at repository root (defines VERSION, NOMOS_NODE_REV, NOMOS_BUNDLE_VERSION)</li>
|
||
</ul>
|
||
<p><strong>Note:</strong> <code>nomos-node</code> binaries are built automatically on demand or can be provided via prebuilt bundles.</p>
|
||
<p><strong>Important:</strong> The <code>versions.env</code> file is required by helper scripts. If missing, the scripts will fail with an error. The file should already exist in the repository root.</p>
|
||
<h2 id="your-first-test"><a class="header" href="#your-first-test">Your First Test</a></h2>
|
||
<p>The framework ships with runnable example binaries in <code>examples/src/bin/</code>.</p>
|
||
<p><strong>Recommended:</strong> Use the convenience script:</p>
|
||
<pre><code class="language-bash"># From the logos-blockchain-testing directory
|
||
scripts/run/run-examples.sh -t 60 -v 1 -e 1 host
|
||
</code></pre>
|
||
<p>This handles circuit setup, binary building, and runs a complete scenario: 1 validator + 1 executor, mixed transaction + DA workload (5 tx/block + 1 channel + 1 blob), 60s duration.</p>
|
||
<p><strong>Alternative:</strong> Direct cargo run (requires manual setup):</p>
|
||
<pre><code class="language-bash"># Requires circuits in place and NOMOS_NODE_BIN/NOMOS_EXECUTOR_BIN set
|
||
POL_PROOF_DEV_MODE=true cargo run -p runner-examples --bin local_runner
|
||
</code></pre>
|
||
<p><strong>Core API Pattern</strong> (simplified example):</p>
|
||
<pre><code class="language-rust ignore">use std::time::Duration;
|
||
|
||
use anyhow::Result;
|
||
use testing_framework_core::scenario::{Deployer, ScenarioBuilder};
|
||
use testing_framework_runner_local::LocalDeployer;
|
||
use testing_framework_workflows::ScenarioBuilderExt;
|
||
|
||
pub async fn run_local_demo() -> Result<()> {
|
||
// Define the scenario (1 validator + 1 executor, tx + DA workload)
|
||
let mut plan = ScenarioBuilder::topology_with(|t| t.network_star().validators(1).executors(1))
|
||
.wallets(1_000)
|
||
.transactions_with(|txs| {
|
||
txs.rate(5) // 5 transactions per block
|
||
.users(500) // use 500 of the seeded wallets
|
||
})
|
||
.da_with(|da| {
|
||
da.channel_rate(1) // 1 channel
|
||
.blob_rate(1) // target 1 blob per block
|
||
.headroom_percent(20) // default headroom when sizing channels
|
||
})
|
||
.expect_consensus_liveness()
|
||
.with_run_duration(Duration::from_secs(60))
|
||
.build();
|
||
|
||
// Deploy and run
|
||
let deployer = LocalDeployer::default();
|
||
let runner = deployer.deploy(&plan).await?;
|
||
let _handle = runner.run(&mut plan).await?;
|
||
|
||
Ok(())
|
||
}</code></pre>
|
||
<p><strong>Note:</strong> The examples are binaries with <code>#[tokio::main]</code>, not test functions. If you want to write integration tests, wrap this pattern in <code>#[tokio::test]</code> functions in your own test suite.</p>
|
||
<p><strong>Important:</strong> <code>POL_PROOF_DEV_MODE=true</code> disables expensive Groth16 zero-knowledge proof generation for leader election. Without it, proof generation is CPU-intensive and tests will timeout. <strong>This is required for all runners</strong> (local, compose, k8s) for practical testing. Never use in production.</p>
|
||
<p><strong>What you should see:</strong></p>
|
||
<ul>
|
||
<li>Nodes spawn as local processes</li>
|
||
<li>Consensus starts producing blocks</li>
|
||
<li>Scenario runs for the configured duration</li>
|
||
<li>Node state/logs written under a temporary per-run directory in the current working directory (removed after the run unless <code>NOMOS_TESTS_KEEP_LOGS=1</code>)</li>
|
||
<li>To write per-node log files to a stable location: set <code>NOMOS_LOG_DIR=/path/to/logs</code> (files will have prefix like <code>nomos-node-0*</code>, may include timestamps)</li>
|
||
</ul>
|
||
<h2 id="what-just-happened"><a class="header" href="#what-just-happened">What Just Happened?</a></h2>
|
||
<p>Let's unpack the code:</p>
|
||
<h3 id="1-topology-configuration"><a class="header" href="#1-topology-configuration">1. Topology Configuration</a></h3>
|
||
<pre><code class="language-rust ignore">use testing_framework_core::scenario::ScenarioBuilder;
|
||
|
||
pub fn step_1_topology() -> testing_framework_core::scenario::Builder<()> {
|
||
ScenarioBuilder::topology_with(|t| {
|
||
t.network_star() // Star topology: all nodes connect to seed
|
||
.validators(1) // 1 validator node
|
||
.executors(1) // 1 executor node (validator + DA dispersal)
|
||
})
|
||
}</code></pre>
|
||
<p>This defines <strong>what</strong> your test network looks like.</p>
|
||
<h3 id="2-wallet-seeding"><a class="header" href="#2-wallet-seeding">2. Wallet Seeding</a></h3>
|
||
<pre><code class="language-rust ignore">use testing_framework_core::scenario::ScenarioBuilder;
|
||
use testing_framework_workflows::ScenarioBuilderExt;
|
||
|
||
pub fn step_2_wallets() -> testing_framework_core::scenario::Builder<()> {
|
||
ScenarioBuilder::with_node_counts(1, 1).wallets(1_000) // Seed 1,000 funded wallet accounts
|
||
}</code></pre>
|
||
<p>Provides funded accounts for transaction submission.</p>
|
||
<h3 id="3-workloads"><a class="header" href="#3-workloads">3. Workloads</a></h3>
|
||
<pre><code class="language-rust ignore">use testing_framework_core::scenario::ScenarioBuilder;
|
||
use testing_framework_workflows::ScenarioBuilderExt;
|
||
|
||
pub fn step_3_workloads() -> testing_framework_core::scenario::Builder<()> {
|
||
ScenarioBuilder::with_node_counts(1, 1)
|
||
.wallets(1_000)
|
||
.transactions_with(|txs| {
|
||
txs.rate(5) // 5 transactions per block
|
||
.users(500) // Use 500 of the 1,000 wallets
|
||
})
|
||
.da_with(|da| {
|
||
da.channel_rate(1) // 1 DA channel (more spawned with headroom)
|
||
.blob_rate(1) // target 1 blob per block
|
||
.headroom_percent(20) // default headroom when sizing channels
|
||
})
|
||
}</code></pre>
|
||
<p>Generates both transaction and DA traffic to stress both subsystems.</p>
|
||
<h3 id="4-expectation"><a class="header" href="#4-expectation">4. Expectation</a></h3>
|
||
<pre><code class="language-rust ignore">use testing_framework_core::scenario::ScenarioBuilder;
|
||
use testing_framework_workflows::ScenarioBuilderExt;
|
||
|
||
pub fn step_4_expectation() -> testing_framework_core::scenario::Builder<()> {
|
||
ScenarioBuilder::with_node_counts(1, 1).expect_consensus_liveness() // This says what success means: blocks must be produced continuously.
|
||
}</code></pre>
|
||
<p>This says <strong>what success means</strong>: blocks must be produced continuously.</p>
|
||
<h3 id="5-run-duration"><a class="header" href="#5-run-duration">5. Run Duration</a></h3>
|
||
<pre><code class="language-rust ignore">use std::time::Duration;
|
||
|
||
use testing_framework_core::scenario::ScenarioBuilder;
|
||
|
||
pub fn step_5_run_duration() -> testing_framework_core::scenario::Builder<()> {
|
||
ScenarioBuilder::with_node_counts(1, 1).with_run_duration(Duration::from_secs(60))
|
||
}</code></pre>
|
||
<p>Run for 60 seconds (~27 blocks with default 2s slots, 0.9 coefficient). Framework ensures this is at least 2× the consensus slot duration. Adjust consensus timing via <code>CONSENSUS_SLOT_TIME</code> and <code>CONSENSUS_ACTIVE_SLOT_COEFF</code>.</p>
|
||
<h3 id="6-deploy-and-execute"><a class="header" href="#6-deploy-and-execute">6. Deploy and Execute</a></h3>
|
||
<pre><code class="language-rust ignore">use anyhow::Result;
|
||
use testing_framework_core::scenario::{Deployer, ScenarioBuilder};
|
||
use testing_framework_runner_local::LocalDeployer;
|
||
|
||
pub async fn step_6_deploy_and_execute() -> Result<()> {
|
||
let mut plan = ScenarioBuilder::with_node_counts(1, 1).build();
|
||
|
||
let deployer = LocalDeployer::default(); // Use local process deployer
|
||
let runner = deployer.deploy(&plan).await?; // Provision infrastructure
|
||
let _handle = runner.run(&mut plan).await?; // Execute workloads & expectations
|
||
|
||
Ok(())
|
||
}</code></pre>
|
||
<p><strong>Deployer</strong> provisions the infrastructure. <strong>Runner</strong> orchestrates execution.</p>
|
||
<h2 id="adjust-the-topology"><a class="header" href="#adjust-the-topology">Adjust the Topology</a></h2>
|
||
<p><strong>With run-examples.sh</strong> (recommended):</p>
|
||
<pre><code class="language-bash"># Scale up to 3 validators + 2 executors, run for 2 minutes
|
||
scripts/run/run-examples.sh -t 120 -v 3 -e 2 host
|
||
</code></pre>
|
||
<p><strong>With direct cargo run:</strong></p>
|
||
<pre><code class="language-bash"># Uses NOMOS_DEMO_* env vars (or legacy *_DEMO_* vars)
|
||
NOMOS_DEMO_VALIDATORS=3 \
|
||
NOMOS_DEMO_EXECUTORS=2 \
|
||
NOMOS_DEMO_RUN_SECS=120 \
|
||
POL_PROOF_DEV_MODE=true \
|
||
cargo run -p runner-examples --bin local_runner
|
||
</code></pre>
|
||
<h2 id="try-docker-compose"><a class="header" href="#try-docker-compose">Try Docker Compose</a></h2>
|
||
<p>Use the same API with a different deployer for reproducible containerized environment.</p>
|
||
<p><strong>Recommended:</strong> Use the convenience script (handles everything):</p>
|
||
<pre><code class="language-bash">scripts/run/run-examples.sh -t 60 -v 1 -e 1 compose
|
||
</code></pre>
|
||
<p>This automatically:</p>
|
||
<ul>
|
||
<li>Fetches circuit assets (to <code>testing-framework/assets/stack/kzgrs_test_params/kzgrs_test_params</code>)</li>
|
||
<li>Builds/uses prebuilt binaries (via <code>NOMOS_BINARIES_TAR</code> if available)</li>
|
||
<li>Builds the Docker image</li>
|
||
<li>Runs the compose scenario</li>
|
||
</ul>
|
||
<p><strong>Alternative:</strong> Direct cargo run with manual setup:</p>
|
||
<pre><code class="language-bash"># Option 1: Use prebuilt bundle (recommended for compose/k8s)
|
||
scripts/build/build-bundle.sh --platform linux # Creates .tmp/nomos-binaries-linux-v0.3.1.tar.gz
|
||
export NOMOS_BINARIES_TAR=.tmp/nomos-binaries-linux-v0.3.1.tar.gz
|
||
|
||
# Option 2: Manual circuit/image setup (rebuilds during image build)
|
||
scripts/setup/setup-nomos-circuits.sh v0.3.1 /tmp/nomos-circuits
|
||
cp -r /tmp/nomos-circuits/* testing-framework/assets/stack/kzgrs_test_params/
|
||
scripts/build/build_test_image.sh
|
||
|
||
# Run with Compose
|
||
NOMOS_TESTNET_IMAGE=logos-blockchain-testing:local \
|
||
POL_PROOF_DEV_MODE=true \
|
||
cargo run -p runner-examples --bin compose_runner
|
||
</code></pre>
|
||
<p><strong>Benefit:</strong> Reproducible containerized environment (Dockerized nodes, repeatable deployments).</p>
|
||
<p><strong>Optional: Prometheus + Grafana</strong></p>
|
||
<p>The runner can integrate with external observability endpoints. For a ready-to-run local stack:</p>
|
||
<pre><code class="language-bash">scripts/setup/setup-observability.sh compose up
|
||
eval "$(scripts/setup/setup-observability.sh compose env)"
|
||
</code></pre>
|
||
<p>Then run your compose scenario as usual (the environment variables enable PromQL querying and node OTLP metrics export).</p>
|
||
<p><strong>Note:</strong> Compose expects KZG parameters at <code>/kzgrs_test_params/kzgrs_test_params</code> inside containers (the directory name is repeated as the filename).</p>
|
||
<p><strong>In code:</strong> Just swap the deployer:</p>
|
||
<pre><code class="language-rust ignore">use anyhow::Result;
|
||
use testing_framework_core::scenario::{Deployer, ScenarioBuilder};
|
||
use testing_framework_runner_compose::ComposeDeployer;
|
||
|
||
pub async fn run_with_compose_deployer() -> Result<()> {
|
||
// ... same scenario definition ...
|
||
let mut plan = ScenarioBuilder::with_node_counts(1, 1).build();
|
||
|
||
let deployer = ComposeDeployer::default(); // Use Docker Compose
|
||
let runner = deployer.deploy(&plan).await?;
|
||
let _handle = runner.run(&mut plan).await?;
|
||
|
||
Ok(())
|
||
}</code></pre>
|
||
<h2 id="next-steps"><a class="header" href="#next-steps">Next Steps</a></h2>
|
||
<p>Now that you have a working test:</p>
|
||
<ul>
|
||
<li><strong>Understand the philosophy</strong>: <a href="testing-philosophy.html">Testing Philosophy</a></li>
|
||
<li><strong>Learn the architecture</strong>: <a href="architecture-overview.html">Architecture Overview</a></li>
|
||
<li><strong>See more examples</strong>: <a href="examples.html">Examples</a></li>
|
||
<li><strong>API reference</strong>: <a href="dsl-cheat-sheet.html">Builder API Quick Reference</a></li>
|
||
<li><strong>Debug failures</strong>: <a href="troubleshooting.html">Troubleshooting</a></li>
|
||
</ul>
|
||
|
||
</main>
|
||
|
||
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
<!-- Mobile navigation buttons -->
|
||
<a rel="prev" href="what-you-will-learn.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="part-i.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="what-you-will-learn.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="part-i.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>
|