@signumjs/core
Version:
Principal package with functions and models for building Signum Network applications.
37 lines (36 loc) • 1.22 kB
TypeScript
/**
* Copyright (c) 2019 Burst Apps Team
* Modified (c) 2021 Signum Network
*/
import { Http } from '@signumjs/http';
/**
* The settings interface for the BurstService class
*
*/
export interface ChainServiceSettings {
/**
* The node/peer host url with protocol and port, e.g. https://testnet.signum.fun:443
*/
readonly nodeHost: string;
/**
* A list of node/peer hosts that can be chosen of, usually a list of reliable nodes. This is necessary for the automatic
* node selection.
*/
readonly reliableNodeHosts?: string[];
/**
* The relative path the Signum Node Http API endpoint, default is '/api' - must begin with slash.
* Usually, you don't use this.
*/
readonly apiRootUrl?: string;
/**
* The options passed to httpClient
* The default implementation uses axios. In case of a custom client pass your own options.
* see [Axios Configuration](https://github.com/axios/axios#request-config)
*/
readonly httpClientOptions?: any;
/**
* If passed an client instance, it will be used instead of default HttpImpl.
* Good for testing, but usually you won't need this
*/
readonly httpClient?: Http;
}