Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tradle/bots
[DEPRECATED] Tradle bot framework, allows to drive user interactions in Tradle mobile and web apps and (soon) using smart contracts for critical functions
https://github.com/tradle/bots
availability bitcoin blockchain bot bot-framework ethereum nodejs react-native scalability serverless tradle
Last synced: about 3 hours ago
JSON representation
[DEPRECATED] Tradle bot framework, allows to drive user interactions in Tradle mobile and web apps and (soon) using smart contracts for critical functions
- Host: GitHub
- URL: https://github.com/tradle/bots
- Owner: tradle
- License: gpl-3.0
- Created: 2017-02-01T00:08:01.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-09-23T16:46:10.000Z (about 6 years ago)
- Last Synced: 2024-04-14T13:16:01.410Z (7 months ago)
- Topics: availability, bitcoin, blockchain, bot, bot-framework, ethereum, nodejs, react-native, scalability, serverless, tradle
- Language: JavaScript
- Homepage:
- Size: 591 KB
- Stars: 19
- Watchers: 6
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @tradle/bots
DEPRECATED: tradle/serverless is where the future is
- [Digital Identity Intro](#digital-identity-intro)
- [Examples](#examples)
- [The pieces of the puzzle](#the-pieces-of-the-puzzle)
- [Your bot, the Tradle server, and the clients](#your-bot-the-tradle-server-and-the-clients)
- [Talk to some sample bots](#talk-to-some-sample-bots)
- [Prerequisites](#prerequisites)
- [Platform](#platform)
- [Environment](#environment)
- [OSX Users](#osx-users)
- [Run docker, login](#run-docker-login)
- [Usage](#usage)
- [Clone this repository](#clone-this-repository)
- [Install dependencies](#install-dependencies)
- [Run Tradle server](#run-tradle-server)
- [Create a provider](#create-a-provider)
- [Charge Provider's Wallet](#charge-providers-wallet)
- [Enable the In-House Bot](#enable-the-in-house-bot)
- [Connect your Tradle app](#connect-your-tradle-app)
- [Web](#web)
- [Mobile](#mobile)
- [Configuring your bot](#configuring-your-bot)
- [Console](#console)
- [Sample Session](#sample-session)
- [Console globals](#console-globals)
- [Strategies](#strategies)
- [Receiving messages](#receiving-messages)
- [Sending messages](#sending-messages)
- [Creating blockchain seals](#creating-blockchain-seals)
- [Events](#events)
- [Shared storage](#shared-storage)
- [Managing users](#managing-users)
- [Validation](#validation)
- [Models](#models)
- [Objects / Resources](#objects--resources)
- [Model Builder (still raw)](#model-builder-still-raw)
- [Known Limitations](#known-limitations)
- [Contributing](#contributing)
## Digital Identity Intro
Jump down the [rabbit hole](./docs/mythos.md).
## Examples
See some existing [bots](./docs/bots.md)
## The pieces of the puzzle
Users of the Tradle app converse with [providers](#your-bot-the-tradle-server-and-the-clients). The brains behind each provider is a bot.
The Tradle server takes care of:
- secure line to your users
- creation/monitoring of blockchain transactions
- calling your bot's web server with messages from the user (and blockchain-related events)
The Tradle app takes care of:
- cross-platform support (iOS & Android). iOS is currently more mature.
- cross-browser support (Chrome, Firefox, Safari, IE11). Chrome currently has the best support.
- offline support, a must on mobiles, but very hard to develop. You have it here out of the box.
- UI. You can customize it with per-provider styles on the server-side. In the near future you will be able to add your own JS code that will be executed in the app.
This framework supports:
- asynchronous messaging
- reliable persistent-queue-based send/receive on both the server and the bot ends (the basis for offline support)
- easy to get started. We provide set of sample bots, which we call "strategies"
## Your bot, the Tradle server, and the clients
The Tradle server acts like a router between your bot and your clients, on their Tradle apps. Your bot will represent a single provider, as different providers typically require different functionality. Being able to set up multiple service providers on one Tradle server makes it easier to test and do demos.
From the client's perspective (see the Tradle app screenshot below), providers are listed together in the Conversations screen.
In the guide that follows, you'll set up a service provider called Silly, and connect your bot to it.
## Talk to some sample bots
At [https://bots.tradle.io](https://bots.tradle.io) there's a Tradle web app set up with a bunch of test bots, some of which are built with this framework (Inviter and Age Verification). Register, click the chats icon in the Profile page footer and chat with bots.
1. Conversation Screen | 2. Chatting with the Inviter bot
:---------------------------:|:---------------------------:
 | 
## Prerequisites
How can you have any pudding if you don't eat your prerequisites?
### Platform
These instructions have been tested on the following platforms:
- macOS Sierra
- Windows 10 Home Edition
If you run into problems setting up, submit an issue!
### Environment
You will be using a dockerized Tradle server, and building your bots with Node.js
- [Docker](https://docs.docker.com/engine/installation/).
On Windows 10 Home Edition you will need to install Docker Toolbox instead of Docker.
Follow the Docker link, find Windows installation page and search for Toolbox.
- [Docker Compose](https://docs.docker.com/compose/install/)
- [Node.js](https://nodejs.org/en/) 6 or later
#### OSX Users
1. Docker used to run via boot2docker, but now has the much better [Docker for Mac](https://docs.docker.com/docker-for-mac/). Install it.
2. Remove environment variables in your `~/.bash_profile` that start with `DOCKER_`. These are boot2docker's legacy.
3. Open a fresh shell. Mm, you smell that? Me neither. boot2docker will plague us no more.
### Run docker, login
1. Create an account on Docker Hub if you haven't already
2. Make sure Docker is running. To make sure you made sure, run `docker info` and count off two microseconds. If it doesn't spit out some awesome stats, docker is probably not running.
3. Run `docker login` in your shell, and login with your Docker Hub credentials
## Usage
### Clone this repository
```sh
git clone https://github.com/tradle/bots tradle-bots
cd tradle-bots
```
### Install dependencies
This project uses [yarn](https://github.com/yarnpkg/yarn) package manager, which is like [npm](https://github.com/npm/npm), but faster, leaner, and more emoji-infused. You had as at "emoji", yarn!
To install it, smirk ironically, and run:
```sh
npm i -g yarn
# if that doesn't work: sudo npm i -g yarn
```
Then install dependencies:
```sh
yarn --ignore-optional
```
### Run Tradle server
This uses the Docker Compose file [docker-compose.yml](./docker-compose.yml), at the root of your `tradle-bots` folder:
On OSX, to enable connecting from the container to the host, run:
```sh
# https://docs.docker.com/docker-for-mac/networking/#/known-limitations-use-cases-and-workarounds
# see: "I want to connect from a container to a service on the host"
sudo ifconfig lo0 alias 10.200.10.1/24
```
Start the server!
```sh
# switch to your tradle-bots directory
# start up dockerized tradle server and web app
yarn run server
# check things are running:
docker ps
# ... NAMES
# ... tradle-web-app
# ... tradle-server
```
### Create a provider
Let's create a provider called Silly, with handle `silly` (url path: `/silly`)
```sh
# attach to the tradle-server container
# or: `yarn run attach`
docker attach tradle-server
# ( you may need to hit Enter an extra time to show the prompt )
# you are now in the tradle server's command line client
# let's create a provider
tradle-server$ newprovider silly Silly
# Generating a really good provider: silly
# This may take a few seconds...
# Enter a local path or a url of the provider logo:
https://afv.com/wp-content/uploads/2014/11/Tongue.png
# subscribe your bot's web server for webhooks
# OSX: see the previous section for the explanation for the IP address value
tradle-server$ newwebhook silly http://10.200.10.1:8000
# Windows: use Docker's NAT address (10.0.75.1) to configure webhook:
tradle-server$ newwebhook silly http://10.0.75.1:8000
# start things up
tradle-server$ restartproviders
```
Your Tradle server is now running at `http://localhost:44444`, and `silly` provider is running at `http://localhost:44444/silly`
*Note: when attached to a Docker container, if you hit Ctrl+C, you will kill it. Docker Compose will automatically restart it (see the `restart: always` flag in [docker-compose.yml](./docker-compose.yml)), but to be nice, detach with `Ctrl+P Ctrl+Q`*
### Charge Provider's Wallet
`restartproviders` will print your provider's wallet's address, e.g.:
```sh
# network: ethereum rinkeby
# silly Balance: 0
# silly : Send coins to 0x0000000000000000000000000000000000000000
```
In order for the provider to write seals to the blockchain, you need to charge this address, for example from this [faucet](https://faucet.rinkeby.io)
When seals are written to the blockchain, you'll see something like this in the tradle-server console:
```sh
# bank silly +2s wrote chain-seal for tradle.Verification in tx with id 0x5ddc1bfbb4d31adc2efdc487e9edfd843d54a7323b349970f646ed0fc18e59b8
# bank silly +2s wrote chain-seal for tradle.PersonalInfo in tx with id 0x9ab91f52871b79d81d768f2b3e9125a146094bad479ff519a8222fc7912b24ad
```
A few minutes later, the customer will be able to see the same seal in the Data Security section of sealed object (e.g. a form or verification). The app typically syncs once every 5-10 minutes. Refresh it to force a sync.
### Enable the In-House Bot
By default, the in-house bot is off. For example, you can enable it and enable a product:
```sh
# turn on the auto-prompter which will guide you through product purchasers
tradle-server$ autoprompt silly true
# auto-verify forms submitted by the customer
tradle-server$ autoverify silly true
# enable some products
tradle-server$ enableproduct silly tradle.CurrentAccount
tradle-server$ enableproduct silly tradle.MortgageProduct
```
See [docs](https://github.com/tradle/server-cli) on configuring your provider
### Connect your Tradle app
#### Web
1. Make sure `docker ps` shows `tradle-web-app` running
2. Open `http://localhost:55555` in Google Chrome. Firefox, Safari and IE11 are almost there.
Note: by default, the dockerized web app connects to your dockerized Tradle server. If you want to point it elsewhere, add a `.env` file in your tradle-bots directory, e.g.:
```sh
DEFAULT_TRADLE_SERVER_URL=https://botserver.tradle.io
```
You can also add additional Tradle servers to your web/mobile app from the app UI (see below, Mobile #3)
#### Mobile
1. Make sure your phone is on the same network as the computer running your Tradle server.
2. Get your computer's local ip.
3. In your Tradle app, on the Conversations screen, click the red button, and choose Add Server URL. Enter the address of your Tradle server: `http://{your_local_ip}:44444`
### Configuring your bot
No `silly` provider is complete without a silly strategy. Below is the annotated default config file, which can be found at [./sample-conf.json](./sample-conf.json). It runs the strategy in [./lib/strategy/silly.js](./lib/strategy/silly.js). Once you outgrow the `silly` strategy (it took me years), and you've sampled the others in [./lib/strategy](./lib/strategy), feel free to create your own. To use a particular config file, run `yarn start` as follows:
```sh
# nerds:
# the extra '--' after yarn start is to help yarn distinguish its own arguments
# from arguments to the underlying script (./cmd.js)
# it is equivalent to: DEBUG=tradle:* ./cmd.js --conf ./path/to/your/config.json
yarn start -- --conf ./path/to/your/config.json
```
```js
{
// the port on which your bot will run its web server
// when you register your webhooks on the Tradle server, specify this port
"port": 8000,
// the console prompt, in this case a red hot chili pepper icon
"repl": "\uD83C\uDF36 ",
// the url of the provider your bot controls on the Tradle server
// url format: http://localhost:44444/{providerHandle}
"providerURL": "http://localhost:44444/silly",
// the directory in which your bot will store its databases
// and any temporary files
"dir": "./storage/silly",
// strategies your bot will use when it starts
"strategies": [
"./lib/strategy/silly.js"
]
}
```
*Note: If running multiple bots simultaneously, be sure to use a different `port` and a different `dir` for each.*
### Console
The easiest way to get started is by playing in the Javascript console. Make sure your Tradle server us up and [running](#run-tradle-server).
The console can be started by running `yarn start`. Below is a sample session. Below that, see an outline of the objects and functions available in the global scope.
#### Sample Session
```sh
# switch to your tradle-bots directory
#
# yarn start runs ./cmd.js with lots of logging. See "scripts" in package.json
$ yarn start -- --conf ./conf/silly.json
# Listening on port 8000
#
# before anything test the connection to your provider:
health()
testing connection to provider...
all good!
# list stored users
bot.users.list()
# no users yet
{}
# list our strategies
bot.strategies.list()
# we're using the silly strategy (see './lib/strategy/silly.js')
# depending on your config (sample-conf.json), you may be using a different one
[ [Function: sillyStrategy] ]
# screw that for now, we want to talk to our users manually
bot.strategies.clear()
bot.strategies.list()
[]
# print to console all received message
togglePrintReceived()
# go to your Tradle app and say something to the provider your bot's hooked up to
# ..yay, we got a message
# a7d454a8ec9a1bd375f9dd16afdadff9ed8765a03016f6abf7dd10df0f7c8fbe {
# "_s": "CkkKBHAyNTYSQQQkBY3Zz1lTCpyGK4aQzW8mzp8cz7KuvP0U9Km8vddXuL8PFnHpeFN60seFpmvGTAmy0hpA4hg/zQVsYXc2h8kIEkcwRQIgdQy4DkLs3AcYZ+LsbZvEyGNbuLzuyNHri1kWuvN3Su8CIQC6TwkhBqyJn+QG5gUFFFmnxZS+iI0OJ2yQIB4I2dGhbA==",
# "_t": "tradle.CustomerWaiting",
# "_z": "ac1c730a4b803b9cb9ca88c6ed0ddadce06d89e5f881f4c91f76e64050728a4c",
# "message": "Ove has entered the chat",
# "time": 1486070892140
}
# list stored users
bot.users.list()
# ok, this is that person that was messaging us earlier
# { a7d454a8ec9a1bd375f9dd16afdadff9ed8765a03016f6abf7dd10df0f7c8fbe:
# { id: 'a7d454a8ec9a1bd375f9dd16afdadff9ed8765a03016f6abf7dd10df0f7c8fbe',
# history: [ [Object], [Object], [Object], [Object], [Object], [Object] ],
# profile: { firstName: 'Ove' } } }
# ok, this is the guy who was messaging us earlier
# let's say hi (make sure to replace a7d4... with the 'id' that bot.users.list() printed out)
bot.send({ userId: 'a7d454a8ec9a1bd375f9dd16afdadff9ed8765a03016f6abf7dd10df0f7c8fbe', object: 'hey Ove!' })
# ok, good chat, let's turn the Silly strategy back on.
# Silly will send a message to the app, and you can chat with Silly,
# but do not expect any serious stuff, be silly yourself
bot.strategies.use(strategies.silly)
# if you build your own strategy, you simply use require(..):
# bot.strategies.use(require('./path/to/my/strategy'))
# or add the path to your own conf file's "strategies" field
```
#### Console globals
as you can see in the session above, the console exposes a bunch of objects and functions in the global scope:
```
- health [Function] test the connection to your provider
- togglePrintReceived [Function] toggle the printing to console of received messages
- bot [Object]
- bot.strategies [Object]
- bot.strategies.list [Function] list enabled strategies
- bot.strategies.use [Function] enable a strategy
- bot.strategies.disable [Function] disable a strategy
- bot.strategies.clear [Function] disable all strategies
- bot.users [Object]
- bot.users.list [Function] list users
- bot.users.get [Function] get a user's state by id
- bot.users.del [Function] delete a user
- bot.users.clear [Function] delete all users
- bot.users.new [Function] create a new user (you probably don't need this)
- bot.seals [Object]
- bot.seals.list [Function] list seals
- bot.seals.get [Function] get a seal by an object link
- bot.seals.queued [Function] get queued seals
- bot.queued [Object]
- bot.queued.seals [Function] list queued seals (same as bot.seals.queued())
- bot.queued.send [Function] list queued sends
- bot.queued.receive [Function] list queued receives
- bot.send [Function] send a message to a user
- bot.shared [Object] basic shared storage
- bot.shared.set [Function] set key-value mapping
- bot.shared.get [Function] get value by key
```
### Strategies
Yadda yadda, the examples were fun, now how do I build my own bot?
Implementing a basic strategy for a bot is easy. See [./lib/strategy](./lib/strategy) for examples. Below is the echo strategy, which echoes everything any given user says back to them (and boy, do users love it).
```js
// ./lib/strategy/echo.js
const { co } = require('bluebird').coroutine
module.exports = function echoStrategy (bot) {
return bot.addReceiveHandler(co(function* ({ user, object, link /*, other goodies*/ }) {
// we received `object`
// send it back
yield bot.send({ userId: user.id, object })
}))
}
```
If your Promises are a bit rusty, or if you're asking yourself "what's `co`?" or "isn't `yield` only for generators?", skim [this](./docs/promises.md)
[./lib/strategy/silly.js](./lib/strategy/silly.js) is a slightly more complex strategy, and [tradle/bot-products](https://github.com/tradle/bot-products) is an expert-system type strategy that is a pared down version of the Tradle server's in-house bot's strategy.
#### Receiving messages
To handle incoming messages from users, add a receive handler as follows:
```js
function myStrategy (bot) {
bot.addReceiveHandler(function ({ user, object, link /*, other goodies*/ }) {
// return a Promise to ensure receive order
})
// tip: wrap in `co` to make your async javascript saner:
//
// const co = require('bluebird').coroutine
// bot.addReceiveHandler(co(function* ({ user, object /*, other goodies*/ }) {
// yield promiseSomething()
// yield promiseSomethingElse()
// }))
}
```
#### Sending messages
To send a message to a user, use `bot.send({ userId, object })`:
```js
function myStrategy (bot) {
// const news = ...
// ...
news.on('raining men', function () {
// bot.send(...) returns a Promise. Sensing a theme?
bot.send({
userId: String,
object: {
_t: 'tradle.SimpleMessage'
message: 'wear a helmet'
}
// equivalent shorthand for sending simple messages:
// object: 'wear a helmet'
})
})
// ...
}
```
#### Creating blockchain seals
Objects sent to a user, or received from a user can be sealed on blockchain as follows. To seal an object, you need to know its `link`, which
```js
function echoAndSealStrategy (bot) {
return bot.addReceiveHandler(co(function* ({ user, object, link /*, other goodies*/ }) {
yield bot.send({ userId: user.id, object })
bot.seal({ link })
}))
}
```
To handle seals being written/read from the blockchain:
```js
// see https://github.com/tradle/server-cli#sample `wroteseal` event
// for a full list of available properties
bot.seals.addOnReadHandler(co(function* ({ link, txId /*, ...*/ }) {
// object with link `link` has been detected
// on the blockchain in the transaction with id `txId`
}))
// see https://github.com/tradle/server-cli#sample `wroteseal` event
// for a full list of available properties
bot.seals.addOnWroteHandler(co(function* ({ link, txId /*, ...*/ }) {
// object with link `link` has been written
// to the blockchain in the transaction with id `txId`
}))
```
#### Events
the `bot.users` object emits the following events:
- 'create': a new user state object has been created
- 'delete': a user state object has been deleted
- 'clear': all user state has been deleted
- 'update': a user state object has changed
the `bot.seals` object emits the following events:
- 'push': a request to seal an object has been pushed to the Tradle server
- 'wrote': the Tradle server has written a seal to the blockchain
- 'read': the Tradle server has read a seal for an object from the blockchain
the `bot` object emits the following events:
- 'message': when a message has been handled by all enabled strategies without error
- 'sent': when a message has been sent to the Tradle server for deliver to the client
- 'seal:push', 'seal:wrote', 'seal:read': re-emitted for convenience from `bot.seals`
- 'user:create', 'user:delete', 'user:clear', 'user:update': re-emitted for convenience from `bot.users`
#### Shared storage
A basic shared key-value storage option is available at `bot.shared`, e.g.:
```js
bot.addReceiveHandler(co(function* ({ user, object }) {
const excellent = bot.shared.get('excellentUsers') || []
if (!excellent.includes(user.id) && isExcellentMessage(object)) {
// remember who's excellent
excellent.push(user.id)
bot.shared.set('excellentUsers', excellent)
yield bot.send({
userId: user.id,
object: 'wow, I just realized...you are excellent!'
})
}
// ...
// be extra excellent to excellent users
}))
// ...
// batch-send excellent users special stuff
```
### Managing users
`bot.users` is the user manager object, which you can explore in the [console](#console). If you like mostly empty JSON objects, you're going to love this one.
Each user has a single state object, which is accessible with `bot.users.get(userId)`
Users are automatically registered with a default state object when the first message from them is received:
```json
{
"id": "..userId..",
"history": []
}
```
When you `bot.send(...)` or when your bot receives messages, they get appended to `state.history`. You can store whatever your evil bot needs on the user state object, just don't forget to `bot.users.save(userState)` lest the evil be thwarted.
## Validation
How can you have any pudding...wait, we already did that one
### Models
[@tradle/validate](http://github.com/tradle/validate)
Validate your models. To be renamed to `@tradle/validate-model` once it has enough deps to break things.
### Objects / Resources
[@tradle/validate-resource](http://github.com/tradle/validate-resource)
Validate objects against their corresponding models.
### Model Builder (still raw)
[@tradle/build-model](http://github.com/tradle/build-model)
Build a model in code.
## Known Limitations
- database: for simplicity and ease of getting started, the bot framework uses [lowdb](https://github.com/typicode/lowdb) for its databases. Yes, it's not a production-level database, it writes synchronously to the file-system, etc. Feel free to substitute it with your personal preference once you're past the prototype phase (e.g. the Tradle server uses LevelDB).
## Contributing
Pull requests are welcome. If you build a strategy that you would like to share or show off, submit a pull request to add it to this README.
The [master](https://github.com/tradle/tradle-bots) branch has stable if outdated code. The [dev](https://github.com/tradle/bots/tree/dev) branch has the latest developments, so pull requests are best submitted there.