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.
- ApiCommand
Info - Information about a single API command.
- ApiCommands
Result - API endpoint listing result.
- ApiEndpoint
- API endpoint information.
- ApiError
- API error structure.
- ApiOption
Info - Information about a command option.
- ApiRequest
- RPC API request.
- ApiResponse
- RPC API response.
- ApiServer
Config - API server configuration.
- ApiStats
- API server statistics.
- ApiVersion
Result - Result of API version query.
- Bitswap
Ledger - Bitswap ledger for a peer Ported from: boxo/bitswap/decision/ledger.go
- Bitswap
Stats - Bitswap statistics Ported from: boxo/bitswap/stat.go
- Connected
Peer - Connected peer information
- DhtProvider
- DHT provider information
- DhtQuery
Result - DHT query result
- DhtStats
- DHT statistics
- Gateway
DirEntry - Directory entry for gateway directory listing.
- Gateway
DirListing - Directory listing result for gateway.
- Gateway
Path - Parsed gateway path representing an IPFS or IPNS request.
- Gateway
Request - Gateway request information.
- Gateway
Response - Gateway response data.
- Gateway
Stats - Gateway statistics.
- Ipns
Entry - IPNS entry for display Ported from: core/commands/name/publish.go
- Ipns
Inspect Result - IPNS record inspection result Ported from: core/commands/name/inspect.go
- Ipns
Publish Options - IPNS publish options Ported from: core/commands/name/publish.go
- Ipns
Record - IPNS record structure Ported from: boxo/ipns/record.go
- Ipns
Resolve Options - IPNS resolve options Ported from: core/commands/name/resolve.go
- Ipns
Resolve Result - IPNS resolve result Ported from: core/commands/name/resolve.go
- Ipns
Validation - IPNS validation result
- KeyGen
Result - 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
- KeyRename
Result - Key rename result Ported from: core/commands/keystore.go
- KeyRm
Result - Key removal result Ported from: core/commands/keystore.go
- MfsChcid
Options - Options for changing CID settings in MFS.
- MfsCp
Options - Options for an MFS copy operation.
- MfsFlush
Result - Result of an MFS flush operation.
- MfsLs
Entry - A single entry in an MFS directory listing.
- MfsLs
Result - Result of an MFS directory listing operation.
- MfsMkdir
Options - Options for an MFS mkdir operation.
- MfsMv
Options - Options for an MFS move/rename operation.
- MfsOp
Result - Generic result for MFS operations.
- MfsRead
Result - Result of an MFS file read operation (internal).
- MfsRm
Options - Options for an MFS remove operation.
- MfsStat
Result - Result of an MFS stat operation.
- MfsWrite
Options - Options for an MFS file write operation.
- Peer
Info - Peer information returned by id command
- Ping
Result - Ping result
- Pubsub
LsResult - Result of listing pubsub topics.
- Pubsub
Message - A message received from or published to a pubsub topic.
- Pubsub
Peer - Information about a peer subscribed to a pubsub topic.
- Pubsub
Peers Result - Result of listing peers for a pubsub topic.
- Pubsub
Publish Result - Result of publishing a message to a pubsub topic.
- Pubsub
Stats - PubSub statistics.
- Pubsub
Subscription - Subscription state for pubsub.
- Reprovide
Result - Bitswap reprovide result
- Wantlist
Entry - Wantlist entry Ported from: boxo/bitswap/wantlist/wantlist.go
Enums§
- Gateway
Content Type - Content type for gateway responses.
- Gateway
Entry Type - Entry type for directory listings.
- Gateway
Method - HTTP method for gateway requests.
- Gateway
Path Type - Type of gateway path (IPFS or IPNS).
- Ipns
Validity Type - IPNS record validity type Ported from: boxo/ipns/pb/ipns.proto
- KeyType
- Key type enumeration Ported from: core/commands/keystore.go
- MfsNode
Type - Type of a node in the Mutable File System.
- Network
Error - Network operation error types
- Pubsub
Router - 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§
- Network
Result - Result type for network operations