Class AbstractTezModule

Hierarchy

AbstractTezModule
- Sotez

Index

Constructors

Properties

_chain _debugMode _provider

Accessors

chain debugMode provider

Methods

query setProvider

Constructors

constructor

new AbstractTezModule(provider: string, chain?: string, debugMode?: boolean): AbstractTezModule
Parameters
- provider: string
- chain: string = 'main'
- debugMode: boolean = false
Returns AbstractTezModule

Properties

_chain

_chain: string

_debugMode

_debugMode: boolean

_provider

_provider: string

Accessors

chain

get chain(): string
Returns string
set chain(value: string): void
Parameters
- value: string
Returns void

debugMode

get debugMode(): boolean
Returns boolean
set debugMode(value: boolean): void
Parameters
- value: boolean
Returns void

provider

get provider(): string
Returns string
set provider(provider: string): void
Parameters
- provider: string
Returns void

Methods

query

query(path: string, payload?: any, method?: string): Promise<any>
Description
Queries a node given a path and payload

Returns
The response of the query

Example
sotez.query(/chains/main/blocks/head) .then(head => console.log(head));
Parameters
- path: string
  
  The RPC path to query
- Optional payload: any
  
  The payload of the query
- Optional method: string
  
  The request method. Either 'GET' or 'POST'
Returns Promise<any>

setProvider

setProvider(provider: string, chain?: string): void
Parameters
- provider: string
- chain: string = ...
Returns void

Generated using TypeDoc