From 7d23d7b9efba0e638c480973764f2bdacc9fd5f7 Mon Sep 17 00:00:00 2001 From: = Date: Mon, 1 Aug 2022 14:42:53 +0000 Subject: [PATCH] update docs for unstable --- unstable/libp2p.html | 2 +- unstable/libp2p/builders.html | 130 ++-- unstable/libp2p/connmanager.html | 2 +- unstable/libp2p/crypto/chacha20poly1305.html | 2 +- unstable/libp2p/crypto/crypto.html | 2 +- unstable/libp2p/crypto/curve25519.html | 2 +- unstable/libp2p/crypto/ecnist.html | 2 +- unstable/libp2p/crypto/ed25519/constants.html | 2 +- unstable/libp2p/crypto/ed25519/ed25519.html | 2 +- unstable/libp2p/crypto/hkdf.html | 2 +- unstable/libp2p/crypto/minasn1.html | 2 +- unstable/libp2p/crypto/rsa.html | 2 +- unstable/libp2p/crypto/secp.html | 2 +- unstable/libp2p/dial.html | 2 +- unstable/libp2p/dialer.html | 2 +- unstable/libp2p/errors.html | 2 +- unstable/libp2p/multiaddress.html | 2 +- unstable/libp2p/multibase.html | 2 +- unstable/libp2p/multicodec.html | 2 +- unstable/libp2p/multihash.html | 2 +- unstable/libp2p/multistream.html | 2 +- unstable/libp2p/muxers/mplex/coder.html | 2 +- unstable/libp2p/muxers/mplex/mplex.html | 2 +- unstable/libp2p/muxers/muxer.html | 2 +- unstable/libp2p/muxers/yamux/yamux.html | 2 +- .../libp2p/nameresolving/nameresolver.html | 2 +- unstable/libp2p/peerid.html | 2 +- unstable/libp2p/peerinfo.html | 4 +- unstable/libp2p/protobuf/minprotobuf.html | 2 +- unstable/libp2p/protocols/identify.html | 2 +- unstable/libp2p/protocols/ping.html | 4 +- unstable/libp2p/protocols/protocol.html | 2 +- unstable/libp2p/protocols/pubsub.html | 2 +- unstable/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 +- unstable/libp2p/protocols/pubsub/mcache.html | 2 +- .../libp2p/protocols/pubsub/peertable.html | 2 +- unstable/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 +- unstable/libp2p/protocols/relay.html | 724 ----------------- unstable/libp2p/protocols/relay/client.html | 478 ++++++++++++ unstable/libp2p/protocols/relay/messages.html | 732 ++++++++++++++++++ unstable/libp2p/protocols/relay/rconn.html | 388 ++++++++++ unstable/libp2p/protocols/relay/relay.html | 561 ++++++++++++++ .../libp2p/protocols/relay/rtransport.html | 424 ++++++++++ unstable/libp2p/protocols/relay/utils.html | 378 +++++++++ unstable/libp2p/protocols/secure/noise.html | 2 +- unstable/libp2p/protocols/secure/secure.html | 35 +- unstable/libp2p/routing_record.html | 4 +- unstable/libp2p/signed_envelope.html | 40 +- unstable/libp2p/stream/bufferstream.html | 4 +- unstable/libp2p/stream/chronosstream.html | 19 +- unstable/libp2p/stream/connection.html | 29 +- unstable/libp2p/stream/lpstream.html | 2 +- unstable/libp2p/stream/streamseq.html | 2 +- unstable/libp2p/switch.html | 44 +- unstable/libp2p/transcoder.html | 2 +- unstable/libp2p/transports/tcptransport.html | 18 +- unstable/libp2p/transports/transport.html | 2 +- unstable/libp2p/transports/wstransport.html | 51 +- .../libp2p/upgrademngrs/muxedupgrade.html | 2 +- unstable/libp2p/upgrademngrs/upgrade.html | 4 +- unstable/libp2p/utility.html | 2 +- unstable/libp2p/utils/heartbeat.html | 2 +- unstable/libp2p/utils/semaphore.html | 2 +- unstable/libp2p/varint.html | 2 +- unstable/libp2p/vbuffer.html | 2 +- unstable/libp2p/wire.html | 2 +- unstable/theindex.html | 384 ++++++--- 77 files changed, 3523 insertions(+), 1046 deletions(-) delete mode 100644 unstable/libp2p/protocols/relay.html create mode 100644 unstable/libp2p/protocols/relay/client.html create mode 100644 unstable/libp2p/protocols/relay/messages.html create mode 100644 unstable/libp2p/protocols/relay/rconn.html create mode 100644 unstable/libp2p/protocols/relay/relay.html create mode 100644 unstable/libp2p/protocols/relay/rtransport.html create mode 100644 unstable/libp2p/protocols/relay/utils.html diff --git a/unstable/libp2p.html b/unstable/libp2p.html index 5717629bb..86c2832ce 100644 --- a/unstable/libp2p.html +++ b/unstable/libp2p.html @@ -260,7 +260,7 @@ class="link-seesrc" target="_blank">Source

- Made with Nim. Generated: 2022-07-27 17:16:39 UTC + Made with Nim. Generated: 2022-08-01 14:42:50 UTC
diff --git a/unstable/libp2p/builders.html b/unstable/libp2p/builders.html index 69f52b6e9..14985dacd 100644 --- a/unstable/libp2p/builders.html +++ b/unstable/libp2p/builders.html @@ -225,8 +225,7 @@ window.addEventListener("DOMContentLoaded", main2); agentVersion: string nameResolver: NameResolver peerStoreCapacity: Option[int] - isCircuitRelay: bool - circuitRelayCanHop: bool">SwitchBuilder + circuitRelay: Relay">SwitchBuilder
  • TransportProvider
    • @@ -278,6 +277,11 @@ window.addEventListener("DOMContentLoaded", main2);
  • withAgentVersion(b: SwitchBuilder; agentVersion: string): SwitchBuilder
    • + + - + + @@ -342,9 +347,9 @@ class="link-seesrc" target="_blank">Source   Source -  Edit +  Edit @@ -373,9 +378,9 @@ class="link-seesrc" target="_blank">Source   Source -  Edit +  Edit @@ -399,9 +404,9 @@ class="link-seesrc" target="_blank">Source   Source -  Edit +  Edit @@ -425,9 +430,9 @@ class="link-seesrc" target="_blank">Source   Source -  Edit +  Edit @@ -452,9 +457,9 @@ class="link-seesrc" target="_blank">Source   Source -  Edit +  Edit @@ -468,6 +473,19 @@ href="https://github.com/status-im/nim-libp2p/tree/unstable/libp2p/signed_envelo class="link-seesrc" target="_blank">Source   Edit + + +
    +
    proc write(pb: var ProtoBuffer; field: int; env: Envelope): Result[void,
+    CryptoError] {....raises: [Defect], tags: [].}
    +
    + + +  Source +  Edit +
    @@ -485,7 +503,7 @@ class="link-seesrc" target="_blank">Source

    - Made with Nim. Generated: 2022-07-27 17:16:35 UTC + Made with Nim. Generated: 2022-08-01 14:42:46 UTC
    diff --git a/unstable/libp2p/stream/bufferstream.html b/unstable/libp2p/stream/bufferstream.html index 2195a4b96..105d9d514 100644 --- a/unstable/libp2p/stream/bufferstream.html +++ b/unstable/libp2p/stream/bufferstream.html @@ -506,7 +506,7 @@ class="link-seesrc" target="_blank">Source

    Exports

    -newLPStreamWriteError, getProtoHeader, shortLog, random, $, MaError, ephemeral, MaPatternOp, HTTP, initVBuffer, getProtoHeader, MaxSizeError, ProtoHeader, ==, getLen, ECDHEScheme, shortLog, init, closed, [], decode, shcopy, shuffle, random, init, VBuffer, Secret, peekVarint, random, $, validate, mapOr, maxInlineKeyLength, TranscoderDNS, QUIC, init, ephemeral, getRequiredField, getField, supported, write, public, MAKind, getBytes, write, init, getField, checkFieldNumber, init, getRepeatedField, matchPartial, getBytes, len, init, readLp, init, initVBuffer, atEof, LPStreamTrackerName, peekSeq, payloadType, <=, LPStreamError, init, IP, protoAddress, decode, newRng, DefaultConnectionTimeout, checkValid, getPublicKey, decodeProposal, WebSockets, CircuitRelay, extractPublicKey, mapAnd, new, hash, new, newLPStreamEOFError, init, ==, DNSADDR, hash, init, write, WSS, LPStream, writePacked, init, closeImpl, readSeq, toBytes, shortLog, encode, TranscoderIP4, protoName, ==, toRawBytes, TranscoderIP6Zone, $, initProtoBuffer, newLPStreamReadError, init, match, writeLPVarint, CryptoResult, decode, ProtoResult, WebRTCDirect, init, init, UDP, PeerInfo, TranscoderOnion, StreamTracker, write, init, readVarint, isEmpty, writeArray, writeLp, LPStreamIncompleteError, PeerId, [], LPStreamEOFError, IP6, shortLog, initVBuffer, ProtoFlags, PKScheme, isUpgraded, payload, stretchKeys, Connection, write, TCP, PrivateKey, getBytes, write, init, &=, PeerInfoError, newLPStreamClosedError, close, init, initProtoBuffer, toException, DNS, init, init, upgrade, goffset, finish, getRawBytes, >, KeyPair, TimeoutHandler, init, high, toString, cmp, init, SupportedWireTypes, formatItIMPL, formatItIMPL, formatItIMPL, Signature, formatItIMPL, toBytes, DigestSheme, IPFS, readOnce, isEmpty, MultiAddress, ProtoScalar, shortLog, LPStreamIncorrectDefect, hex, protocols, init, HTTPS, tryAndWarn, LPError, getPtr, write, sign, encode, update, MaResult, init, ProtoField, toBytes, writeSeq, &, DNS6, IpTransportProtocol, toOpenArray, init, allFuturesThrowing, IP4, TranscoderPort, isEnough, write, getField, DNSANY, createExchange, >=, init, mac, payloadDomain, $, init, LPStreamLimitError, libp2p_pki_schemes, SignedPayload, init, toBytes, newLPStreamLimitError, write, keyOpenArray, init, match, $, isEmpty, LPStreamReadError, getRequiredRepeatedField, newLPStreamIncompleteError, newLPStreamReadError, initProtoBuffer, MAProtocol, getPackedRepeatedField, initStream, contains, init, shortLog, DNS4, readArray, selectBest, newLPStreamIncorrectDefect, P2PPattern, Envelope, hasPublicKey, toException, init, isEnough, Reliable, hex, ProtoBuffer, closeImpl, write, WS, readVarint, encode, init, getField, match, getField, <, iv, onUpgrade, readLine, Eof, CryptoError, getField, append, MaPattern, vsizeof, init, peekArray, UNIX, PeerRecord, SupportedSchemes, getRepeatedField, LPStreamWriteError, getField, RsaDefaultKeySize, hash, Unreliable, SupportedSchemesInt, random, checkFutures, macOpenArray, init, validate, $, protoCode, mapEq, getField, concat, TranscoderP2P, AddressInfo, ConnectionTrackerName, TranscoderIP6, init, write, EnvelopeError, encode, len, MaxMessageSize, createProposal, MaPatResult, Direction, key, InvalidVarintError, shortLog, ==, write, getBytes, write, UTP, finish, verify, PublicKey, writeLp, writePBVarint, ProtoFieldKind, readExactly, protoArgument, getRepeatedField, ProtoError, init, initStream, getField, ivOpenArray, closeWithEOF, orError, decodeExchange, getField, MaInvalidAddress, LPStreamClosedError, writeVarint, items, write, getOrder, TranscoderUnix, SignedPeerRecord, join +newLPStreamWriteError, getProtoHeader, shortLog, random, $, MaError, ephemeral, MaPatternOp, HTTP, initVBuffer, getProtoHeader, MaxSizeError, ProtoHeader, ==, getLen, ECDHEScheme, shortLog, init, closed, [], shuffle, random, init, VBuffer, Secret, peekVarint, random, $, validate, mapOr, key, maxInlineKeyLength, TranscoderDNS, QUIC, init, ephemeral, getRequiredField, getField, supported, getWrapped, getBytes, public, MAKind, write, write, init, getField, checkFieldNumber, init, getRepeatedField, matchPartial, getBytes, len, readLp, init, initVBuffer, atEof, LPStreamTrackerName, peekSeq, payloadType, <=, LPStreamError, init, decode, IP, protoAddress, newRng, DefaultConnectionTimeout, checkValid, getPublicKey, decodeProposal, WebSockets, CircuitRelay, extractPublicKey, mapAnd, new, hash, new, newLPStreamEOFError, init, ==, DNSADDR, hash, init, write, WSS, LPStream, writePacked, init, closeImpl, readSeq, toBytes, shortLog, encode, TranscoderIP4, init, protoName, ==, toRawBytes, TranscoderIP6Zone, $, initProtoBuffer, newLPStreamReadError, init, match, writeLPVarint, CryptoResult, ProtoResult, WebRTCDirect, init, init, UDP, PeerInfo, TranscoderOnion, StreamTracker, write, init, readVarint, isEmpty, writeArray, writeLp, shcopy, LPStreamIncompleteError, PeerId, [], LPStreamEOFError, IP6, shortLog, initVBuffer, decode, ProtoFlags, PKScheme, isUpgraded, payload, stretchKeys, Connection, write, TCP, PrivateKey, getBytes, write, init, &=, PeerInfoError, newLPStreamClosedError, close, init, initProtoBuffer, toException, DNS, init, init, upgrade, goffset, finish, getRawBytes, >, KeyPair, TimeoutHandler, init, high, toString, cmp, init, SupportedWireTypes, formatItIMPL, formatItIMPL, formatItIMPL, Signature, formatItIMPL, toBytes, DigestSheme, IPFS, readOnce, isEmpty, MultiAddress, ProtoScalar, shortLog, LPStreamIncorrectDefect, hex, protocols, init, HTTPS, tryAndWarn, LPError, getPtr, write, sign, encode, update, MaResult, init, ProtoField, toBytes, writeSeq, &, DNS6, IpTransportProtocol, toOpenArray, init, allFuturesThrowing, IP4, TranscoderPort, isEnough, write, getField, DNSANY, createExchange, >=, init, mac, payloadDomain, $, LPStreamLimitError, libp2p_pki_schemes, SignedPayload, init, toBytes, newLPStreamLimitError, write, keyOpenArray, init, match, $, isEmpty, LPStreamReadError, getRequiredRepeatedField, newLPStreamIncompleteError, newLPStreamReadError, initProtoBuffer, MAProtocol, getPackedRepeatedField, initStream, contains, init, shortLog, DNS4, readArray, selectBest, newLPStreamIncorrectDefect, P2PPattern, Envelope, hasPublicKey, toException, isEnough, Reliable, hex, ProtoBuffer, closeImpl, write, decode, WS, readVarint, encode, init, getField, match, getField, <, iv, onUpgrade, readLine, Eof, CryptoError, getField, append, MaPattern, vsizeof, init, peekArray, UNIX, PeerRecord, SupportedSchemes, getRepeatedField, LPStreamWriteError, getField, RsaDefaultKeySize, hash, Unreliable, SupportedSchemesInt, random, checkFutures, macOpenArray, init, validate, $, protoCode, mapEq, getField, write, concat, TranscoderP2P, AddressInfo, ConnectionTrackerName, TranscoderIP6, init, write, EnvelopeError, encode, len, MaxMessageSize, createProposal, MaPatResult, Direction, init, InvalidVarintError, shortLog, ==, write, getBytes, write, init, UTP, finish, verify, PublicKey, writeLp, writePBVarint, ProtoFieldKind, readExactly, protoArgument, getRepeatedField, ProtoError, init, initStream, getField, ivOpenArray, closeWithEOF, orError, decodeExchange, getField, MaInvalidAddress, LPStreamClosedError, writeVarint, items, write, getOrder, TranscoderUnix, SignedPeerRecord, join
    @@ -516,7 +516,7 @@ class="link-seesrc" target="_blank">Source

    - Made with Nim. Generated: 2022-07-27 17:16:36 UTC + Made with Nim. Generated: 2022-08-01 14:42:47 UTC
    diff --git a/unstable/libp2p/stream/chronosstream.html b/unstable/libp2p/stream/chronosstream.html index 1e3c8f116..06a10d185 100644 --- a/unstable/libp2p/stream/chronosstream.html +++ b/unstable/libp2p/stream/chronosstream.html @@ -258,6 +258,11 @@ window.addEventListener("DOMContentLoaded", main2);
  • closeImpl(s: ChronosStream): Future[void]
    • + + + +