Welcome to OriginTrail documentation!

This document contains an overview of the ODN network structure, guides for installing and running an OriginTrail node, presents ODN functionalities and discusses supported data structuring on the network.

Feel free to leave suggestions or feedback on the github repository for this documentation.

Table of Contents

General

• Introduction
  • What is OriginTrail
  • OriginTrail Decentralized Network Overview
  • Useful Links

ODN Functionalities

• Dataset operations
  • Importing datasets to the local node knowledge graph
    • Supported standards
  • Replicating datasets across the ODN
  • Verification and signature checks
• Querying the data
  • Decentralized Knowledge Graph querying - Network query
  • Local Knowledge Graph querying - Graph Trail
    • Identifier types and values and trail depth
    • Connection types
    • Reach parameter
• Connectors
• Vertex Data permissioning

API Reference

• Introduction to API

Running a node

• Getting started
  • Setup & manage your node
    • Hardware requirements
    • Installation instructions
      • Read Me First
    • Prerequisites
    • Installation via Docker
      • Prerequisites
      • Docker installed
      • Open Ports
      • Installation
      • Run a node on the MAINNET
      • Run a node on the TESTNET
    • Manual installation
      • Prerequisites
      • NodeJS
      • Database - ArangoDB
      • Installation
      • Starting The Node
    • Important Notes
    • Useful commands
      • Check node status
      • Starting OT Node
      • Stopping OT Node
  • Configuration
    • Prerequisites
    • Basic configuration
    • Configuration file
  • Setting up Ethereum RPC
    • RPC server configuration
    • Using own Ethereum node as RPC host
  • Setting up SSL on a node
    • Prerequisites
    • Configuration
  • How to update
    • Docker
    • Manual installation
• Identity management
  • Introduction
    • Network Identity
    • Blockchain profile and identity
  • Identity values and identity files
    • ERC725 Identity value
    • Network Identity value
    • How to use existing identity files
  • Identity management
    • Token management
      • Staking and locking tokens
      • Withdrawing tokens
    • Key (wallet) management
      • Changing operational keys (wallets)
      • Changing management keys (wallets)
• Backup and restore
  • Introduction
    • ⚠️ Before you start ⚠️
  • Step 1/3: Backing up your data
  • Step 2/3: Reinstalling your docker image
  • Step 3/3: Restoring the node data
  • Additional options
• Configuration parameters for node
  • Database
  • Blockchain
  • Network
  • Churn Plugin
  • Auto Updater
  • Dataset Storage

Implementation

• Data Structure Guidelines
  • GS1 EPCIS XML
    • Document data
    • Master data
    • Visibility event data
    • How an event is represented in the graph
    • Connectors in EPCIS files
    • Permissioned data in EPCIS files
  • Verifiable credentials data model
  • OT-JSON Data Structure and Guidelines
    • Introduction and Motivation
    • OT-JSON essentials
    • Conceptual essentials
  • Web of Things
    • How an event is represented in the graph
• OT-JSON Structure
  • Dataset structure
    • Attribute definitions
    • Dataset header
    • Validation schemas
    • Attribute definitions
  • Hash structure
  • Signing
  • Object structure
    • Attribute definitions
    • Object identifiers section
    • Attribute definitions
    • Object properties section
    • Object Related objects section
    • Attribute definitions
    • Attachments section
    • Attribute definitions
  • Connector objects
  • OT-JSON Versions
    • OT-JSON 1.2
    • OT-JSON 1.1
    • OT-JSON 1.0
    • Sorting differences overview
• XML EPCIS Examples
  • 1. Basic sales example
  • 2. Complex manufacturer-distributor-retail (MDR) sale

Contribution Guidelines

• Contribution Guidelines
• Pull Requests
• Contributor Code of Conduct
• Questions, Bugs, Features
  • Got a Question or Problem?
  • Found an Issue or Bug?
  • Missing a Feature?
  • Want a Doc Fix?

Indices and tables

• Index
• Module Index
• Search Page