2023-09-07 14:09:36 +00:00
<!doctype html>
< html lang = "en" class = "no-js" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
< link rel = "icon" href = "https://libp2p.io/img/logo_small.png" >
2024-08-23 13:58:38 +00:00
< meta name = "generator" content = "mkdocs-1.6.0, mkdocs-material-9.5.33" >
2023-09-07 14:09:36 +00:00
< title > nim-libp2p< / title >
2024-07-23 12:15:39 +00:00
< link rel = "stylesheet" href = "/nim-libp2p/docs/assets/stylesheets/main.3cba04c6.min.css" >
2023-09-07 14:09:36 +00:00
2024-06-13 10:30:22 +00:00
< link rel = "stylesheet" href = "/nim-libp2p/docs/assets/stylesheets/palette.06af60db.min.css" >
2023-09-07 14:09:36 +00:00
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
< 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 >
< script > _ _md _scope = new URL ( "/nim-libp2p/docs/" , 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 = "default" data-md-color-primary = "blue-grey" data-md-color-accent = "indigo" >
< 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" >
< / div >
< div data-md-component = "announce" >
< / div >
< header class = "md-header md-header--shadow" data-md-component = "header" >
< nav class = "md-header__inner md-grid" aria-label = "Header" >
< a href = "/nim-libp2p/docs/." title = "nim-libp2p" class = "md-header__button md-logo" aria-label = "nim-libp2p" data-md-component = "logo" >
< img src = "https://libp2p.io/img/logo_small.png" alt = "logo" >
< / a >
< label class = "md-header__button md-icon" for = "__drawer" >
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
< 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" >
nim-libp2p
< / span >
< / div >
< div class = "md-header__topic" data-md-component = "header-topic" >
< span class = "md-ellipsis" >
< / span >
< / div >
< / div >
< / div >
< form class = "md-header__option" data-md-component = "palette" >
2024-06-13 10:30:22 +00:00
< input class = "md-option" data-md-color-media = "" data-md-color-scheme = "default" data-md-color-primary = "blue-grey" data-md-color-accent = "indigo" aria-label = "Switch to dark mode" type = "radio" name = "__palette" id = "__palette_0" >
< label class = "md-header__button md-icon" title = "Switch to dark mode" for = "__palette_1" hidden >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5m0 8a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3 3Z" / > < / svg >
< / label >
< input class = "md-option" data-md-color-media = "" data-md-color-scheme = "slate" data-md-color-primary = "blue-grey" data-md-color-accent = "indigo" aria-label = "Switch to light mode" type = "radio" name = "__palette" id = "__palette_1" >
< label class = "md-header__button md-icon" title = "Switch to light mode" for = "__palette_0" hidden >
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 24 24" > < path d = "M17 6H7c-3.31 0-6 2.69-6 6s2.69 6 6 6h10c3.31 0 6-2.69 6-6s-2.69-6-6-6zm0 10H7c-2.21 0-4-1.79-4-4s1.79-4 4-4h10c2.21 0 4 1.79 4 4s-1.79 4-4 4zM7 9c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3z" / > < / svg >
< / label >
< / form >
2023-09-07 14:09:36 +00:00
2024-06-13 10:30:22 +00:00
< 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 >
2023-09-07 14:09:36 +00:00
< label class = "md-header__button md-icon" for = "__search" >
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
< 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" >
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
< 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 >
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
< 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" >
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
< 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" >
2024-06-13 10:30:22 +00:00
< div class = "md-search__scrollwrap" tabindex = "0" data-md-scrollfix >
2023-09-07 14:09:36 +00:00
< 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/nim-libp2p" title = "Go to repository" class = "md-source" data-md-component = "source" >
< div class = "md-source__icon md-icon" >
2024-07-23 12:15:39 +00:00
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 448 512" > <!-- ! Font Awesome Free 6.6.0 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 >
2023-09-07 14:09:36 +00:00
< / div >
< div class = "md-source__repository" >
status-im/nim-libp2p
< / div >
< / a >
< / div >
< / nav >
< / header >
< div class = "md-container" data-md-component = "container" >
< 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" >
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
< nav class = "md-nav md-nav--primary" aria-label = "Navigation" data-md-level = "0" >
< label class = "md-nav__title" for = "__drawer" >
< a href = "/nim-libp2p/docs/." title = "nim-libp2p" class = "md-nav__button md-logo" aria-label = "nim-libp2p" data-md-component = "logo" >
< img src = "https://libp2p.io/img/logo_small.png" alt = "logo" >
< / a >
nim-libp2p
< / label >
< div class = "md-nav__source" >
< a href = "https://github.com/status-im/nim-libp2p" title = "Go to repository" class = "md-source" data-md-component = "source" >
< div class = "md-source__icon md-icon" >
2024-07-23 12:15:39 +00:00
< svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 448 512" > <!-- ! Font Awesome Free 6.6.0 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 >
2023-09-07 14:09:36 +00:00
< / div >
< div class = "md-source__repository" >
status-im/nim-libp2p
< / div >
< / a >
< / div >
< ul class = "md-nav__list" data-md-scrollfix >
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
< li class = "md-nav__item md-nav__item--nested" >
2024-06-13 10:30:22 +00:00
< input class = "md-nav__toggle md-toggle " type = "checkbox" id = "__nav_1" >
2023-09-07 14:09:36 +00:00
2024-06-13 10:30:22 +00:00
< label class = "md-nav__link" for = "__nav_1" id = "__nav_1_label" tabindex = "0" >
< span class = "md-ellipsis" >
Tutorials
< / 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 >
Tutorials
< / label >
< ul class = "md-nav__list" data-md-scrollfix >
2023-09-07 14:09:36 +00:00
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
< li class = "md-nav__item" >
< a href = "/nim-libp2p/docs/." class = "md-nav__link" >
2024-06-13 10:30:22 +00:00
< span class = "md-ellipsis" >
Introduction
< / span >
2023-09-07 14:09:36 +00:00
< / a >
< / li >
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
< li class = "md-nav__item" >
< a href = "/nim-libp2p/docs/tutorial_1_connect/" class = "md-nav__link" >
2024-06-13 10:30:22 +00:00
< span class = "md-ellipsis" >
Simple connection
< / span >
2023-09-07 14:09:36 +00:00
< / a >
< / li >
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
< li class = "md-nav__item" >
< a href = "/nim-libp2p/docs/tutorial_2_customproto/" class = "md-nav__link" >
2024-06-13 10:30:22 +00:00
< span class = "md-ellipsis" >
Create a custom protocol
< / span >
2023-09-07 14:09:36 +00:00
< / a >
< / li >
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
< li class = "md-nav__item" >
< a href = "/nim-libp2p/docs/tutorial_3_protobuf/" class = "md-nav__link" >
2024-06-13 10:30:22 +00:00
< span class = "md-ellipsis" >
Protobuf
< / span >
2023-09-07 14:09:36 +00:00
< / a >
< / li >
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
< li class = "md-nav__item" >
< a href = "/nim-libp2p/docs/tutorial_4_gossipsub/" class = "md-nav__link" >
2024-06-13 10:30:22 +00:00
< span class = "md-ellipsis" >
GossipSub
< / span >
2023-09-07 14:09:36 +00:00
< / a >
< / li >
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
< li class = "md-nav__item" >
< a href = "/nim-libp2p/docs/tutorial_5_discovery/" class = "md-nav__link" >
2024-06-13 10:30:22 +00:00
< span class = "md-ellipsis" >
Discovery Manager
< / span >
2023-09-07 14:09:36 +00:00
< / a >
< / li >
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
< li class = "md-nav__item" >
< a href = "/nim-libp2p/docs/tutorial_6_game/" class = "md-nav__link" >
2024-06-13 10:30:22 +00:00
< span class = "md-ellipsis" >
Game
< / span >
2023-09-07 14:09:36 +00:00
< / a >
< / li >
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
< li class = "md-nav__item" >
< a href = "/nim-libp2p/docs/circuitrelay/" class = "md-nav__link" >
2024-06-13 10:30:22 +00:00
< span class = "md-ellipsis" >
Circuit Relay
< / span >
2023-09-07 14:09:36 +00:00
< / a >
< / li >
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
2024-06-13 10:30:22 +00:00
< / ul >
< / nav >
2023-09-07 14:09:36 +00:00
< / li >
2024-06-13 10:30:22 +00:00
2023-09-07 14:09:36 +00:00
< li class = "md-nav__item" >
< a href = "/nim-libp2p/master/libp2p.html" class = "md-nav__link" >
2024-06-13 10:30:22 +00:00
< span class = "md-ellipsis" >
Reference
< / span >
2023-09-07 14:09:36 +00:00
< / a >
< / 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" >
< / nav >
< / div >
< / div >
< / div >
< div class = "md-content" data-md-component = "content" >
< article class = "md-content__inner md-typeset" >
< h1 > 404 - Not found< / h1 >
< / article >
< / div >
2024-06-13 10:30:22 +00:00
< script > var target = document . getElementById ( location . hash . slice ( 1 ) ) ; target && target . name && ( target . checked = target . name . startsWith ( "__tabbed_" ) ) < / script >
2023-09-07 14:09:36 +00:00
< / div >
< / 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 >
2024-06-13 10:30:22 +00:00
< script id = "__config" type = "application/json" > { "base" : "/nim-libp2p/docs/" , "features" : [ "navigation.instant" , "search.highlight" ] , "search" : "/nim-libp2p/docs/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 >
2023-09-07 14:09:36 +00:00
2024-08-23 13:58:38 +00:00
< script src = "/nim-libp2p/docs/assets/javascripts/bundle.af256bd8.min.js" > < / script >
2023-09-07 14:09:36 +00:00
< / body >
< / html >
