GatewayMode enum

The central node orchestrating all IPFS operations.

IPFSNode is the main class for interacting with the IPFS network. It manages storage, networking, and protocol handlers, providing a high-level API for content operations.

Creating a Node:

// Offline mode (local storage only)
final node = await IPFSNode.create(IPFSConfig(offline: true));
await node.start();

// P2P mode (full network participation)
final node = await IPFSNode.create(IPFSConfig(offline: false));
await node.start();
// print('Peer ID: ${node.peerID}');

Adding Content:

final cid = await node.addFile(fileBytes);
// print('Added content: $cid');

Retrieving Content:

final data = await node.get(cid);

Lifecycle: Always call start before using the node and stop when done:

await node.start();
try {
  // Use the node...
} finally {
  await node.stop();
}

See also:

  • IPFS for a simpler high-level wrapper
  • IPFSConfig for configuration options
  • IPFSNodeBuilder for advanced node construction
  • IPFSNodeBuilder for advanced node construction Modes for retrieving content via the IPFSNode.

Strategies:

  • internal: Use the native Dart P2P node (libp2p).
  • public: Use public HTTP gateways (e.g. ipfs.io).
  • local: Use a local IPFS daemon (e.g. go-ipfs at localhost:8080).
  • custom: Use a user-defined HTTP gateway URL.
Inheritance
Available extensions

Values

internal → const GatewayMode

Use internal P2P node (default).

public → const GatewayMode

Use public gateway (ipfs.io).

local → const GatewayMode

Use local gateway (localhost:8080).

custom → const GatewayMode

Use custom URL.

Properties

hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
name String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

values → const List<GatewayMode>
A constant List of the values in this enum, in order of their declaration.