1
0
mirror of https://github.com/oceanprotocol-archive/squid-js.git synced 2024-02-02 15:31:51 +01:00

Improve Config comments.

This commit is contained in:
Pedro Gutiérrez 2019-05-08 17:23:03 +02:00
parent abd4ccac1e
commit 23d4749b12

View File

@ -2,27 +2,45 @@ import { LogLevel } from "../utils/Logger"
export { LogLevel } from "../utils/Logger"
export class Config {
/* Aquarius Config */
// the url to the aquarius
/**
* Aquarius URL.
* @type {string}
*/
public aquariusUri: string
/* Brizo Config */
// the url to the brizo
/**
* Brizo URL.
* @type {string}
*/
public brizoUri: string
// the address of brizo
/**
* Address of Brizo.
* @type {string}
*/
public brizoAddress?: string
/* Keeper Config */
// the uri to the node we want to connect to, not need if web3Provider is set
/**
* Ethereum node URL.
* @type {string}
*/
public nodeUri?: string
// from outside eg. metamask
/**
* Web3 Provider.
* @type {any}
*/
public web3Provider?: any
// the uri of the secret store to connect to
/**
* Secret Store URL.
* @type {string}
*/
public secretStoreUri: string
/* Squid config */
public verbose: boolean | LogLevel
/**
* Log level.
* @type {boolean | LogLevel}
*/
public verbose?: boolean | LogLevel
}
export default Config