Guides

This section aims to provide hands-on guides to demonstrate how to use Trinity. If you are looking for detailed API descriptions check out the API section.

• Quickstart
  • Installation
    • Installing on Ubuntu
    • Installing on macOS
    • Installing through Docker
  • Running Trinity
    • Running as a light client
    • Ropsten vs Mainnet
  • Connecting to preferred nodes
  • Retrieving Chain information via web3
• Architecture
  • Layering
    • EVM
    • P2P
    • Trinity Application Code
  • Processes
    • Main Application Process
    • Database Process
    • Networking Process
    • Plugin Processes
• Writing Plugins
  • What can plugins do?
  • Understanding the different plugin categories
    • Plugins that redefine the Trinity process
    • Plugins that spawn their own new isolated process
    • Plugins that run inside the networking process
  • The plugin lifecycle
    • Plugin state: NOT_READY
    • Plugin state: READY
    • Plugin state: STARTED
    • Plugin state: STOPPED
  • Defining plugins
    • Configuring Command Line Arguments
    • Defining a plugins starting point
    • Starting a plugin
  • Communication pattern
  • Distributing plugins