ethstorage-sdk v1.2.7

ethstorage-sdk

Tool for uploading and downloading data for EthStorage network, utilizing the EIP-5018 standard for data.

Installation

With npm do

$ npm install ethstorage-sdk

Example

Constructor

Init ethstorage-sdk.

const { EthStorage } = require("ethstorage-sdk")

const ethStorage = new EthStorage(rpc, privateKey);

or

const ethStorage = new EthStorage(rpc, privateKey, flatDirectoryAddress);

Deploy

Deploy the implementation contract of the eip-5018 standard FlatDirectory.

// ethStorageContract is the contract address of ETHstorage deployed on L1. 
await ethStorage.deploy(ethStorageContract);

// Sepolia integrates this address internally
await ethStorage.deploySepolia();

Upload

Upload files to FlatDirectory.

// Pass the file path or file selected via browser folder.
await ethStorage.upload(fileOrPath);

or

const data = fs.readFileSync(filePath);
await ethStorage.uploadData(fileName, data);

Download

Download uploaded data from the EthStorage network.

// Since the data is downloaded from ethstorage, the provided RPC should be an ethstorage RPC.
const data = await ethStorage.download(fileName, ethStorageRpc);

or

const { Download } = require("ethstorage-sdk")
const data = await Download(ethstorageRpc, flatDirectoryAddress, fileName);