Welcome to OriginTrail documentation!

GENERAL

• Introduction
  • Setting up the Node
  • Service provider guidelines
  • Development contribution
• Data Layer
  • Underlying technology and technical rationale
  • Entities in graph structure (ontology)
    • Objects and ObjectClasses
    • Events and EventClasses
    • Connections
  • Conclusion and future steps
• 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
    • Manual Prerequisites Installation
      • NodeJS
      • Database - ArangoDB
        • Ubuntu 16.04
        • Mac Os X
      • Database Setup
      • Database - Neo4j
        • Ubuntu 16.04
  • Automatic installation
  • Manual Node Installation
  • Starting The Node
  • Important Notes
• Wallet Setup
  • Metamask
  • Wallet
  • Get some funds on the wallet
• Node Configuration
  • .env File Configuration
• Import data

API REFERENCE

• Introduction to API
• Prerequisites
• Import
  • /api/import POST
    • Parameters
    • Responses
  • /api/import_info GET
    • Parameters
    • Responses
• Replication
  • /api/replication POST
    • Parameters
    • Responses
  • /api/replication/ :{replication_id} GET
    • Parameters
    • Responses
• Read
  • /api/query/network POST
    • Responses
  • /api/query/{query_id}/responses GET
    • Responses
  • /api/query/network/{query_param} GET
    • Responses
  • /api/read/network POST
    • Responses
      • Local read
  • /api/query/local POST
    • Responses
  • /api/query/local/import POST
    • Responses
  • /api/query/local/import:{import_id} GET
    • Responses
• Local Search
  • /api/trail GET
    • Responses
  • /api/fingerprint GET
    • Responses
• Profile Token Management
  • /api/deposit POST
    • Responses
  • /api/withdraw POST
    • Responses

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?

Indices and tables

• Index
• Module Index
• Search Page