Class OracleClient

Hierarchy (View Summary)

default
- OracleClient

Index

Constructors

constructor

new OracleClient(
    address: `ok_${string}`,
    options: { onAccount: AccountBase; onNode: Node } & OracleClientPostQueryOptions & {
        interval?: number;
    } & Partial<
        { _expectedMineRate?: number; _microBlockCycle?: number; onNode: Node },
    >,
): OracleClient
Parameters
- address: `ok_${string}`
  Oracle public key
- options: { onAccount: AccountBase; onNode: Node } & OracleClientPostQueryOptions & {
  interval?: number;
  } & Partial<
  { _expectedMineRate?: number; _microBlockCycle?: number; onNode: Node },
  >
  Options object
  - onAccount: AccountBase
    Account to use
  - onNode: Node
    Node to use
  - 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
  - OptionalonAccount?: AccountBase
    Account to use
  - OptionalonCompiler?: CompilerBase
  - OptionalonNode?: Node
    Node to use
  - OptionalqueryFee?: Int
  - OptionalqueryTtlType?: delta | block
  - OptionalqueryTtlValue?: number
  - 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
  - Optionalinterval?: number
  - onAccount
    Account to use
  - onNode
    Node to use
Returns OracleClient
Overrides default.constructor
- Defined in oracle/OracleClient.ts:30

Properties

`Readonly`address

address: `ok_${string}`

Oracle public key

options

options: { onAccount: AccountBase; onNode: Node } & OracleClientPostQueryOptions & {
interval?: number;
} & Partial<
{ _expectedMineRate?: number; _microBlockCycle?: number; onNode: Node },
>

Options object

Methods

getQueries

getQueries(options?: { onNode?: Node }): Promise<OracleQuery[]>
Get oracle queries from the node
Parameters
- options: { onNode?: Node } = {}
  Options object
Returns Promise<OracleQuery[]>
Inherited from default.getQueries
- Defined in oracle/OracleBase.ts:55

getQuery

getQuery(
queryId: `oq_${string}`,
options?: { onNode?: Node },
): Promise<OracleQuery>
Get oracle query entry from the node
Parameters
- queryId: `oq_${string}`
  Oracle query ID
- options: { onNode?: Node } = {}
  Options object
Returns Promise<OracleQuery>
Inherited from default.getQuery
- Defined in oracle/OracleBase.ts:65

getState

getState(options?: { onNode?: Node }): Promise<RegisteredOracle>
Get oracle entry from the node
Parameters
- options: { onNode?: Node } = {}
  Options object
Returns Promise<RegisteredOracle>
Inherited from default.getState
- Defined in oracle/OracleBase.ts:46

pollForResponse

pollForResponse(
    queryId: `oq_${string}`,
    options?: { interval?: number } & Partial<
        { _expectedMineRate?: number; _microBlockCycle?: number; onNode: Node },
    >,
): Promise<string>
Poll for oracle response to query
Parameters
- queryId: `oq_${string}`
  Oracle Query id
- options: { interval?: number } & Partial<
  { _expectedMineRate?: number; _microBlockCycle?: number; onNode: Node },
  > = {}
  Options object
  - Optionalinterval?: number
    Poll interval
  - interval
    Poll interval
Returns Promise<string>
Oracle response
- Defined in oracle/OracleClient.ts:74

postQuery

postQuery(
query: string,
options?: OracleClientPostQueryOptions,
): Promise<SendTransactionReturnType & { queryId: `oq_${string}` }>
Post query to oracle
Parameters
- query: string
  Query to oracle
- options: OracleClientPostQueryOptions = {}
  Options object
Returns Promise<SendTransactionReturnType & { queryId: `oq_${string}` }>
Transaction details and query ID
- Defined in oracle/OracleClient.ts:45

query

query(
    query: string,
    options?: OracleClientPostQueryOptions & { interval?: number } & Partial<
        { _expectedMineRate?: number; _microBlockCycle?: number; onNode: Node },
    >,
): Promise<string>
Post query to oracle and wait for response
Parameters
- query: string
  Query to oracle
- options: OracleClientPostQueryOptions & { interval?: number } & Partial<
  { _expectedMineRate?: number; _microBlockCycle?: number; onNode: Node },
  > = {}
  Options object
Returns Promise<string>
Oracle response
- Defined in oracle/OracleClient.ts:99

Class OracleClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

onAccount: AccountBase

onNode: Node

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

Optionaldenomination?: AE_AMOUNT_FORMATS

Optionalfee?: Int

OptionalinnerTx?: boolean

Optionalinterval?: number

OptionalnetworkId?: string

Optionalnonce?: number

OptionalonAccount?: AccountBase

OptionalonCompiler?: CompilerBase

OptionalonNode?: Node

OptionalqueryFee?: Int

OptionalqueryTtlType?: delta | block

OptionalqueryTtlValue?: number

OptionalresponseTtlType?: delta | block

OptionalresponseTtlValue?: number

Optionalstrategy?: Enum1

Optionalttl?: number

Optionalverify?: boolean

Optionalversion?: 1

OptionalwaitMined?: boolean

Optionalinterval?: number

onAccount

onNode

Returns OracleClient

Properties

Readonlyaddress

options

Methods

getQueries

Parameters

Returns Promise<OracleQuery[]>

getQuery

Parameters

Returns Promise<OracleQuery>

getState

Parameters

Returns Promise<RegisteredOracle>

pollForResponse

Parameters

Optionalinterval?: number

interval

Returns Promise<string>

postQuery

Parameters

Returns Promise<SendTransactionReturnType & { queryId: `oq_${string}` }>

query

Parameters

Returns Promise<string>

Settings

On This Page

`Optional`_canIncreaseFee?: boolean

`Optional`_expectedMineRate?: number

`Optional`_isInternalBuild?: boolean

`Optional`_microBlockCycle?: number

`Optional`absoluteTtl?: boolean

`Optional`aeppOrigin?: string

`Optional`aeppRpcClientId?: string

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

`Optional`blocks?: number

`Optional`confirm?: number | boolean

`Optional`denomination?: AE_AMOUNT_FORMATS

`Optional`fee?: Int

`Optional`innerTx?: boolean

`Optional`interval?: number

`Optional`networkId?: string

`Optional`nonce?: number

`Optional`onAccount?: AccountBase

`Optional`onCompiler?: CompilerBase

`Optional`onNode?: Node

`Optional`queryFee?: Int

`Optional`queryTtlType?: delta | block

`Optional`queryTtlValue?: number

`Optional`responseTtlType?: delta | block

`Optional`responseTtlValue?: number

`Optional`strategy?: Enum1

`Optional`ttl?: number

`Optional`verify?: boolean

`Optional`version?: 1

`Optional`waitMined?: boolean

`Optional`interval?: number

`Readonly`address

`Optional`interval?: number