https://github.com/questnetwork/quest-coral-js

Data/File Persistance For The Quest Network
https://github.com/questnetwork/quest-coral-js

ipfs

Last synced: 5 days ago
JSON representation

Data/File Persistance For The Quest Network

• Host: GitHub
• URL: https://github.com/questnetwork/quest-coral-js
• Owner: QuestNetwork
• License: agpl-3.0
• Created: 2020-09-12T23:44:26.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-10-19T16:28:13.000Z (over 4 years ago)
• Last Synced: 2024-12-15T23:20:51.454Z (about 2 months ago)
• Topics: ipfs
• Language: JavaScript
• Homepage:
• Size: 67.4 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Quest Coral JS

> IPFS Datastore For The Quest Network

## Lead Maintainer

[StationedInTheField](https://github.com/StationedInTheField)

## Description

IPFS Datastore For The Quest Network.

## Installation & Usage

``npm install @questnetwork/[email protected]``

We recommend to use our [quest-cli](https://github.com/QuestNetwork/quest-cli) to test and build the package.

Pro Tip: Put a file in your `/bin` that runs the quest-cli like so `node /path/to/quest-cli/index.js` from any folder on your system. It's much nicer!

## API

### dag

#### async set(path, unencrytpedObject,storagePath)

[![Bee](https://img.shields.io/badge/process-Bee-yellow)](https://github.com/QuestNetwork/quest-bee-js) [![Ocean](https://img.shields.io/badge/process-Ocean-blue)](https://github.com/QuestNetwork/quest-ocean-js)

Returns the reference object.

``

let latestRef = .ocean.coral.dag.set('/my/path',unencrytpedObject,{ storagePath: '/archive/social/timeline/transaction' });

``

#### async add(path, unencrytpedObject,storagePath)

[![Bee](https://img.shields.io/badge/process-Bee-yellow)](https://github.com/QuestNetwork/quest-bee-js) [![Ocean](https://img.shields.io/badge/process-Ocean-blue)](https://github.com/QuestNetwork/quest-ocean-js)

Returns the reference object.

``

let latestRef = .ocean.coral.dag.add('/my/path',unencrytpedObject,{ storagePath: '/archive/social/timeline/transaction' });

``

#### async get(pathOrCid, config = {})

[![Bee](https://img.shields.io/badge/process-Bee-yellow)](https://github.com/QuestNetwork/quest-bee-js) [![Ocean](https://img.shields.io/badge/process-Ocean-blue)](https://github.com/QuestNetwork/quest-ocean-js)

Returns the decrypted object or array of objects.

``

let array = .ocean.coral.dag.get('/my/path',{ limit: 5 });

``

## Features

**0.9.4**

- Basic functionality

- Uses [`ipfs.dag`](https://docs.ipfs.io/concepts/merkle-dag/)

## Support Us

This project is a lot of work, please help us start a non-profit for it (ツ)

| Ethereum| Bitcoin |

|---|---|

| `0xBC2A050E7B87610Bc29657e7e7901DdBA6f2D34E` | `bc1qujrqa3s34r5h0exgmmcuf8ejhyydm8wwja4fmq`   |

|     |  |

## License

GNU Affero GPLv3