https://github.com/capsulesocial/ipfs-wrapper

A wrapper around IPFS for speeding up the loading of web3 frontend applications.
https://github.com/capsulesocial/ipfs-wrapper

blogchain capsulesocial frontend ipfs ipfs-core js-ipfs web3

Last synced: 21 days ago
JSON representation

A wrapper around IPFS for speeding up the loading of web3 frontend applications.

• Host: GitHub
• URL: https://github.com/capsulesocial/ipfs-wrapper
• Owner: capsulesocial
• License: agpl-3.0
• Created: 2022-08-10T12:16:36.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-08-15T21:35:17.000Z (over 1 year ago)
• Last Synced: 2024-12-17T11:44:12.724Z (25 days ago)
• Topics: blogchain, capsulesocial, frontend, ipfs, ipfs-core, js-ipfs, web3
• Language: TypeScript
• Homepage:
• Size: 550 KB
• Stars: 17
• Watchers: 2
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ipfs-wrapper

![npm (scoped)](https://img.shields.io/npm/v/@capsulesocial/ipfs-wrapper)

A wrapper around [ipfs-core](https://www.npmjs.com/package/ipfs-core) for speeding up the loading of web3 frontend applications.

Used on [Blogchain](https://blogchain.app).

## Requirements

- NodeJS v14.5.0 or higher.

## Usage

```typescript

import ipfs, { initIPFS } from '@capsulesocial/capsule-ipfs'

initIPFS();

(async () => {

    const data = { foo: "random json data" };

    const cid = await ipfs().sendJSONData(data);

    const receivedData = await ipfs().getJSONData(cid);

    console.log(receivedData);

})();

```

## License

[GNU AFFERO GENERAL PUBLIC LICENSE 3](./LICENSE)