Module types

Source
Expand description

NextGraph network protocol types

Corresponds to the BARE schema

Structs§

AdminRequestV0
Admin request
AdminResponseV0
Response to an AdminRequest V0
AppMessageV0
AppMessageV0
AuthResultV0
Authentication result
BindAddress
Bind address
BlockResultV0
Response to a BlockSearch* request
BlockSearchRandomV0
Block search along a random walk in the overlay
BlockSearchTopicV0
Object search in a pub/sub topic
BlocksExistV0
Request to know if some blocks are present locally
BlocksFoundV0
Response which blocks have been found locally. V0
BlocksGetV0
Request a Block by ID
BlocksPutV0
Request to store one or more blocks
BootstrapContentV0
Bootstrap content Version 0
BootstrapIframeMsg
BrokerCoreV0
Core Broker connection details Version 0
BrokerOverlayConfigV0
Broker Overlay Config
BrokerServer
BrokerServerContentV0
BrokerServerV0
BrokerServer details Version 0
ClientAuthContentV0
Content of ClientAuthV0
ClientAuthV0
Client authentication
ClientInfoV0
ClientMessageV0
Broker message for an overlay
ClientRequestV0
Broker overlay request
ClientResponseV0
Response to a ClientRequest
CommitGetV0
Request a Commit by ID
CoreAdvertV0
CoreAdvert V0
CoreBlockResultV0
Core Block Result V0
CoreBlocksGetV0
Core Block Get V0
CoreBrokerConnectResponseV0
CoreBrokerConnectResponse V0
CoreBrokerConnectV0
CoreBrokerConnect V0
CoreBrokerJoinedAdvertV0
CoreBrokerJoinedAdvert V0
CoreBrokerLeftAdvertV0
CoreBrokerLeftAdvert V0
CoreDirectMessageV0
CoreDirectMessage V0
CoreOverlayJoinedAdvertV0
CoreOverlayJoinedAdvert V0
CoreRequestV0
CoreRequest V0
CoreResponseV0
CoreResponse V0
CoreTopicSyncReqV0
Core Topic synchronization request
CreateAccountBSPV0
Create an account at a Broker Service Provider (BSP). Version 0
Credentials
used to initiate a session at a local broker V0
EmptyAppResponse
ExportedWallet
ExtObjectGetV0
Request object(s) by ID by non-members to a broker
ExtRequestV0
External request with its request ID
ExtResponseV0
Response to an ExtRequest
ExtWalletGetExportV0
ForwardedPeerAdvertV0
ForwardedPeerAdvertV0
ForwardedPeerConflictV0
ForwardedPeerConflictV0
IPTransportAddr
IP transport address
InnerOverlayLink
Inner Overlay Link
InnerOverlayMessagePayloadV0
Inner Overlay message payload V0
InnerOverlayMessageV0
Inner Overlay message V0
Interface
InvitationV0
Invitation to create an account at a broker. Version 0
ListenerInfo
ListenerInfo
ListenerV0
DaemonConfig Listener Version 0
LocalBootstrapInfoV0
Local Bootstrap info Version 0, served at /.ng_bootstrap
ObjectDelV0
Request to delete an object
ObjectLinkV0
Obtains one or more objects of a repo (Commit, File) by their ID.
ObjectPinV0
Request to pin an object
ObjectUnpinV0
Request to unpin an object
OpenRepoV0
Request to open a repo in a non-durable way (without pinning it).
OuterOverlayMessageV0
OuterOverlayMessage V0
OuterOverlayRequestV0
OuterOverlayRequestV0 V0
OuterOverlayResponseV0
OuterOverlayResponse V0
OverlayAdvertMarkerV0
OverlayAdvertMarker V0
OverlayAdvertPayloadV0
Overlay Advert Payload V0
OverlayAdvertV0
Overlay Advert V0 : used by a broker peer every time it (re)joins an overlay
PeerAdvertContentV0
Content of PeerAdvertV0
PeerAdvertV0
Peer advertisement
PinRepoV0
Request to pin a repo on the broker.
ProbeResponse
ProbeResponse
PublicRepoLinkV0
Link for a Public Repo
PublishEvent
Request to publish an event in pubsub
PublisherAdvertContentV0
Content of PublisherAdvertV0
PublisherAdvertV0
Topic advertisement by a publisher
ReadBranchLinkV0
Read access to a branch of a Public, Protected or Group store.
RefreshPinRepoV0
Request to refresh the Pinning of a previously pinned repo.
RelayRequest
RelayRequest
RelayResponse
RelayResponse
RepoLinkV0
Link to a repository
RepoPinStatusReqV0
Request the status of pinning for a repo on the broker. V0
RepoPinStatusV0
Response with the status of pinning for a repo on the broker. V0
ReturnPathTimingAdvertV0
ReturnPathTimingAdvertV0
SubMarkerV0
Topic subscription marker sent by all publishers, back to subscriber
SubReqV0
Topic subscription request by a peer
TopicSubResV0
Topic subscription response V0
TopicSubV0
Request subscription to a Topic of an already opened or pinned Repo
TopicSyncReqV0
Topic synchronization request
TopicUnsubV0
Request unsubscription from a Topic of an already opened or pinned Repo
TunnelRequest
Tunnel Request
TunnelResponse
Tunnel Response
UnpinRepoV0
Request to unpin a repo on the broker.
UnsubReqV0
Topic unsubscription request by a subscriber
WalletPutExportV0
Request to store one or more blocks

Enums§

AcceptForwardForV0
AcceptForwardForV0 type
AdminRequest
Admin request
AdminRequestContentV0
Content of AdminRequestV0
AdminResponse
Response to an AdminRequest
AdminResponseContentV0
Content of AdminResponseV0
AppMessage
App message
AppMessageContentV0
AppMessageContentV0
AuthResult
Authentication result
Authorization
BlockResult
Response to a BlockSearch* request
BlockSearchRandom
Block request by ID using a random walk in the overlay
BlockSearchTopic
Object request by ID to publishers
BlocksExist
Request to store one or more blocks
BlocksFound
Response which blocks have been found locally.
BlocksGet
Request an object by ID
BlocksPut
Request to store one or more blocks
BootstrapContent
BrokerCore
Core Broker connection details
BrokerOverlayPermission
Broker Overlay Permission
BrokerServerTypeV0
BrokerServerTypeV0 type
ClientAuth
Client authentication
ClientInfo
Client Info
ClientMessage
Broker message for an overlay
ClientMessageContentV0
Content of ClientMessageV0
ClientRequest
Broker overlay request
ClientRequestContentV0
Content of ClientRequestV0
ClientResponse
Response to a ClientRequest
ClientResponseContentV0
Content of ClientResponseV0
ClientType
info : { type : WEB | NATIVE-IOS | NATIVE-ANDROID | NATIVE-MACOS | NATIVE-LINUX | NATIVE-WIN NATIVE-SERVICE | NODE-SERVICE | VERIFIER | CLIENT-BROKER | CLI vendor : (UA, node version, tauri webview, rust version) os : operating system string version : version of client date_install date_updated : last update } Client Type
CommitGet
Request a Commit by ID (see CommitGetV0 for more details)
CoreAdvert
CoreAdvertContentV0
Content of CoreAdvert V0
CoreBlockResult
CoreBlocksGet
CoreBrokerConnect
CoreBrokerConnect
CoreBrokerConnectResponse
CoreBrokerConnectResponse
CoreBrokerDisconnect
CoreBrokerJoinedAdvert
CoreBrokerLeftAdvert
CoreDirectMessage
CoreDirectMessageContentV0
Content of CoreDirectMessage V0
CoreMessage
Core message
CoreMessageV0
CoreMessageV0
CoreOverlayJoin
CoreOverlayJoinV0
Content of CoreOverlayJoin V0
CoreOverlayJoinedAdvert
CoreRequest
Request sent to a broker in the core network
CoreRequestContentV0
Content of CoreRequest V0
CoreResponse
Response to a Request sent to a broker in the core network
CoreResponseContentV0
Content CoreResponse V0
CoreTopicSyncReq
Topic synchronization request
CreateAccountBSP
Create an account at a Broker Service Provider (BSP).
ExtObjectGet
Request object(s) by ID by non-members
ExtRequest
External request are made by clients directly to a core broker of their choice.
ExtRequestContentV0
Content of ExtRequestV0
ExtResponse
Response to an ExtRequest
ExtResponseContentV0
Content of ExtResponseV0
ForwardedPeerAdvert
Forwarded Peer advertisement
ForwardedPeerConflict
Forwarded Peer advertisement conflict
IP
IP address
InnerOverlayMessage
Inner Overlay message
InnerOverlayMessageContentV0
Content of InnerOverlayMessageV0
InterfaceType
Invitation
Invitation to create an account at a broker.
InvitationCode
LocalBootstrapInfo
Locator
NetAddr
Network address
NgLink
NextGraph Link
NgLinkV0
NextGraph Link V0
ObjectDel
Request to delete an object
ObjectLink
Link to a specific commit, without its causal past
ObjectPin
Request to pin an object
ObjectUnpin
Request to unpin an object
OpenRepo
Request to open a repo
OuterOverlayMessage
OuterOverlayMessageContentV0
OuterOverlayRequest
OuterOverlayRequestContentV0
Content of OuterOverlayRequest V0
OuterOverlayResponse
OuterOverlayResponseContentV0
Content of OuterOverlayResponse V0
OverlayAccess
Overlay Access
OverlayAdvert
Overlay Advert : used by a broker peer every time it (re)joins an overlay
OverlayAdvertMarker
OverlayLeave
Overlay leave request
OverlayLink
Overlay Link
PeerAdvert
Peer advertisement
PeerStatus
Status of a Forwarded Peer, sent in the Advert
PinRepo
Request to pin a repo
ProtocolMessage
PublicRepoLink
Link to a public repository
PublisherAdvert
Topic advertisement by a publisher
ReadBranchLink
Link to a repository
RefreshPinRepo
Request to pin a repo
RegistrationConfig
Registration config
RepoLink
Link to a repository
RepoPinStatus
Response with the status of pinning for a repo on the broker.
RepoPinStatusReq
Request the status of pinning for a repo on the broker.
ReturnPathTimingAdvert
SubMarker
Topic subscription acknowledgement by a publisher
SubReq
Topic subscription request by a peer
TopicSub
Request subscription to a Topic of an already opened or pinned Repo
TopicSubRes
Topic subscription response
TopicSyncReq
Topic synchronization request
TopicSyncRes
Topic synchronization response
TopicSyncResV0
Topic synchronization response V0
TopicUnsub
Request unsubscription from a Topic of an already opened or pinned Repo
TransportProtocol
IP transport protocol
UnpinRepo
Request to unpin a repo
UnsubReq
Topic unsubscription request by a subscriber
WalletPutExport
Request to store one or more blocks

Traits§

IStreamable

Type Aliases§

ClientId
Client ID: client of a user
CoreBrokerDisconnectV0
sent to a direct peer just before closing the connection
ExtTopicSyncReq
Topic synchronization request
IPv4
IPv4 address
IPv6
IPv6 address
LocatorV0
RepoOpened
SessionId
Overlay session ID