From 16dc60a663633cdb95a024015acf26ada10f5477 Mon Sep 17 00:00:00 2001 From: = Date: Thu, 25 Jan 2024 15:42:41 +0000 Subject: [PATCH] update docs for zz-dbg --- zz-dbg/libp2p.html | 2 +- zz-dbg/libp2p/builders.html | 119 +++--- zz-dbg/libp2p/connmanager.html | 14 +- zz-dbg/libp2p/crypto/chacha20poly1305.html | 2 +- zz-dbg/libp2p/crypto/crypto.html | 2 +- zz-dbg/libp2p/crypto/curve25519.html | 2 +- zz-dbg/libp2p/crypto/ecnist.html | 2 +- zz-dbg/libp2p/crypto/ed25519/constants.html | 2 +- zz-dbg/libp2p/crypto/ed25519/ed25519.html | 2 +- zz-dbg/libp2p/crypto/hkdf.html | 2 +- zz-dbg/libp2p/crypto/minasn1.html | 2 +- zz-dbg/libp2p/crypto/rsa.html | 2 +- zz-dbg/libp2p/crypto/secp.html | 2 +- zz-dbg/libp2p/dial.html | 13 +- zz-dbg/libp2p/dialer.html | 39 +- zz-dbg/libp2p/errors.html | 2 +- zz-dbg/libp2p/multiaddress.html | 342 +++++++++--------- zz-dbg/libp2p/multibase.html | 2 +- zz-dbg/libp2p/multicodec.html | 58 +-- zz-dbg/libp2p/multihash.html | 2 +- zz-dbg/libp2p/multistream.html | 28 +- zz-dbg/libp2p/muxers/mplex/coder.html | 4 +- zz-dbg/libp2p/muxers/mplex/mplex.html | 2 +- zz-dbg/libp2p/muxers/muxer.html | 10 +- zz-dbg/libp2p/muxers/yamux/yamux.html | 112 +++--- zz-dbg/libp2p/nameresolving/nameresolver.html | 2 +- zz-dbg/libp2p/observedaddrmanager.html | 2 +- zz-dbg/libp2p/peerid.html | 2 +- zz-dbg/libp2p/peerinfo.html | 4 +- zz-dbg/libp2p/protobuf/minprotobuf.html | 2 +- .../protocols/connectivity/autonat/core.html | 2 +- .../connectivity/autonat/server.html | 2 +- .../protocols/connectivity/relay/client.html | 2 +- .../connectivity/relay/messages.html | 2 +- .../protocols/connectivity/relay/rconn.html | 2 +- .../protocols/connectivity/relay/relay.html | 8 +- .../connectivity/relay/rtransport.html | 17 +- .../protocols/connectivity/relay/utils.html | 10 +- zz-dbg/libp2p/protocols/identify.html | 107 +++--- zz-dbg/libp2p/protocols/ping.html | 6 +- zz-dbg/libp2p/protocols/protocol.html | 2 +- zz-dbg/libp2p/protocols/pubsub.html | 2 +- zz-dbg/libp2p/protocols/pubsub/errors.html | 2 +- zz-dbg/libp2p/protocols/pubsub/floodsub.html | 2 +- zz-dbg/libp2p/protocols/pubsub/gossipsub.html | 5 +- .../protocols/pubsub/gossipsub/behavior.html | 2 +- .../protocols/pubsub/gossipsub/scoring.html | 2 +- .../protocols/pubsub/gossipsub/types.html | 2 +- zz-dbg/libp2p/protocols/pubsub/mcache.html | 2 +- zz-dbg/libp2p/protocols/pubsub/peertable.html | 2 +- zz-dbg/libp2p/protocols/pubsub/pubsub.html | 2 +- .../libp2p/protocols/pubsub/pubsubpeer.html | 8 +- .../libp2p/protocols/pubsub/rpc/message.html | 2 +- .../libp2p/protocols/pubsub/rpc/messages.html | 2 +- .../libp2p/protocols/pubsub/rpc/protobuf.html | 2 +- .../libp2p/protocols/pubsub/timedcache.html | 2 +- zz-dbg/libp2p/protocols/rendezvous.html | 2 +- zz-dbg/libp2p/protocols/secure/noise.html | 2 +- zz-dbg/libp2p/protocols/secure/secure.html | 16 +- zz-dbg/libp2p/routing_record.html | 4 +- zz-dbg/libp2p/signed_envelope.html | 2 +- zz-dbg/libp2p/stream/bufferstream.html | 4 +- zz-dbg/libp2p/stream/chronosstream.html | 2 +- zz-dbg/libp2p/stream/connection.html | 4 +- zz-dbg/libp2p/stream/lpstream.html | 10 +- zz-dbg/libp2p/stream/streamseq.html | 2 +- zz-dbg/libp2p/switch.html | 31 +- zz-dbg/libp2p/transcoder.html | 2 +- zz-dbg/libp2p/transports/tcptransport.html | 10 +- zz-dbg/libp2p/transports/transport.html | 19 +- zz-dbg/libp2p/transports/wstransport.html | 13 +- zz-dbg/libp2p/upgrademngrs/muxedupgrade.html | 40 +- zz-dbg/libp2p/upgrademngrs/upgrade.html | 36 +- zz-dbg/libp2p/utility.html | 23 +- zz-dbg/libp2p/utils/future.html | 2 +- zz-dbg/libp2p/utils/heartbeat.html | 2 +- zz-dbg/libp2p/utils/offsettedseq.html | 2 +- zz-dbg/libp2p/utils/semaphore.html | 2 +- zz-dbg/libp2p/varint.html | 2 +- zz-dbg/libp2p/vbuffer.html | 2 +- zz-dbg/libp2p/wire.html | 2 +- zz-dbg/theindex.html | 64 ++-- 82 files changed, 663 insertions(+), 617 deletions(-) diff --git a/zz-dbg/libp2p.html b/zz-dbg/libp2p.html index c7d94796c..802015c12 100644 --- a/zz-dbg/libp2p.html +++ b/zz-dbg/libp2p.html @@ -260,7 +260,7 @@ class="link-seesrc" target="_blank">Source

- Made with Nim. Generated: 2023-12-21 17:01:45 UTC + Made with Nim. Generated: 2024-01-25 15:42:37 UTC
diff --git a/zz-dbg/libp2p/builders.html b/zz-dbg/libp2p/builders.html index 0324ff4d5..c85d4fe53 100644 --- a/zz-dbg/libp2p/builders.html +++ b/zz-dbg/libp2p/builders.html @@ -228,7 +228,8 @@ window.addEventListener("DOMContentLoaded", main2); autonat: bool circuitRelay: Relay rdv: RendezVous - services: seq[Service]">SwitchBuilder + services: seq[Service] + observedAddrManager: ObservedAddrManager">SwitchBuilder
  • TransportProvider
    • @@ -320,6 +321,13 @@ window.addEventListener("DOMContentLoaded", main2);
  • withNoise(b: SwitchBuilder): SwitchBuilder
    • + + @@ -344,9 +344,9 @@ class="link-seesrc" target="_blank">Source   Source -  Edit +  Edit @@ -361,9 +361,9 @@ class="link-seesrc" target="_blank">Source   Source -  Edit +  Edit @@ -374,24 +374,23 @@ class="link-seesrc" target="_blank">Source Connects to a peer and retrieve its PeerId   Source -  Edit +  Edit 
    method connect(self: Dialer; peerId: PeerId; addrs: seq[MultiAddress];
-               forceDial = false; reuseConnection = true;
-               upgradeDir = Direction.Out): Future[void] {.stackTrace: false,
-    ...gcsafe, raises: [], tags: [RootEffect].}
    + forceDial = false; reuseConnection = true; dir = Direction.Out): Future[ + void] {.stackTrace: false, ...gcsafe, raises: [], tags: [RootEffect].}
    connect remote peer without negotiating a protocol   Source -  Edit +  Edit
    @@ -403,9 +402,9 @@ class="link-seesrc" target="_blank">Source create a protocol stream and establish a connection if one doesn't exist already   Source -  Edit +  Edit @@ -416,9 +415,9 @@ class="link-seesrc" target="_blank">Source create a protocol stream over an existing connection   Source -  Edit +  Edit @@ -430,9 +429,9 @@ class="link-seesrc" target="_blank">Source Create a protocol stream in order to check if a connection is possible. Doesn't use the Connection Manager to save it.   Source -  Edit +  Edit @@ -451,7 +450,7 @@ class="link-seesrc" target="_blank">Source

    - Made with Nim. Generated: 2023-12-21 17:01:43 UTC + Made with Nim. Generated: 2024-01-25 15:42:35 UTC
    diff --git a/zz-dbg/libp2p/errors.html b/zz-dbg/libp2p/errors.html index 4fb8c7a7c..ab3bef443 100644 --- a/zz-dbg/libp2p/errors.html +++ b/zz-dbg/libp2p/errors.html @@ -357,7 +357,7 @@ class="link-seesrc" target="_blank">Source

    - Made with Nim. Generated: 2023-12-21 17:01:43 UTC + Made with Nim. Generated: 2024-01-25 15:42:34 UTC
    diff --git a/zz-dbg/libp2p/multiaddress.html b/zz-dbg/libp2p/multiaddress.html index a9921ebd8..644363b9f 100644 --- a/zz-dbg/libp2p/multiaddress.html +++ b/zz-dbg/libp2p/multiaddress.html @@ -765,14 +765,14 @@ window.addEventListener("DOMContentLoaded", main2); @@ -247,8 +252,12 @@ window.addEventListener("DOMContentLoaded", main2); Procs @@ -429,9 +427,9 @@ class="link-seesrc" target="_blank">Source check if transport supports the multiaddress   Source -  Edit +  Edit @@ -462,10 +460,9 @@ class="link-seesrc" target="_blank">Source -
    -
    method upgrade(self: Transport; conn: Connection; direction: Direction;
-               peerId: Opt[PeerId]): Future[Muxer] {.base, ...gcsafe, raises: [],
-    tags: [].}
    +
    +
    method upgrade(self: Transport; conn: Connection; peerId: Opt[PeerId]): Future[
+    Muxer] {.base, ...gcsafe, raises: [], tags: [].}
    base upgrade method that the transport uses to perform transport specific upgrades @@ -491,7 +488,7 @@ class="link-seesrc" target="_blank">Source

    - Made with Nim. Generated: 2023-12-21 17:01:43 UTC + Made with Nim. Generated: 2024-01-25 15:42:34 UTC
    diff --git a/zz-dbg/libp2p/transports/wstransport.html b/zz-dbg/libp2p/transports/wstransport.html index dd63789c2..6b43c7ee1 100644 --- a/zz-dbg/libp2p/transports/wstransport.html +++ b/zz-dbg/libp2p/transports/wstransport.html @@ -423,9 +423,8 @@ class="link-seesrc" target="_blank">Source

    Methods

    -
    method accept(self: WsTransport): Future[Connection] {....gcsafe,
-    stackTrace: false, ...gcsafe, raises: [], raises: [], raises: [],
-    tags: [RootEffect].}
    +
    method accept(self: WsTransport): Future[Connection] {.stackTrace: false,
+    ...gcsafe, raises: [], raises: [], raises: [], tags: [RootEffect].}
    accept a new WS connection @@ -515,8 +514,8 @@ class="link-seesrc" target="_blank">Source
    -
    method stop(self: WsTransport): Future[void] {....gcsafe, stackTrace: false,
-    ...gcsafe, raises: [], raises: [], raises: [], tags: [RootEffect].}
    +
    method stop(self: WsTransport): Future[void] {.stackTrace: false, ...gcsafe,
+    raises: [], raises: [], raises: [], tags: [RootEffect].}
    stop the transport @@ -545,7 +544,7 @@ class="link-seesrc" target="_blank">Source
    @@ -555,7 +554,7 @@ class="link-seesrc" target="_blank">Source

    - Made with Nim. Generated: 2023-12-21 17:01:44 UTC + Made with Nim. Generated: 2024-01-25 15:42:36 UTC
    diff --git a/zz-dbg/libp2p/upgrademngrs/muxedupgrade.html b/zz-dbg/libp2p/upgrademngrs/muxedupgrade.html index a11595569..0b9df4c70 100644 --- a/zz-dbg/libp2p/upgrademngrs/muxedupgrade.html +++ b/zz-dbg/libp2p/upgrademngrs/muxedupgrade.html @@ -216,8 +216,8 @@ window.addEventListener("DOMContentLoaded", main2); Procs