Saltar al contenido principal

IPFS

El módulo IPFS permite interactuar con el protocolo IPFS desde el sdk de Alfa.

MFS - Mutable File System

El módulo ipfs implementa el MFS de IPFS, el cual permite interactuar con el sistema de archivos de IPFS de forma similar a como se hace con el sistema de archivos de un sistema operativo.

Métodos​

Obtener un archivo desde IPFS​

El método get permite obtener un archivo desde IPFS.

const ipfs = sdk.ipfs;

const ipfsHash = new IPFSHash('QmWJzrpSQmZySFkyMu6faFRsQnAVHHZjsYcbpEg6ZM7N56')

const result = await ipfs.get(ipfsHash);

Obtener un archivo desde un directorio en IPFS​

El método getPath permite obtener un archivo que se encuentre en un directorio ipfs.

const ipfs = sdk.ipfs;

const ipfsPath = new IPFSPath('/myfolder/QmWJzrpSQmZySFkyMu6faFRsQnAVHHZjsYcbpEg6ZM7N56')

const result = await ipfs.getPath(ipfsPath);

Anclar un archivo o directorio en IPFS​

El método pin permite anclar un archivo o directorio en IPFS.

const ipfs = sdk.ipfs;

const content = new Blob(["Hola mundo"]);

const result = await ipfs.pin({ content }, { filename: "helloWord.txt" });
Content

El contenido es de tipo Content y puede ser un string, Blob, ArrayBuffer, Uint8Array, Iterable<Uint8Array>.

Leer un archivo desde MFS​

El método read permite leer un archivo desde MFS.

const ipfs = sdk.ipfs;

const path = new MFSPath('/images/hello.jpg')

const result = await ipfs.read(path);

Listar archivos de un directorio en MFS​

El método ls permite listar los archivos de un directorio en MFS.

const ipfs = sdk.ipfs;

const path = new MFSPath('/images')

const result = await ipfs.ls(path);

Escribir un archivo en MFS​

El método write permite escribir un archivo en MFS.

const ipfs = sdk.ipfs;

const path = new MFSPath("/images");

const file = new File([], "hello.jpg");

const result = await ipfs.write(path, file);

Eliminar un archivo o directorio de MFS​

El método rm permite eliminar un archivo o directorio de MFS.

const ipfs = sdk.ipfs;

const path = new MFSPath("/images/hello.jpg");

const result = await ipfs.rm(path);

Crear un directorio en MFS​

El método mkdir permite crear un directorio en MFS.

const ipfs = sdk.ipfs;

const path = new MFSPath("/myFiles");

const result = await ipfs.mkdir(path);

Obtener información de un archivo o directorio en MFS​

El método stat permite obtener la información de un archivo o directorio en MFS.

const path = new MFSPath("/images");

const result = await ipfs.stat(path);

Mover un archivo o directorio en MFS​

El método mv permite mover un archivo o directorio en MFS.

const ipfs = sdk.ipfs;

const from = new MFSPath("/images/hello.jpg");

const to = new MFSPath('/myFiles/')

const result = await ipfs.mv(from, to);

Copiar un archivo o directorio en MFS​

El método cp permite copiar un archivo o directorio en MFS.

const ipfs = sdk.ipfs;

const from = new MFSPath("/images/hello.jpg");

const to = new MFSPath('/myFiles/copyHello.jpg')

const result = await ipfs.cp(from, to);