Class OKP4Container<V>

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

Type Parameters

V extends OKP4Version

Hierarchy (view full)

DevnetContainer
- OKP4Container

Index

Constructors

constructor

new OKP4Container<V>(__namedParameters): OKP4Container<V>
Type Parameters
- V extends "5.0"
Parameters
- __namedParameters: Partial<OKP4Container<V> & {
  platformVersion: "5.0";
  }>
Returns OKP4Container<V>
Overrides DevnetContainer.constructor
- Defined in devnet/devnet-okp4.ts:16

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<OKP4Container<V>>

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

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<OKP4Container<V>>

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<OKP4Container<V>>

Wait for the devnet to be removed.

running

running: boolean = false

Whether the devnet container is started.

`Readonly` started

started: Promise<OKP4Container<V>>

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.

`Static` v

v: Record<"5.0", Partial<OKP4Container<"5.0">>> = ...

Supported versions of OKP4.

Accessors

platform

get platform(): string
Returns string
Inherited from DevnetContainer.platform
- Defined in devnet/devnet-base.ts:95

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
Inherited from DevnetContainer.runFile
- Defined in devnet/devnet-base.ts:123

stateDir

get stateDir(): Directory
This directory contains the state of the devnet, such as statefile, runfile, genesis accounts.

Returns Directory
Inherited from DevnetContainer.stateDir
- Defined in devnet/devnet-base.ts:107

stateFile

get stateFile(): File
This file contains the state of the devnet, such as container ID.

Returns File
Inherited from DevnetContainer.stateFile
- Defined in devnet/devnet-base.ts:115

Methods

connect

connect(parameter?): Promise<OKP4Connection>
Obtain a Connection object to this devnet, optionally with a specific Identity.
Parameters
- parameter: string | Partial<OKP4MnemonicIdentity & {
  mnemonic?: string;
  }> = {}
Returns Promise<OKP4Connection>
Overrides DevnetContainer.connect
- Defined in devnet/devnet-okp4.ts:37

export

export(repository?, tag?): Promise<any>
Export the contents of the devnet as a container image.
Parameters
- repository: string = ...
- tag: string = ...
Returns Promise<any>
Inherited from DevnetContainer.export
- Defined in devnet/devnet-base.ts:166

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;
}>
Inherited from DevnetContainer.getIdentity
- Defined in devnet/devnet-base.ts:160

Class OKP4Container<V>

Type Parameters

V extends OKP4Version

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

V extends "5.0"

Parameters

__namedParameters: Partial<OKP4Container<V> & { platformVersion: "5.0"; }>

Returns OKP4Container<V>

Properties

Optional chainId

container

Readonly created

Optional exitHandler

Type declaration

Parameters

Rest ...args: any

Returns void

gasToken

genesisAccounts

genesisUploads

initScript

log

Optional nodeBinary

nodeHost

Optional nodePort

Optional nodePortMode

nodeProtocol

onScriptExit

Readonly paused

platformName

platformVersion

Readonly removed

running

Readonly started

stateRoot

Optional url

verbose

waitMore

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>

waitString

Static v

Accessors

platform

Returns string

runFile

Returns File

stateDir

Returns Directory

stateFile

Returns File

Methods

connect

Parameters

parameter: string | Partial<OKP4MnemonicIdentity & { mnemonic?: string; }> = {}

Returns Promise<OKP4Connection>

export

Parameters

repository: string = ...

tag: string = ...

Returns Promise<any>

getIdentity

Parameters

name: string | { name?: string; }

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

__namedParameters: Partial<OKP4Container<V> & {
platformVersion: "5.0";
}>

`Optional` chainId

`Readonly` created

`Optional` exitHandler

`Rest` ...args: any

`Optional` nodeBinary

`Optional` nodePort

`Optional` nodePortMode

`Readonly` paused

`Readonly` removed

`Readonly` started

`Optional` url

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

`Optional` interval?: number

`Optional` retries?: number

`Static` v

parameter: string | Partial<OKP4MnemonicIdentity & {
mnemonic?: string;
}> = {}

name: string | {
name?: string;
}

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