@iexec/iexec-oracle-factory-wrapper/dist/types/common.d.ts

A wrapper for creating API based oracles for ethereum on the top of iExec

import { AbstractProvider } from 'ethers';
import { EnhancedWallet } from 'iexec';
import { IExecConfigOptions } from 'iexec/IExecConfig';
export type * from '../utils/reactive.js';
/**
 * Ethereum address.
 */
export type Address = string;
/**
 * Ethereum Name Service (ENS) name.
 */
export type ENS = string;
/**
 * ethereum address or ENS name (Ethereum Name Service)
 */
export type AddressOrENS = Address | ENS;
/**
 * Configuration options for OracleFactory.
 */
export type OracleFactoryOptions = {
    oracleContract?: AddressOrENS;
    iexecOptions?: IExecConfigOptions;
    ipfsNode?: string;
    ipfsGateway?: string;
    oracleApp?: AddressOrENS;
    oracleAppWhitelist?: AddressOrENS;
    workerpool?: AddressOrENS;
};
/**
 * Configuration options for OracleReader.
 */
export type OracleReaderOptions = {
    oracleContract?: AddressOrENS;
    ipfsGateway?: string;
    providerOptions?: any;
};
export type Web3SignerProvider = EnhancedWallet;
export type Web3ReadOnlyProvider = AbstractProvider;
export type DataType = 'boolean' | 'string' | 'number' | 'raw';
type ParamsBase = {
    /**
     * API url.
     */
    url: string;
    /**
     * HTTP method.
     */
    method: 'GET' | 'POST' | 'PUT' | 'DELETE';
    /**
     * HTTP request headers.
     */
    headers?: Record<string, string>;
    /**
     * HTTP request body.
     */
    body?: string;
    /**
     * Path to the data in the JSON response of the API.
     */
    JSONPath: string;
    /**
     * Type of data to get from the response of the API.
     */
    dataType: DataType;
};
/**
 * Raw parameters for fetching the data from an API.
 */
export type RawParams = ParamsBase & {
    /**
     * Secret API key to use for the oracle call.
     *
     * The API key will replace any occurrence of the `%API_KEY%` placeholder in the `url`, `headers` and `body`.
     */
    apiKey?: string;
};
/**
 * Oracle set of parameters for fetching the data from an API.
 */
export type ParamSet = ParamsBase & {
    /**
     * Address of the encrypted dataset containing the secret API key to use for the oracle call.
     *
     * The API key will replace any occurrence of the `%API_KEY%` placeholder in the `url`, `headers` and `body`.
     */
    dataset?: Address;
};
/**
 * CID of a ParamSet uploaded on IPFS.
 *
 * The CID is unique for each ParamSet.
 */
export type ParamSetCID = string;
/**
 * Oracle ID computed from the ParamSet of the oracle.
 *
 * The OracleID is unique for each ParamSet.
 */
export type OracleID = string;
/**
 * Parameters for reading data from an oracle.
 */
export type ReadOracleParams = {
    /**
     * Identifier of the oracle to read.
     */
    paramSetOrCidOrOracleId: ParamSet | ParamSetCID | OracleID;
    /**
     * Type of data to read.
     */
    dataType?: DataType;
};
/**
 * Options for reading data from an oracle.
 */
export type ReadOracleOptions = {
    ipfsGateway?: string;
    oracleContract?: Address;
};
/**
 * Response from an oracle query.
 */
export type OracleValue = {
    value: boolean | string | number;
    date: number;
};