Class MockIPFSNode

A MockIPFS node provides default behaviours and allows defining custom behaviour rules to simulate interactions with the IPFS network without requiring a full node or access to the real IPFS network.

This should not be created directly: instead, call then getLocal() or getRemote() methods exported from this module.

Once you have a MockIPFS node, you can start defining rules using any of the forX() methods. Each method returns a rule builder, allowing you to add extra matching constraints, followed by a thenX() final method which enables the rule, returning a promise that resolves once the rule is constructed and active.

Hierarchy

MockIPFSNode

Index

Constructors

constructor

new MockIPFSNode(mockttpServer: Mockttp, options?: MockIPFSOptions): MockIPFSNode
Parameters
- mockttpServer: Mockttp
- options: MockIPFSOptions = {}
Returns MockIPFSNode
- Defined in mockipfs-node.ts:67

Accessors

ipfsOptions

get ipfsOptions(): {
    host: string;
    port: number;
    protocol: string;
}
The IPFS options required to connect to this MockIPFS node. These can be passed directly to IPFS.create from ipfs-http-client to create a real IPFS client that connects to this mock node.

Returns {
    host: string;
    port: number;
    protocol: string;
}
- host: string
- port: number
- protocol: string
- Defined in mockipfs-node.ts:104

Methods

forAdd

forAdd(): AddRuleBuilder
Mock IPFS add requests, mocking the behaviour of the add command while ensuring that the added content is never actually sent to a real IPFS node.

Returns AddRuleBuilder
- Defined in mockipfs-node.ts:159

forAddIncluding

forAddIncluding(...content: (string | Uint8Array | {
content?: string | Uint8Array;
path: string;
})[]): AddRuleBuilder
Mock IPFS add requests containing certain types of content, mocking the behaviour of the add command while ensuring that the added content is never actually sent to a real IPFS node.
Parameters
- Rest ...content: (string | Uint8Array | {
  content?: string | Uint8Array;
  path: string;
  })[]
Returns AddRuleBuilder
- Defined in mockipfs-node.ts:185

forCat

forCat(cid?: string): ContentRetrievalRuleBuilder
Mock IPFS cat requests, returning fake content instead of the real content for the given CID.

This takes an optional CID argument. If not provided, the mock will match all cat requests for any CID.
Parameters
- Optional cid: string
Returns ContentRetrievalRuleBuilder
- Defined in mockipfs-node.ts:144

forGet

forGet(cid?: string): ContentRetrievalRuleBuilder
Mock IPFS get requests, returning fake content instead of the real content for the given CID.

This takes an optional CID argument. If not provided, the mock will match all get requests for any CID.
Parameters
- Optional cid: string
Returns ContentRetrievalRuleBuilder
- Defined in mockipfs-node.ts:170

forNamePublish

forNamePublish(nameKey?: string): NamePublishRuleBuilder
Mock the behaviour of IPNS name publishing.

This takes an optional name argument to match. If not provided, the defined behaviour will apply for all IPFS resolutions for any name.
Parameters
- Optional nameKey: string
Returns NamePublishRuleBuilder
- Defined in mockipfs-node.ts:215

forNameResolve

forNameResolve(name?: string): NameResolveRuleBuilder
Mock the behaviour of IPNS name resolutions.

This takes an optional name argument to match. If not provided, the defined behaviour will apply for all IPFS resolutions for any name.
Parameters
- Optional name: string
Returns NameResolveRuleBuilder
- Defined in mockipfs-node.ts:202

forPinAdd

forPinAdd(cid?: string): PinAddRuleBuilder
Mock the behaviour of IPFS pinning.

This takes an optional CID argument. If not provided, the mock will match pinning of any CID.
Parameters
- Optional cid: string
Returns PinAddRuleBuilder
- Defined in mockipfs-node.ts:228

forPinLs

forPinLs(): PinLsRuleBuilder
Mock the behaviour of IPFS pin listing.

Returns PinLsRuleBuilder
- Defined in mockipfs-node.ts:264

forPinRemoteAdd

forPinRemoteAdd(cid?: string): PinRemoteAddRuleBuilder
Mock the behaviour of IPFS pinning to a remote service

This takes an optional CID argument. If not provided, the mock will match remote pinning of any CID.
Parameters
- Optional cid: string
Returns PinRemoteAddRuleBuilder
- Defined in mockipfs-node.ts:241

forPinRemoteLs

forPinRemoteLs(): PinRemoteLsRuleBuilder
Mock the behaviour of IPFS remote pinning service listing.

Returns PinRemoteLsRuleBuilder
- Defined in mockipfs-node.ts:273

forPinRm

forPinRm(cid?: string): PinRmRuleBuilder
Mock the behaviour of IPFS pin removal.

This takes an optional CID argument. If not provided, the mock will match unpinning of any CID.
Parameters
- Optional cid: string
Returns PinRmRuleBuilder
- Defined in mockipfs-node.ts:254

getAddedContent

getAddedContent(): Promise<{
content?: Uint8Array;
path?: string;
}[]>
Get the list of all IPFS CIDs & content that have been added to this IPFS mock node since it started.

Returns Promise<{
content?: Uint8Array;
path?: string;
}[]>
- Defined in mockipfs-node.ts:299

getAddedPins

getAddedPins(): Promise<{
cid: string;
}[]>
Get the list of all IPFS pins that have been added to this IPFS mock node since it started.

Returns Promise<{
cid: string;
}[]>
- Defined in mockipfs-node.ts:323

getIPNSPublications

getIPNSPublications(): Promise<{
name: null | string;
value: string;
}[]>
Get the list of all IPNS publications that have been received by this IPFS mock node since it started.

Returns Promise<{
name: null | string;
value: string;
}[]>
- Defined in mockipfs-node.ts:315

getIPNSQueries

getIPNSQueries(): Promise<{
name: null | string;
}[]>
Get the list of all IPNS resolution queries that have been received by this IPFS mock node since it started.

Returns Promise<{
name: null | string;
}[]>
- Defined in mockipfs-node.ts:307

getQueriedContent

getQueriedContent(): Promise<{
path: string;
}[]>
Get the list of all IPFS CIDs that have been requested from this IPFS mock node since it started.

Returns Promise<{
path: string;
}[]>
- Defined in mockipfs-node.ts:283

getRemovedPins

getRemovedPins(): Promise<{
cid: string;
}[]>
Get the list of all IPFS pins that have been removed from this IPFS mock node since it started.

Returns Promise<{
cid: string;
}[]>
- Defined in mockipfs-node.ts:331

reset

reset(): void
Returns void
- Defined in mockipfs-node.ts:94

start

start(): Promise<void>
The node must be started before use. Starting the node resets it, removing any rules that may have been added previously and configuring default behaviours for unmatched requests.

Returns Promise<void>
- Defined in mockipfs-node.ts:84

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in mockipfs-node.ts:90

Class MockIPFSNode

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

mockttpServer: Mockttp

options: MockIPFSOptions = {}

Returns MockIPFSNode

Accessors

ipfsOptions

Returns { host: string; port: number; protocol: string; }

host: string

port: number

protocol: string

Methods

forAdd

Returns AddRuleBuilder

forAddIncluding

Parameters

Rest ...content: (string | Uint8Array | { content?: string | Uint8Array; path: string; })[]

Returns AddRuleBuilder

forCat

Parameters

Optional cid: string

Returns ContentRetrievalRuleBuilder

forGet

Parameters

Optional cid: string

Returns ContentRetrievalRuleBuilder

forNamePublish

Parameters

Optional nameKey: string

Returns NamePublishRuleBuilder

forNameResolve

Parameters

Optional name: string

Returns NameResolveRuleBuilder

forPinAdd

Parameters

Optional cid: string

Returns PinAddRuleBuilder

forPinLs

Returns PinLsRuleBuilder

forPinRemoteAdd

Parameters

Optional cid: string

Returns PinRemoteAddRuleBuilder

forPinRemoteLs

Returns PinRemoteLsRuleBuilder

forPinRm

Parameters

Optional cid: string

Returns PinRmRuleBuilder

getAddedContent

Returns Promise<{ content?: Uint8Array; path?: string; }[]>

getAddedPins

Returns Promise<{ cid: string; }[]>

getIPNSPublications

Returns Promise<{ name: null | string; value: string; }[]>

getIPNSQueries

Returns Promise<{ name: null | string; }[]>

getQueriedContent

Returns Promise<{ path: string; }[]>

getRemovedPins

Returns Promise<{ cid: string; }[]>

reset

Returns void

start

Returns Promise<void>

stop

Returns Promise<void>

Settings

Member Visibility

Theme

Returns {
host: string;
port: number;
protocol: string;
}

`Rest` ...content: (string | Uint8Array | {
content?: string | Uint8Array;
path: string;
})[]

`Optional` cid: string

`Optional` cid: string

`Optional` nameKey: string

`Optional` name: string

`Optional` cid: string

`Optional` cid: string

`Optional` cid: string

Returns Promise<{
content?: Uint8Array;
path?: string;
}[]>

Returns Promise<{
cid: string;
}[]>

Returns Promise<{
name: null | string;
value: string;
}[]>

Returns Promise<{
name: null | string;
}[]>

Returns Promise<{
path: string;
}[]>

Returns Promise<{
cid: string;
}[]>