DigiOracle Docs v1.0.1
  • 📔KlayOracle Documentation
  • Fundamentals
    • Introduction
    • Architecture
    • Aggregation Mechanism
    • Node & data provider communication
    • Installing KlayOracle
  • Smart Contract Developers
    • Price Feeds
      • Quick Start: Code Samples
      • How to Use KlayOracle Price Feeds
    • Random Number Generator
      • Quick Start: Code Samples
      • How to Use KlayOracle Random Number Generator
  • Data Providers
    • Introduction
    • Install & run data providers locally
    • How It Works
      • Configuring Data Feeds
      • Reducers
      • Data provider utilities
      • Configuration Files & Environmental Variables
      • OracleProvider Contract
      • Bootstrap Data Providers
    • Best Practices
  • Nodes
    • Introduction
    • Install & run node locally
  • Community
    • DigiOracle Champion Program
      • About the DigiOracle Champion Program
      • How to create content & become a DigiOracle Champion
      • Contribution Guidelines
      • FAQs
    • Bounties
Powered by GitBook
On this page
  • Installing from source
  • System Requirements
  • Installing from Docker
  1. Fundamentals

Installing KlayOracle

PreviousNode & data provider communicationNextPrice Feeds

Last updated 2 years ago

KlayOracle v1 is still in active development, therefore the recommended installation method is by running from source.

Installing from source

System Requirements

  • version 18 and above.

  • Mac/Linux machine, with at least 4GB of RAM and 10GB of storage

  • Docker desktop

To get started installing KlayOracle, clone the locally.

git clone https://github.com/KlayOracle/klayoracle-monorepo.git
cd klayoracle-monorepo

KlayOracle is written in Go. Go code is grouped into packages, and packages are grouped into modules. Each module specifies dependencies needed to run the code, including the Go version and the set of other modules it requires.

While installing from source, the data provider and nodes need to be configured and run through their respective packages within the monorepo.

  • Install & run node locally

Installing from Docker

The is actively working on Docker images for faster installation & setup of nodes and data providers. Pending a full launch, an experimental version has been released, along with a video guide to get started.

This documentation will be updated in the near future with step-by-step instructions for using KlayOracle with Docker.

Install Go
klayoracle-monorepo
Install & run data provider locally
KlayOracle team