nimbus-eth1/protocol-interop-testing.html

1536 lines
47 KiB
HTML

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="prev" href="fluffy-with-portal-hive.html">
<link rel="next" href="eth-data-exporter.html">
<link rel="icon" href="assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.27">
<title>Protocol Interoperability Testing - The Nimbus Fluffy Guide</title>
<link rel="stylesheet" href="assets/stylesheets/main.6543a935.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="stylesheets/extra.css">
<script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="light-blue">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#protocol-interoperability-testing" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="." title="The Nimbus Fluffy Guide" class="md-header__button md-logo" aria-label="The Nimbus Fluffy Guide" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
The Nimbus Fluffy Guide
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Protocol Interoperability Testing
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="light-blue" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
</label>
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="white" data-md-color-accent="light-blue" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
</label>
</form>
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/status-im/nimbus-eth1" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="index.html" class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="quick-start.html" class="md-tabs__link">
Getting started
</a>
</li>
<li class="md-tabs__item">
<a href="prerequisites.html" class="md-tabs__link">
How-to
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="basics-for-developers.html" class="md-tabs__link">
Developers
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="." title="The Nimbus Fluffy Guide" class="md-nav__button md-logo" aria-label="The Nimbus Fluffy Guide" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
The Nimbus Fluffy Guide
</label>
<div class="md-nav__source">
<a href="https://github.com/status-im/nimbus-eth1" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
<label class="md-nav__link" for="__nav_1" id="__nav_1_label" tabindex="0">
<span class="md-ellipsis">
Home
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_1">
<span class="md-nav__icon md-icon"></span>
Home
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="index.html" class="md-nav__link">
<span class="md-ellipsis">
The Nimbus Fluffy Guide
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Getting started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Getting started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="quick-start.html" class="md-nav__link">
<span class="md-ellipsis">
Quick start - Linux/macOS
</span>
</a>
</li>
<li class="md-nav__item">
<a href="quick-start-windows.html" class="md-nav__link">
<span class="md-ellipsis">
Quick start - Windows
</span>
</a>
</li>
<li class="md-nav__item">
<a href="quick-start-docker.html" class="md-nav__link">
<span class="md-ellipsis">
Quick start - Docker
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
How-to
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
How-to
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_1" >
<label class="md-nav__link" for="__nav_3_1" id="__nav_3_1_label" tabindex="0">
<span class="md-ellipsis">
Installation
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_1_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_1">
<span class="md-nav__icon md-icon"></span>
Installation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="prerequisites.html" class="md-nav__link">
<span class="md-ellipsis">
Prerequisites
</span>
</a>
</li>
<li class="md-nav__item">
<a href="build-from-source.html" class="md-nav__link">
<span class="md-ellipsis">
Build from source
</span>
</a>
</li>
<li class="md-nav__item">
<a href="upgrade.html" class="md-nav__link">
<span class="md-ellipsis">
Upgrade
</span>
</a>
</li>
<li class="md-nav__item">
<a href="metrics.html" class="md-nav__link">
<span class="md-ellipsis">
Metrics and their visualisation
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
<label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
<span class="md-ellipsis">
Access the network
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_2">
<span class="md-nav__icon md-icon"></span>
Access the network
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="connect-to-portal.html" class="md-nav__link">
<span class="md-ellipsis">
Connect to the Portal network
</span>
</a>
</li>
<li class="md-nav__item">
<a href="access-content.html" class="md-nav__link">
<span class="md-ellipsis">
Access content on the Portal network
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_3" >
<label class="md-nav__link" for="__nav_3_3" id="__nav_3_3_label" tabindex="0">
<span class="md-ellipsis">
Portal bridge
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3_3">
<span class="md-nav__icon md-icon"></span>
Portal bridge
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="history-content-bridging.html" class="md-nav__link">
<span class="md-ellipsis">
Bridging content: Portal history network
</span>
</a>
</li>
<li class="md-nav__item">
<a href="beacon-content-bridging.html" class="md-nav__link">
<span class="md-ellipsis">
Bridging content into the Portal beacon network
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="db_pruning.html" class="md-nav__link">
<span class="md-ellipsis">
Database pruning
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-ellipsis">
Developers
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Developers
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="basics-for-developers.html" class="md-nav__link">
<span class="md-ellipsis">
The basics for developers
</span>
</a>
</li>
<li class="md-nav__item">
<a href="test-suite.html" class="md-nav__link">
<span class="md-ellipsis">
Fluffy test suite
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4_3" >
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
<span class="md-ellipsis">
Local testnet
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4_3">
<span class="md-nav__icon md-icon"></span>
Local testnet
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="run-local-testnet.html" class="md-nav__link">
<span class="md-ellipsis">
Running a local testnet
</span>
</a>
</li>
<li class="md-nav__item">
<a href="testnet-history-network.html" class="md-nav__link">
<span class="md-ellipsis">
Testing history network on local testnet
</span>
</a>
</li>
<li class="md-nav__item">
<a href="testnet-beacon-network.html" class="md-nav__link">
<span class="md-ellipsis">
Testing beacon network on local testnet
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="fluffy-with-portal-hive.html" class="md-nav__link">
<span class="md-ellipsis">
Fluffy with Portal-hive
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Protocol Interoperability Testing
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="protocol-interop-testing.html" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Protocol Interoperability Testing
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#run-fluffy-and-test-protocol-messages-via-json-rpc-api" class="md-nav__link">
<span class="md-ellipsis">
Run Fluffy and test protocol messages via JSON-RPC API
</span>
</a>
<nav class="md-nav" aria-label="Run Fluffy and test protocol messages via JSON-RPC API">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#testing-discovery-v5-layer" class="md-nav__link">
<span class="md-ellipsis">
Testing Discovery v5 Layer
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#testing-portal-networks-layer" class="md-nav__link">
<span class="md-ellipsis">
Testing Portal Networks Layer
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#test-discovery-and-portal-wire-protocol-messages-with-cli-tools" class="md-nav__link">
<span class="md-ellipsis">
Test Discovery and Portal Wire protocol messages with cli tools
</span>
</a>
<nav class="md-nav" aria-label="Test Discovery and Portal Wire protocol messages with cli tools">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#testing-discovery-v5-layer-dcli" class="md-nav__link">
<span class="md-ellipsis">
Testing Discovery v5 Layer: dcli
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#testing-portal-networks-layer-portalcli" class="md-nav__link">
<span class="md-ellipsis">
Testing Portal Networks Layer: portalcli
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="eth-data-exporter.html" class="md-nav__link">
<span class="md-ellipsis">
Exporting Ethereum content for Portal
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#run-fluffy-and-test-protocol-messages-via-json-rpc-api" class="md-nav__link">
<span class="md-ellipsis">
Run Fluffy and test protocol messages via JSON-RPC API
</span>
</a>
<nav class="md-nav" aria-label="Run Fluffy and test protocol messages via JSON-RPC API">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#testing-discovery-v5-layer" class="md-nav__link">
<span class="md-ellipsis">
Testing Discovery v5 Layer
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#testing-portal-networks-layer" class="md-nav__link">
<span class="md-ellipsis">
Testing Portal Networks Layer
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#test-discovery-and-portal-wire-protocol-messages-with-cli-tools" class="md-nav__link">
<span class="md-ellipsis">
Test Discovery and Portal Wire protocol messages with cli tools
</span>
</a>
<nav class="md-nav" aria-label="Test Discovery and Portal Wire protocol messages with cli tools">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#testing-discovery-v5-layer-dcli" class="md-nav__link">
<span class="md-ellipsis">
Testing Discovery v5 Layer: dcli
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#testing-portal-networks-layer-portalcli" class="md-nav__link">
<span class="md-ellipsis">
Testing Portal Networks Layer: portalcli
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="protocol-interoperability-testing">Protocol Interoperability Testing<a class="headerlink" href="#protocol-interoperability-testing" title="Permanent link">#</a></h1>
<p>This document shows a set of commands that can be used to test the individual
protocol messages per network (Discovery v5 and Portal networks), e.g. to test
client protocol interoperability.</p>
<p>Two ways are explained, the first, by keeping a node running and interacting
with it through the JSON-RPC service. The second, by running cli applications
that attempt to send 1 specific message and then shutdown.</p>
<p>The first is more powerful and complete, the second one might be easier to do
some quick testing.</p>
<h2 id="run-fluffy-and-test-protocol-messages-via-json-rpc-api">Run Fluffy and test protocol messages via JSON-RPC API<a class="headerlink" href="#run-fluffy-and-test-protocol-messages-via-json-rpc-api" title="Permanent link">#</a></h2>
<p>First build Fluffy as explained <a href="quick-start.html#build-the-fluffy-client">here</a>.</p>
<p>Next run it with the JSON-RPC server enabled:
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>./build/fluffy<span class="w"> </span>--rpc<span class="w"> </span>--bootstrap-node:enr:&lt;base64<span class="w"> </span>encoding<span class="w"> </span>of<span class="w"> </span>ENR&gt;
</code></pre></div></p>
<h3 id="testing-discovery-v5-layer">Testing Discovery v5 Layer<a class="headerlink" href="#testing-discovery-v5-layer" title="Permanent link">#</a></h3>
<p>Testing the Discovery v5 protocol messages:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="c1"># Ping / Pong</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>curl<span class="w"> </span>-s<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>-H<span class="w"> </span><span class="s1">&#39;Content-Type: application/json&#39;</span><span class="w"> </span>-d<span class="w"> </span><span class="s1">&#39;{&quot;jsonrpc&quot;:&quot;2.0&quot;,&quot;id&quot;:&quot;1&quot;,&quot;method&quot;:&quot;discv5_ping&quot;,&quot;params&quot;:[&quot;enr:&lt;base64 encoding of ENR&gt;&quot;]}&#39;</span><span class="w"> </span>http://localhost:8545<span class="w"> </span><span class="p">|</span><span class="w"> </span>jq
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="c1"># FindNode / Nodes</span>
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="c1"># Extra parameter is an array of requested logarithmic distances</span>
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a>curl<span class="w"> </span>-s<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>-H<span class="w"> </span><span class="s1">&#39;Content-Type: application/json&#39;</span><span class="w"> </span>-d<span class="w"> </span><span class="s1">&#39;{&quot;jsonrpc&quot;:&quot;2.0&quot;,&quot;id&quot;:&quot;1&quot;,&quot;method&quot;:&quot;discv5_findNode&quot;,&quot;params&quot;:[&quot;enr:&lt;base64 encoding of ENR&gt;&quot;, [254, 255, 256]]}&#39;</span><span class="w"> </span>http://localhost:8545<span class="w"> </span><span class="p">|</span><span class="w"> </span>jq
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a>
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="c1"># TalkReq / TalkResp</span>
<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="c1"># Extra parameters are the protocol id and the request byte string, hex encoded.</span>
<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a>curl<span class="w"> </span>-s<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>-H<span class="w"> </span><span class="s1">&#39;Content-Type: application/json&#39;</span><span class="w"> </span>-d<span class="w"> </span><span class="s1">&#39;{&quot;jsonrpc&quot;:&quot;2.0&quot;,&quot;id&quot;:&quot;1&quot;,&quot;method&quot;:&quot;discv5_talkReq&quot;,&quot;params&quot;:[&quot;enr:&lt;base64 encoding of ENR&gt;&quot;, &quot;&quot;, &quot;&quot;]}&#39;</span><span class="w"> </span>http://localhost:8545<span class="w"> </span><span class="p">|</span><span class="w"> </span>jq
<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a>
<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a><span class="c1"># Read out the discover v5 routing table contents</span>
<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a>curl<span class="w"> </span>-s<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>-H<span class="w"> </span><span class="s1">&#39;Content-Type: application/json&#39;</span><span class="w"> </span>-d<span class="w"> </span><span class="s1">&#39;{&quot;jsonrpc&quot;:&quot;2.0&quot;,&quot;id&quot;:&quot;1&quot;,&quot;method&quot;:&quot;discv5_routingTableInfo&quot;,&quot;params&quot;:[]}&#39;</span><span class="w"> </span>http://localhost:8545<span class="w"> </span><span class="p">|</span><span class="w"> </span>jq
</code></pre></div>
<h3 id="testing-portal-networks-layer">Testing Portal Networks Layer<a class="headerlink" href="#testing-portal-networks-layer" title="Permanent link">#</a></h3>
<p>Testing the Portal wire protocol messages:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="c1"># Ping / Pong</span>
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>curl<span class="w"> </span>-s<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>-H<span class="w"> </span><span class="s1">&#39;Content-Type: application/json&#39;</span><span class="w"> </span>-d<span class="w"> </span><span class="s1">&#39;{&quot;jsonrpc&quot;:&quot;2.0&quot;,&quot;id&quot;:&quot;1&quot;,&quot;method&quot;:&quot;portal_statePing&quot;,&quot;params&quot;:[&quot;enr:&lt;base64 encoding of ENR&gt;&quot;]}&#39;</span><span class="w"> </span>http://localhost:8545<span class="w"> </span><span class="p">|</span><span class="w"> </span>jq
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a>
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="c1"># FindNode / Nodes</span>
<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a><span class="c1"># Extra parameter is an array of requested logarithmic distances</span>
<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a>curl<span class="w"> </span>-s<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>-H<span class="w"> </span><span class="s1">&#39;Content-Type: application/json&#39;</span><span class="w"> </span>-d<span class="w"> </span><span class="s1">&#39;{&quot;jsonrpc&quot;:&quot;2.0&quot;,&quot;id&quot;:&quot;1&quot;,&quot;method&quot;:&quot;portal_stateFindNodes&quot;,&quot;params&quot;:[&quot;enr:&lt;base64 encoding of ENR&gt;&quot;, [254, 255, 256]]}&#39;</span><span class="w"> </span>http://localhost:8545<span class="w"> </span><span class="p">|</span><span class="w"> </span>jq
<a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a>
<a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a><span class="c1"># FindContent / Content</span>
<a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a><span class="c1"># A request with an invalid content key will not receive a response</span>
<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a>curl<span class="w"> </span>-s<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>-H<span class="w"> </span><span class="s1">&#39;Content-Type: application/json&#39;</span><span class="w"> </span>-d<span class="w"> </span><span class="s1">&#39;{&quot;jsonrpc&quot;:&quot;2.0&quot;,&quot;id&quot;:&quot;1&quot;,&quot;method&quot;:&quot;portal_stateFindContent&quot;,&quot;params&quot;:[&quot;enr:&lt;base64 encoding of ENR&gt;&quot;, &quot;02829bd824b016326a401d083b33d092293333a830d1c390624d3bd4e409a61a858e5dcc5517729a9170d014a6c96530d64dd8621d&quot;]}&#39;</span><span class="w"> </span>http://localhost:8545<span class="w"> </span><span class="p">|</span><span class="w"> </span>jq
<a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a>
<a id="__codelineno-2-12" name="__codelineno-2-12" href="#__codelineno-2-12"></a><span class="c1"># Read out the Portal state network routing table contents</span>
<a id="__codelineno-2-13" name="__codelineno-2-13" href="#__codelineno-2-13"></a>curl<span class="w"> </span>-s<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>-H<span class="w"> </span><span class="s1">&#39;Content-Type: application/json&#39;</span><span class="w"> </span>-d<span class="w"> </span><span class="s1">&#39;{&quot;jsonrpc&quot;:&quot;2.0&quot;,&quot;id&quot;:&quot;1&quot;,&quot;method&quot;:&quot;portal_stateRoutingTableInfo&quot;,&quot;params&quot;:[]}&#39;</span><span class="w"> </span>http://localhost:8545<span class="w"> </span><span class="p">|</span><span class="w"> </span>jq
</code></pre></div>
<blockquote>
<p>The <code>portal_state_</code> prefix can be replaced for testing other networks such as
<code>portal_history_</code>.</p>
</blockquote>
<h2 id="test-discovery-and-portal-wire-protocol-messages-with-cli-tools">Test Discovery and Portal Wire protocol messages with cli tools<a class="headerlink" href="#test-discovery-and-portal-wire-protocol-messages-with-cli-tools" title="Permanent link">#</a></h2>
<h3 id="testing-discovery-v5-layer-dcli">Testing Discovery v5 Layer: dcli<a class="headerlink" href="#testing-discovery-v5-layer-dcli" title="Permanent link">#</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="c1"># Build dcli from nim-eth vendor module</span>
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="o">(</span><span class="nb">cd</span><span class="w"> </span>vendor/nim-eth/<span class="p">;</span><span class="w"> </span>../../env.sh<span class="w"> </span>nimble<span class="w"> </span>build_dcli<span class="o">)</span>
</code></pre></div>
<p>With the <code>dcli</code> tool you can test the individual Discovery v5 protocol messages,
e.g.:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="c1"># Test Discovery Ping, should print the content of ping message</span>
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>./vendor/nim-eth/build/dcli<span class="w"> </span>ping<span class="w"> </span>enr:&lt;base64<span class="w"> </span>encoding<span class="w"> </span>of<span class="w"> </span>ENR&gt;
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="c1"># Test Discovery FindNode, should print the content of the returned ENRs</span>
<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a><span class="c1"># Default a distance of 256 is requested, change this with --distance argument</span>
<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a>./vendor/nim-eth/build/dcli<span class="w"> </span>findnode<span class="w"> </span>enr:&lt;base64<span class="w"> </span>encoding<span class="w"> </span>of<span class="w"> </span>ENR&gt;
<a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a>
<a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a><span class="c1"># Test Discovery TalkReq, should print the TalkResp content</span>
<a id="__codelineno-4-9" name="__codelineno-4-9" href="#__codelineno-4-9"></a>./vendor/nim-eth/build/dcli<span class="w"> </span>talkreq<span class="w"> </span>enr:&lt;base64<span class="w"> </span>encoding<span class="w"> </span>of<span class="w"> </span>ENR&gt;
</code></pre></div>
<blockquote>
<p>Each <code>dcli</code> run will default generate a new network key and thus a new node id
and ENR.</p>
</blockquote>
<h3 id="testing-portal-networks-layer-portalcli">Testing Portal Networks Layer: portalcli<a class="headerlink" href="#testing-portal-networks-layer-portalcli" title="Permanent link">#</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="c1"># Build portalcli</span>
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>make<span class="w"> </span>portalcli
</code></pre></div>
<p>With the <code>portalcli</code> tool you can test the individual Portal wire protocol
messages, e.g.:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="c1"># Test Portal wire Ping, should print the content of ping message</span>
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>./build/portalcli<span class="w"> </span>ping<span class="w"> </span>enr:&lt;base64<span class="w"> </span>encoding<span class="w"> </span>of<span class="w"> </span>ENR&gt;
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a>
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="c1"># Test Portal wire FindNode, should print the content of the returned ENRs</span>
<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a><span class="c1"># Default a distance of 256 is requested, change this with --distance argument</span>
<a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a>./build/portalcli<span class="w"> </span>findnodes<span class="w"> </span>enr:&lt;base64<span class="w"> </span>encoding<span class="w"> </span>of<span class="w"> </span>ENR&gt;
<a id="__codelineno-6-7" name="__codelineno-6-7" href="#__codelineno-6-7"></a>
<a id="__codelineno-6-8" name="__codelineno-6-8" href="#__codelineno-6-8"></a><span class="c1"># Test Portal wire FindContent, should print the returned content</span>
<a id="__codelineno-6-9" name="__codelineno-6-9" href="#__codelineno-6-9"></a>./build/portalcli<span class="w"> </span>findcontent<span class="w"> </span>enr:&lt;base64<span class="w"> </span>encoding<span class="w"> </span>of<span class="w"> </span>ENR&gt;
<a id="__codelineno-6-10" name="__codelineno-6-10" href="#__codelineno-6-10"></a>
<a id="__codelineno-6-11" name="__codelineno-6-11" href="#__codelineno-6-11"></a><span class="c1"># Default the history network is tested, but you can provide another protocol id</span>
<a id="__codelineno-6-12" name="__codelineno-6-12" href="#__codelineno-6-12"></a>./build/portalcli<span class="w"> </span>ping<span class="w"> </span>enr:&lt;base64<span class="w"> </span>encoding<span class="w"> </span>of<span class="w"> </span>ENR&gt;<span class="w"> </span>--protocol-id:0x500B
</code></pre></div>
<blockquote>
<p>Each <code>portalcli</code> run will default generate a new network key and thus a new
node id and ENR.</p>
</blockquote>
</article>
</div>
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var tab,labels=set.querySelector(".tabbed-labels");for(tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": ".", "features": ["navigation.expand", "navigation.tabs", "navigation.top", "content.tabs.link"], "search": "assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="assets/javascripts/bundle.ad660dcc.min.js"></script>
</body>
</html>