README.md

tradle engine

SDK for real-rime auditable blockchain-based messaging

Overview

This main component of Tradle's SDK is two-turbine engine, a two-channel communication device: 1) real-time messaging, and 2) blockchain seals. Messages can be plain or structured messages. The engine is made to work on mobiles, desktops and servers. Having one codebase is important to minimize security reviews.

The engine is designed to work with intermittent connections, common on mobile devices. For that it keeps an internal log of all actions and events, and resumes operations as soon as network connection is restored.

The engine's operations are covered by a patent. The tatent is filed only for defensive purposes, so you are welcome to use it in your open source projects.

this module is used by Tradle

The engine provides a higher level API to a number of low level Tradle components. A UI is developed separately, on React Native based UI for iOS and Android, and using React Native Web for the Web.

Datalog

This module uses a datalog, a log-based database of experienced activity that you can use to bootstrap your own databases from.

Messaging API

Details to follow

Usage

See examples

Events

tim.on('ready', function () {...})

the engine has completed initialization. You don't need to wait for this event, internal logic takes care of it.

tim.on('message', function (message, sender) {...}

You've received a message from sender

tim.on('wroteseal', function (seal) {...}

An object was sealed to a blockchain

tim.on('readseal', function (seal) {...}

An object was read off chain

tim.on('sent', function (msg) {...}

A message was successfully delivered