{"title": "Web3stash Library", "website": "https://www.npmjs.com/package/web3stash", "createdAt": 1714135055918, "userGithub": "mbcse", "credentials": {}, "description": "# Web3Stash\nWeb3Stash is a standard library to get a single api to connect to multiple decentralised storage service providers. If you are looking to connect to blockchain services like ipfs, pinata, nft.storage, arweave, bundlr, helia etc but don't want to read there docs and set them up individually, You can use this package to connect to any of these services. The best part is all the configuration settings and upload functions are almost same across all the services.\n\n# How this library works and Ease Your Development\n\n## Install the library\nThe official web3stash Node.js package. This is the easiest way to start developing with multiple decentralised storage service providers. \n\n```js\nInstall via NPM\nnpm install --save web3stash\n```\n\n## Importing and Using Package\nTake a look at how you might import and use the web3Stash package:\n\n```js\n// require the webStash module\nconst {Web3Stash} = require('web3stash');\n//or\nimport {Web3Stash} from 'web3stash';\n// provide service name, config properties like privateKeys\nconst service = Web3Stash(<serviceName>, <config>, <configOptions>)\n// Call the methods(Same for all services)\nservice.uploadJson(<jsonData>, <options>).then().catch()\nservice.uploadImage(<path to image>, <options>).then().catch()\nservice.uploadVideo(<path to video file>, <options>).then().catch()\nservice.uploadFile(<path to file>, <options>).then().catch()\n\n```\n\n### Start using services\nHead to services tab in [docs](https://theblockchainchief.gitbook.io/web3stash/) page and pass config details based on the service you want to use. All services need same three things when initialising web3Stash as shown above:\n\n```js\nWeb3Stash(<serviceName>, <config>, <configOptions>)\n```\n\n- serviceName(string) -  Here you have to put service you want to use like \"PINATA\", \"ARWEAVE\", \"BUNDLR\", etc in string format \n\n\nWe have made this project opensource and planning to integrate more and more services and also add data streaming and chunk uploading for big files for all the services we support making data uploading to decentralized storage networks easy, efficient, fast, and scalable. \n\nWe have been winner/Finalist at EthGlobal HackFS 2023.", "projectGithub": "mbcse/web3stash", "projectTwitter": "mbcse"}
Web3stash Library
# Web3Stash
Web3Stash is a standard library to get a single api to connect to multiple decentralised storage service providers. If you are looking to connect to blockchain services like ipfs, pinata, nft.storage, arweave, bundlr, helia etc but don't want to read there docs and set them up individually, You can use this package to connect to any of these services. The best part is all the configuration settings and upload functions are almost same across all the services.

# How this library works and Ease Your Development

## Install the library
The official web3stash Node.js package. This is the easiest way to start developing with multiple decentralised storage service providers. 

```js
Install via NPM
npm install --save web3stash
```

## Importing and Using Package
Take a look at how you might import and use the web3Stash package:

```js
// require the webStash module
const {Web3Stash} = require('web3stash');
//or
import {Web3Stash} from 'web3stash';
// provide service name, config properties like privateKeys
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 services tab in [docs](https://theblockchainchief.gitbook.io/web3stash/) page and pass config details based on the service you want to use. All services need same three things when initialising web3Stash as shown above:

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

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


We have made this project opensource and planning to integrate more and more services and also add data streaming and chunk uploading for big files for all the services we support making data uploading to decentralized storage networks easy, efficient, fast, and scalable. 

We have been winner/Finalist at EthGlobal HackFS 2023.
Web3stash Library