smokyish / tl-dev-docs-1

Technical documentation around the Trustlines protocol

Trustlines Developer Docs

Work In Progress

---

Trustlines Developer Docs will contain all the technical documentation related to Trustlines Protocol.

Here you can find all kind of technical details about Trustlines as well as code related documentation.

This site is a work in progress and the documentation currently resides in their respective repositories of the trustlines-protocol GitHub organization.

Content

• Blockchain

The Trustlines Blockchain is a minimal viable Proof-of-Stake (mPoS) Ethereum sidechain.

• Client library

The clientlib is a JS-library which makes it easy to build applications on top of the Trustlines Protocol. It provides a high level API to enable applications to interact with the smart contract system on the blockchain via the relay servers.

• Relay Servers

The Relay Servers are an optional bridge between client apps and the Trustlines blockchain. They offer services which are not feasible to be implemented on-chain or within the client apps. Importantly, Relay servers calculate optimal paths and relay transactions.

• Smart Contract System

The smart contract system is a collection of solidity contracts deployed on the Trustlines Blockchain. Transfers within the Trustlines Network are executed by the smart contracts. All trustlines (i.e. credit lines and balances between users) are notarized on the Trustlines Blockchain. Furthermore, the smart contracts enforce the rules determining how trustlines can be created, used and updated.

Requirements and steps for running the site locally

Requirements

• Ruby version 2.4.0 or above, including all development headers (ruby version can be checked by running ruby -v)
• RubyGems (which you can check by running gem -v)
• GCC and Make (in case your system doesn’t have them installed, which you can check by running gcc -v, g++ -v and make -v in your system’s command line interface)
• Jekyll (currently using v4.0.0)

Steps to install locally

• Install Ruby
• Install Gem
• Install Jekyll

Running locally

• cd path-to-your-tl-dev-docs-folder/
• Run bundle exec jekyll serve
• Open http://127.0.0.1:4000/ in your favourite browser
  • If you're running into a 404 Not found error, try setting baseurl: "" in the _config.yml file and run serve again.