MetaMorph: A Decentralized Oracle Tool

Introduction

MetaMorph is a flexible and robust Oracle service that allows developers to request data from multiple independent Oracle sources. This system gives developers more control and choice over where they source their data from. Key features include a quorum mechanism to ensure a sufficient number of sources have submitted data and threshold parameters to guarantee data freshness. The system also supports callback requests.

You can explore some available oracles for your chosen network here. This is not all available oracles, and you are able to even host your own oracle yourself https://morpheus.scry.finance/

Build your own oracle

https://docs.scry.finance/docs/morpheus/build-your-own-oracle

How to request data from multiple oracles

Interface

interface IMetamorph {
    
    event dataCallbackRequested(uint requestID, uint bounty);

    // Functions to get data feeds
    function getFeeds(
        address[] memory morpheus,
        uint256[] memory IDs,
        uint256 threshold
    )
        external
        view
        returns (uint256 value, uint256 decimals, string memory valStr, bytes memory valBytes,uint timestamp);

    function getFeedsRaw(
        address[] memory morpheus,
        uint256[] memory IDs
    )
        external
        view
        returns (
            uint256[] memory value,
            uint256[] memory decimals,
            string[] memory valStr,
            bytes[] memory valBytes,
            uint256[] memory valTimestamps
        );

    function getFeedsQuorum(
        address[] memory morpheus,
        uint256[] memory IDs,
        uint256 threshold,
        uint256 quorum
    )
        external
        view
        returns (
            uint256 value,
            uint256 decimals,
            string memory valStr,
            bytes memory valBytes,
            uint timestamp
        );

    function getFeedPortal(
        uint256 ID
    )
        external
        view
        returns (
            uint256 value,
             uint256 decimals,
             string memory valStr,
            bytes memory valBytes,
            uint timestamp
        );

    function requestFeed(
        address[] memory morpheus,
        string memory APIendpoint,
        string memory APIendpointPath,
        uint256 decimals,
        uint256[] memory bounties
    ) external payable returns (uint256[] memory);

    function requestFeed(
        address[] memory morpheus,
        string memory APIendpoint,
        string memory APIendpointPath,
        uint256 decimals
    ) external payable returns (uint256[] memory);

    function requestFeedPortal(
        address[] memory morpheus,
        string memory APIendpoint,
        string memory APIendpointPath,
        uint256 decimals,
        uint256 threshold,
        uint256 quorum
    ) external payable returns (uint256 requestPortalID);

    function requestFeedCallback(
        address[] memory morpheus,
        string memory APIendpoint,
        string memory APIendpointPath,
        uint256 decimals,
        uint256[] memory bounties,
        uint threshold,
        uint quorum,
        address receiveAddrs,
        uint256 bountyGuardian
    ) external payable returns (uint256[] memory, uint requestID);

    function fillRequest(uint256 ID) external;

    function refillRequest(uint256 ID, uint guardianBounty) external payable;

    function updateFeeds(
        address[] memory morpheus,
        uint256[] memory IDs,
        uint256[] memory bounties
    ) external payable;

    function updatePortal(uint ID) external payable;
}

Requesting data from multiple oracles is a simple process in the MetaMorph contract. This can be achieved by calling the requestFeed function and specifying a list of morpheus addresses (representing the oracles), the APIendpoint, APIendpointPath, and decimals for the data you want, and an array of bounties to be paid to each oracle.

function requestFeed(
        address[] memory morpheus,
        string memory APIendpoint,
        string memory APIendpointPath,
        uint256 decimals
    ) external payable returns (uint256[] memory);

Deployments

Optimism

0xd3233c02adAAE7ad27cA43d03A6b965cd9a638c0

Sepolia

0x7Fd992696B7aEab1B9Cadce6D748971De8209e85

Base 0xdb66b4d2C4bE0f26D07Cfc4a9166d437C8243f16#code

Choice of data source

By providing an array of Morpheus (oracles) addresses, the MetaMorph contract allows developers to specify which oracles they want to source their data from. This feature provides a level of customization and can increase the trustworthiness of the data by diversifying the data sources.

Independent oracles

The Morpheus oracles operate independently of one another. This feature means that each oracle provides its data, which is fetched from its specified API endpoint, and that data is not influenced by any other oracle. This design increases the robustness and decentralization of the Morpheus system.

Threshold for fresh data

The MetaMorph contract allows developers to set a threshold parameter, which ensures that only fresh data is returned. If the timestamp of the data is within the threshold, the data is considered valid; otherwise, it is disregarded. This parameter can be set in both the getFeeds and getFeedsQuorum functions.

function getFeeds(
        address[] memory morpheus,
        uint256[] memory IDs,
        uint256 threshold
    ) external view returns (uint256 value, uint256 decimals, string memory valStr, bytes memory valBytes,uint timestamp);

Quorum for source validation

The getFeedsQuorum function includes a quorum parameter, which ensures that a sufficient number of sources have submitted their data before a value is returned. This feature enhances the reliability of the data by requiring a minimum number of validations.

function getFeedsQuorum(
        address[] memory morpheus,
        uint256[] memory IDs,
        uint256 threshold,
        uint256 quorum
    ) external view returns (uint256 value, uint256 decimals, string memory valStr, bytes memory valBytes,uint timestamp);

Requests with callbacks

The MetaMorph contract supports requests with callbacks. This feature allows developers to call the requestFeedCallback function, which triggers an event dataCallbackRequested after the feed request is made. When the data is ready, the fillRequest function can be called by watchers nodes, which triggers a callback to the specified receiver address with the fetched data.

function requestFeedCallback(
        address[] memory morpheus,
        string memory APIendpoint,
        string memory APIendpointPath,
        uint256 decimals,
        uint256[] memory bounties,
        uint threshold,
        uint quorum,
        address receiveAddrs,
        uint256 bountyGuardian
    ) external payable returns (uint256[] memory,uint ID);

Parameters:

  • morpheus[] (address[]): Array of addresses of the Oracle contracts to request data from.

  • APIendpoint (string): The API endpoint from which the Oracle should fetch data.

  • APIendpointPath (string): The specific path within the API from which the data should be fetched.

  • decimals (uint256): Number of decimal places the returned data should have.

  • bounties[] (uint256[]): Array of bounties (payment) for each Oracle.

  • threshold (uint): Maximum age of data to be accepted, in seconds.

  • quorum (uint): Minimum number of Oracles that need to respond for the data to be accepted.

  • receiveAddrs (address): Address to send the callback to once data is available.

  • bountyGuardian (uint256): Bounty for the Guardian who fills the request.

Returns:

  • ids[] (uint256[]): Array of IDs of the feed data requested from each Oracle.

  • requestID (uint256): ID of the data request.

You must implement the following in your contract that receives the callback

requestCallback Function

Description

The requestCallback function is called by the MetaMorph contract when the requested data is ready. It ensures that the call is coming from the MetaMorph contract and that the request ID matches the expected value. Once the data is validated, it is stored and an event is emitted to notify that the data has been received.

function requestCallback(
        uint256 data,
        uint256 decimals,string calldata strdata,
        bytes calldata bytesdata,
        uint timestamp,
        uint reqID
    ) external {
    
    }

Parameters

  • data (uint256): The numerical data fetched by the Oracle.

  • decimals(uint256): The decimals for the data fetched by the Oracle.

  • strdata (string): A string representation of the data fetched by the Oracle. This can be used to provide additional context or details about the data.

  • bytesdata (bytes): A bytes representation of the data fetched by the Oracle. This can be used to provide the data in a different encoding or format.

  • timestamp(uint256): The average timestamp from data fetched by the Oracle

  • reqID (uint): The request ID associated with the data request. This must match the request ID that was returned by the requestFeedCallback function in the MetaMorph contract.

Security Considerations

  • The function should be called by the MetaMorph contract. If the sender is not the MetaMorph contract, the transaction should be reverted

  • The reqID parameter must match the requestID expected by the receiving contract. If there is a mismatch, the transaction will be reverted with the message "Request mismatch."

Example Usage

function requestCallback(
        uint256 data,
        string calldata strdata,
        bytes calldata bytesdata,
        uint timestamp,
        uint reqID
    ) external {
        require(
            msg.sender == address(metamorph),
            "Only MetaMorph can call this function"
        );
        require(requestID == reqID, "Request mismatch");
        receivedData = data;
        receivedStrData = strdata;
        mycustomAddrs = address(bytesdata);
        emit DataReceived(data,strdata,bytesdata);
    }

Notes

  • Make sure to define the metamorph address and the requestID variable in your contract, as they are used in the requirements.

  • The strdata and bytesdata parameters can be used to provide additional information about the data, depending on the specific use case and the API being queried.

Portals

requestFeedPortal

  • Description: This function allows users to request feeds for multiple Morpheus oracles. It stores the parameters of this request, like the list of oracles (morpheus), API endpoint details, decimals, and more. The data is stored in the request mapping using a unique requestPortalID.

  • Parameters:

    • morpheus: An array of addresses for the Morpheus oracles.

    • APIendpoint: The API endpoint string for the request.

    • APIendpointPath: The path for the API endpoint.

    • decimals: The number of decimals for the returned value.

    • threshold: The time threshold for the data.

    • quorum: The minimum number of data points required to form a consensus.

  • Returns: A unique requestPortalID that is associated with the request.

  • Usage: Call this function with the desired parameters to request data feeds from multiple Morpheus oracles.

getFeedPortal

  • Description: Retrieve the consolidated data from the multiple Morpheus oracles, based on a previously created portal request. This function internally calls getFeedsQuorum with parameters from the request associated with the provided ID.

  • Parameters:

    • ID: The unique identifier (requestPortalID) of the request.

  • Returns:

    • value: The median value of the data feeds.

    • decimals: The decimals value of the data feeds.

    • valStr: The most used string in the data feeds.

    • valBytes: The bytes representation of the most used string.

    • timestamp: The average value of the data feeds timestamps for submits.

  • Usage: After making a portal request using requestFeedPortal, call this function with the requestPortalID to retrieve the consolidated data.

updatePortal

  • Description: Allows a user to update an existing portal requests oracle data. This function calculates the bounty required for each Morpheus oracle based on the sent amount (msg.value) and updates the feeds using updateFeeds.

  • Parameters:

    • ID: The unique identifier (requestPortalID) of the request to be updated.

  • Usage: If you've previously made a portal request and wish to update it, use this function, specifying the requestPortalID and sending the required bounty amount.

Supporting Structures and Mappings:

requeststruct

struct requeststruct {
        uint[] ids;
        address[] morpheus;
        address target;
        uint bounty;
        uint threshold;
        uint quorum;
        string endpoint;
        string path;
        uint decimals;
    }

  • Description: A structure that stores details about a request.

  • Fields:

    • ids: An array of unique identifiers for the request.

    • morpheus: An array of addresses for the Morpheus oracles.

    • threshold: The time threshold for the data.

    • quorum: The minimum number of data points required to form a consensus.

request

  • Description: A mapping that maps a unique requestPortalID to a requeststruct, storing the details of each request.

  • Usage: Used internally to store and retrieve details of each portal request.

How to use:

  1. Initiating a Portal Request:

    If you want to request data feeds from multiple Morpheus oracles, use the requestFeedPortal function. Provide the required parameters, such as the addresses of the oracles, API endpoint details, decimals, threshold, and quorum. Once executed, the function will return a unique requestPortalID.

  2. Retrieving Data from a Portal Request:

    After creating a portal request, you can retrieve the consolidated data by calling getFeedPortal. Provide the requestPortalID as a parameter, and the function will return the consolidated data.

  3. Updating a Portal Request:

    If you need to update the data from the Morpheus oracles in an existing portal request, call the updatePortal function. Specify the requestPortalID and send the required amount of Ether as the bounty. The function will update the data based on the provided bounty.t

Portals: An Overview

Portals act as a standardized and easy to use template for oracle requests across multiple oracles, while allowing for full customizability and independance. Think of them as "presets" or "templates" for oracle lookups. These presets allow for the consistent and streamlined access to external data.

Key Aspects of Portals:

  1. Ease of Use:

    • Portals standardize oracle requests. Instead of crafting a unique oracle request every time, users can simply invoke a portal with a known set of parameters. This makes it much simpler for developers and contracts to get the information they need without reinventing the wheel each time or storing unneeded data thats only needed once.

  2. Sharing & Reusability:

    • Developers or data providers can create specific portal presets that are known to be reliable and share them across the community. This allows for reuse, where others can leverage these established portals instead of creating their own. These portals can also be shared around to get use for oracles or to create easy to use plug and play requests and lookup.

    • By establishing a shared set of portal presets, it ensures that there's consistency in the data being accessed across different contracts or platforms.

  3. Simplified Data Retrieval:

    • Portals abstract away much of the complexity involved in making oracle requests. This means contracts or developers don't need to understand the intricacies of each oracle or external data source; they just interact with the portal.

  4. Transparency:

    • Given that these portals are onchain, every access or data pull is transparent and can be audited. This ensures that there's no malicious or unintentional alteration of data during its retrieval.

    • It provides a clear history of data access patterns, ensuring that stakeholders can verify the data's provenance and the reliability of its source.

Conclusion

The MetaMorph contract is a powerful tool that allows developers to fetch, validate, and process data from multiple, independent oracles in a decentralized and customizable way. By leveraging features like threshold checks, quorum requirements, and callback functionality, developers can ensure that their data is secure and decentralized.

Sample Callback

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.0;

// The MetaMorph interface interface
interface IMetaMorph {
    function requestFeedCallback(
        address[] memory morpheus,
        string memory APIendpoint,
        string memory APIendpointPath,
        uint256 decimals,
        uint256[] memory bounties,
        uint threshold,
        uint quorum,
        address receiveAddrs,
        uint256 bountyGuardian
    ) external payable returns (uint256[] memory,uint requestID);

    function refillRequest(uint256 ID, uint bountyGuardian) external payable;
}

contract MyContract {
    IMetaMorph public metamorph; // This is the data we're interested in
    uint256 public receivedData;
    uint bounties = 3;
    uint requestID;
    // Event to log the received data
    event DataReceived(uint256 data);

    // Set the address of the MetaMorph contract on deployment
    constructor(address _metamorph) {
        metamorph = IMetaMorph(_metamorph);
        requestData();
    }

    // Request data from the MetaMorph contract
    function requestData() internal {
        address[] memory morpheus = new address[](3);
        morpheus[0] = 0x0000000000071821e8033345A7Be174647bE0706; // replace with actual oracle address
        morpheus[1] = 0x0000000000071821e8033345A7Be174647bE0706; // replace with actual oracle address
        morpheus[2] = 0x0000000000071821e8033345A7Be174647bE0706; // replace with actual oracle address
        uint256[] memory bounty = new uint256[](3);
        bounty[0] = 0.001 ether; // replace with actual bounty
        bounty[1] = 0.001 ether; // replace with actual bounty
        bounty[2] = 0.001 ether; // replace with actual bounty
        (,requestID) = metamorph.requestFeedCallback{value: 0.004 ether}(
            morpheus,
            "https://api.example.com",
            "pathtodata",
            2, //dec
            bounty,
            600,
            2,
            address(this),
            0.001 ether
        );
    }

    // Refresh data from the MetaMorph contract
    function refreshData() public payable {
        metamorph.refillRequest{value: msg.value}(
            requestID,
            msg.value - ((msg.value * bounties) / (bounties + 2))
        );
    }

    // The callback function that the MetaMorph contract will call
    function requestCallback(
        uint256 data,
        string calldata strdata,
        bytes calldata bytesdata,
        uint timestamp,
        uint reqID
    ) external {
        // Ensure the call is coming from the MetaMorph contract
        require(
            msg.sender == address(metamorph),
            "Only MetaMorph can call this function"
        );
        require(requestID == reqID, "Request mismatch");
        receivedData = data;
        // Emit the event
        emit DataReceived(data);
    }
}

PreviousSample Templates for ContractsNextVRF Hash RanCh

Last updated