Class RemoteConfigMetadata

Represent the remote config metadata object and handles:

Validation
Reading
Making a migration
Converting from and to plain object

Implements

Index

Constructors

Properties

deploymentName hederaExplorerChartVersion hederaJsonRpcRelayChartVersion hederaMirrorNodeChartVersion hederaPlatformVersion lastUpdateBy lastUpdatedAt namespace soloChartVersion soloVersion state

Accessors

Methods

makeMigration toObject validate fromObject

Constructors

constructor

new RemoteConfigMetadata(
    namespace: string,
    deploymentName: string,
    state: DeploymentStates,
    lastUpdatedAt: Date,
    lastUpdateBy: `${string}@${string}.${string}`,
    soloVersion: string,
    soloChartVersion?: string,
    hederaPlatformVersion?: string,
    hederaMirrorNodeChartVersion?: string,
    hederaExplorerChartVersion?: string,
    hederaJsonRpcRelayChartVersion?: string,
    migration?: Migration,
): RemoteConfigMetadata
Parameters
- namespace: string
- deploymentName: string
- state: DeploymentStates
- lastUpdatedAt: Date
- lastUpdateBy: `${string}@${string}.${string}`
- soloVersion: string
- soloChartVersion: string = ''
- hederaPlatformVersion: string = ''
- hederaMirrorNodeChartVersion: string = ''
- hederaExplorerChartVersion: string = ''
- hederaJsonRpcRelayChartVersion: string = ''
- Optionalmigration: Migration
Returns RemoteConfigMetadata
- Defined in src/core/config/remote/metadata.ts:27

Properties

`Readonly`deploymentName

deploymentName: string

hederaExplorerChartVersion

hederaExplorerChartVersion: string = ''

hederaJsonRpcRelayChartVersion

hederaJsonRpcRelayChartVersion: string = ''

hederaMirrorNodeChartVersion

hederaMirrorNodeChartVersion: string = ''

hederaPlatformVersion

hederaPlatformVersion: string = ''

`Readonly`lastUpdateBy

lastUpdateBy: `${string}@${string}.${string}`

`Readonly`lastUpdatedAt

lastUpdatedAt: Date

`Readonly`namespace

namespace: string

soloChartVersion

soloChartVersion: string = ''

`Readonly`soloVersion

soloVersion: string

`Readonly`state

state: DeploymentStates

Accessors

migration

get migration(): Migration
Retrieves the migration if such exists

Returns Migration
Implementation of RemoteConfigMetadataStructure.migration
- Defined in src/core/config/remote/metadata.ts:55

Methods

makeMigration

makeMigration(email: `${string}@${string}.${string}`, fromVersion: string): void
Simplifies making a migration
Parameters
- email: `${string}@${string}.${string}`
- fromVersion: string
Returns void
- Defined in src/core/config/remote/metadata.ts:48

toObject

toObject(): RemoteConfigMetadataStructure
Converts the class instance to a plain object.

Returns RemoteConfigMetadataStructure
the plain object representation of the class.
Implementation of ToObject.toObject
- Defined in src/core/config/remote/metadata.ts:122

validate

validate(): void
Validates all properties of the class and throws if data is invalid

Returns void
Implementation of Validate.validate
- Defined in src/core/config/remote/metadata.ts:88

`Static`fromObject

fromObject(metadata: RemoteConfigMetadataStructure): RemoteConfigMetadata
Handles conversion from a plain object to instance
Parameters
- metadata: RemoteConfigMetadataStructure
Returns RemoteConfigMetadata
- Defined in src/core/config/remote/metadata.ts:62