README.md

description
Step by step tutorials to get started with example bots.

Tutorials for newcomers

Type of repositories on Obyte Github page

Obyte Github page is located there https://github.com/byteball

ocore - main core library

• syncs full database if full node.
• relays storage units if full node.

obyte-gui-wallet - wallet apps with GUI

• inherits ocore library.
• light node or full node.
• wallet functionality.
• graphical user interface for Windows, MacOS, Linux, Android and iOS.

headless-obyte - wallet for server without GUI

• inherits ocore library.
• light node or full node.
• wallet functionality.
• can be controlled via chat.
• can be controlled via JSON-RPC service.

obyte-witness - nodes that determine the main chain

• inherits headless-obyte and ocore library.
• only full node.
• recommended to be behind TOR.
• post new units (moves itself funds or posts oracle data) serially.

obyte-relay - peer that can be connected directly

• inherits ocore library.
• only full node.
• accepts incoming connections.
• provides new units, stable units, balances & suitable parents to light nodes.
• notifies wallet apps about new witnesses.

obyte-hub - hub that relays chat messages

• inherits obyte-relay and ocore library.
• relays encrypted chat messages between devices.
• notifies wallet apps about new app version.
• shows list of chat bots that are available to pair with.
• shows metadata about assets.

bot-example - template for new projects

• inherits headless-obyte and ocore library.
• customized chat messages handling can be added.
• customized actions on new transactions and stable transactions can be added.
• can be used as a base of any new project that needs Obyte wallet functionality.

Tutorials to setup a node

• Setting up headless wallet (Debian/Ubuntu Linux)
• Setting up headless wallet with Docker image
• Setting up headless wallet on Raspberry Pi

Examples of using these libraries

• Ping-poing payments
• Logging into website
• Weather oracle
• Bet on weather bot