status-im
/
nim-libp2p
mirror of https://github.com/status-im/nim-libp2p.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
nim-libp2p/master/libp2p/routing_record.html

433 lines
54 KiB
HTML
Raw Normal View History

update docs for master
2023-12-18 18:06:09 +00:00
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Favicon -->
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
<!-- CSS -->
<title>libp2p/routing_record</title>
<link rel="stylesheet" type="text/css" href="../nimdoc.out.css">
<script type="text/javascript" src="../dochack.js"></script>
<script type="text/javascript">
function main() {
var pragmaDots = document.getElementsByClassName("pragmadots");
for (var i = 0; i < pragmaDots.length; i++) {
pragmaDots[i].onclick = function(event) {
// Hide tease
event.target.parentNode.style.display = "none";
// Show actual
event.target.parentNode.nextElementSibling.style.display = "inline";
}
}
function switchTheme(e) {
if (e.target.checked) {
document.documentElement.setAttribute('data-theme', 'dark');
localStorage.setItem('theme', 'dark');
} else {
document.documentElement.setAttribute('data-theme', 'light');
localStorage.setItem('theme', 'light');
}
}
const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
if (toggleSwitch !== null) {
toggleSwitch.addEventListener('change', switchTheme, false);
}
var currentTheme = localStorage.getItem('theme');
if (!currentTheme && window.matchMedia('(prefers-color-scheme: dark)').matches) {
currentTheme = 'dark';
}
if (currentTheme) {
document.documentElement.setAttribute('data-theme', currentTheme);
if (currentTheme === 'dark' && toggleSwitch !== null) {
toggleSwitch.checked = true;
}
}
}
window.addEventListener('DOMContentLoaded', main);
</script>
</head>
<body>
<div class="document" id="documentId">
<div class="container">
<h1 class="title">libp2p/routing_record</h1>
<div class="row">
<div class="three columns">
<div class="theme-switch-wrapper">
<label class="theme-switch" for="checkbox">
<input type="checkbox" id="checkbox" />
<div class="slider round"></div>
</label>
&nbsp;&nbsp;&nbsp; <em>Dark Mode</em>
</div>
<div id="global-links">
<ul class="simple">
<li>
<a href="../theindex.html">Index</a>
</li>
</ul>
</div>
<div id="searchInputDiv">
Search: <input type="text" id="searchInput"
onkeyup="search()" />
</div>
<div>
Group by:
<select onchange="groupBy(this.value)">
<option value="section">Section</option>
<option value="type">Type</option>
</select>
</div>
<script type="text/javascript">
function main2() {
// Create the slider
var firstSlider = document.getElementsByClassName("theme-switch-wrapper")[0];
var newSlider = document.createRange().createContextualFragment(`
<div class="theme-switch-wrapper">
<label class="theme-switch" for="internalcheckbox">
<input type="checkbox" id="internalcheckbox">
<div class="slider round"></div>
</label>
&nbsp;&nbsp;&nbsp; <em>Internal</em>
</div>
`);
var sliderInst = firstSlider.after(newSlider);
// Restore slider state from storage
var currentMode = localStorage.getItem('privateMode');
if (currentMode == "private") {
document.getElementById("internalcheckbox").checked = true;
} else {
hidePrivateProcs();
}
document.getElementById("internalcheckbox").onclick = togglePrivateProcs;
}
function hidePrivateProcs() {
var toHide = document.getElementsByClassName("tohide");
for (var i = 0; i < toHide.length; i++) {
var pragmas = toHide[i].querySelectorAll("span.Identifier");
var public = false;
for (var z = 0; z < pragmas.length; z++) {
if (pragmas[z].innerText == "public") {
public = true;
break;
}
}
if (public == false) {
toHide[i].style.display = "none";
toHide[i].classList.add("hidden");
links = document.querySelectorAll("a[href='#" + encodeURIComponent(toHide[i].id) + "']");
for (var y = 0; y < links.length; y++) {
links[y].parentNode.style.display = "none";
links[y].parentNode.classList.add("hidden");
}
}
}
// TOC
var nestedSections = document.getElementsByClassName("nested-toc-section");
for (var i = 0; i < nestedSections.length; i++) {
if (nestedSections[i].querySelectorAll("li:not(.hidden)").length == 0) {
nestedSections[i].style.display = "none";
nestedSections[i].classList.add("hidden");
}
}
var sections = document.getElementsByClassName("simple-toc-section");
for (var i = 0; i < sections.length; i++) {
if (sections[i].querySelectorAll(".nested-toc-section:not(.hidden)").length == 0) {
sections[i].parentNode.style.display = "none";
sections[i].parentNode.classList.add("hidden");
}
}
// Sections
var sections = document.getElementsByClassName("section");
for (var i = 0; i < sections.length; i++) {
if (sections[i].querySelectorAll(".item > div").length == 0) continue;
if (sections[i].querySelectorAll(".item > div:not(.hidden)").length == 0) {
sections[i].style.display = "none";
sections[i].classList.add("hidden");
}
}
}
function showPrivateProcs() {
var toHide = Array.from(document.getElementsByClassName("hidden"));
for (var i = 0; i < toHide.length; i++) {
toHide[i].style.display = "";
toHide[i].classList.remove("hidden");
}
}
function togglePrivateProcs() {
if (document.getElementById("internalcheckbox").checked) {
localStorage.setItem('privateMode', 'private');
showPrivateProcs();
} else {
localStorage.setItem('privateMode', 'public');
hidePrivateProcs();
}
}
window.addEventListener("DOMContentLoaded", main2);
</script>
<ul class="simple simple-toc" id="toc-list">
<li>
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
<ul class="simple simple-toc-section">
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#7" id="57">Types</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#AddressInfo"
title="AddressInfo = object
address*: MultiAddress">AddressInfo</a></li>
<li><a class="reference" href="#PeerRecord"
title="PeerRecord = object
peerId*: PeerId
seqNo*: uint64
addresses*: seq[AddressInfo]">PeerRecord</a></li>
<li><a class="reference" href="#SignedPeerRecord"
title="SignedPeerRecord = SignedPayload[PeerRecord]">SignedPeerRecord</a></li>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">checkValid
<li><a class="reference" href="#checkValid%2CSignedPeerRecord"
title="checkValid(spr: SignedPeerRecord): Result[void, EnvelopeError]">checkValid(spr: SignedPeerRecord): Result[void, EnvelopeError]</a></li>
</ul>
<ul class="simple nested-toc-section">decode
<li><a class="reference" href="#decode%2Ctypedesc%5BPeerRecord%5D%2Cseq%5Bbyte%5D"
title="decode(T: typedesc[PeerRecord]; buffer: seq[byte]): Result[PeerRecord,
ProtoError]">decode(T: typedesc[PeerRecord]; buffer: seq[byte]): Result[PeerRecord,
ProtoError]</a></li>
</ul>
<ul class="simple nested-toc-section">encode
<li><a class="reference" href="#encode%2CPeerRecord"
title="encode(record: PeerRecord): seq[byte]">encode(record: PeerRecord): seq[byte]</a></li>
</ul>
<ul class="simple nested-toc-section">init
<li><a class="reference" href="#init%2Ctypedesc%5BPeerRecord%5D%2CPeerId%2Cseq%5BMultiAddress%5D"
title="init(T: typedesc[PeerRecord]; peerId: PeerId; addresses: seq[MultiAddress];
seqNo = toUnix(getTime()).uint64): T:type">init(T: typedesc[PeerRecord]; peerId: PeerId; addresses: seq[MultiAddress];
seqNo = toUnix(getTime()).uint64): T:type</a></li>
</ul>
<ul class="simple nested-toc-section">payloadDomain
<li><a class="reference" href="#payloadDomain%2Ctypedesc%5BPeerRecord%5D"
title="payloadDomain(T: typedesc[PeerRecord]): string">payloadDomain(T: typedesc[PeerRecord]): string</a></li>
</ul>
<ul class="simple nested-toc-section">payloadType
<li><a class="reference" href="#payloadType%2Ctypedesc%5BPeerRecord%5D"
title="payloadType(T: typedesc[PeerRecord]): seq[byte]">payloadType(T: typedesc[PeerRecord]): seq[byte]</a></li>
</ul>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#19" id="69">Exports</a>
<ul class="simple simple-toc-section">
</ul>
</li>
</ul>
</div>
&nbsp;&nbsp;<a
update docs for master
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/routing_record.nim#L1"
update docs for master
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source</a>
update docs for master
2024-06-19 14:49:07 +00:00
&nbsp;&nbsp;<a href="https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/routing_record.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
update docs for master
2023-12-18 18:06:09 +00:00
<div class="nine columns" id="content">
<div id="tocRoot"></div>
<p class="module-desc">This module implements Routing Records.Functions related to signed peer records</p>
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="multiaddress.html">multiaddress</a>, <a class="reference external" href="multicodec.html">multicodec</a>, <a class="reference external" href="peerid.html">peerid</a>, <a class="reference external" href="protobuf/minprotobuf.html">protobuf/minprotobuf</a>, <a class="reference external" href="signed_envelope.html">signed_envelope</a>
</dl></div>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<div id="AddressInfo" class="tohide">
<dt><pre><a href="routing_record.html#AddressInfo"><span class="Identifier">AddressInfo</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">address</span><span class="Operator">*</span><span class="Other">:</span> <a href="multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
update docs for master
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/routing_record.nim#L21"
update docs for master
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source</a>
update docs for master
2024-06-19 14:49:07 +00:00
&nbsp;&nbsp;<a href="https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/routing_record.nim#L21" class="link-seesrc" target="_blank" >Edit</a>
update docs for master
2023-12-18 18:06:09 +00:00
</dd>
</div>
<div id="PeerRecord" class="tohide">
<dt><pre><a href="routing_record.html#PeerRecord"><span class="Identifier">PeerRecord</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">peerId</span><span class="Operator">*</span><span class="Other">:</span> <a href="peerid.html#PeerId"><span class="Identifier">PeerId</span></a>
<span class="Identifier">seqNo</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">uint64</span>
<span class="Identifier">addresses</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="routing_record.html#AddressInfo"><span class="Identifier">AddressInfo</span></a><span class="Other">]</span>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
update docs for master
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/routing_record.nim#L24"
update docs for master
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source</a>
update docs for master
2024-06-19 14:49:07 +00:00
&nbsp;&nbsp;<a href="https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/routing_record.nim#L24" class="link-seesrc" target="_blank" >Edit</a>
update docs for master
2023-12-18 18:06:09 +00:00
</dd>
</div>
<div id="SignedPeerRecord" class="tohide">
<dt><pre><a href="routing_record.html#SignedPeerRecord"><span class="Identifier">SignedPeerRecord</span></a> <span class="Other">=</span> <a href="signed_envelope.html#SignedPayload"><span class="Identifier">SignedPayload</span></a><span class="Other">[</span><a href="routing_record.html#PeerRecord"><span class="Identifier">PeerRecord</span></a><span class="Other">]</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
update docs for master
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/routing_record.nim#L78"
update docs for master
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source</a>
update docs for master
2024-06-19 14:49:07 +00:00
&nbsp;&nbsp;<a href="https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/routing_record.nim#L78" class="link-seesrc" target="_blank" >Edit</a>
update docs for master
2023-12-18 18:06:09 +00:00
</dd>
</div>
</dl></div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<div id="checkValid,SignedPeerRecord" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#checkValid%2CSignedPeerRecord"><span class="Identifier">checkValid</span></a><span class="Other">(</span><span class="Identifier">spr</span><span class="Other">:</span> <a href="routing_record.html#SignedPeerRecord"><span class="Identifier">SignedPeerRecord</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Result</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span> <a href="signed_envelope.html#EnvelopeError"><span class="Identifier">EnvelopeError</span></a><span class="Other">]</span> {.
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
update docs for master
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/routing_record.nim#L86"
update docs for master
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source</a>
update docs for master
2024-06-19 14:49:07 +00:00
&nbsp;&nbsp;<a href="https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/routing_record.nim#L86" class="link-seesrc" target="_blank" >Edit</a>
update docs for master
2023-12-18 18:06:09 +00:00
</dd>
</div>
<div id="decode,typedesc[PeerRecord],seq[byte]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#decode%2Ctypedesc%5BPeerRecord%5D%2Cseq%5Bbyte%5D"><span class="Identifier">decode</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="routing_record.html#PeerRecord"><span class="Identifier">PeerRecord</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">buffer</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Result</span><span class="Other">[</span><a href="routing_record.html#PeerRecord"><span class="Identifier">PeerRecord</span></a><span class="Other">,</span>
<a href="protobuf/minprotobuf.html#ProtoError"><span class="Identifier">ProtoError</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
update docs for master
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/routing_record.nim#L29"
update docs for master
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source</a>
update docs for master
2024-06-19 14:49:07 +00:00
&nbsp;&nbsp;<a href="https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/routing_record.nim#L29" class="link-seesrc" target="_blank" >Edit</a>
update docs for master
2023-12-18 18:06:09 +00:00
</dd>
</div>
<div id="encode,PeerRecord" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#encode%2CPeerRecord"><span class="Identifier">encode</span></a><span class="Other">(</span><span class="Identifier">record</span><span class="Other">:</span> <a href="routing_record.html#PeerRecord"><span class="Identifier">PeerRecord</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
update docs for master
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/routing_record.nim#L52"
update docs for master
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source</a>
update docs for master
2024-06-19 14:49:07 +00:00
&nbsp;&nbsp;<a href="https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/routing_record.nim#L52" class="link-seesrc" target="_blank" >Edit</a>
update docs for master
2023-12-18 18:06:09 +00:00
</dd>
</div>
<div id="init,typedesc[PeerRecord],PeerId,seq[MultiAddress]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#init%2Ctypedesc%5BPeerRecord%5D%2CPeerId%2Cseq%5BMultiAddress%5D"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="routing_record.html#PeerRecord"><span class="Identifier">PeerRecord</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">peerId</span><span class="Other">:</span> <a href="peerid.html#PeerId"><span class="Identifier">PeerId</span></a><span class="Other">;</span> <span class="Identifier">addresses</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="multiaddress.html#MultiAddress"><span class="Identifier">MultiAddress</span></a><span class="Other">]</span><span class="Other">;</span>
<span class="Identifier">seqNo</span> <span class="Other">=</span> <span class="Identifier">toUnix</span><span class="Other">(</span><span class="Identifier">getTime</span><span class="Other">(</span><span class="Other">)</span><span class="Other">)</span><span class="Other">.</span><span class="Identifier">uint64</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T:type</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
update docs for master
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/routing_record.nim#L66"
update docs for master
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source</a>
update docs for master
2024-06-19 14:49:07 +00:00
&nbsp;&nbsp;<a href="https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/routing_record.nim#L66" class="link-seesrc" target="_blank" >Edit</a>
update docs for master
2023-12-18 18:06:09 +00:00
</dd>
</div>
<div id="payloadDomain,typedesc[PeerRecord]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#payloadDomain%2Ctypedesc%5BPeerRecord%5D"><span class="Identifier">payloadDomain</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="routing_record.html#PeerRecord"><span class="Identifier">PeerRecord</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
update docs for master
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/routing_record.nim#L80"
update docs for master
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source</a>
update docs for master
2024-06-19 14:49:07 +00:00
&nbsp;&nbsp;<a href="https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/routing_record.nim#L80" class="link-seesrc" target="_blank" >Edit</a>
update docs for master
2023-12-18 18:06:09 +00:00
</dd>
</div>
<div id="payloadType,typedesc[PeerRecord]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#payloadType%2Ctypedesc%5BPeerRecord%5D"><span class="Identifier">payloadType</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="routing_record.html#PeerRecord"><span class="Identifier">PeerRecord</span></a><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
update docs for master
2024-06-19 14:49:07 +00:00
href="https://github.com/vacp2p/nim-libp2p/tree/master/libp2p/routing_record.nim#L83"
update docs for master
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source</a>
update docs for master
2024-06-19 14:49:07 +00:00
&nbsp;&nbsp;<a href="https://github.com/vacp2p/nim-libp2p/edit/devel/libp2p/routing_record.nim#L83" class="link-seesrc" target="_blank" >Edit</a>
update docs for master
2023-12-18 18:06:09 +00:00
</dd>
</div>
</dl></div>
<div class="section" id="19">
<h1><a class="toc-backref" href="#19">Exports</a></h1>
<dl class="item">
update docs for master
2024-09-19 12:37:50 +00:00
<a href="peerid.html#formatItIMPL.t,PeerId"><span class="Identifier">formatItIMPL</span></a>, <a href="utility.html#exclIfIt.t,HashSet[T],untyped"><span class="Identifier">exclIfIt</span></a>, <a href="peerid.html#hash.t,PeerId"><span class="Identifier">hash</span></a>, <a href="peerid.html#shortLog,PeerId"><span class="Identifier">shortLog</span></a>, <a href="peerid.html#random,typedesc[PeerId]"><span class="Identifier">random</span></a>, <a href="peerid.html#$,PeerId"><span class="Identifier">$</span></a>, <a href="peerid.html#write,VBuffer,PeerId"><span class="Identifier">write</span></a>, <a href="peerid.html#PeerId"><span class="Identifier">PeerId</span></a>, <a href="peerid.html#==.t,PeerId,PeerId"><span class="Identifier">==</span></a>, <a href="peerid.html#getField,ProtoBuffer,int,PeerId"><span class="Identifier">getField</span></a>, <a href="peerid.html#<=.t,PeerId,PeerId"><span class="Identifier">&lt;=</span></a>, <a href="utility.html#capLen,seq[T],Natural"><span class="Identifier">capLen</span></a>, <a href="peerid.html#init,PeerId,openArray[byte]"><span class="Identifier">init</span></a>, <a href="peerid.html#validate,PeerId"><span class="Identifier">validate</span></a>, <a href="peerid.html#init,PeerId,string"><span class="Identifier">init</span></a>, <a href="peerid.html#match,PeerId,PrivateKey"><span class="Identifier">match</span></a>, <a href="peerid.html#<.t,PeerId,PeerId"><span class="Identifier">&lt;</span></a>, <a href="peerid.html#getBytes.t,PeerId"><span class="Identifier">getBytes</span></a>, <a href="peerid.html#maxInlineKeyLength"><span class="Identifier">maxInlineKeyLength</span></a>, <a href="peerid.html#write,ProtoBuffer,int,PeerId"><span class="Identifier">write</span></a>, <a href="utility.html#withValue.t,,untyped,untyped"><span class="Identifier">withValue</span></a>, <a href="utility.html#safeConvert,SomeOrdinal"><span class="Identifier">safeConvert</span></a>, <a href="utility.html#shortLog,openArray[byte]"><span class="Identifier">shortLog</span></a>, <a href="peerid.html#>=.t,PeerId,PeerId"><span class="Identifier">&gt;=</span></a>, <a href="utility.html#withValue.t,Result[T,E],untyped,untyped"><span class="Identifier">withValue</span></a>, <a href="utility.html#public.t"><span class="Identifier">public</span></a>, <a href="utility.html#shortLog,string"><span class="Identifier">shortLog</span></a>, <a href="utility.html#compilesOr.t,untyped,untyped"><span class="Identifier">compilesOr</span></a>, <a href="peerid.html#toBytes,PeerId,openArray[byte]"><span class="Identifier">toBytes</span></a>, <a href="peerid.html#match,PeerId,PublicKey"><span class="Identifier">match</span></a>, <a href="utility.html#valueOr.t,Option[T],untyped"><span class="Identifier">valueOr</span></a>, <a href="peerid.html#init,typedesc[PeerId],openArray[byte]"><span class="Identifier">init</span></a>, <a href="peerid.html#init,typedesc[PeerId],string"><span class="Identifier">init</span></a>, <a href="peerid.html#init,typedesc[PeerId],PublicKey"><span class="Identifier">init</span></a>, <a href="utility.html#toOpt.t,Result[T,E]"><span class="Identifier">toOpt</span></a>, <a href="peerid.html#init,typedesc[PeerId],PrivateKey"><span class="Identifier">init</span></a>, <a href="utility.html#withValue.m,,untyped,untyped,untyped"><span class="Identifier">withValue</span></a>, <a href="peerid.html#hasPublicKey,PeerId"><span class="Identifier">hasPublicKey</span></a>, <a href="peerid.html#>.t,PeerId,PeerId"><span class="Identifier">&gt;</span></a>, <a href="peerid.html#hex,PeerId"><span class="Identifier">hex</span></a>, <a href="peerid.html#len.t,PeerId"><span class="Identifier">len</span></a>, <a href="utility.html#exceptionToAssert.t,untyped"><span class="Identifier">exceptionToAssert</span></a>, <a href="peerid.html#cmp,PeerId,PeerId"><span class="Identifier">cmp</span></a>, <a href="peerid.html#extractPublicKey,PeerId,PublicKey"><span class="Identifier">extractPublicKey</span></a>, <a href="multiaddress.html#DNS_OR_IP"><span class="Identifier">DNS_OR_IP</span></a>, <a href="utility.html#exclIfIt.t,HashSet[T],unt
update docs for master
2023-12-18 18:06:09 +00:00
</dl></div>
</div>
</div>
<div class="row">
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
update docs for master
2024-11-09 03:53:18 +00:00
<small style="color: var(--hint);">Made with Nim. Generated: 2024-11-09 03:53:05 UTC</small>
update docs for master
2023-12-18 18:06:09 +00:00
</div>
</div>
</div>
</div>
</body>
</html>