Quick Start

Install the library

The official web3stash Node.js package. This is the easiest way to start developing with multiple decentralized storage service providers!

Node

# Install via NPM
npm install --save web3stash

Importing and Using Package

Take a look at how you might import and use the web3stash package:

Node

// require the web3stash module
const {Web3Stash} = require('web3stash');
//or
import {Web3Stash} from 'web3stash';
//Provide service name, config properties like private keys
const service = Web3Stash(<serviceName>, <config>, <configOptions>)
// Call the methods(Same for all services)
service.uploadJson(<jsonData>, <options>).then().catch()
service.uploadImage(<path to image>, <options>).then().catch()
service.uploadVideo(<path to video file>, <options>).then().catch()
service.uploadFile(<path to file>, <options>).then().catch()

Start using services

Head to the services tab and pass config details based on the service you want to use. All services need the same three things when initializing web3stash as shown above:

Web3Stash(<serviceName>, <config>, <configOptions>)

• serviceName(string) - Here you have to put the service you want to use like "PINATA", "ARWEAVE", "BUNDLR", etc in string format

• config (object) - This will be an object where you will pass keys, tokens, URL, etc and it differs based on the service type you are using for example, If you are using Pinata, you have to pass {apiKey:"", apiSecret:""} while for NFT.STORAGE you have to pass {token:""}.

• configOptions(object) - This is an optional field and here you can pass configuration options related to the service you are using. Let's say if you are using bundlr and want to pass providerUrl, timeout, logger,Services etc. You can pass those stuff here using configOptions.

Head to Individual services to get details for configuration!