1.0.0 • Published 3 years ago

dexie-skynet-sync-protocol v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
3 years ago

dexie-skynet-sync-protocol

Synopsis

This is a simple implementation of the ISyncProtocol to work with Skynet SkyDB and Sia Skynet

Installation

npm install --save dexie-skynet-sync-protocol

Basic Usage

import Dexie from 'dexie'
import 'dexie-observable'
import 'dexie-syncable'

// import skynet sync protocol
import 'dexie-skynet-sync-protocol'

...
// at some point you want to start sync with skynet

db.syncable.connect('skynet', 'https://siasky.net', {
    seed: '[user-seed]', // for genKeyPairFromSeed
    poolInterval: 10000, // milliseconds
    rootItem: '[any-unique-name]'
})

Contributing

If you feel you can help in any way, be it with documentation, examples, extra testing, or new features please open an issue or pull request. If you have any questions feel free to open an issue with your question.

License

MIT License