djdns / js-deje

JS implementation of DEJE client

js-deje, a JavaScript DEJE library

This allows browsers and Node.js servers to act as DEJE clients. The DEJE protocol is built on WAMP, so even in the browser, JavaScript is a first-class citizen among protocol peers.

This library is currently very limited - even less production-ready than the Go implementation of DEJE. It's quick-and-dirty, with demos in mind. Not only that, but it implements the current "toy" edition of the protocol, which is profoundly griefable.

Also note that the final version will depend on having access to a bitcoind API server that you have reasonable trust in. DEJE uses the Bitcoin blockchain as a distributed, secure timestamping service. This is less of a pain in the butt than it sounds, because the standard daemon implementation exposes a REST HTTP interface.

Dependencies

• jsSHA 1.5.0+
• AutobahnJS 0.8.2 (Latest version that supports WAMP 1, where Turnpike is currently stuck at)

js-deje's Issues

sniff_events support for 01-publish-events

We're adding a few new messages to the toy protocol.

DJDNS/go-deje#22

Should be extremely simple to add support in the sniff_events callback, since the same code will work equally well on 01-publish-history and 01-publish-events.

Request events when attempting to navigate timestamps, and there are missing events

Will want to look at how the Go version does it, and try to decide what makes sense for JS. I don't want to bikeshed it too much for an iteration of the protocol that will eventually be replaced, but this feature would be useful now.

Manual timestamp navigation

Ability to click any timestamp in the visible list to GoTo it.

Navless tip determination

DJDNS/go-deje#52

Bring js-deje up to speed with go-deje.

Travis CI integration

We really want to run the serialization test suite every time we push. Someday, there will also be a test suite for the rest of the code, and we want that to be able to just hook into an existing Travis setup.

Timestamps should not be cleared when rcving 02-publish-events

This legacy logic is destructive.

DELETE leaves null entry when used on arrays

If you have an array with 2 elements, and you DELETE the second, you end up with [, null]. That's not correct. And since DELETE can have some more complex implications on arrays, we need to make sure this works right.

Clean up object serialization API

There's a bit of awkwardly duplicated code in document.serialize and event.serialize. Both of them should, ideally, accept a format object and pass it on to utils.serialize.

Will also need changes to the test suite.

Update serialization schema for documents

Don't include the topic or quorums now. We've gotten rid of both.

Implement Event.compatibleWith(other)

Right now this just returns true, because for demo purposes, that's usually the case. For the real world, with scary people, we need something a little more robust, that actually takes the event graph topography into account.

Move client.js functionality into document.js

There's a lot of functionality bloat in client.js, because document.js was only very recently created. Let's spread the load a little.

Update to support protocol v02

Version 02 of the protocol is out and working in go-deje, although the ticket to update the version number itself is still pending at this time (DJDNS/go-deje#38).

Update js-deje to support the new protocol mechanisms, and deprecate the old ones.

Automatic timestamp navigation

Figure out, and go to, the current tip event, as per current client.timestamps value.

This is that permanent logic that's gonna stick around even when we stop passing timestamps around between peers.

Event serialization does not sort keys of objects

For the sake of determinism, we always sort keys as part of JSON serialization. But js-deje doesn't do that yet, which means it can get different hash values for the same events.

Track timestamps

I didn't want to outrageously inflate the scope of #5, and support things that are totally unprecedented/not strictly necessary for the browser client. But for simple, drop-in use, especially for other projects? We want us some timestamp support.

Peer timestamp sharing is not a permanent situation, but it's here to stay for awhile, so it's not chasing shadows to support it in js-deje.

Add deje-serialization-tests support

Use the deje-serialization-tests repo as a submodule for testing serialization. Use nodejs to do this in the command line.