@xyo-network/filesystem-archivist

Primary SDK for using XYO Protocol 2.0

Install

Using npm:

npm install {{name}}

Using yarn:

yarn add {{name}}

Using pnpm:

pnpm add {{name}}

Using bun:

bun add {{name}}

License

See the LICENSE file for license rights and limitations (LGPL-3.0-only).

Reference

packages

modules

### packages

  ### archivist

    ### packages

      ### filesystem

        ### .temp-typedoc

          ### classes

            ### <a id="FilesystemArchivist"></a>FilesystemArchivist

@xyo-network/filesystem-archivist

Description

Currently only a read-only archivist that loads payloads from filesystem but allows for future expansion to read/write

Extends

• AbstractArchivist<TParams>

Type Parameters

TParams

TParams extends FilesystemArchivistParams = FilesystemArchivistParams

Implements

• ArchivistInstance

Constructors

Constructor

new FilesystemArchivist<TParams>(key, params): FilesystemArchivist<TParams>;

Parameters

key

unknown

params

Partial<TParams & RequiredCreatableParams>

Returns

FilesystemArchivist<TParams>

Inherited from

AbstractArchivist<TParams>.constructor

Properties

uniqueName

readonly static uniqueName: string;

Inherited from

AbstractArchivist.uniqueName

defaultNextLimitSetting

protected static defaultNextLimitSetting: number;

Inherited from

AbstractArchivist.defaultNextLimitSetting

configSchemas

readonly static configSchemas: Schema[];

Overrides

AbstractArchivist.configSchemas

defaultConfigSchema

readonly static defaultConfigSchema: Schema = FilesystemArchivistConfigSchema;

Overrides

AbstractArchivist.defaultConfigSchema

labels

readonly static labels: object;

network.xyo.storage.class

network.xyo.storage.class: string = 'disk';

Overrides

AbstractArchivist.labels

allowRandomAccount

readonly static allowRandomAccount: boolean;

Inherited from

AbstractArchivist.allowRandomAccount

defaultLogger

static defaultLogger: Logger;

Inherited from

AbstractArchivist.defaultLogger

enableLazyLoad

static enableLazyLoad: boolean;

Inherited from

AbstractArchivist.enableLazyLoad

privateConstructorKey

protected static privateConstructorKey: string;

Inherited from

AbstractArchivist.privateConstructorKey

_account

protected _account: AccountInstance | undefined;

Inherited from

AbstractArchivist._account

_cachedManifests

protected _cachedManifests: LRUCache<number, ModuleManifestPayload, unknown>;

Inherited from

AbstractArchivist._cachedManifests

_globalReentrancyMutex

protected _globalReentrancyMutex: Mutex | undefined;

Inherited from

AbstractArchivist._globalReentrancyMutex

_lastError?

protected optional _lastError?: ModuleDetailsError;

Inherited from

AbstractArchivist._lastError

_moduleConfigQueryValidator

protected _moduleConfigQueryValidator: Queryable | undefined;

Inherited from

AbstractArchivist._moduleConfigQueryValidator

_supportedQueryValidator

protected _supportedQueryValidator: Queryable | undefined;

Inherited from

AbstractArchivist._supportedQueryValidator

useNewResolver

readonly static useNewResolver: false = false;

Inherited from

AbstractArchivist.useNewResolver

Accessors

defaultNextLimit

Get Signature

get static defaultNextLimit(): number;

Returns

number

Inherited from

AbstractArchivist.defaultNextLimit

requireAllParents

Get Signature

get requireAllParents(): boolean;

Returns

boolean

Inherited from

AbstractArchivist.requireAllParents

payloadCountGauge

Get Signature

get protected payloadCountGauge(): Gauge<Attributes> | null | undefined;

Returns

Gauge<Attributes> | null | undefined

Inherited from

AbstractArchivist.payloadCountGauge

payloadCountMeter

Get Signature

get protected payloadCountMeter(): Meter | null;

Returns

Meter | null

Inherited from

AbstractArchivist.payloadCountMeter

storeParentReads

Get Signature

get protected storeParentReads(): boolean;

Returns

boolean

Inherited from

AbstractArchivist.storeParentReads

filePath

Get Signature

get filePath(): string;

Returns

string

queries

Get Signature

get queries(): Schema[];

Returns

Schema[]

Implementation of

ArchivistInstance.queries

Overrides

AbstractArchivist.queries

account

Get Signature

get account(): AccountInstance;

Returns

AccountInstance

Implementation of

ArchivistInstance.account

Inherited from

AbstractArchivist.account

additionalSigners

Get Signature

get additionalSigners(): AccountInstance[];

Returns

AccountInstance[]

Inherited from

AbstractArchivist.additionalSigners

address

Get Signature

get address(): Lowercase<string> & object & object;

Returns

Lowercase<string> & object & object

Implementation of

ArchivistInstance.address

Inherited from

AbstractArchivist.address

allowAnonymous

Get Signature

get allowAnonymous(): boolean;

Returns

boolean

Inherited from

AbstractArchivist.allowAnonymous

allowNameResolution

Get Signature

get allowNameResolution(): boolean;

Returns

boolean

Inherited from

AbstractArchivist.allowNameResolution

archiving

Get Signature

get archiving(): 
  | {
  archivists?: ModuleIdentifier[];
  queries?: Schema[];
}
  | undefined;

Returns

| { archivists?: ModuleIdentifier[]; queries?: Schema[]; } | undefined

Inherited from

AbstractArchivist.archiving

archivist

Get Signature

get archivist(): ModuleIdentifier | undefined;

Returns

ModuleIdentifier | undefined

Inherited from

AbstractArchivist.archivist

config

Get Signature

get config(): TParams["config"] & object;

Returns

TParams["config"] & object

Implementation of

ArchivistInstance.config

Inherited from

AbstractArchivist.config

dead

Get Signature

get dead(): boolean;

Returns

boolean

Inherited from

AbstractArchivist.dead

ephemeralQueryAccountEnabled

Get Signature

get ephemeralQueryAccountEnabled(): boolean;

Returns

boolean

Inherited from

AbstractArchivist.ephemeralQueryAccountEnabled

globalReentrancyMutex

Get Signature

get globalReentrancyMutex(): Mutex | undefined;

Returns

Mutex | undefined

Inherited from

AbstractArchivist.globalReentrancyMutex

id

Get Signature

get id(): string;

The name (if specified) or address of the module

Returns

string

Implementation of

ArchivistInstance.id

Inherited from

AbstractArchivist.id

logger

Get Signature

get logger(): Logger | undefined;

Returns

Logger | undefined

Inherited from

AbstractArchivist.logger

priority

Get Signature

get priority(): 2;

Returns

2

Implementation of

ArchivistInstance.priority

Inherited from

AbstractArchivist.priority

reentrancy

Get Signature

get reentrancy(): 
  | {
  action: "skip" | "wait";
  scope: "global";
}
  | undefined;

Returns

| { action: "skip" | "wait"; scope: "global"; } | undefined

Inherited from

AbstractArchivist.reentrancy

statusReporter

Get Signature

get statusReporter(): 
  | ModuleStatusReporter & CreatableStatusReporter<void>
  | undefined;

The status reporter used to broadcast lifecycle changes.

Returns

| ModuleStatusReporter & CreatableStatusReporter<void> | undefined

Inherited from

AbstractArchivist.statusReporter

timestamp

Get Signature

get timestamp(): boolean;

Returns

boolean

Inherited from

AbstractArchivist.timestamp

moduleConfigQueryValidator

Get Signature

get protected moduleConfigQueryValidator(): Queryable;

Returns

Queryable

Inherited from

AbstractArchivist.moduleConfigQueryValidator

supportedQueryValidator

Get Signature

get protected supportedQueryValidator(): Queryable;

Returns

Queryable

Inherited from

AbstractArchivist.supportedQueryValidator

downResolver

Get Signature

get downResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;

Returns

CompositeModuleResolver<CompositeModuleResolverParams>

Inherited from

AbstractArchivist.downResolver

modName

Get Signature

get modName(): string | undefined;

Returns

string | undefined

Implementation of

ArchivistInstance.modName

Inherited from

AbstractArchivist.modName

moduleIdentifierTransformers

Get Signature

get moduleIdentifierTransformers(): ModuleIdentifierTransformer[];

Returns

ModuleIdentifierTransformer[]

Inherited from

AbstractArchivist.moduleIdentifierTransformers

privateResolver

Get Signature

get privateResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;

Returns

CompositeModuleResolver<CompositeModuleResolverParams>

Inherited from

AbstractArchivist.privateResolver

root

Get Signature

get root(): this;

Returns

this

Inherited from

AbstractArchivist.root

timeBudget

Get Signature

get timeBudget(): number | undefined;

Returns

number | undefined

Inherited from

AbstractArchivist.timeBudget

upResolver

Get Signature

get upResolver(): CompositeModuleResolver<CompositeModuleResolverParams>;

Returns

CompositeModuleResolver<CompositeModuleResolverParams>

Inherited from

AbstractArchivist.upResolver

Methods

~~all()~~

all(): Promise<WithStorageMeta<Payload>[]>;

Returns

Promise<WithStorageMeta<Payload>[]>

Deprecated

use next or snapshot instead

Implementation of

ArchivistInstance.all

Inherited from

AbstractArchivist.all

allQuery()

allQuery(account): Promise<ModuleQueryResult>;

deprecated use nextQuery or snapshotQuery instead

Parameters

account

AccountInstance

Returns

Promise<ModuleQueryResult>

Implementation of

ArchivistInstance.allQuery

Inherited from

AbstractArchivist.allQuery

clear()

clear(): Promise<void>;

Returns

Promise<void>

Implementation of

ArchivistInstance.clear

Inherited from

AbstractArchivist.clear

clearQuery()

clearQuery(account): Promise<ModuleQueryResult>;

Parameters

account

AccountInstance

Returns

Promise<ModuleQueryResult>

Implementation of

ArchivistInstance.clearQuery

Inherited from

AbstractArchivist.clearQuery

commit()

commit(): Promise<object[]>;

Returns

Promise<object[]>

Implementation of

ArchivistInstance.commit

Inherited from

AbstractArchivist.commit

commitQuery()

commitQuery(account): Promise<ModuleQueryResult>;

Parameters

account

AccountInstance

Returns

Promise<ModuleQueryResult>

Implementation of

ArchivistInstance.commitQuery

Inherited from

AbstractArchivist.commitQuery

delete()

delete(hashes): Promise<WithStorageMeta<Payload>[]>;

Parameters

hashes

BrandedHash[]

Returns

Promise<WithStorageMeta<Payload>[]>

Implementation of

ArchivistInstance.delete

Inherited from

AbstractArchivist.delete

deleteQuery()

deleteQuery(hashes, account?): Promise<ModuleQueryResult>;

Parameters

hashes

BrandedHash[]

account?

AccountInstance

Returns

Promise<ModuleQueryResult>

Implementation of

ArchivistInstance.deleteQuery

Inherited from

AbstractArchivist.deleteQuery

get()

get(hashes): Promise<WithStorageMeta<Payload>[]>;

Parameters

hashes

BrandedHash[]

Returns

Promise<WithStorageMeta<Payload>[]>

Implementation of

ArchivistInstance.get

Inherited from

AbstractArchivist.get

getQuery()

getQuery(hashes, account?): Promise<ModuleQueryResult>;

Parameters

hashes

BrandedHash[]

account?

AccountInstance

Returns

Promise<ModuleQueryResult>

Implementation of

ArchivistInstance.getQuery

Inherited from

AbstractArchivist.getQuery

insert()

insert(payloads): Promise<WithStorageMeta<Payload>[]>;

Parameters

payloads

Payload[]

Returns

Promise<WithStorageMeta<Payload>[]>

Implementation of

ArchivistInstance.insert

Inherited from

AbstractArchivist.insert

insertQuery()

insertQuery(payloads, account?): Promise<ModuleQueryResult>;

Parameters

payloads

Payload[]

account?

AccountInstance

Returns

Promise<ModuleQueryResult>

Implementation of

ArchivistInstance.insertQuery

Inherited from

AbstractArchivist.insertQuery

next()

next(options?): Promise<WithStorageMeta<Payload>[]>;

Parameters

options?

ArchivistNextOptions

Returns

Promise<WithStorageMeta<Payload>[]>

Implementation of

ArchivistInstance.next

Inherited from

AbstractArchivist.next

nextQuery()

nextQuery(options?, account?): Promise<ModuleQueryResult>;

Parameters

options?

ArchivistNextOptions

account?

AccountInstance

Returns

Promise<ModuleQueryResult>

Implementation of

ArchivistInstance.nextQuery

Inherited from

AbstractArchivist.nextQuery

snapshot()

snapshot(): Promise<ArchivistSnapshotPayload<WithStorageMeta<Payload>, BrandedHash>[]>;

Returns

Promise<ArchivistSnapshotPayload<WithStorageMeta<Payload>, BrandedHash>[]>

Implementation of

ArchivistInstance.snapshot

Inherited from

AbstractArchivist.snapshot

snapshotQuery()

snapshotQuery(account?): Promise<ModuleQueryResult>;

Parameters

account?

AccountInstance

Returns

Promise<ModuleQueryResult>

Inherited from

AbstractArchivist.snapshotQuery

deleteWithConfig()

protected deleteWithConfig(hashes, config?): Promise<WithStorageMeta<Payload>[]>;

Parameters

hashes

BrandedHash[]

config?

ActionConfig

Returns

Promise<WithStorageMeta<Payload>[]>

Inherited from

AbstractArchivist.deleteWithConfig

generateStats()

protected generateStats(): Promisable<ArchivistStatsPayload>;

Returns

Promisable<ArchivistStatsPayload>

Inherited from

AbstractArchivist.generateStats

getFromParent()

protected getFromParent(hashes, archivist): Promise<[WithStorageMeta<Payload>[], BrandedHash[]]>;

Parameters

hashes

BrandedHash[]

archivist

ReadArchivist

Returns

Promise<[WithStorageMeta<Payload>[], BrandedHash[]]>

Inherited from

AbstractArchivist.getFromParent

getFromParents()

protected getFromParents(hashes): Promise<[WithStorageMeta<Payload>[], BrandedHash[]]>;

Parameters

hashes

BrandedHash[]

Returns

Promise<[WithStorageMeta<Payload>[], BrandedHash[]]>

Inherited from

AbstractArchivist.getFromParents

getWithConfig()

protected getWithConfig(hashes, _config?): Promise<WithStorageMeta<Payload>[]>;

Parameters

hashes

BrandedHash[]

_config?

InsertConfig

Returns

Promise<WithStorageMeta<Payload>[]>

Inherited from

AbstractArchivist.getWithConfig

insertQueryHandler()

protected insertQueryHandler<T>(query, payloads?): Promise<WithStorageMeta<Payload>[]>;

Type Parameters

T

T extends QueryBoundWitnessWrapper<Query> = QueryBoundWitnessWrapper<Query>

Parameters

query

T

payloads?

Payload[]

Returns

Promise<WithStorageMeta<Payload>[]>

Inherited from

AbstractArchivist.insertQueryHandler

insertWithConfig()

protected insertWithConfig(payloads, config?): Promise<WithStorageMeta<Payload>[]>;

Parameters

payloads

Payload[]

config?

InsertConfig

Returns

Promise<WithStorageMeta<Payload>[]>

Inherited from

AbstractArchivist.insertWithConfig

nextHandler()

protected nextHandler(_options?): Promisable<WithStorageMeta<Payload>[]>;

Parameters

_options?

ArchivistNextOptions

Returns

Promisable<WithStorageMeta<Payload>[]>

Inherited from

AbstractArchivist.nextHandler

nextWithConfig()

protected nextWithConfig(options?, _config?): Promise<WithStorageMeta<Payload>[]>;

Parameters

options?

ArchivistNextOptions

_config?

InsertConfig

Returns

Promise<WithStorageMeta<Payload>[]>

Inherited from

AbstractArchivist.nextWithConfig

parentArchivists()

protected parentArchivists(): Promise<ArchivistParentInstanceMap>;

Returns

Promise<ArchivistParentInstanceMap>

Inherited from

AbstractArchivist.parentArchivists

payloadCountHandler()

protected payloadCountHandler(): number;

Returns

number

Inherited from

AbstractArchivist.payloadCountHandler

queryHandler()

protected queryHandler<T, TConfig>(
   query, 
   payloads, 
queryConfig?): Promise<ModuleQueryHandlerResult>;

Type Parameters

T

T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness

TConfig

TConfig extends ModuleConfig = ModuleConfig

Parameters

query

T

payloads

Payload[]

queryConfig?

TConfig

Returns

Promise<ModuleQueryHandlerResult>

Inherited from

AbstractArchivist.queryHandler

reportPayloadCount()

protected reportPayloadCount(): void;

Returns

void

Inherited from

AbstractArchivist.reportPayloadCount

snapshotHandler()

protected snapshotHandler(): PromisableArray<ArchivistSnapshotPayload<WithStorageMeta<Payload>, BrandedHash>>;

Returns

PromisableArray<ArchivistSnapshotPayload<WithStorageMeta<Payload>, BrandedHash>>

Inherited from

AbstractArchivist.snapshotHandler

stateHandler()

protected stateHandler(): Promise<Payload[]>;

Returns

Promise<Payload[]>

Inherited from

AbstractArchivist.stateHandler

writeToParent()

protected writeToParent(parent, payloads): Promise<Payload[]>;

Parameters

parent

ArchivistInstance

payloads

Payload[]

Returns

Promise<Payload[]>

Inherited from

AbstractArchivist.writeToParent

writeToParents()

protected writeToParents(payloads): Promise<Payload[]>;

Parameters

payloads

Payload[]

Returns

Promise<Payload[]>

Inherited from

AbstractArchivist.writeToParents

allHandler()

protected allHandler(): PromisableArray<WithStorageMeta<Payload>>;

Returns

PromisableArray<WithStorageMeta<Payload>>

Overrides

AbstractArchivist.allHandler

clearHandler()

protected clearHandler(): void | Promise<void>;

Returns

void | Promise<void>

Overrides

AbstractArchivist.clearHandler

commitHandler()

protected commitHandler(): Promise<object[]>;

Returns

Promise<object[]>

Overrides

AbstractArchivist.commitHandler

deleteHandler()

protected deleteHandler(hashes): PromisableArray<WithStorageMeta<Payload>>;

Parameters

hashes

BrandedHash[]

Returns

PromisableArray<WithStorageMeta<Payload>>

Overrides

AbstractArchivist.deleteHandler

getHandler()

protected getHandler(hashes): Promise<WithStorageMeta<Payload>[]>;

Parameters

hashes

BrandedHash[]

Returns

Promise<WithStorageMeta<Payload>[]>

Overrides

AbstractArchivist.getHandler

insertHandler()

protected insertHandler(payloads): Promise<WithStorageMeta<Payload>[]>;

Parameters

payloads

Payload[]

Returns

Promise<WithStorageMeta<Payload>[]>

Overrides

AbstractArchivist.insertHandler

startHandler()

protected startHandler(): Promise<void>;

Returns

Promise<void>

Overrides

AbstractArchivist.startHandler

_getRootFunction()

static _getRootFunction(funcName): any;

Parameters

funcName

string

Returns

any

Inherited from

AbstractArchivist._getRootFunction

_noOverride()

static _noOverride(functionName): void;

Parameters

functionName

string

Returns

void

Inherited from

AbstractArchivist._noOverride

createHandler()

static createHandler<T>(inInstance): Promise<T & AbstractModule<any, any>>;

Static hook called during creation to perform additional initialization. Override in subclasses to customize post-construction setup.

Type Parameters

T

T extends CreatableInstance<CreatableParams, EventData>

Parameters

inInstance

T

Returns

Promise<T & AbstractModule<any, any>>

The instance, potentially modified

Inherited from

AbstractArchivist.createHandler

determineAccount()

static determineAccount(params): Promise<AccountInstance>;

Parameters

params

account?

AccountInstance | "random"

accountPath?

string

wallet?

WalletInstance

Returns

Promise<AccountInstance>

Inherited from

AbstractArchivist.determineAccount

factory()

static factory<TModule>(this, params?): CreatableModuleFactory<TModule>;

Type Parameters

TModule

TModule extends CreatableModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>

Parameters

this

CreatableModule<TModule>

params?

Partial<TModule["params"]>

Returns

CreatableModuleFactory<TModule>

Inherited from

AbstractArchivist.factory

isAllowedSchema()

static isAllowedSchema(schema): boolean;

Parameters

schema

Schema

Returns

boolean

Inherited from

AbstractArchivist.isAllowedSchema

paramsHandler()

static paramsHandler<T>(inParams?): Promise<T["params"]>;

Static hook called during creation to validate and transform params. Override in subclasses to add default values or validation.

Type Parameters

T

T extends AttachableModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>

Parameters

inParams?

Partial<T["params"]>

Returns

Promise<T["params"]>

The processed params ready for construction

Inherited from

AbstractArchivist.paramsHandler

_getRootFunction()

_getRootFunction(funcName): any;

Parameters

funcName

string

Returns

any

Inherited from

AbstractArchivist._getRootFunction

busy()

busy<R>(closure): Promise<R>;

Type Parameters

R

R

Parameters

closure

() => Promise<R>

Returns

Promise<R>

Inherited from

AbstractArchivist.busy

emit()

emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>;

Emits an event, invoking all registered listeners concurrently.

Type Parameters

TEventName

TEventName extends keyof ArchivistModuleEventData = keyof ArchivistModuleEventData

TEventArgs

TEventArgs extends EventArgs = ArchivistModuleEventData[TEventName]

Parameters

eventName

TEventName

The event to emit.

eventArgs

TEventArgs

The data to pass to listeners.

Returns

Promise<void>

Implementation of

ArchivistInstance.emit

Inherited from

AbstractArchivist.emit

isSupportedQuery()

isSupportedQuery(query, assert?): boolean;

Parameters

query

Schema

assert?

string | boolean

Returns

boolean

Inherited from

AbstractArchivist.isSupportedQuery

previousHash()

previousHash(): Promisable<string | undefined>;

Returns

Promisable<string | undefined>

Implementation of

ArchivistInstance.previousHash

Inherited from

AbstractArchivist.previousHash

query()

query<T, TConfig>(
   query, 
   payloads?, 
queryConfig?): Promise<ModuleQueryResult>;

Type Parameters

T

T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness

TConfig

TConfig extends ModuleConfig = ModuleConfig

Parameters

query

T

payloads?

Payload[]

queryConfig?

TConfig

Returns

Promise<ModuleQueryResult>

Implementation of

ArchivistInstance.query

Inherited from

AbstractArchivist.query

queryable()

queryable<T, TConfig>(
   query, 
   payloads?, 
queryConfig?): Promise<boolean>;

Type Parameters

T

T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness

TConfig

TConfig extends ModuleConfig = ModuleConfig

Parameters

query

T

payloads?

Payload[]

queryConfig?

TConfig

Returns

Promise<boolean>

Implementation of

ArchivistInstance.queryable

Inherited from

AbstractArchivist.queryable

_checkDead()

protected _checkDead(): void;

Returns

void

Inherited from

AbstractArchivist._checkDead

archivistInstance()

Call Signature

protected archivistInstance(): Promise<
  | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
| undefined>;

Returns

Promise< | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload> | undefined>

Inherited from

AbstractArchivist.archivistInstance

Call Signature

protected archivistInstance(required): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>>;

Parameters

required

true

Returns

Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>>

Inherited from

AbstractArchivist.archivistInstance

bindHashes()

protected bindHashes(
   hashes, 
   schema, 
account?): PromiseEx<unknown, AccountInstance>;

Parameters

hashes

BrandedHash[]

schema

Schema[]

account?

AccountInstance

Returns

PromiseEx<unknown, AccountInstance>

Inherited from

AbstractArchivist.bindHashes

bindHashesInternal()

protected bindHashesInternal(
   hashes, 
   schema, 
   account?): Promise<{
  schema: "network.xyo.boundwitness" & object;
  addresses: Lowercase<string> & object & object[];
  payload_hashes: BrandedHash[];
  payload_schemas: BrandedSchema<string>[];
  previous_hashes: (BrandedHash | null)[];
  $destination?: Lowercase<string> & object & object;
  $sourceQuery?: BrandedHash;
  $signatures: (BrandedHex | null)[];
}>;

Parameters

hashes

BrandedHash[]

schema

Schema[]

account?

AccountInstance

Returns

Promise<{ schema: "network.xyo.boundwitness" & object; addresses: Lowercase<string> & object & object[]; payload_hashes: BrandedHash[]; payload_schemas: BrandedSchema<string>[]; previous_hashes: (BrandedHash | null)[]; $destination?: Lowercase<string> & object & object; $sourceQuery?: BrandedHash; $signatures: (BrandedHex | null)[]; }>

Inherited from

AbstractArchivist.bindHashesInternal

bindQuery()

protected bindQuery<T>(
   query, 
   payloads?, 
   account?, 
additionalSigners?): PromiseEx<[UnsignedQueryBoundWitness, Payload[], Payload[]], AccountInstance>;

Type Parameters

T

T extends Query

Parameters

query

T

payloads?

Payload[]

account?

AccountInstance

additionalSigners?

AccountInstance[]

Returns

PromiseEx<[UnsignedQueryBoundWitness, Payload[], Payload[]], AccountInstance>

Inherited from

AbstractArchivist.bindQuery

bindQueryInternal()

protected bindQueryInternal<T>(
   query, 
   payloads?, 
   account?, 
additionalSigners?): Promise<[UnsignedQueryBoundWitness, Payload[], Payload[]]>;

Type Parameters

T

T extends Query

Parameters

query

T

payloads?

Payload[]

account?

AccountInstance

additionalSigners?

AccountInstance[]

Returns

Promise<[UnsignedQueryBoundWitness, Payload[], Payload[]]>

Inherited from

AbstractArchivist.bindQueryInternal

bindQueryResult()

protected bindQueryResult<T>(
   query, 
   payloads, 
   additionalWitnesses?, 
errors?): Promise<ModuleQueryResult>;

Type Parameters

T

T extends Query

Parameters

query

T

payloads

Payload[]

additionalWitnesses?

AccountInstance[]

errors?

ModuleError[]

Returns

Promise<ModuleQueryResult>

Inherited from

AbstractArchivist.bindQueryResult

generateConfigAndAddress()

protected generateConfigAndAddress(_maxDepth?): Promisable<Payload[]>;

Parameters

_maxDepth?

number

Returns

Promisable<Payload[]>

Inherited from

AbstractArchivist.generateConfigAndAddress

generateDescribe()

protected generateDescribe(): Promise<ModuleDescriptionPayload>;

Returns

Promise<ModuleDescriptionPayload>

Inherited from

AbstractArchivist.generateDescribe

~~getArchivist()~~

protected getArchivist(): Promise<
  | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>
| undefined>;

Returns

Promise< | ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload> | undefined>

Deprecated

use archivistInstance() instead

Inherited from

AbstractArchivist.getArchivist

isAllowedArchivingQuery()

protected isAllowedArchivingQuery(schema): boolean;

Parameters

schema

Schema

Returns

boolean

Inherited from

AbstractArchivist.isAllowedArchivingQuery

moduleAddressHandler()

protected moduleAddressHandler(): Promisable<(AddressPayload | AddressPreviousHashPayload)[]>;

Returns

Promisable<(AddressPayload | AddressPreviousHashPayload)[]>

Inherited from

AbstractArchivist.moduleAddressHandler

stopHandler()

protected stopHandler(): Promise<void>;

Override in subclasses to define stop behavior. Throw an error on failure.

Returns

Promise<void>

Inherited from

AbstractArchivist.stopHandler

subscribeHandler()

protected subscribeHandler(): void;

Returns

void

Inherited from

AbstractArchivist.subscribeHandler

validateConfig()

protected validateConfig(config?, parents?): boolean;

Parameters

config?

unknown

parents?

string[]

Returns

boolean

Inherited from

AbstractArchivist.validateConfig

addParent()

addParent(mod): void;

Parameters

mod

ModuleInstance

Returns

void

Implementation of

ArchivistInstance.addParent

Inherited from

AbstractArchivist.addParent

certifyParents()

certifyParents(): Promise<Payload[]>;

Returns

Promise<Payload[]>

Inherited from

AbstractArchivist.certifyParents

createHandler()

createHandler(): Promise<void>;

Returns

Promise<void>

Inherited from

AbstractArchivist.createHandler

manifest()

manifest(maxDepth?): Promise<ModuleManifestPayload>;

Parameters

maxDepth?

number

Returns

Promise<ModuleManifestPayload>

Implementation of

ArchivistInstance.manifest

Inherited from

AbstractArchivist.manifest

manifestQuery()

manifestQuery(account, maxDepth?): Promise<ModuleQueryResult<ModuleManifestPayload>>;

Parameters

account

AccountInstance

maxDepth?

number

Returns

Promise<ModuleQueryResult<ModuleManifestPayload>>

Implementation of

ArchivistInstance.manifestQuery

Inherited from

AbstractArchivist.manifestQuery

moduleAddress()

moduleAddress(): Promise<(AddressPayload | AddressPreviousHashPayload)[]>;

Returns

Promise<(AddressPayload | AddressPreviousHashPayload)[]>

Implementation of

ArchivistInstance.moduleAddress

Inherited from

AbstractArchivist.moduleAddress

parents()

parents(): Promisable<NodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>[]>;

Returns

Promisable<NodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>[]>

Implementation of

ArchivistInstance.parents

Inherited from

AbstractArchivist.parents

privateChildren()

privateChildren(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;

Returns

Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>

Implementation of

ArchivistInstance.privateChildren

Inherited from

AbstractArchivist.privateChildren

publicChildren()

publicChildren(): Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;

Returns

Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>

Implementation of

ArchivistInstance.publicChildren

Inherited from

AbstractArchivist.publicChildren

removeParent()

removeParent(address): void;

Parameters

address

BrandedAddress

Returns

void

Implementation of

ArchivistInstance.removeParent

Inherited from

AbstractArchivist.removeParent

resolve()

Call Signature

resolve(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;

Returns

Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>

Implementation of

ArchivistInstance.resolve

Inherited from

AbstractArchivist.resolve

Call Signature

resolve<T>(all, options?): Promise<T[]>;

Type Parameters

T

T extends ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>> = ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>

Parameters

all

"*"

options?

ModuleFilterOptions<T>

Returns

Promise<T[]>

Implementation of

ArchivistInstance.resolve

Inherited from

AbstractArchivist.resolve

Call Signature

resolve<T>(id, options?): Promise<T | undefined>;

Type Parameters

T

T extends ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>> = ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>

Parameters

id

ModuleIdentifier

options?

ModuleFilterOptions<T>

Returns

Promise<T | undefined>

Implementation of

ArchivistInstance.resolve

Inherited from

AbstractArchivist.resolve

resolveIdentifier()

resolveIdentifier(id, options?): Promise<BrandedAddress | undefined>;

Parameters

id

ModuleIdentifier

options?

ObjectFilterOptions<AnyObject>

Returns

Promise<BrandedAddress | undefined>

Inherited from

AbstractArchivist.resolveIdentifier

resolvePrivate()

Call Signature

resolvePrivate<T>(all, options?): Promise<T[]>;

Type Parameters

T

T extends ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>> = ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>

Parameters

all

"*"

options?

ModuleFilterOptions<T>

Returns

Promise<T[]>

Implementation of

ArchivistInstance.resolvePrivate

Inherited from

AbstractArchivist.resolvePrivate

Call Signature

resolvePrivate<T>(id, options?): Promise<T | undefined>;

Type Parameters

T

T extends ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>> = ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>

Parameters

id

ModuleIdentifier

options?

ModuleFilterOptions<T>

Returns

Promise<T | undefined>

Implementation of

ArchivistInstance.resolvePrivate

Inherited from

AbstractArchivist.resolvePrivate

siblings()

siblings(): Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;

Returns

Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>

Implementation of

ArchivistInstance.siblings

Inherited from

AbstractArchivist.siblings

state()

state(): Promise<Payload[]>;

Returns

Promise<Payload[]>

Implementation of

ArchivistInstance.state

Inherited from

AbstractArchivist.state

stateQuery()

stateQuery(account): Promise<ModuleQueryResult>;

Parameters

account

AccountInstance

Returns

Promise<ModuleQueryResult>

Implementation of

ArchivistInstance.stateQuery

Inherited from

AbstractArchivist.stateQuery

subscribe()

subscribe(_queryAccount?): void;

Parameters

_queryAccount?

AccountInstance

Returns

void

Inherited from

AbstractArchivist.subscribe

manifestHandler()

protected manifestHandler(maxDepth?, _ignoreAddresses?): Promise<ModuleManifestPayload>;

Parameters

maxDepth?

number

_ignoreAddresses?

BrandedAddress[]

Returns

Promise<ModuleManifestPayload>

Inherited from

AbstractArchivist.manifestHandler

resolveArchivingArchivists()

protected resolveArchivingArchivists(): Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>[]>;

Returns

Promise<ArchivistInstance<ArchivistParams<AnyConfigSchema<ArchivistConfig>>, ArchivistModuleEventData, Payload>[]>

Inherited from

AbstractArchivist.resolveArchivingArchivists

sendQuery()

protected sendQuery<T, P, R>(
   queryPayload, 
   payloads?, 
account?): Promise<R[]>;

Type Parameters

T

T extends Query

P

P extends Payload = Payload

R

R extends Payload = Payload

Parameters

queryPayload

T

payloads?

P[]

account?

AccountInstance

Returns

Promise<R[]>

Inherited from

AbstractArchivist.sendQuery

sendQueryRaw()

protected sendQueryRaw<T, P, R>(
   queryPayload, 
   payloads?, 
account?): Promise<ModuleQueryResult<R>>;

Type Parameters

T

T extends Query

P

P extends Payload = Payload

R

R extends Payload = Payload

Parameters

queryPayload

T

payloads?

P[]

account?

AccountInstance

Returns

Promise<ModuleQueryResult<R>>

Inherited from

AbstractArchivist.sendQueryRaw

storeToArchivists()

protected storeToArchivists(payloads): Promise<Payload[]>;

Parameters

payloads

Payload[]

Returns

Promise<Payload[]>

Inherited from

AbstractArchivist.storeToArchivists

          ### interfaces

            ### <a id="FileSystemArchivistData"></a>FileSystemArchivistData

@xyo-network/filesystem-archivist

Properties

payloads

payloads: Payload[];

          ### type-aliases

            ### <a id="FilesystemArchivistConfig"></a>FilesystemArchivistConfig

@xyo-network/filesystem-archivist

type FilesystemArchivistConfig = ArchivistConfig<{
  filePath?: string;
  schema: FilesystemArchivistConfigSchema;
}>;

            ### <a id="FilesystemArchivistConfigSchema"></a>FilesystemArchivistConfigSchema

@xyo-network/filesystem-archivist

type FilesystemArchivistConfigSchema = typeof FilesystemArchivistConfigSchema;

            ### <a id="FilesystemArchivistParams"></a>FilesystemArchivistParams

@xyo-network/filesystem-archivist

type FilesystemArchivistParams = ArchivistParams<AnyConfigSchema<FilesystemArchivistConfig>>;

          ### variables

            ### <a id="FilesystemArchivistConfigSchema"></a>FilesystemArchivistConfigSchema

@xyo-network/filesystem-archivist

const FilesystemArchivistConfigSchema: "network.xyo.archivist.filesystem.config" & object;

Type Declaration

__schema

readonly __schema: true;