Class DevnetContainerAbstract

A private local instance of a network, running in a container managed by @fadroma/oci.

Hierarchy (view full)

Implements

Constructors

constructor

Properties

chainId? container created exitHandler? gasToken? genesisAccounts genesisUploads initScript log nodeBinary? nodeHost nodePort? nodePortMode? nodeProtocol onScriptExit paused platformName platformVersion removed running started stateRoot url? verbose waitMore waitPort waitString

Accessors

platform runFile stateDir stateFile

Methods

connect export getIdentity

Constructors

constructor

Properties

Optional chainId

chainId?: string

Chain ID of chain node running inside devnet container.

container

container: Container = ...

Container instance of devnet.

Readonly created

created: Promise<DevnetContainer>

Wait for the devnet to be created.

Optional exitHandler

exitHandler?: ((...args) => void)

The exit handler that cleans up external resources.

Type declaration

    • (...args): void

    • The exit handler that cleans up external resources.

      Parameters

      • Rest ...args: any

      Returns void

Optional gasToken

gasToken?: Native

Denomination of base gas token for this chain.

genesisAccounts

genesisAccounts: Record<string, string | number | bigint> = {}

Initial accounts.

genesisUploads

genesisUploads: Record<string, Partial<CompiledCode>> = {}

Initial uploads.

initScript

initScript: Path = ...

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

log

log: Core.Console = ...

Logger.

Optional nodeBinary

nodeBinary?: string

Name of binary in container to start.

nodeHost

nodeHost: string = 'localhost'

The hostname of the API URL.

Optional nodePort

nodePort?: string | number

The port of the API URL.

Optional nodePortMode

nodePortMode?: APIMode

Which service does the API URL port correspond to.

nodeProtocol

nodeProtocol: string = 'http'

The protocol of the API URL without the trailing colon.

onScriptExit

onScriptExit: "remove" | "pause" | "remain"

What to do with the devnet once the process that has spawned it exits.

  • "remain": the devnet container keeps running
  • "pause": the devnet container is stopped
  • "remove": the devnet container is stopped and removed, along with the state directory

Readonly paused

paused: Promise<DevnetContainer>

Wait for the devnet to be stopped.

platformName

platformName: Platform

Name of devnet platform.

platformVersion

platformVersion: string

Version of devnet platform.

Readonly removed

removed: Promise<DevnetContainer>

Wait for the devnet to be removed.

running

running: boolean = false

Whether the devnet container is started.

Readonly started

started: Promise<DevnetContainer>

Wait for the devnet to be started.

stateRoot

stateRoot: Directory

This directory contains the state of all devnets, e.g. ~/.local/share/fadroma/devnets. The devnet container will create a subdirectory named after the chain ID.

Optional url

url?: string | URL

URL for connecting to a remote devnet.

verbose

verbose: boolean = false

Whether more detailed output is preferred.

waitMore

waitMore: number = 7

Seconds to wait after first block. Tests override this to save time.

waitPort

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

Function that waits for port to open after launching container. Tests override this to save time.

Type declaration

    • (__namedParameters): Promise<void>

    • Function that waits for port to open after launching container. Tests override this to save time.

      Parameters

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

      Returns Promise<void>

waitString

waitString: string = ''

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

Accessors

platform

runFile

  • get runFile(): File

  • This file is created when the container is started. Deleting it tells the script running inside the container to kill the devnet.

    Returns File

stateDir

  • get stateDir(): Directory

  • This directory contains the state of the devnet, such as statefile, runfile, genesis accounts.

    Returns Directory

stateFile

  • get stateFile(): File

  • This file contains the state of the devnet, such as container ID.

    Returns File

Methods

Abstract connect

export

  • export(repository?, tag?): Promise<any>

  • Export the contents of the devnet as a container image.

    Parameters

    • repository: string = ...
    • tag: string = ...

    Returns Promise<any>

getIdentity

  • getIdentity(name): Promise<Partial<Identity> & {
        mnemonic: string;
    }>

  • Get info for named genesis account, including the mnemonic

    Parameters

    • name: string | {
          name?: string;
      }

    Returns Promise<Partial<Identity> & {
        mnemonic: string;
    }>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc