Hierarchy

• ISwitchboardOracle
  • TsNodeOracle

Index

Constructors

• constructor

Properties

• chain
• config
• envVariables
• imageTag
• isActive
• logFile
• logs
• network
• onCloseCallback
• onDataCallback
• onErrorCallback
• oracleProcess
• secretPath
• silent
• sourcePath
• switchboardDirectory
• timestamp

Methods

• addLog
• awaitReady
• getArgs
• kill
• saveLogs
• start
• startAndAwait
• stop
• parseEnvVariables

Constructors

constructor

• new TsNodeOracle(sourcePath: string, config: IOracleConfig): TsNodeOracle

• Overrides ISwitchboardOracle.constructor

  Parameters

  • sourcePath: string

  • config: IOracleConfig

  Returns TsNodeOracle

Properties

readonlychain

chain: Chain

Overrides ISwitchboardOracle.chain

readonlyconfig

config: IOracleConfig

readonlyenvVariables

envVariables: Record<string, string>

Overrides ISwitchboardOracle.envVariables

readonlyimageTag

imageTag: string = "TsNode"

Overrides ISwitchboardOracle.imageTag

isActive

isActive: boolean = true

readonlylogFile

logFile: string

Overrides ISwitchboardOracle.logFile

logs

logs: string[] = []

Overrides ISwitchboardOracle.logs

readonlynetwork

network: Network

Overrides ISwitchboardOracle.network

onCloseCallback

onCloseCallback: (code: number, signal: Signals) => void

Type declaration

• • (code: number, signal: Signals): void

  • Parameters

    • code: number

    • signal: Signals

    Returns void

onDataCallback

onDataCallback: (data: any) => void

Type declaration

• • (data: any): void

  • Parameters

    • data: any

    Returns void

onErrorCallback

onErrorCallback: (error: Error) => void

Type declaration

• • (error: Error): void

  • Parameters

    • error: Error

    Returns void

optionaloracleProcess

oracleProcess?: ChildProcess

readonlysecretPath

secretPath: string

Overrides ISwitchboardOracle.secretPath

readonlysilent

silent: false = false

Overrides ISwitchboardOracle.silent

readonlysourcePath

sourcePath: string

readonlyswitchboardDirectory

switchboardDirectory: string

Overrides ISwitchboardOracle.switchboardDirectory

readonlytimestamp

timestamp: number = ...

Methods

publicaddLog

• addLog(log: string): void

• Inherited from ISwitchboardOracle.addLog

  Parameters

  • log: string

  Returns void

awaitReady

• awaitReady(timeout?: number): Promise<void>

• Overrides ISwitchboardOracle.awaitReady

  @throws

  if timeout is exceeded and oracle heartbeat was never detected

  ---

  Parameters

  • timeout: number = 60

    the number of seconds to await for the oracle to start successfully heartbeating

  Returns Promise<void>

getArgs

• getArgs(): string[]

• Returns string[]

kill

• kill(exitCode?: number | Signals): void

• Overrides ISwitchboardOracle.kill

  Parameters

  • exitCode: number | Signals = "SIGINT"

  Returns void

publicsaveLogs

• saveLogs(): void

• Inherited from ISwitchboardOracle.saveLogs

  Save an array of oracle logs

  ---

  Returns void

start

• start(): Promise<void>

• Overrides ISwitchboardOracle.start

  Returns Promise<void>

publicstartAndAwait

• startAndAwait(timeout?: number): Promise<void>

• Inherited from ISwitchboardOracle.startAndAwait

  Start a Switchboard oracle and await for the oracle to signal readiness.

  @throws

  if timeout is exceeded and oracle heartbeat was never detected

  ---

  Parameters

  • timeout: number = 60

    the number of seconds to await for the oracle to start successfully heartbeating

  Returns Promise<void>

stop

• stop(): boolean

• Overrides ISwitchboardOracle.stop

  Returns boolean

publicstaticparseEnvVariables

• parseEnvVariables(config: IOracleConfig): Record<string, string>

• Inherited from ISwitchboardOracle.parseEnvVariables

  Parameters

  • config: IOracleConfig

  Returns Record<string, string>