Skip to main content

Crate ferripfs_network

Crate ferripfs_network 

Source
Expand description

libp2p networking for ferripfs, ported from Kubo’s core/node/libp2p.

This crate provides:

  • libp2p host initialization with configurable transports
  • TCP, QUIC, WebSocket transport support
  • Noise encryption and Yamux multiplexing
  • mDNS local peer discovery
  • Kademlia DHT for peer/content routing
  • AutoNAT for NAT detection
  • Circuit relay client
  • Connection management
  • Daemon process management

Re-exports§

pub use behavior::FerripfsBehavior;
pub use daemon::Daemon;
pub use daemon::DaemonConfig;
pub use daemon::DaemonHandle;
pub use host::HostConfig;
pub use host::NetworkHost;
pub use swarm::SwarmBuilder;
pub use swarm::SwarmConfig;

Modules§

behavior
Combined network behavior for ferripfs.
daemon
Daemon process management.
host
Network host initialization and management.
swarm
Swarm builder with transport configuration.

Structs§

ApiArgument
API argument definition.
ApiClient
API client for connecting to a running IPFS daemon.
ApiCommandInfo
Information about a single API command.
ApiCommandsResult
API endpoint listing result.
ApiEndpoint
API endpoint information.
ApiError
API error structure.
ApiOptionInfo
Information about a command option.
ApiRequest
RPC API request.
ApiResponse
RPC API response.
ApiServerConfig
API server configuration.
ApiStats
API server statistics.
ApiVersionResult
Result of API version query.
BitswapLedger
Bitswap ledger for a peer Ported from: boxo/bitswap/decision/ledger.go
BitswapStats
Bitswap statistics Ported from: boxo/bitswap/stat.go
ConnectedPeer
Connected peer information
DhtProvider
DHT provider information
DhtQueryResult
DHT query result
DhtStats
DHT statistics
GatewayDirEntry
Directory entry for gateway directory listing.
GatewayDirListing
Directory listing result for gateway.
GatewayPath
Parsed gateway path representing an IPFS or IPNS request.
GatewayRequest
Gateway request information.
GatewayResponse
Gateway response data.
GatewayStats
Gateway statistics.
IpnsEntry
IPNS entry for display Ported from: core/commands/name/publish.go
IpnsInspectResult
IPNS record inspection result Ported from: core/commands/name/inspect.go
IpnsPublishOptions
IPNS publish options Ported from: core/commands/name/publish.go
IpnsRecord
IPNS record structure Ported from: boxo/ipns/record.go
IpnsResolveOptions
IPNS resolve options Ported from: core/commands/name/resolve.go
IpnsResolveResult
IPNS resolve result Ported from: core/commands/name/resolve.go
IpnsValidation
IPNS validation result
KeyGenResult
Key generation result Ported from: core/commands/keystore.go
KeyInfo
Key information Ported from: core/commands/keystore.go
KeyList
Key list result Ported from: core/commands/keystore.go
KeyRenameResult
Key rename result Ported from: core/commands/keystore.go
KeyRmResult
Key removal result Ported from: core/commands/keystore.go
MfsChcidOptions
Options for changing CID settings in MFS.
MfsCpOptions
Options for an MFS copy operation.
MfsFlushResult
Result of an MFS flush operation.
MfsLsEntry
A single entry in an MFS directory listing.
MfsLsResult
Result of an MFS directory listing operation.
MfsMkdirOptions
Options for an MFS mkdir operation.
MfsMvOptions
Options for an MFS move/rename operation.
MfsOpResult
Generic result for MFS operations.
MfsReadResult
Result of an MFS file read operation (internal).
MfsRmOptions
Options for an MFS remove operation.
MfsStatResult
Result of an MFS stat operation.
MfsWriteOptions
Options for an MFS file write operation.
PeerInfo
Peer information returned by id command
PingResult
Ping result
PubsubLsResult
Result of listing pubsub topics.
PubsubMessage
A message received from or published to a pubsub topic.
PubsubPeer
Information about a peer subscribed to a pubsub topic.
PubsubPeersResult
Result of listing peers for a pubsub topic.
PubsubPublishResult
Result of publishing a message to a pubsub topic.
PubsubStats
PubSub statistics.
PubsubSubscription
Subscription state for pubsub.
ReprovideResult
Bitswap reprovide result
WantlistEntry
Wantlist entry Ported from: boxo/bitswap/wantlist/wantlist.go

Enums§

GatewayContentType
Content type for gateway responses.
GatewayEntryType
Entry type for directory listings.
GatewayMethod
HTTP method for gateway requests.
GatewayPathType
Type of gateway path (IPFS or IPNS).
IpnsValidityType
IPNS record validity type Ported from: boxo/ipns/pb/ipns.proto
KeyType
Key type enumeration Ported from: core/commands/keystore.go
MfsNodeType
Type of a node in the Mutable File System.
NetworkError
Network operation error types
PubsubRouter
PubSub router type enumeration.

Constants§

AGENT_VERSION
Agent version string
API_VERSION
API version string.
BITSWAP_PROTOCOL_VERSION
Bitswap protocol version
DEFAULT_API_ADDRESS
Default RPC API address.
DEFAULT_API_PORT
Default RPC API port (matches Kubo).
DEFAULT_GATEWAY_ADDRESS
Default gateway address.
DEFAULT_GATEWAY_PORT
Default gateway port.
FLOODSUB_PROTOCOL_ID
FloodSub protocol ID.
GOSSIPSUB_PROTOCOL_ID
Default GossipSub protocol ID.
IPFS_PATH_PREFIX
IPFS path prefix.
IPFS_PREFIX
IPFS protocol prefix
IPNS_DEFAULT_LIFETIME
Default IPNS record lifetime (24 hours)
IPNS_DEFAULT_TTL
Default IPNS record TTL in nanoseconds (1 hour)
IPNS_PATH_PREFIX
IPNS path prefix.
IPNS_PREFIX
IPNS protocol prefix
MFS_ROOT
The root path for MFS operations.
MFS_SEPARATOR
The path separator character used in MFS paths.
PROTOCOL_VERSION
Protocol version
PUBSUB_PROTOCOL_VERSION
Protocol version for pubsub.

Type Aliases§

NetworkResult
Result type for network operations