Skip to main content

Engine

Members​

NameTypeDescription
eventsEventEmitterEvent object using the Node.js event emitter API

Methods​

constructor​

Description​

Consumes an instance of Client to instantiate a new Engine.

Example​

  constructor(client: IEngine["client"])

connect​

Description​

TODO

Example​

connect(
  params: EngineTypes.ConnectParams,
): Promise<{ uri?: string; approval: () => Promise<SessionTypes.Struct> }>

pair​

Description​

TODO

Example​

pair(params: EngineTypes.PairParams): Promise<PairingTypes.Struct>

approve​

Description​

TODO

Example​

approve(
  params: EngineTypes.ApproveParams,
): Promise<{ topic: string; acknowledged: () => Promise<SessionTypes.Struct> }>

reject​

Description​

TODO

Example​

reject(params: EngineTypes.RejectParams): Promise<void>

updateAccounts​

Description​

TODO

Example​

updateAccounts(params: EngineTypes.UpdateAccountsParams): Promise<void>

updateNamespaces​

Description​

TODO

Example​

updateNamespaces(params: EngineTypes.UpdateNamespacesParams): Promise<void>

updateExpiry​

Description​

TODO

Example​

updateExpiry(params: EngineTypes.UpdateExpiryParams): Promise<void>

request​

Description​

TODO

Example​

request(params: EngineTypes.RequestParams): Promise<JsonRpcResponse>

respond​

Description​

TODO

Example​

respond(params: EngineTypes.RespondParams): Promise<void>

emit​

Description​

TODO

Example​

emit(params: EngineTypes.EmitParams): Promise<void>

ping​

Description​

TODO

Example​

ping(params: EngineTypes.PingParams): Promise<void>

disconnect​

Description​

TODO

Example​

disconnect(params: EngineTypes.DisconnectParams): Promise<void>