Skip to content


This module contains all the interaction operations of the behaviours with IPFS.

IPFSInteractionError Objects

class IPFSInteractionError(Exception)

A custom exception for IPFS interaction errors.

IPFSInteract Objects

class IPFSInteract()

Class for interacting with IPFS.


def __init__(domain: str, loader_cls: Type = Loader, storer_cls: Type = Storer)

Initialize an IPFSInteract.


  • domain: the IPFS domain name.


def store_and_send(filepath: str, obj: SupportedObjectType, multiple: bool, filetype: Optional[SupportedFiletype] = None, custom_storer: Optional[CustomStorerType] = None, **kwargs: Any, ,) -> str

Temporarily store a file locally, in order to send it to IPFS and retrieve a hash, and then delete it.


def get_and_read(hash_: str, target_dir: str, multiple: bool = False, filename: Optional[str] = None, filetype: Optional[SupportedFiletype] = None, custom_loader: CustomLoaderType = None) -> SupportedObjectType

Get, store and read a file from IPFS.

Back to top