Class ConnectConfig

Connection configuration. Factory for Chain and Agent objects.

Hierarchy

Config
- ConnectConfig
  - Config

Index

Constructors

constructor

new ConnectConfig(options?, environment?): ConnectConfig
Parameters
- options: Partial<ConnectConfig> = {}
- Optional environment: Environment
Returns ConnectConfig
Overrides Config.constructor
- Defined in connect/connect.ts:52

Properties

agentName

agentName: string = ...

Name of stored mnemonic to use for authentication (currently devnet only)

`Optional` chain

chain?: string = ...

Name of chain to use.

`Optional` chainId

chainId?: string

Override chain id.

chainMode

chainMode: ChainMode = ...

Override chain mode.

`Optional` `Readonly` environment

environment?: Environment

log

log: ConnectConsole = ...

Logger handle.

`Optional` mnemonic

mnemonic?: string = ...

Mnemonic to use for authentication. Hidden from logs by default.

scrt

scrt: Config

Secret Network configuration.

`Optional` testnetMnemonic

testnetMnemonic?: string = ...

Mnemonic to use for authentication to testnet.

Methods

getAgent

getAgent<A>(options?): A
Create the Agent instance identified by the configuration.
Type Parameters
- A extends Agent
Parameters
- options: Partial<A> = {}
Returns A
- Defined in connect/connect.ts:121

getChain

getChain<C>(chainToGet?): C
Create the Chain instance specified by the configuration.
Type Parameters
- C extends Chain
Parameters
- chainToGet: undefined | string | ((config) => Chain) = ...
Returns C
- Defined in connect/connect.ts:105

`Protected` getChainId

getChainId(): string
Returns string
- Defined in connect/connect.ts:63

`Protected` getChainMode

getChainMode(): ChainMode
Returns ChainMode
- Defined in connect/connect.ts:73

getFlag

getFlag<T, U>(name, fallback?): T | U
Type Parameters
- T extends boolean
- U
Parameters
- name: string
- Optional fallback: (() => T | U)
  - - (): T | U
    - Returns T | U
Returns T | U
Inherited from Config.getFlag
- Defined in ensuite/toolbox/conf/conf.d.ts:11

getNumber

getNumber<T, U>(name, fallback?): T | U
Type Parameters
- T extends number
- U
Parameters
- name: string
- Optional fallback: (() => T | U)
  - - (): T | U
    - Returns T | U
Returns T | U
Inherited from Config.getNumber
- Defined in ensuite/toolbox/conf/conf.d.ts:13

getString

getString<T, U>(name, fallback?): T | U
Type Parameters
- T extends string
- U
Parameters
- name: string
- Optional fallback: (() => T | U)
  - - (): T | U
    - Returns T | U
Returns T | U
Inherited from Config.getString
- Defined in ensuite/toolbox/conf/conf.d.ts:12

listChains

listChains(): void
List all known chains.

Returns void
- Defined in connect/connect.ts:132

override

override(options): ConnectConfig
Parameters
- options: object
Returns ConnectConfig
Inherited from Config.override
- Defined in ensuite/toolbox/conf/conf.d.ts:10

Class ConnectConfig

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: Partial<ConnectConfig> = {}

Optional environment: Environment

Returns ConnectConfig

Properties

agentName

Optional chain

Optional chainId

chainMode

Optional Readonly environment

log

Optional mnemonic

scrt

Optional testnetMnemonic

Methods

getAgent

Type Parameters

A extends Agent

Parameters

options: Partial<A> = {}

Returns A

getChain

Type Parameters

C extends Chain

Parameters

chainToGet: undefined | string | ((config) => Chain) = ...

Returns C

Protected getChainId

Returns string

Protected getChainMode

Returns ChainMode

getFlag

Type Parameters

T extends boolean

U

Parameters

name: string

Optional fallback: (() => T | U)

Returns T | U

Returns T | U

getNumber

Type Parameters

T extends number

U

Parameters

name: string

Optional fallback: (() => T | U)

Returns T | U

Returns T | U

getString

Type Parameters

T extends string

U

Parameters

name: string

Optional fallback: (() => T | U)

Returns T | U

Returns T | U

listChains

Returns void

override

Parameters

options: object

Returns ConnectConfig

Settings

Member Visibility

Theme

On This Page

`Optional` environment: Environment

`Optional` chain

`Optional` chainId

`Optional` `Readonly` environment

`Optional` mnemonic

`Optional` testnetMnemonic

`Protected` getChainId

`Protected` getChainMode

`Optional` fallback: (() => T | U)

`Optional` fallback: (() => T | U)

`Optional` fallback: (() => T | U)