Class ChainService

constructor

• new ChainService(settings): ChainService

• Creates Service instance

  Parameters

  • settings: ChainServiceSettings

    The settings for the service

  Returns ChainService

settings

query

• query<T>(method, args?, options?): Promise<T>

• Requests a query to the configured chain node

  Type Parameters

  • T

  Parameters

  • method: string

    The method according https://europe.signum.network/api-doc/
  • args: any = {}

    A JSON object which will be mapped to url params
  • Optionaloptions: any

    The optional request configuration for the passed Http client (default is AxiosRequestConfig )

  Returns Promise<T>

  The response data of success

  Throws

  HttpError in case of failure

selectBestHost

• selectBestHost(reconfigure?, timeout?, checkMethod?): Promise<string>

• Selects the fastest responding host from the configured reliable node hosts.

  Parameters

  • reconfigure: boolean = false

    An optional flag to set automatic reconfiguration. Default is false Attention: Reconfiguration works only, if you use the default http client. Otherwise, you need to reconfigure manually!
  • timeout: number = 10_000

    The optional amount of time in milliseconds to check. Default is 10_000
  • checkMethod: string = 'getBlockchainStatus'

    The optional API method to be called. This applies only for GET methods. Default is getBlockchainStatus

  Returns Promise<string>

  Promise resolving to the selected host

  Throws

  Error if no reliable hosts are configured or if all hosts fail

send

• send<T>(method, args?, body?, options?): Promise<T>

• Send data to chain node

  Type Parameters

  • T

  Parameters

  • method: string

    The method according https://europe.signum.network/api-doc/. Note that there are only a few POST methods
  • args: SendArgs = {}

    A JSON object which will be mapped to url params
  • Optionalbody: object

    An object with key value pairs to submit as post body
  • Optionaloptions: any

    The optional request configuration for the passed Http client (default is AxiosRequestConfig )

  Returns Promise<T>

  The response data of success

  Throws

  HttpError in case of failure

toApiEndpoint

• toApiEndpoint(method, data?): string

• Mounts an API conformant endpoint of format <host>?requestType=getBlock&height=123

  Parameters

  • method: string

    The method name for requestType
  • data: object = {}

    A JSON object which will be mapped to url params

  Returns string

  The mounted url (without host)

  See

  https://docs.signum.network/signum/node-http-api