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/peerinfo< / 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/peerinfo< / 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 >
< 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 >
< 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 = "#AddressMapper"
title="AddressMapper = proc (listenAddrs: seq[MultiAddress]): Future[seq[MultiAddress]] {.
gcsafe, raises: [].}">AddressMapper< / a > < / li >
< li > < a class = "reference" href = "#PeerInfo"
title="PeerInfo {.public.} = ref object
peerId*: PeerId
2024-06-06 11:07:46 +00:00
listenAddrs*: seq[MultiAddress] ## contains addresses the node listens on, which may include wildcard and private addresses (not directly reachable).
addrs*: seq[MultiAddress] ## contains resolved addresses that other peers can use to connect, including public-facing NAT and port-forwarded addresses.
addressMappers*: seq[AddressMapper] ## contains a list of procs that can be used to resolve the listen addresses into dialable addresses.
2023-12-18 18:06:09 +00:00
protocols*: seq[string]
protoVersion*: string
agentVersion*: string
privateKey*: PrivateKey
publicKey*: PublicKey
signedPeerRecord*: SignedPeerRecord">PeerInfo< / a > < / li >
< li > < a class = "reference" href = "#PeerInfoError"
title="PeerInfoError = object of LPError">PeerInfoError< / 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" > addrs
< li > < a class = "reference" href = "#addrs%2CPeerInfo"
title="addrs(p: PeerInfo): seq[MultiAddress]">addrs(p: PeerInfo): seq[MultiAddress]< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > fullAddrs
< li > < a class = "reference" href = "#fullAddrs%2CPeerInfo"
title="fullAddrs(p: PeerInfo): MaResult[seq[MultiAddress]]">fullAddrs(p: PeerInfo): MaResult[seq[MultiAddress]]< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > new
< li > < a class = "reference" href = "#new%2Ctypedesc%5BPeerInfo%5D%2CPrivateKey%2CopenArray%5BMultiAddress%5D%2CopenArray%5Bstring%5D%2Cstring%2Cstring"
title="new(p: typedesc[PeerInfo]; key: PrivateKey;
listenAddrs: openArray[MultiAddress] = [];
protocols: openArray[string] = []; protoVersion: string = " " ;
agentVersion: string = " " ; addressMappers = newSeq[AddressMapper]()): PeerInfo">new(p: typedesc[PeerInfo]; key: PrivateKey;
listenAddrs: openArray[MultiAddress] = [];
protocols: openArray[string] = []; protoVersion: string = " " ;
agentVersion: string = " " ; addressMappers = newSeq[AddressMapper]()): PeerInfo< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > parseFullAddress
< li > < a class = "reference" href = "#parseFullAddress%2CMultiAddress"
title="parseFullAddress(ma: MultiAddress): MaResult[(PeerId, MultiAddress)]">parseFullAddress(ma: MultiAddress): MaResult[(PeerId, MultiAddress)]< / a > < / li >
< li > < a class = "reference" href = "#parseFullAddress"
title="parseFullAddress(ma: string | seq[byte]): MaResult[(PeerId, MultiAddress)]">parseFullAddress(ma: string | seq[byte]): MaResult[(PeerId, MultiAddress)]< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > shortLog
< li > < a class = "reference" href = "#shortLog%2CPeerInfo"
title="shortLog(p: PeerInfo): auto">shortLog(p: PeerInfo): auto< / a > < / li >
< / ul >
< ul class = "simple nested-toc-section" > update
< li > < a class = "reference" href = "#update%2CPeerInfo"
title="update(p: PeerInfo): Future[void]">update(p: PeerInfo): Future[void]< / a > < / li >
< / ul >
< / ul >
< / li >
< li >
< a class = "reference reference-toplevel" href = "#18" id = "68" > Templates< / a >
< ul class = "simple simple-toc-section" >
< ul class = "simple nested-toc-section" > formatItIMPL
< li > < a class = "reference" href = "#formatItIMPL.t%2CPeerInfo"
title="formatItIMPL(it: PeerInfo): auto">formatItIMPL(it: PeerInfo): auto< / 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 >
< a
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/peerinfo.nim#L1"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerinfo.nim#L1" class = "link-seesrc" target = "_blank" > Edit< / a >
< div class = "nine columns" id = "content" >
< div id = "tocRoot" > < / div >
< p class = "module-desc" > Our local peer info< / p >
< div class = "section" id = "6" >
< h1 > < a class = "toc-backref" href = "#6" > Imports< / a > < / h1 >
< dl class = "item" >
< a class = "reference external" href = "peerid.html" > peerid< / a > , < a class = "reference external" href = "multiaddress.html" > multiaddress< / a > , < a class = "reference external" href = "multicodec.html" > multicodec< / a > , < a class = "reference external" href = "crypto/crypto.html" > crypto/crypto< / a > , < a class = "reference external" href = "routing_record.html" > routing_record< / a > , < a class = "reference external" href = "errors.html" > errors< / a > , < a class = "reference external" href = "utility.html" > utility< / a >
< / dl > < / div >
< div class = "section" id = "7" >
< h1 > < a class = "toc-backref" href = "#7" > Types< / a > < / h1 >
< dl class = "item" >
< div id = "AddressMapper" class = "tohide" >
< dt > < pre > < a href = "peerinfo.html#AddressMapper" > < span class = "Identifier" > AddressMapper< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > proc< / span > < span class = "Other" > (< / span > < span class = "Identifier" > listenAddrs< / 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 = "Other" > :< / span > < span class = "Identifier" > Future< / 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 > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > gcsafe< / span > < span class = "Other" > ,< / span > < span class = "Identifier" > raises< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
< dd >
2024-06-06 11:07:46 +00:00
A proc that expected to resolve the listen addresses into dialable addresses
2023-12-18 18:06:09 +00:00
< a
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/peerinfo.nim#L24"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerinfo.nim#L24" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< div id = "PeerInfo" class = "tohide" >
< dt > < pre > < a href = "peerinfo.html#PeerInfo" > < span class = "Identifier" > PeerInfo< / span > < / a > {.< span class = "Identifier" > public< / span > .} < span class = "Other" > =< / span > < span class = "Keyword" > ref< / 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 >
2024-06-06 11:07:46 +00:00
< span class = "Identifier" > listenAddrs< / span > < span class = "Operator" > *< / 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 = "Comment" > ## contains addresses the node listens on, which may include wildcard and private addresses (not directly reachable).< / span >
< span class = "Identifier" > addrs< / span > < span class = "Operator" > *< / 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 = "Comment" > ## contains resolved addresses that other peers can use to connect, including public-facing NAT and port-forwarded addresses.< / span >
< span class = "Identifier" > addressMappers< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < span class = "Identifier" > seq< / span > < span class = "Other" > [< / span > < a href = "peerinfo.html#AddressMapper" > < span class = "Identifier" > AddressMapper< / span > < / a > < span class = "Other" > ]< / span > < span class = "Comment" > ## contains a list of procs that can be used to resolve the listen addresses into dialable addresses.< / span >
2023-12-18 18:06:09 +00:00
< span class = "Identifier" > protocols< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < span class = "Identifier" > seq< / span > < span class = "Other" > [< / span > < span class = "Identifier" > string< / span > < span class = "Other" > ]< / span >
< span class = "Identifier" > protoVersion< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < span class = "Identifier" > string< / span >
< span class = "Identifier" > agentVersion< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < span class = "Identifier" > string< / span >
< span class = "Identifier" > privateKey< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < a href = "crypto/crypto.html#PrivateKey" > < span class = "Identifier" > PrivateKey< / span > < / a >
< span class = "Identifier" > publicKey< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < a href = "crypto/crypto.html#PublicKey" > < span class = "Identifier" > PublicKey< / span > < / a >
< span class = "Identifier" > signedPeerRecord< / span > < span class = "Operator" > *< / span > < span class = "Other" > :< / span > < a href = "routing_record.html#SignedPeerRecord" > < span class = "Identifier" > SignedPeerRecord< / span > < / a >
< / pre > < / dt >
< dd >
< a
2024-06-11 15:19:55 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/peerinfo.nim#L28"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-11 15:19:55 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerinfo.nim#L28" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "PeerInfoError" class = "tohide" >
< dt > < pre > < a href = "peerinfo.html#PeerInfoError" > < span class = "Identifier" > PeerInfoError< / span > < / a > < span class = "Other" > =< / span > < span class = "Keyword" > object< / span > < span class = "Keyword" > of< / span > < a href = "errors.html#LPError" > < span class = "Identifier" > LPError< / span > < / a > < / pre > < / dt >
< dd >
< a
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/peerinfo.nim#L22"
class="link-seesrc" target="_blank">Source< / a >
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerinfo.nim#L22" class = "link-seesrc" target = "_blank" > Edit< / a >
< / dd >
< / div >
< / dl > < / div >
< div class = "section" id = "12" >
< h1 > < a class = "toc-backref" href = "#12" > Procs< / a > < / h1 >
< dl class = "item" >
< div id = "addrs,PeerInfo" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#addrs%2CPeerInfo" > < span class = "Identifier" > addrs< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > p< / span > < span class = "Other" > :< / span > < a href = "peerinfo.html#PeerInfo" > < span class = "Identifier" > PeerInfo< / span > < / a > < span class = "Other" > )< / 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 > < 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 > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span > < span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > tags< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < / span > .}< / pre > < / dt >
< dd >
< a
2024-06-11 15:19:55 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/peerinfo.nim#L70"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-11 15:19:55 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerinfo.nim#L70" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "fullAddrs,PeerInfo" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#fullAddrs%2CPeerInfo" > < span class = "Identifier" > fullAddrs< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > p< / span > < span class = "Other" > :< / span > < a href = "peerinfo.html#PeerInfo" > < span class = "Identifier" > PeerInfo< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < a href = "multiaddress.html#MaResult" > < span class = "Identifier" > MaResult< / span > < / a > < 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 > < 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 > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span >
< span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < 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 >
< a
2024-06-11 15:19:55 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/peerinfo.nim#L73"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-11 15:19:55 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerinfo.nim#L73" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "new,typedesc[PeerInfo],PrivateKey,openArray[MultiAddress],openArray[string],string,string" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#new%2Ctypedesc%5BPeerInfo%5D%2CPrivateKey%2CopenArray%5BMultiAddress%5D%2CopenArray%5Bstring%5D%2Cstring%2Cstring" > < span class = "Identifier" > new< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > p< / span > < span class = "Other" > :< / span > < span class = "Identifier" > typedesc< / span > < span class = "Other" > [< / span > < a href = "peerinfo.html#PeerInfo" > < span class = "Identifier" > PeerInfo< / span > < / a > < span class = "Other" > ]< / span > < span class = "Other" > ;< / span > < span class = "Identifier" > key< / span > < span class = "Other" > :< / span > < a href = "crypto/crypto.html#PrivateKey" > < span class = "Identifier" > PrivateKey< / span > < / a > < span class = "Other" > ;< / span >
< span class = "Identifier" > listenAddrs< / span > < span class = "Other" > :< / span > < span class = "Identifier" > openArray< / 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 = "Other" > [< / span > < span class = "Other" > ]< / span > < span class = "Other" > ;< / span >
< span class = "Identifier" > protocols< / span > < span class = "Other" > :< / span > < span class = "Identifier" > openArray< / span > < span class = "Other" > [< / span > < span class = "Identifier" > string< / span > < span class = "Other" > ]< / span > < span class = "Other" > =< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < span class = "Other" > ;< / span > < span class = "Identifier" > protoVersion< / span > < span class = "Other" > :< / span > < span class = "Identifier" > string< / span > < span class = "Other" > =< / span > < span class = "StringLit" > " " < / span > < span class = "Other" > ;< / span >
< span class = "Identifier" > agentVersion< / span > < span class = "Other" > :< / span > < span class = "Identifier" > string< / span > < span class = "Other" > =< / span > < span class = "StringLit" > " " < / span > < span class = "Other" > ;< / span > < span class = "Identifier" > addressMappers< / span > < span class = "Other" > =< / span > < span class = "Identifier" > newSeq< / span > < span class = "Other" > [< / span > < a href = "peerinfo.html#AddressMapper" > < span class = "Identifier" > AddressMapper< / span > < / a > < span class = "Other" > ]< / span > < span class = "Other" > (< / span > < span class = "Other" > )< / span > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < a href = "peerinfo.html#PeerInfo" > < span class = "Identifier" > PeerInfo< / span > < / a > {.
< span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < span class = "Identifier" > raises< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < a href = "errors.html#LPError" > < span class = "Identifier" > LPError< / span > < / a > < span class = "Other" > ]< / span > < span class = "Other" > ,< / span > < span class = "Identifier" > raises< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < span class = "Other" > ,< / span > < / span > < span class = "Identifier" > public< / span > .}< / pre > < / dt >
< dd >
< a
2024-06-11 15:19:55 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/peerinfo.nim#L92"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-11 15:19:55 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerinfo.nim#L92" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "parseFullAddress,MultiAddress" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#parseFullAddress%2CMultiAddress" > < span class = "Identifier" > parseFullAddress< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > ma< / span > < span class = "Other" > :< / span > < a href = "multiaddress.html#MultiAddress" > < span class = "Identifier" > MultiAddress< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < a href = "multiaddress.html#MaResult" > < span class = "Identifier" > MaResult< / span > < / a > < span class = "Other" > [< / span > < span class = "Other" > (< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > ,< / span > < a href = "multiaddress.html#MultiAddress" > < span class = "Identifier" > MultiAddress< / span > < / a > < span class = "Other" > )< / 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 > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span > < span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < 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 >
< a
2024-06-11 15:19:55 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/peerinfo.nim#L80"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-11 15:19:55 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerinfo.nim#L80" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "parseFullAddress" class = "tohide" >
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#parseFullAddress" > < span class = "Identifier" > parseFullAddress< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > ma< / span > < span class = "Other" > :< / span > < span class = "Identifier" > string< / span > < span class = "Operator" > |< / 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 > < a href = "multiaddress.html#MaResult" > < span class = "Identifier" > MaResult< / span > < / a > < span class = "Other" > [< / span > < span class = "Other" > (< / span > < a href = "peerid.html#PeerId" > < span class = "Identifier" > PeerId< / span > < / a > < span class = "Other" > ,< / span > < a href = "multiaddress.html#MultiAddress" > < span class = "Identifier" > MultiAddress< / span > < / a > < span class = "Other" > )< / 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 > < span class = "Identifier" > public< / span > .}< / pre > < / dt >
< dd >
< a
2024-06-11 15:19:55 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/peerinfo.nim#L89"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-11 15:19:55 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerinfo.nim#L89" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "shortLog,PeerInfo" class = "tohide" >
< dt > < pre > < span class = "Keyword" > func< / span > < a href = "#shortLog%2CPeerInfo" > < span class = "Identifier" > shortLog< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > p< / span > < span class = "Other" > :< / span > < a href = "peerinfo.html#PeerInfo" > < span class = "Identifier" > PeerInfo< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > auto< / 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 > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span > < span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < 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 >
< a
2024-06-11 15:19:55 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/peerinfo.nim#L43"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-11 15:19:55 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerinfo.nim#L43" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< div id = "update,PeerInfo" class = "tohide" >
2024-04-29 13:39:28 +00:00
< dt > < pre > < span class = "Keyword" > proc< / span > < a href = "#update%2CPeerInfo" > < span class = "Identifier" > update< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > p< / span > < span class = "Other" > :< / span > < a href = "peerinfo.html#PeerInfo" > < span class = "Identifier" > PeerInfo< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > Future< / span > < span class = "Other" > [< / span > < span class = "Identifier" > void< / span > < span class = "Other" > ]< / span > {.< span class = "Identifier" > stackTrace< / span > < span class = "Other" > :< / span > < span class = "DecNumber" > false< / 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" > gcsafe< / span > < span class = "Other" > ,< / span >
2023-12-18 18:06:09 +00:00
< span class = "Identifier" > raises< / span > < span class = "Other" > :< / span > < span class = "Other" > [< / span > < span class = "Other" > ]< / span > < span class = "Other" > ,< / span > < / span > < span class = "Identifier" > public< / 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 > < span class = "Identifier" > public< / span > < span class = "Other" > ,< / span > < span > < span class = "Other pragmadots" > ...< / span > < / span > < span class = "pragmawrap" > < 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 >
< a
2024-06-06 11:07:46 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/peerinfo.nim#L55"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-06 11:07:46 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerinfo.nim#L55" class = "link-seesrc" target = "_blank" > Edit< / a >
2023-12-18 18:06:09 +00:00
< / dd >
< / div >
< / dl > < / div >
< div class = "section" id = "18" >
< h1 > < a class = "toc-backref" href = "#18" > Templates< / a > < / h1 >
< dl class = "item" >
< div id = "formatItIMPL.t,PeerInfo" class = "tohide" >
< dt > < pre > < span class = "Keyword" > template< / span > < a href = "#formatItIMPL.t%2CPeerInfo" > < span class = "Identifier" > formatItIMPL< / span > < / a > < span class = "Other" > (< / span > < span class = "Identifier" > it< / span > < span class = "Other" > :< / span > < a href = "peerinfo.html#PeerInfo" > < span class = "Identifier" > PeerInfo< / span > < / a > < span class = "Other" > )< / span > < span class = "Other" > :< / span > < span class = "Identifier" > auto< / span > < / pre > < / dt >
< dd >
< a
2024-06-11 15:19:55 +00:00
href="https://github.com/status-im/nim-libp2p/tree/master/libp2p/peerinfo.nim#L52"
2023-12-18 18:06:09 +00:00
class="link-seesrc" target="_blank">Source< / a >
2024-06-11 15:19:55 +00:00
< a href = "https://github.com/status-im/nim-libp2p/edit/devel/libp2p/peerinfo.nim#L52" class = "link-seesrc" target = "_blank" > Edit< / a >
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" >
2024-06-12 13:48:27 +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" > < =< / 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" > < < / 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.t,S" > < 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" > > =< / 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" > > < / 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],untyped_2" >
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 / >
2024-06-12 13:48:27 +00:00
< small style = "color: var(--hint);" > Made with Nim. Generated: 2024-06-12 13:48:13 UTC< / small >
2023-12-18 18:06:09 +00:00
< / div >
< / div >
< / div >
< / div >
< / body >
< / html >
