# Packages
Package xtestutils provides golang testutils for developing with TemporalX.
# Functions
NewAddrInfoFromHost creates an AddrInfo from a HostInfo.
No description provided by the author
NewDAGService returns a DAGService that implements ipld.DAGService using NodeAPIClient.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewReplication creates a new Replication file, with the correct header.
No description provided by the author
NewReplicatorClientConstructor is a convenient way to make a NewReplicatorClient.
NewServerSourceFromHost creates an ServerSource from a HostInfo.
NewSignedSubscription creates a fully signed SignedSubscription with the given private key.
NewSimpleConnectionProvider creates a SimpleConnectionProvider.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ServerSourcesToAddrInfos returns AddrInfos from ServerSources TODO: unstable API.
# Constants
DEGRADED_PERFORMANCE indicates the system is currently under heavy load.
ERROR indicates that the system is currently experiencing an error and should not be used.
ONLINE indicates everything is working as expected.
PURGING indicates the system is undergoing data removal a purging system is not available for use unless all other nodes are unavailable.
BS_FORCE indicates to force the request regardless of any possible issues.
DEFAULT indicates to use the default settings.
BS_DELETE is used to delete a block from the store.
BS_GET is used to get a block from the store.
BS_GET_ALL is used to retrieve all blocks from the store It is the gRPC equivalent of Blockstore::AllKeysChan.
BS_GET_MANY is used to get many blocks from the store.
BS_GET_STATS is used to retrieve statistics about individual blocks.
BS_HAS is used to retrieve whether or not we have the block.
BS_HASH_ON_READ_DISABLE is used to disable hash on read.
BS_HASH_ON_READ_ENABLE is used to enable hash on read.
BS_PUT is used to put a single block in the store.
BS_PUT_MANY is used to put many blocks in the store.
CM_CONNECT is used to connect to a libp2p peer.
CM_DISCONNECT is used to disconnect from a libp2p peer.
CM_GET_PEERS is used to return all known peers.
CM_STATUS is used to return status information about libp2p peer connections useful for determining whether or not we are connected to someone.
DAG_ADD_LINKS is used to add links to an IPLD node object.
DAG_GET is used to retrieve IPLD object data.
DAG_GET_LINKS is used to retrieve all links contained in an IPLD node object.
DAG_NEW_NODE is used to create a new IPLD node object.
DAG_PUT is used to add new IPLD objects.
DAG_STAT is used to retrieve ipld.NodeStats information.
EX_DISABLE is used to disable a particular node extras feature.
EX_ENABLE is used to enable a particular node extras feature.
DISCOVERY is a libp2p discovery service.
IDENTIFY is the identify service.
MDNS is used to discover libp2p hosts over mdns.
PUBSUB is the libp2p pubsub system.
GC_START is used to start gc.
GC_STATUS is used to retrieve gc status.
C_STOP is used to stop GC.
KS_DELETE is used to delete private keys from our keystore.
KS_GET is used to retrieve private key bytes from our keystore.
KS_HAS is used to check if the key exists in our keystore.
KS_LIST is used to list all keys in our keystore by their name.
KS_PUT is used to store private key bytes in our keystore.
equivalent of ipfs p2p close.
equivalent of ipfs p2p forward.
equivalent of ipfs p2p listen.
equivalent of ipfs p2p ls.
PS_GET_TOPICS is used to return a list of subscribed pubsub topics.
PS_LIST_PEERS is used to return a list of peers subscribed to topics we are subscribed to.
PS_PUBLISH is used to publisbh a message to a pubsub topic.
PS_SUBSCRIBE is used to establish a persistent subscription to a pubsub topic.
No description provided by the author
No description provided by the author
REF_GET_COUNT is used to get the reference count of a particular cid.
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ErrConnectToSelf is returned by a connection provider if it attempts to connect to itself.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
AddrInfo can be used to ID and locate a server (see also libp2p/go-libp2p-core/peer#AddrInfo).
Blob is a chunk of binary data.
No description provided by the author
BlockstoreRequest is a message used to control blockstores.
BlockstoreResponse is a response to a BlockstoreqRequest.
No description provided by the author
No description provided by the author
Contains status information about a particular disconnect attempt.
Used to submit a request to Dag or DagStream RPCs.
Used in response to a Dag or DagStream RPC.
DAGService implements ipld.DAGService using NodeAPIClient.
DownloadRequest is used to download a UnixFS object although it can in theory be used with other type of objects there may be some undefined behavior.
DownloadResponse contains the response to a download request which allows the gRPC server to stream blobs to the client.
Empty is an empty message.
No description provided by the author
GetPeersResponse is a response to GetPeers containing a slice of peer IDs.
An IPFS MerkleDAG Link.
An IPFS MerkleDAG Node.
IPLDStat is statistics about an individual dag node it is a protocol buffer wrapper around ipld.NodeStat.
Used to submit a request to Keystore RPC.
Used in response to a Keystore RPC.
ManageGCRequest is a message used to control TemporalX garbage collection.
ManageGCResponse is a message used as a response to gc control requests.
NameSysPublishRequest is used to publish a value.
NameSysResolveRequest is used to resolve an IPNS name.
NameSysResolveRequest is an answer to a resolve request.
P2PLsInfo contains information about a single p2p stream.
P2PRequest is a request message holding the details of a particular P2P rpc call.
P2PResponse is a response message sent in response to a P2PRequest message.
No description provided by the author
No description provided by the author
No description provided by the author
represents an individual pubsub peer.
No description provided by the author
No description provided by the author
PutResponse is a response to any data storage (put) requests.
RefCountRequest is used to analyze the reference counter store, and retrieve usage information.
RefCountResponse is used to return the information gathered by a RefCount rpc call.
Replication message is a signable data structure to represent a replication scheme.
No description provided by the author
ServerSource is a list of one or more servers.
No description provided by the author
SimpleGRPCConnectionProvider is a simple GRPCConnectionProvider.
StatusResponse is used to return API status information.
No description provided by the author
No description provided by the author
UnimplementedAdminAPIServer can be embedded to have forward compatible implementations.
UnimplementedFileAPIServer can be embedded to have forward compatible implementations.
UnimplementedNameSysAPIServer can be embedded to have forward compatible implementations.
UnimplementedNodeAPIServer can be embedded to have forward compatible implementations.
UnimplementedPubSubAPIServer can be embedded to have forward compatible implementations.
UnimplementedReplicatorServer can be embedded to have forward compatible implementations.
UnimplementedStatusAPIServer can be embedded to have forward compatible implementations.
UploadOptions allows controlling the parameters of a file upload.
UploadRequest is used to upload data as a UnixFS object.
VersionResponse is used to return API version information.
# Interfaces
AdminAPIClient is the client API for AdminAPI service.
AdminAPIServer is the server API for AdminAPI service.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
FileAPIClient is the client API for FileAPI service.
FileAPIServer is the server API for FileAPI service.
GRPCConnectionProvider provides the ConnectionToServer function, which returns a *grpc.ClientConn from a AddrInfo, using the IP address given in MultiAddress, port from GrpcPort, and certificate checked with peer.ID.
HostInfo is an interface that we can build an AddrInfo from.
No description provided by the author
No description provided by the author
NameSysAPIClient is the client API for NameSysAPI service.
NameSysAPIServer is the server API for NameSysAPI service.
No description provided by the author
No description provided by the author
NodeAPIClient is the client API for NodeAPI service.
NodeAPIServer is the server API for NodeAPI service.
No description provided by the author
No description provided by the author
PubSubAPIClient is the client API for PubSubAPI service.
PubSubAPIServer is the server API for PubSubAPI service.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ReplicatorClient is the client API for Replicator service.
ReplicatorServer is the server API for Replicator service.
StatusAPIClient is the client API for StatusAPI service.
StatusAPIServer is the server API for StatusAPI service.
# Type aliases
AddPeer is a callback when a new peer should be added.
APISTATUS is an enum to return a concise description of api status.
BSREQOPTS are options for blockstore requests.
BSREQTYPE is a particular blockstore request type.
Close is a function that closes a resource.
CONNMGMTREQTYPE indicates the particular ConnMgmt request being performed.
DAGREQTYPE indicates the particular DagAPI request being performed.
EXTRASREQTYPE indicates the particular Extras request being performed.
EXTRASTYPE denotes a particular extras type.
GCREQTYPE specifies the type of GC management call being performed.
KSREQTYPE indicates the particular KeystoreAPI request being performed.
P2PREQTYPE denotes the particular type of request being used in the p2p rpc.
PSREQTYPE indicates the particular PubSubAPI request being performed.
REFREQOPTS are options for fine-tuning ref count requests.
REFREQTYPE is used to indicate the type of ref count request being made.