Class Oracle

constructor

• new Oracle(
      account: AccountBase,
      options: OracleRegisterOptions & OracleExtendTtlOptions & {
          includeResponded?: boolean;
          interval?: number;
      } & Partial<
          { _expectedMineRate?: number; _microBlockCycle?: number; onNode: Node },
      > & OracleRespondToQueryOptions & { onNode: Node },
  ): Oracle

  Parameters

  • account: AccountBase

    Account to use as oracle
  • options: OracleRegisterOptions & OracleExtendTtlOptions & {
        includeResponded?: boolean;
        interval?: number;
    } & Partial<
        { _expectedMineRate?: number; _microBlockCycle?: number; onNode: Node },
    > & OracleRespondToQueryOptions & { onNode: Node }

    Options object

  Returns Oracle

Readonlyaccount

extendTtl

• extendTtl(options?: OracleExtendTtlOptions): Promise<SendTransactionReturnType>

  Extend oracle ttl

  Parameters

  • options: OracleExtendTtlOptions = {}

    Options object

  Returns Promise<SendTransactionReturnType>

handleQueries

• handleQueries(
      getResponse: (q: OracleQuery) => string | Promise<string>,
      options?: { includeResponded?: boolean; interval?: number } & Partial<
          { _expectedMineRate?: number; _microBlockCycle?: number; onNode: Node },
      > & OracleRespondToQueryOptions,
  ): () => void

  Respond to queries to oracle based on callback value

  Parameters

  • getResponse: (q: OracleQuery) => string | Promise<string>

    Callback to respond on query
  • options: { includeResponded?: boolean; interval?: number } & Partial<
        { _expectedMineRate?: number; _microBlockCycle?: number; onNode: Node },
    > & OracleRespondToQueryOptions = {}

    Options object

    • OptionalincludeResponded?: boolean

    • Optionalinterval?: number

      Poll interval (default: 5000)

    • interval

      Poll interval (default: 5000)

    • Optional_canIncreaseFee?: boolean

    • Optional_expectedMineRate?: number

    • Optional_isInternalBuild?: boolean

    • Optional_microBlockCycle?: number

    • OptionalabsoluteTtl?: boolean

    • OptionalaeppOrigin?: string

    • OptionalaeppRpcClientId?: string

    • OptionalauthData?: AuthData | (tx: `tx_${string}`) => Promise<AuthData>

    • Optionalblocks?: number

    • Optionalconfirm?: number | boolean

      Number of micro blocks that should be mined after tx get included

    • Optionaldenomination?: AE_AMOUNT_FORMATS

    • Optionalfee?: Int

    • OptionalinnerTx?: boolean

    • Optionalinterval?: number

    • OptionalnetworkId?: string

    • Optionalnonce?: number

    • OptionalonCompiler?: CompilerBase

    • OptionalonNode?: Node

    • OptionalresponseTtlType?: delta | block

    • OptionalresponseTtlValue?: number

    • Optionalstrategy?: Enum1

    • Optionalttl?: number

    • Optionalverify?: boolean

      Verify transaction before broadcast, throw error if not

    • Optionalversion?: 1

    • OptionalwaitMined?: boolean

      Ensure that transaction get into block

  Returns () => void

  Callback to stop polling function

pollQueries

• pollQueries(
      onQuery: (query: OracleQuery) => void,
      options?: { includeResponded?: boolean; interval?: number } & Partial<
          { _expectedMineRate?: number; _microBlockCycle?: number; onNode: Node },
      >,
  ): () => void

  Poll for oracle queries

  Parameters

  • onQuery: (query: OracleQuery) => void

    OnQuery callback
  • options: { includeResponded?: boolean; interval?: number } & Partial<
        { _expectedMineRate?: number; _microBlockCycle?: number; onNode: Node },
    > = {}

    Options object

    • OptionalincludeResponded?: boolean

    • Optionalinterval?: number

      Poll interval (default: 5000)

    • interval

      Poll interval (default: 5000)

  Returns () => void

  Callback to stop polling function

register

• register(
      queryFormat: string,
      responseFormat: string,
      options?: OracleRegisterOptions,
  ): Promise<SendTransactionReturnType>

  Register oracle

  Parameters

  • queryFormat: string

    Format of query
  • responseFormat: string

    Format of query response
  • options: OracleRegisterOptions = {}

    Options object

  Returns Promise<SendTransactionReturnType>

respondToQuery

• respondToQuery(
      queryId: `oq_${string}`,
      response: string,
      options?: OracleRespondToQueryOptions,
  ): Promise<SendTransactionReturnType>

  Respond to a query

  Parameters

  • queryId: `oq_${string}`

    Oracle query id
  • response: string

    The response to query
  • options: OracleRespondToQueryOptions = {}

    Options object

  Returns Promise<SendTransactionReturnType>