From 4d01d91520f399ddbf8def9c92e3b345940e421f Mon Sep 17 00:00:00 2001 From: = Date: Thu, 6 Jun 2024 12:38:50 +0000 Subject: [PATCH] update docs for gossipsub-version --- gossipsub-version/libp2p.html | 2 +- gossipsub-version/libp2p/builders.html | 140 +++--- gossipsub-version/libp2p/connmanager.html | 2 +- .../libp2p/crypto/chacha20poly1305.html | 2 +- gossipsub-version/libp2p/crypto/crypto.html | 4 +- .../libp2p/crypto/curve25519.html | 2 +- gossipsub-version/libp2p/crypto/ecnist.html | 2 +- .../libp2p/crypto/ed25519/constants.html | 2 +- .../libp2p/crypto/ed25519/ed25519.html | 2 +- gossipsub-version/libp2p/crypto/hkdf.html | 2 +- gossipsub-version/libp2p/crypto/minasn1.html | 2 +- gossipsub-version/libp2p/crypto/rsa.html | 2 +- gossipsub-version/libp2p/crypto/secp.html | 2 +- gossipsub-version/libp2p/dial.html | 2 +- gossipsub-version/libp2p/dialer.html | 2 +- gossipsub-version/libp2p/errors.html | 2 +- gossipsub-version/libp2p/multiaddress.html | 4 +- gossipsub-version/libp2p/multibase.html | 2 +- gossipsub-version/libp2p/multicodec.html | 4 +- gossipsub-version/libp2p/multihash.html | 2 +- gossipsub-version/libp2p/multistream.html | 2 +- .../libp2p/muxers/mplex/coder.html | 2 +- .../libp2p/muxers/mplex/mplex.html | 2 +- gossipsub-version/libp2p/muxers/muxer.html | 2 +- .../libp2p/muxers/yamux/yamux.html | 2 +- .../libp2p/nameresolving/nameresolver.html | 2 +- .../libp2p/observedaddrmanager.html | 2 +- gossipsub-version/libp2p/peerid.html | 4 +- gossipsub-version/libp2p/peerinfo.html | 54 +-- .../libp2p/protobuf/minprotobuf.html | 4 +- .../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 | 2 +- .../connectivity/relay/rtransport.html | 2 +- .../protocols/connectivity/relay/utils.html | 2 +- .../libp2p/protocols/identify.html | 2 +- gossipsub-version/libp2p/protocols/ping.html | 4 +- .../libp2p/protocols/protocol.html | 2 +- .../libp2p/protocols/pubsub.html | 2 +- .../libp2p/protocols/pubsub/errors.html | 2 +- .../libp2p/protocols/pubsub/floodsub.html | 2 +- .../libp2p/protocols/pubsub/gossipsub.html | 2 +- .../protocols/pubsub/gossipsub/behavior.html | 2 +- .../protocols/pubsub/gossipsub/scoring.html | 2 +- .../protocols/pubsub/gossipsub/types.html | 2 +- .../libp2p/protocols/pubsub/mcache.html | 2 +- .../libp2p/protocols/pubsub/peertable.html | 2 +- .../libp2p/protocols/pubsub/pubsub.html | 2 +- .../libp2p/protocols/pubsub/pubsubpeer.html | 4 +- .../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 +- .../libp2p/protocols/rendezvous.html | 2 +- .../libp2p/protocols/secure/noise.html | 2 +- .../libp2p/protocols/secure/secure.html | 2 +- gossipsub-version/libp2p/routing_record.html | 4 +- .../services/wildcardresolverservice.html | 436 ++++++++++++++++++ gossipsub-version/libp2p/signed_envelope.html | 4 +- .../libp2p/stream/bufferstream.html | 4 +- .../libp2p/stream/chronosstream.html | 2 +- .../libp2p/stream/connection.html | 4 +- gossipsub-version/libp2p/stream/lpstream.html | 2 +- .../libp2p/stream/streamseq.html | 2 +- gossipsub-version/libp2p/switch.html | 4 +- gossipsub-version/libp2p/transcoder.html | 2 +- .../libp2p/transports/tcptransport.html | 4 +- .../libp2p/transports/transport.html | 2 +- .../libp2p/transports/wstransport.html | 2 +- .../libp2p/upgrademngrs/muxedupgrade.html | 2 +- .../libp2p/upgrademngrs/upgrade.html | 4 +- gossipsub-version/libp2p/utility.html | 30 +- gossipsub-version/libp2p/utils/future.html | 2 +- gossipsub-version/libp2p/utils/heartbeat.html | 2 +- .../libp2p/utils/offsettedseq.html | 2 +- gossipsub-version/libp2p/utils/semaphore.html | 2 +- gossipsub-version/libp2p/varint.html | 2 +- gossipsub-version/libp2p/vbuffer.html | 2 +- gossipsub-version/libp2p/wire.html | 4 +- gossipsub-version/theindex.html | 36 +- 83 files changed, 684 insertions(+), 198 deletions(-) create mode 100644 gossipsub-version/libp2p/services/wildcardresolverservice.html diff --git a/gossipsub-version/libp2p.html b/gossipsub-version/libp2p.html index 2dab70c26..20ee9e633 100644 --- a/gossipsub-version/libp2p.html +++ b/gossipsub-version/libp2p.html @@ -260,7 +260,7 @@ class="link-seesrc" target="_blank">Source

- Made with Nim. Generated: 2024-06-05 20:57:53 UTC + Made with Nim. Generated: 2024-06-06 12:38:41 UTC
diff --git a/gossipsub-version/libp2p/builders.html b/gossipsub-version/libp2p/builders.html index fa5f78bf6..2403ad41a 100644 --- a/gossipsub-version/libp2p/builders.html +++ b/gossipsub-version/libp2p/builders.html @@ -229,7 +229,8 @@ window.addEventListener("DOMContentLoaded", main2); circuitRelay: Relay rdv: RendezVous services: seq[Service] - observedAddrManager: ObservedAddrManager">SwitchBuilder + observedAddrManager: ObservedAddrManager + enableWildcardResolver: bool">SwitchBuilder
  • TransportProvider
    • @@ -268,13 +269,17 @@ window.addEventListener("DOMContentLoaded", main2); @@ -330,9 +332,9 @@ class="link-seesrc" target="_blank">Source   Source -  Edit +  Edit @@ -395,9 +397,9 @@ class="link-seesrc" target="_blank">Source   Source -  Edit +  Edit @@ -407,9 +409,21 @@ class="link-seesrc" target="_blank">Source   Source -  Edit +  Edit + + + +
    +
    template withValue[T, E](self: Result[T, E]; value, body: untyped): untyped
    +
    + + +  Source +  Edit
    @@ -444,7 +458,7 @@ class="link-seesrc" target="_blank">Source

    - Made with Nim. Generated: 2024-06-05 20:57:46 UTC + Made with Nim. Generated: 2024-06-06 12:38:33 UTC
    diff --git a/gossipsub-version/libp2p/utils/future.html b/gossipsub-version/libp2p/utils/future.html index e8b7bc1cd..a8aaeb850 100644 --- a/gossipsub-version/libp2p/utils/future.html +++ b/gossipsub-version/libp2p/utils/future.html @@ -271,7 +271,7 @@ class="link-seesrc" target="_blank">Source

    - Made with Nim. Generated: 2024-06-05 20:57:51 UTC + Made with Nim. Generated: 2024-06-06 12:38:38 UTC
    diff --git a/gossipsub-version/libp2p/utils/heartbeat.html b/gossipsub-version/libp2p/utils/heartbeat.html index 7763a14cc..516ca2b17 100644 --- a/gossipsub-version/libp2p/utils/heartbeat.html +++ b/gossipsub-version/libp2p/utils/heartbeat.html @@ -245,7 +245,7 @@ class="link-seesrc" target="_blank">Source

    - Made with Nim. Generated: 2024-06-05 20:57:51 UTC + Made with Nim. Generated: 2024-06-06 12:38:38 UTC
    diff --git a/gossipsub-version/libp2p/utils/offsettedseq.html b/gossipsub-version/libp2p/utils/offsettedseq.html index cfea1c522..fac9aa9ae 100644 --- a/gossipsub-version/libp2p/utils/offsettedseq.html +++ b/gossipsub-version/libp2p/utils/offsettedseq.html @@ -512,7 +512,7 @@ class="link-seesrc" target="_blank">Source

    - Made with Nim. Generated: 2024-06-05 20:57:51 UTC + Made with Nim. Generated: 2024-06-06 12:38:38 UTC
    diff --git a/gossipsub-version/libp2p/utils/semaphore.html b/gossipsub-version/libp2p/utils/semaphore.html index 4abb2ad8d..ae6e91758 100644 --- a/gossipsub-version/libp2p/utils/semaphore.html +++ b/gossipsub-version/libp2p/utils/semaphore.html @@ -362,7 +362,7 @@ class="link-seesrc" target="_blank">Source

    - Made with Nim. Generated: 2024-06-05 20:57:50 UTC + Made with Nim. Generated: 2024-06-06 12:38:38 UTC
    diff --git a/gossipsub-version/libp2p/varint.html b/gossipsub-version/libp2p/varint.html index 4500616e3..cba897759 100644 --- a/gossipsub-version/libp2p/varint.html +++ b/gossipsub-version/libp2p/varint.html @@ -725,7 +725,7 @@ class="link-seesrc" target="_blank">Source

    - Made with Nim. Generated: 2024-06-05 20:57:46 UTC + Made with Nim. Generated: 2024-06-06 12:38:33 UTC
    diff --git a/gossipsub-version/libp2p/vbuffer.html b/gossipsub-version/libp2p/vbuffer.html index 792970659..837423096 100644 --- a/gossipsub-version/libp2p/vbuffer.html +++ b/gossipsub-version/libp2p/vbuffer.html @@ -636,7 +636,7 @@ class="link-seesrc" target="_blank">Source

    - Made with Nim. Generated: 2024-06-05 20:57:48 UTC + Made with Nim. Generated: 2024-06-06 12:38:35 UTC
    diff --git a/gossipsub-version/libp2p/wire.html b/gossipsub-version/libp2p/wire.html index 1c29d06a1..c35af61ea 100644 --- a/gossipsub-version/libp2p/wire.html +++ b/gossipsub-version/libp2p/wire.html @@ -605,7 +605,7 @@ class="link-seesrc" target="_blank">Source

    Exports

    -DNS_OR_IP, hash, UDP_DNS, MaError, IPFS, MaPatternOp, isEmpty, WS_DNS, initVBuffer, ProtoScalar, getProtoHeader, hex, protocols, bytes, ==, getLen, HTTPS, UNIX, TranscoderIP6, encode, [], MaResult, init, ProtoField, peekVarint, getRequiredRepeatedField, mapOr, writeSeq, WebSockets_IP, &, DNS6, TLS_WS, [], IpTransportProtocol, QUIC, toOpenArray, IP4, TranscoderPort, withValue, safeConvert, getRequiredField, $, WS_IP, withValue, public, MAKind, getField, checkFieldNumber, TranscoderOnion3, getRepeatedField, matchPartial, protoArgument, match, data, WebSockets, $, isEmpty, HTTP, initVBuffer, finish, VBuffer, init, TcpOnion3, initProtoBuffer, MAProtocol, peekSeq, getPackedRepeatedField, toOpt, getProtoHeader, ProtoHeader, IP, getField, protoAddress, DNS4, readArray, getPtr, isEnough, P2PPattern, CircuitRelay, contains, isEnough, Reliable, ProtoBuffer, len, WS, exceptionToAssert, mapAnd, UDP_IP, DNSANY, DNSADDR, append, write, WSS_IP, peekArray, WSS, readSeq, getRepeatedField, TCP_IP, getField, writePacked, Unreliable, TCP_DNS, capLen, init, protoName, protoArgument, validate, mapEq, Onion3, MaPattern, TranscoderIP6Zone, $, initProtoBuffer, concat, TranscoderP2P, WSS_DNS, writeLPVarint, write, ProtoResult, WebRTCDirect, len, UDP, MaPatResult, TranscoderOnion, write, init, shortLog, items, isEmpty, writeArray, write, WebSockets_DNS, init, UTP, [], IP6, shortLog, ProtoFlags, finish, writePBVarint, valueOr, ProtoFieldKind, TCP, TranscoderDNS, getRepeatedField, ProtoError, init, init, getField, MultiAddress, &=, readVarint, compilesOr, vsizeof, getField, TranscoderIP4, init, initVBuffer, protoCode, MaInvalidAddress, initProtoBuffer, DNS, write, TranscoderUnix, high, toString, writeVarint, SupportedWireTypes +DNS_OR_IP, hash, UDP_DNS, MaError, IPFS, MaPatternOp, isEmpty, WS_DNS, initVBuffer, ProtoScalar, getProtoHeader, hex, protocols, bytes, ==, getLen, HTTPS, UNIX, isEnough, TranscoderIP6, encode, [], MaResult, init, ProtoField, peekVarint, getRequiredRepeatedField, mapOr, writeSeq, WebSockets_IP, &, DNS6, TLS_WS, [], IpTransportProtocol, QUIC, toOpenArray, IP4, TranscoderPort, withValue, safeConvert, getRequiredField, $, WS_IP, withValue, public, MAKind, getField, checkFieldNumber, TranscoderOnion3, getRepeatedField, matchPartial, protoArgument, match, data, WebSockets, $, isEmpty, HTTP, initVBuffer, finish, VBuffer, init, TcpOnion3, initProtoBuffer, MAProtocol, peekSeq, getPackedRepeatedField, toOpt, getProtoHeader, ProtoHeader, IP, getField, protoAddress, DNS4, readArray, getPtr, withValue, P2PPattern, CircuitRelay, contains, isEnough, Reliable, ProtoBuffer, len, WS, exceptionToAssert, mapAnd, UDP_IP, DNSANY, DNSADDR, append, write, WSS_IP, peekArray, WSS, readSeq, getRepeatedField, TCP_IP, getField, writePacked, Unreliable, TCP_DNS, capLen, init, protoName, protoArgument, validate, mapEq, Onion3, MaPattern, TranscoderIP6Zone, $, initProtoBuffer, concat, TranscoderP2P, WSS_DNS, writeLPVarint, write, ProtoResult, WebRTCDirect, len, UDP, MaPatResult, TranscoderOnion, write, init, shortLog, items, isEmpty, writeArray, write, WebSockets_DNS, init, UTP, [], IP6, shortLog, ProtoFlags, finish, writePBVarint, valueOr, ProtoFieldKind, TCP, TranscoderDNS, getRepeatedField, ProtoError, init, init, getField, MultiAddress, &=, readVarint, compilesOr, vsizeof, getField, TranscoderIP4, init, initVBuffer, protoCode, MaInvalidAddress, initProtoBuffer, DNS, write, TranscoderUnix, high, toString, writeVarint, SupportedWireTypes
    @@ -615,7 +615,7 @@ class="link-seesrc" target="_blank">Source

    - Made with Nim. Generated: 2024-06-05 20:57:50 UTC + Made with Nim. Generated: 2024-06-06 12:38:38 UTC
    diff --git a/gossipsub-version/theindex.html b/gossipsub-version/theindex.html index cf93d657e..8d7a368ee 100644 --- a/gossipsub-version/theindex.html +++ b/gossipsub-version/theindex.html @@ -70,7 +70,7 @@ window.addEventListener('DOMContentLoaded', main);

    Index

    - Modules: libp2p, libp2p/builders, libp2p/connmanager, libp2p/crypto/chacha20poly1305, libp2p/crypto/crypto, libp2p/crypto/curve25519, libp2p/crypto/ecnist, libp2p/crypto/ed25519/constants, libp2p/crypto/ed25519/ed25519, libp2p/crypto/hkdf, libp2p/crypto/minasn1, libp2p/crypto/rsa, libp2p/crypto/secp, libp2p/dial, libp2p/dialer, libp2p/errors, libp2p/multiaddress, libp2p/multibase, libp2p/multicodec, libp2p/multihash, libp2p/multistream, libp2p/muxers/mplex/coder, libp2p/muxers/mplex/mplex, libp2p/muxers/muxer, libp2p/muxers/yamux/yamux, libp2p/nameresolving/nameresolver, libp2p/observedaddrmanager, libp2p/peerid, libp2p/peerinfo, libp2p/protobuf/minprotobuf, libp2p/protocols/connectivity/autonat/core, libp2p/protocols/connectivity/autonat/server, libp2p/protocols/connectivity/relay/client, libp2p/protocols/connectivity/relay/messages, libp2p/protocols/connectivity/relay/rconn, libp2p/protocols/connectivity/relay/relay, libp2p/protocols/connectivity/relay/rtransport, libp2p/protocols/connectivity/relay/utils, libp2p/protocols/identify, libp2p/protocols/ping, libp2p/protocols/protocol, libp2p/protocols/pubsub/errors, libp2p/protocols/pubsub/floodsub, libp2p/protocols/pubsub/gossipsub, libp2p/protocols/pubsub/gossipsub/behavior, libp2p/protocols/pubsub/gossipsub/scoring, libp2p/protocols/pubsub/gossipsub/types, libp2p/protocols/pubsub/mcache, libp2p/protocols/pubsub/peertable, libp2p/protocols/pubsub/pubsub, libp2p/protocols/pubsub/pubsubpeer, libp2p/protocols/pubsub/rpc/message, libp2p/protocols/pubsub/rpc/messages, libp2p/protocols/pubsub/rpc/protobuf, libp2p/protocols/pubsub/timedcache, libp2p/protocols/rendezvous, libp2p/protocols/secure/noise, libp2p/protocols/secure/secure, libp2p/routing_record, libp2p/signed_envelope, libp2p/stream/bufferstream, libp2p/stream/chronosstream, libp2p/stream/connection, libp2p/stream/lpstream, libp2p/stream/streamseq, libp2p/switch, libp2p/transcoder, libp2p/transports/tcptransport, libp2p/transports/transport, libp2p/transports/wstransport, libp2p/upgrademngrs/muxedupgrade, libp2p/upgrademngrs/upgrade, libp2p/utility, libp2p/utils/future, libp2p/utils/heartbeat, libp2p/utils/offsettedseq, libp2p/utils/semaphore, libp2p/varint, libp2p/vbuffer, libp2p/wire.

    API symbols

    + Modules: libp2p, libp2p/builders, libp2p/connmanager, libp2p/crypto/chacha20poly1305, libp2p/crypto/crypto, libp2p/crypto/curve25519, libp2p/crypto/ecnist, libp2p/crypto/ed25519/constants, libp2p/crypto/ed25519/ed25519, libp2p/crypto/hkdf, libp2p/crypto/minasn1, libp2p/crypto/rsa, libp2p/crypto/secp, libp2p/dial, libp2p/dialer, libp2p/errors, libp2p/multiaddress, libp2p/multibase, libp2p/multicodec, libp2p/multihash, libp2p/multistream, libp2p/muxers/mplex/coder, libp2p/muxers/mplex/mplex, libp2p/muxers/muxer, libp2p/muxers/yamux/yamux, libp2p/nameresolving/nameresolver, libp2p/observedaddrmanager, libp2p/peerid, libp2p/peerinfo, libp2p/protobuf/minprotobuf, libp2p/protocols/connectivity/autonat/core, libp2p/protocols/connectivity/autonat/server, libp2p/protocols/connectivity/relay/client, libp2p/protocols/connectivity/relay/messages, libp2p/protocols/connectivity/relay/rconn, libp2p/protocols/connectivity/relay/relay, libp2p/protocols/connectivity/relay/rtransport, libp2p/protocols/connectivity/relay/utils, libp2p/protocols/identify, libp2p/protocols/ping, libp2p/protocols/protocol, libp2p/protocols/pubsub/errors, libp2p/protocols/pubsub/floodsub, libp2p/protocols/pubsub/gossipsub, libp2p/protocols/pubsub/gossipsub/behavior, libp2p/protocols/pubsub/gossipsub/scoring, libp2p/protocols/pubsub/gossipsub/types, libp2p/protocols/pubsub/mcache, libp2p/protocols/pubsub/peertable, libp2p/protocols/pubsub/pubsub, libp2p/protocols/pubsub/pubsubpeer, libp2p/protocols/pubsub/rpc/message, libp2p/protocols/pubsub/rpc/messages, libp2p/protocols/pubsub/rpc/protobuf, libp2p/protocols/pubsub/timedcache, libp2p/protocols/rendezvous, libp2p/protocols/secure/noise, libp2p/protocols/secure/secure, libp2p/routing_record, libp2p/services/wildcardresolverservice, libp2p/signed_envelope, libp2p/stream/bufferstream, libp2p/stream/chronosstream, libp2p/stream/connection, libp2p/stream/lpstream, libp2p/stream/streamseq, libp2p/switch, libp2p/transcoder, libp2p/transports/tcptransport, libp2p/transports/transport, libp2p/transports/wstransport, libp2p/upgrademngrs/muxedupgrade, libp2p/upgrademngrs/upgrade, libp2p/utility, libp2p/utils/future, libp2p/utils/heartbeat, libp2p/utils/offsettedseq, libp2p/utils/semaphore, libp2p/varint, libp2p/vbuffer, libp2p/wire.

    API symbols

    `$`:
    +
    getProtocolArgument:
    getProtoHeader:
    +
    NetworkInterfaceProvider:
    NetworkReachability:
    run:
    safeConvert:
    Sha256:
    +
    WildcardAddressResolverService:
    window:
    withAddress:
    • builders: withAddress(b: SwitchBuilder; address: MultiAddress): SwitchBuilder
      • + data-doc-search-tag="builders: withAddress(b: SwitchBuilder; address: MultiAddress; + enableWildcardResolver: bool = true): SwitchBuilder" href="libp2p/builders.html#withAddress%2CSwitchBuilder%2CMultiAddress%2Cbool">builders: withAddress(b: SwitchBuilder; address: MultiAddress; + enableWildcardResolver: bool = true): SwitchBuilder
    withAddresses:
    • builders: withAddresses(b: SwitchBuilder; addresses: seq[MultiAddress]): SwitchBuilder
      • + data-doc-search-tag="builders: withAddresses(b: SwitchBuilder; addresses: seq[MultiAddress]; + enableWildcardResolver: bool = true): SwitchBuilder" href="libp2p/builders.html#withAddresses%2CSwitchBuilder%2Cseq%5BMultiAddress%5D%2Cbool">builders: withAddresses(b: SwitchBuilder; addresses: seq[MultiAddress]; + enableWildcardResolver: bool = true): SwitchBuilder
    withAgentVersion:
    WithVarintLength: