docs
Basics of eyeOracle

Welcome to eyeOracle Documentation

Welcome to the official documentation for eyeOracle. This page will guide you through the core concepts, setup process, and integration of our oracle service with your smart contracts.

What is eyeOracle?

eyeOracle is a decentralized solution designed to bridge the gap between smart contracts and external data sources. While smart contracts are inherently secure, they cannot access data outside of the blockchain on their own. eyeOracle solves this by allowing smart contracts to make secure and reliable API calls.

Key Features

  • Decentralized Data Access: Fetch external data (such as APIs) securely and reliably.
  • Data Availability with Redundancy: Ensures data availability with 3-node redundancy for higher reliability.
  • Seamless Integration: Easily integrate the oracle into your smart contracts with minimal setup.
  • GET and POST Requests: Supports both GET and POST HTTP methods for maximum flexibility.
  • Secure Secret Management: Safely store and access secrets such as API keys.

Why use eyeOracle?

Smart contracts are powerful, but their inability to fetch external data directly can be limiting. eyeOracle opens up new possibilities by enabling interaction with the external world, such as:

  • Fetching live prices from financial markets.
  • Accessing weather data for decentralized insurance platforms.
  • Interacting with external services like social media or IoT devices.

How It Works

The oracle operates in a simple but secure way:

  1. Request Data: Your smart contract makes a request to eyeOracle to fetch or submit external data.
  2. Processing: The oracle service processes the request, retrieves or sends data, and ensures that the process remains secure.
  3. Data Delivered: The result is passed back to your smart contract, allowing it to continue its execution based on real-world data.

This diagram describes the flow from when the client makes a request with exampleSendRequestPOST() until the oracle returns a response with the callback fulfillRequest().

Sequeintial Calls to External API

The Oracle nodes are configured sequentially, not in parallel, which ensures a smooth integration with POST requests. This setup allows only one API call to the target, preventing duplicate requests. In case one node fails, another node will take over and complete the request without any issues. This structure provides both reliability and redundancy, making it ideal for POST requests.

Getting Started

To begin integrating eyeOracle into your project, follow the steps in the Getting Started section. You'll learn how to set up your environment, connect to the oracle, and start fetching data for your decentralized applications.

For more details on how to make requests, manage secrets, or customize your oracle setup, refer to the following sections:

Getting Started