Class Devnet

A private local instance of a network.

Hierarchy

Devnet

Implements

DevnetHandle

Constructors

constructor

new Devnet(options?): Devnet
Create an object representing a devnet. Must call the respawn method to get it running.
Parameters
- options: Partial<Devnet> = {}
Returns Devnet
- Defined in fadroma-devnet.ts:104

Properties

accounts

accounts: string[] = ...

List of genesis accounts that will be given an initial balance when creating the devnet container for the first time.

chainId

chainId: string

The chain ID that will be passed to the devnet node.

`Optional` containerId

containerId?: string

ID of container if exists

deleteOnExit

deleteOnExit: boolean

Whether to destroy this devnet on exit.

`Optional` dockerfile

dockerfile?: string

Path to Dockerfile to build image

dontMountState

dontMountState: boolean

Whether to skip mounting a local state directory into/out of the container.

`Optional` engine

engine?: Engine

Containerization engine (Docker or Podman).

`Private` exitHandlerSet

exitHandlerSet: boolean = false

Kludge.

host

host: string

The hostname of the API URL.

`Optional` imageTag

imageTag?: string

Name or tag of image if set

`Optional` initScript

initScript?: string

If set, overrides the script that launches the devnet in the container.

keepRunning

keepRunning: boolean

Whether the devnet should remain running after the command ends.

launchTimeout

launchTimeout: number

After how many seconds to throw if container is not ready.

platform

Which kind of devnet to launch

podman

podman: boolean

Whether to use Podman instead of Docker to run the devnet container.

`Optional` port

port?: string | number

The port of the API URL.

portMode

portMode: DevnetPortMode

Which service does the API URL port correspond to.

`Protected` postLaunchWait

postLaunchWait: number = 7

Seconds to wait after first block. Overridable for testing.

protocol

protocol: string

The protocol of the API URL without the trailing colon.

readyPhrase

readyPhrase: string

Once this phrase is encountered in the log output from the container, the devnet is ready to accept requests.

running

running: boolean = false

Is this thing on?

stateDir

stateDir: string

This directory is created to remember the state of the devnet setup.

verbose

verbose: boolean

Whether more detailed output is preferred.

`Protected` waitPort

waitPort: ((__namedParameters) => Promise<void>) = waitPort

Type declaration

- (__namedParameters): Promise<void>
- Overridable for testing.
  Parameters
  - __namedParameters: {
        host: string;
        interval?: number;
        port: number;
        retries?: number;
    }
    - host: string
    - Optional interval?: number
    - port: number
    - Optional retries?: number
  Returns Promise<void>

`Static` RE_NON_PRINTABLE

RE_NON_PRINTABLE: RegExp = ...

Regexp for non-printable characters.

`Static` dockerTags

`Static` dockerfiles

`Static` initScriptMount

initScriptMount: string = 'devnet.init.mjs'

`Static` portModes

Default connection type to expose on each devnet variant.

`Static` readyMessage

`Static` stateFile

stateFile: string = 'devnet.json'

Accessors

container

get container(): undefined | Promise<Container>
Handle to created devnet container

Returns undefined | Promise<Container>
- Defined in fadroma-devnet.ts:201

image

get image(): undefined | Promise<Image>
This should point to the standard production docker image for the network.

Returns undefined | Promise<Image>
- Defined in fadroma-devnet.ts:151

initScriptMount

get initScriptMount(): string
Virtual path inside the container where the init script is mounted.

Returns string
- Defined in fadroma-devnet.ts:158

log

get log(): DevnetConsole
Returns DevnetConsole
- Defined in fadroma-devnet.ts:141

spawnEnv

get spawnEnv(): Record<string, string>
Environment variables in the container.

Returns Record<string, string>
- Defined in fadroma-devnet.ts:163

spawnOptions

get spawnOptions(): {
    env: Record<string, string>;
    exposed: string[];
    extra: {
        AttachStderr: boolean;
        AttachStdin: boolean;
        AttachStdout: boolean;
        Domainname: string;
        HostConfig: {
            Binds: string[];
            NetworkMode: string;
            PortBindings: {};
        };
        Hostname: string;
        Tty: boolean;
    };
}
Options for the container.

Returns {
    env: Record<string, string>;
    exposed: string[];
    extra: {
        AttachStderr: boolean;
        AttachStdin: boolean;
        AttachStdout: boolean;
        Domainname: string;
        HostConfig: {
            Binds: string[];
            NetworkMode: string;
            PortBindings: {};
        };
        Hostname: string;
        Tty: boolean;
    };
}
- env: Record<string, string>
- exposed: string[]
- extra: {
      AttachStderr: boolean;
      AttachStdin: boolean;
      AttachStdout: boolean;
      Domainname: string;
      HostConfig: {
          Binds: string[];
          NetworkMode: string;
          PortBindings: {};
      };
      Hostname: string;
      Tty: boolean;
  }
  - AttachStderr: boolean
  - AttachStdin: boolean
  - AttachStdout: boolean
  - Domainname: string
  - HostConfig: {
        Binds: string[];
        NetworkMode: string;
        PortBindings: {};
    }
    - Binds: string[]
    - NetworkMode: string
    - PortBindings: {}
  - Hostname: string
  - Tty: boolean
- Defined in fadroma-devnet.ts:182

stateFile

get stateFile(): JSONFile<Partial<this>>
This file contains the id of the current devnet container. TODO store multiple containers

Returns JSONFile<Partial<this>>
- Defined in fadroma-devnet.ts:266

url

get url(): URL
The API URL that can be used to talk to the devnet.

Returns URL
Implementation of DevnetHandle.url
- Defined in fadroma-devnet.ts:146

Methods

assertPresence

assertPresence(): Promise<void>
Emit a warning if devnet state is missing.

Returns Promise<void>
Implementation of DevnetHandle.assertPresence
- Defined in fadroma-devnet.ts:208

create

create(): Promise<this>
Create the devnet container and save state.

Returns Promise<this>
- Defined in fadroma-devnet.ts:222

delete

delete(): Promise<this>
Returns Promise<this>
- Defined in fadroma-devnet.ts:320

export

export(repository?, tag?): Promise<string>
Export the state of the devnet as a container image.
Parameters
- Optional repository: string
- Optional tag: string
Returns Promise<string>
- Defined in fadroma-devnet.ts:314

`Private` forceDelete

forceDelete(): Promise<void>
Returns Promise<void>
- Defined in fadroma-devnet.ts:358

getAccount

getAccount(name): Promise<Partial<Agent>>
Get the info for a genesis account, including the mnemonic
Parameters
- name: string
Returns Promise<Partial<Agent>>
Implementation of DevnetHandle.getAccount
- Defined in fadroma-devnet.ts:387

getChain

getChain<C, D>($C?): C
Get a Chain object corresponding to this devnet.
Type Parameters
- C extends Chain
- D extends ChainClass<C>
Parameters
- $C: ChainClass<C> = ...
Returns C
- Defined in fadroma-devnet.ts:378

pause

pause(): Promise<this>
Stop the container.

Returns Promise<this>
- Defined in fadroma-devnet.ts:294

save

save(extra?): Promise<this>
Write the state of the devnet to a file. This saves the info needed to respawn the node
Parameters
- extra: {} = {}
Returns Promise<this>
- Defined in fadroma-devnet.ts:253

`Protected` setExitHandler

setExitHandler(): void
Returns void
- Defined in fadroma-devnet.ts:400

start

start(): Promise<this>
Start the container.

Returns Promise<this>
Implementation of DevnetHandle.start
- Defined in fadroma-devnet.ts:272

`Static` deleteMany

deleteMany(path, ids?): Promise<Devnet[]>
Parameters
- path: string | Path
- Optional ids: string[]
Returns Promise<Devnet[]>
- Defined in fadroma-devnet.ts:423

`Static` load

load(dir, allowInvalid?): Devnet
Restore a Devnet from the info stored in the state file
Parameters
- dir: string | Path
- allowInvalid: boolean = false
Returns Devnet
- Defined in fadroma-devnet.ts:435

`Static` logFilter

logFilter(data): boolean
Filter logs when waiting for the ready phrase.
Parameters
- data: string
Returns boolean
- Defined in fadroma-devnet.ts:496

Class Devnet

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: Partial<Devnet> = {}

Returns Devnet

Properties

accounts

chainId

Optional containerId

deleteOnExit

Optional dockerfile

dontMountState

Optional engine

Private exitHandlerSet

host

Optional imageTag

Optional initScript

keepRunning

launchTimeout

platform

podman

Optional port

portMode

Protected postLaunchWait

protocol

readyPhrase

running

stateDir

verbose

Protected waitPort

Type declaration

Parameters

__namedParameters: { host: string; interval?: number; port: number; retries?: number; }

host: string

Optional interval?: number

port: number

Optional retries?: number

Returns Promise<void>

Static RE_NON_PRINTABLE

Static dockerTags

Static dockerfiles

Static initScriptMount

Static portModes

Static readyMessage

Static stateFile

Accessors

container

Returns undefined | Promise<Container>

image

Returns undefined | Promise<Image>

initScriptMount

Returns string

log

Returns DevnetConsole

spawnEnv

Returns Record<string, string>

spawnOptions

Returns { env: Record<string, string>; exposed: string[]; extra: { AttachStderr: boolean; AttachStdin: boolean; AttachStdout: boolean; Domainname: string; HostConfig: { Binds: string[]; NetworkMode: string; PortBindings: {}; }; Hostname: string; Tty: boolean; }; }

env: Record<string, string>

exposed: string[]

extra: { AttachStderr: boolean; AttachStdin: boolean; AttachStdout: boolean; Domainname: string; HostConfig: { Binds: string[]; NetworkMode: string; PortBindings: {}; }; Hostname: string; Tty: boolean; }

AttachStderr: boolean

AttachStdin: boolean

AttachStdout: boolean

Domainname: string

HostConfig: { Binds: string[]; NetworkMode: string; PortBindings: {}; }

Binds: string[]

NetworkMode: string

PortBindings: {}

Hostname: string

Tty: boolean

stateFile

`Optional` containerId

`Optional` dockerfile

`Optional` engine

`Private` exitHandlerSet

`Optional` imageTag

`Optional` initScript

`Optional` port

`Protected` postLaunchWait

`Protected` waitPort

__namedParameters: {
host: string;
interval?: number;
port: number;
retries?: number;
}

`Optional` interval?: number

`Optional` retries?: number

`Static` RE_NON_PRINTABLE

`Static` dockerTags

`Static` dockerfiles

`Static` initScriptMount

`Static` portModes

`Static` readyMessage

`Static` stateFile

Returns {
env: Record<string, string>;
exposed: string[];
extra: {
AttachStderr: boolean;
AttachStdin: boolean;
AttachStdout: boolean;
Domainname: string;
HostConfig: {
Binds: string[];
NetworkMode: string;
PortBindings: {};
};
Hostname: string;
Tty: boolean;
};
}

extra: {
AttachStderr: boolean;
AttachStdin: boolean;
AttachStdout: boolean;
Domainname: string;
HostConfig: {
Binds: string[];
NetworkMode: string;
PortBindings: {};
};
Hostname: string;
Tty: boolean;
}

HostConfig: {
Binds: string[];
NetworkMode: string;
PortBindings: {};
}

`Optional` repository: string

`Optional` tag: string

`Private` forceDelete

`Protected` setExitHandler

`Static` deleteMany

`Optional` ids: string[]

`Static` load

`Static` logFilter