Welcome to OriginTrail documentation!

GENERAL

• Introduction
  • Setting up the Node
  • Service provider guidelines
  • Development contribution
• Data Layer
  • Underlying data structures and technical rationale
  • Entities in the graph structure (ontology)
    • Objects and ObjectClasses
    • Events and EventClasses
    • Identifiers
    • Connections
• Network structure
  • Network entities and classification
  • Data Provider
  • Data Creator Node
  • Data Holder Node
  • Data Viewer
  • Service initiation
  • Servicing period
    • Data replication
    • Testing and compensation
    • Litigation procedure
    • Proving mechanism
  • Querying data
  • Conclusion and further research

NODE SETUP

• Installation
  • Read Me First
  • Prerequisites
    • System requirements
  • Installation via Docker Prerequisites
    • Public IP or open communication
    • Docker installed
    • Open Ports
  • Installation via Docker
    • Run a node on the TESTNET
    • Run a node on the MAINNET
    • Check node status
    • Starting OT Node
    • Stopping OT Node
  • Manual Installation Prerequisites
    • NodeJS
    • Database - ArangoDB
    • Ubuntu 16.04
    • Mac OS X
  • Manual Node Installation
    • Starting The Node
    • Important Notes
  • OT Node update
    • Docker
    • Manual installation
• Identity Configuration
  • Node network profile
  • ERC725 Identity
  • How do I obtain my current ERC725 identity?
  • Network identity
  • What about tokens and how do I get them on my wallet?
• Node Configuration
  • Pre-requirements
  • Open Ports
  • Configuring the node
    • Basic configuration
    • Configuration file
• RPC server host
  • RPC server configuration
  • Using Infura as RPC host
  • Using own Ethereum node as RPC host
• Setting up SSL on a node
  • Prerequirements
  • Configuration
• Import data

API REFERENCE

• Introduction to API

IMPLEMENTATION

• Implementation
  • Setting up a Project on OriginTrail
    • Step 1: Structuring a use case
    • Step 2: Getting raw data and structuring the sample files
    • Step 3: Installing and setting up a node
    • Step 4: Putting the data through Node
    • Step 5: Integration of OriginTrail with enterprise IT system
    • Step 6: Utilization of the data on ODN
• Data Structure Guidelines
  • Problem definition
  • Types of data structure
    • GS1 EPCIS structure
    • EPCIS data structuring guidelines
  • GS1 EPCIS XML File structure
    • Document data
    • Master data
    • Visibility event data
    • OriginTrail Extension section
  • Providing XML structured data to OriginTrail Decentralized Network
  • XML EPCIS Examples
    • 1. Basic sales example
    • 2. Complex manufacturer-distributor-retail (MDR) sale
    • 3. MDR with zero knowledge proof
    • 4. MDR with aggregation events
• Namespace
  • GS1 CBV Namespace
  • OriginTrail Namespace
  • Object urn:ot:object
    • Actor urn:ot:object:actor
      • urn:ot:object:actor:id
      • urn:ot:object:actor:name
      • urn:ot:object:actor:description
      • urn:ot:object:actor:category
      • urn:ot:object:actor:wallet
    • Product urn:ot:object:product
      • urn:ot:object:product:id
      • urn:ot:object:product:description
      • urn:ot:object:product:category
    • Batch urn:ot:object:product:batch
      • urn:ot:object:product:batch:id
      • urn:ot:object:product:batch:productId
      • urn:ot:object:product:batch:productionDate
      • urn:ot:object:product:batch:expirationDate
    • Location urn:ot:object:location
      • urn:ot:object:location:id
      • urn:ot:object:location:category
      • urn:ot:object:location:description
      • urn:ot:object:location:actorId
  • Event urn:ot:event
    • Transport urn:ot:event:transport
    • Transformation urn:ot:event:transformation
    • Observation urn:ot:event:observation
    • Ownership urn:ot:event:ownership
    • Extension

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?

UPCOMING RELEASE / v4.0 Freedom

• OT-RFC 01 - OriginTrail v4 Data Layer specification (Freedom - Gemini Release)
  • Introduction
  • Technical block scheme
  • Vocabulary definition
  • Architecture proposal
  • Data layer acceptance criteria
    • Data layer requirements & User stories
    • Standards related
    • Architecture related
    • Performance related requirements
  • OT-JSON essentials
  • Conceptual essentials
• OT-RFC-02 - Data Layer v4 API
  • Introduction
  • Swagger link
  • Important note on compatibility
  • Solution proposition
    • API Handlers
  • API Reference and call explanation
    • Import
    • Replication
    • Export
    • Object trail
    • Get dataset information
    • Get a list of datasets containing identifiers
    • List supported standards
    • List available API versions
  • Global status codes
  • API versioning
  • API specification
    • Import request
    • Import result
    • Replication request
    • Replication result
    • Export request
    • Export result
    • Object trail
    • List supported dataset standards
    • List available API version
• OT-RFC-03: OriginTrail v4 Data Layer - OT-JSON v1.0 data structure
  • Abstract
  • Proposed solution
  • Dataset structure
    • Attribute definitions
    • Dataset header
    • Validation schemas
    • Attribute definitions
  • 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-RFC-04: OriginTrail Data Layer - Graph data structure (internal level)
  • Abstract
  • Proposed solution
  • Internal Level Architecture
    • Graph Data Structure
    • Vertex objects
    • Edge objects
  • Dataset metadata
• OT-RFC-05: OriginTrail v4 Data Layer - Database Level Structure
  • Abstract
  • Proposed solution
  • Database level architecture
    • Graph vertices
      • Entity Object vertices
      • Datao bject vertices
      • Identifier vertices
      • Connector vertices
    • Edges
      • Entity Object vertices
      • Entity relation edges
      • Data relation edges
      • Identifier relation edges
      • Connector edges
      • Dataset connection edges
    • Dataset metadata

Indices and tables

• Index
• Module Index
• Search Page