pure | 📦
code style | standard
This engine takes consensus rules in JavaScript. Then it consumes blocks, and maintains a local view of the decentralized state.
It wouldn't be wrong to call it an indexer, but it would only be half of it.
Because there's also a garbarge collector.
warn: instructions below are outdated
$ npm i @telamon/picostore browser-level memory-levelStarter example using bundled DiffMemory:
import { Feed } from 'picofeed'
import { MemoryLevel } from 'memory-level'
import { Store, DiffMemory } from 'picoengine'
// First an identity and a feed/chain
const { pk: pubkey, sk: secret } = Feed.signPair()
const feed = new Feed()
// Create a database and pass it to the engine
const db = new MemoryLevel('app', { keyEncoding: 'view', valueEncoding: 'view' })
const store = new Store(db)
// Register a collection and it's controller
const collection = engine.register('peers', DiffMemory)
// Restore state from previous boot/pageload
await store.load()
// Eventually you'll want to create your own subclass of `Memory`
// but the bundled `DiffMemory`-class is a good starting point
// because it provides the function `mutate()`
await collection.mutate(feed, currentValue => {
return {
name: 'Bob',
location: 'bahamas',
occupation: 'fishwarrior'
}
}, secret)
await collection.readState(pubkey) // => { name: 'Bob', ...}
// TODO: transmit feed.buffer to a buddy
// and your local state will be replicated
// on their end
debuggerPlease keep an eye on the picostack repo, there will be more complete examples and starting points.
TODO:
| __ \ Help Wanted! | | | | | |
| | | | ___ ___ ___ _ __ | |_| | __ _| |__ ___ ___ ___
| | | |/ _ \/ __/ _ \ '_ \| __| | / _` | '_ \/ __| / __|/ _ \
| |__| | __/ (_| __/ | | | |_| |___| (_| | |_) \__ \_\__ \ __/
|_____/ \___|\___\___|_| |_|\__|______\__,_|_.__/|___(_)___/\___|
If you're reading this it means that the docs are missing or in a bad state.
Writing and maintaining friendly and useful documentation takes
effort and time.
__How_to_Help____________________________________.
| |
| - Open an issue if you have questions! |
| - Star this repo if you found it interesting |
| - Fork off & help document <3 |
| - Say Hi! :) https://discord.gg/K5XjmZx |
|.________________________________________________|
- Holding off package rename Engine ("pico-engine" is taken, pengine?)
- Migrated to Picofeed 8.x
- Completeley reworked slices into 'Memory'
- combined
filter(),rreduce()callbacks intocompute() - Garbage collector now uses Reference counting.
- Dropped required
sweep()callback, possible to override default if needed. signal()andtrap()is mostly unchanged- New api's missing docs:
index(),lookup(),postpone() - Jumped from
msgpackrtocborg, not sure why.
- WeblocksAPI
- internal serializer changed to msgpackr
- added OOOB cache
- Exposed tags AUTHOR & CHAIN on public api's
- memdown devDep replaced with MemoryLevel
- signal() & trap() api
- craploads of bugfixes
- added
parentBlockto validator & reducer interface - added
dispatch(feed, loudFail = false)setting to true will throw on validation error - changed returning
truewithin a validator silently ignores block even with loudFail active - fixed craploads of bugs
By making a pull request, you agree to release your modifications under the license stated in the next section.
Only changesets by human contributors will be accepted.
2021 🄯 Tony Ivanov