Class ArchivingModule<TParams, TEventData>`Abstract`

Type Parameters

TParams extends ModuleParams<ArchivingModuleConfig> = ModuleParams<ArchivingModuleConfig>
TEventData extends ModuleEventData = ModuleEventData

Hierarchy

AbstractModule<TParams, TEventData>
- ArchivingModule
  - AbstractSentinel

Implements

Module<TParams, TEventData>

Constructors

constructor

new ArchivingModule<TParams, TEventData>(params): ArchivingModule<TParams, TEventData>
Type Parameters
- TParams extends ModuleParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<{
      archivists?: string[];
      schema: string;
  }, "schema">, undefined> = ModuleParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<{
      archivists?: string[];
      schema: string;
  }, "schema">, undefined>
- TEventData extends ModuleEventData<TEventData> = ModuleEventData
Parameters
- params: TParams
Returns ArchivingModule<TParams, TEventData>
Inherited from AbstractModule.constructor
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:22

Properties

`Protected` `Readonly` _baseModuleQueryAccountPaths

_baseModuleQueryAccountPaths: Record<"network.xyo.query.module.discover" | "network.xyo.query.module.account" | "network.xyo.query.module.subscribe", string>

`Protected` `Readonly` _queryAccounts

_queryAccounts: Record<"network.xyo.query.module.discover" | "network.xyo.query.module.account" | "network.xyo.query.module.subscribe", undefined | AccountInstance>

`Protected` _started

_started: boolean

`Protected` `Readonly` account

account: AccountInstance

`Protected` commitArchivist

commitArchivist: (() => Promise<undefined | ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: string;
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<Omit<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.archivist.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<{
    parents?: ArchivistParents;
    schema: "network.xyo.archivist.config";
    storeParentReads?: boolean;
} & Omit<undefined, "schema">, "schema">, "schema"> & {
    schema: string;
}, "schema">, undefined>, ArchivistModuleEventData>>)

Type declaration

- (): Promise<undefined | ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.archivist.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<{
      parents?: ArchivistParents;
      schema: "network.xyo.archivist.config";
      storeParentReads?: boolean;
  } & Omit<undefined, "schema">, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>, ArchivistModuleEventData>>
- Returns Promise<undefined | ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.archivist.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<{
      parents?: ArchivistParents;
      schema: "network.xyo.archivist.config";
      storeParentReads?: boolean;
  } & Omit<undefined, "schema">, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>, ArchivistModuleEventData>>

`Readonly` downResolver

downResolver: CompositeModuleResolver

eventData

eventData: TEventData

`Protected` `Readonly` moduleConfigQueryValidator

moduleConfigQueryValidator: Queryable<SchemaFields & PayloadFields & BoundWitnessFields & {
    query: string;
    resultSet?: string;
    schema: "network.xyo.boundwitness";
}>

`Readonly` params

params: TParams

`Protected` readArchivist

readArchivist: (() => Promise<undefined | ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: string;
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<Omit<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.archivist.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<{
    parents?: ArchivistParents;
    schema: "network.xyo.archivist.config";
    storeParentReads?: boolean;
} & Omit<undefined, "schema">, "schema">, "schema"> & {
    schema: string;
}, "schema">, undefined>, ArchivistModuleEventData>>)

Type declaration

- (): Promise<undefined | ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.archivist.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<{
      parents?: ArchivistParents;
      schema: "network.xyo.archivist.config";
      storeParentReads?: boolean;
  } & Omit<undefined, "schema">, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>, ArchivistModuleEventData>>
- Returns Promise<undefined | ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.archivist.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<{
      parents?: ArchivistParents;
      schema: "network.xyo.archivist.config";
      storeParentReads?: boolean;
  } & Omit<undefined, "schema">, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>, ArchivistModuleEventData>>

`Protected` `Readonly` supportedQueryValidator

supportedQueryValidator: Queryable<SchemaFields & PayloadFields & BoundWitnessFields & {
    query: string;
    resultSet?: string;
    schema: "network.xyo.boundwitness";
}>

`Readonly` upResolver

upResolver: CompositeModuleResolver

`Protected` writeArchivist

writeArchivist: (() => Promise<undefined | ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: string;
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<Omit<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.archivist.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<{
    parents?: ArchivistParents;
    schema: "network.xyo.archivist.config";
    storeParentReads?: boolean;
} & Omit<undefined, "schema">, "schema">, "schema"> & {
    schema: string;
}, "schema">, undefined>, ArchivistModuleEventData>>)

Type declaration

- (): Promise<undefined | ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.archivist.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<{
      parents?: ArchivistParents;
      schema: "network.xyo.archivist.config";
      storeParentReads?: boolean;
  } & Omit<undefined, "schema">, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>, ArchivistModuleEventData>>
- Returns Promise<undefined | ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.archivist.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<{
      parents?: ArchivistParents;
      schema: "network.xyo.archivist.config";
      storeParentReads?: boolean;
  } & Omit<undefined, "schema">, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>, ArchivistModuleEventData>>

`Static` configSchema

configSchema: string

`Static` `Optional` defaultLogger

defaultLogger?: Logger

Accessors

`Protected` `Abstract` _queryAccountPaths

get _queryAccountPaths(): Record<string, string>
Returns Record<string, string>
Inherited from AbstractModule._queryAccountPaths
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:29

address

get address(): string
Returns string
Implementation of Module.address

Inherited from AbstractModule.address
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:23

allowAnonymous

get allowAnonymous(): boolean
Returns boolean
Inherited from AbstractModule.allowAnonymous
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:24

config

get config(): TParams["config"]
Returns TParams["config"]
Implementation of Module.config

Inherited from AbstractModule.config
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:25

`Protected` logger

get logger(): Logger | Console
Returns Logger | Console
Inherited from AbstractModule.logger
- Defined in protocol/packages/core/dist/types/lib/Base.d.ts:23

queries

get queries(): string[]
Returns string[]
Implementation of Module.queries

Inherited from AbstractModule.queries
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:26

queryAccountPaths

get queryAccountPaths(): Readonly<Record<string, undefined | string>>
Returns Readonly<Record<string, undefined | string>>
Inherited from AbstractModule.queryAccountPaths
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:27

queryAccounts

get queryAccounts(): Readonly<Record<string, undefined | AccountInstance>>
Returns Readonly<Record<string, undefined | AccountInstance>>
Inherited from AbstractModule.queryAccounts
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:28

Methods

`Protected` bindHashes

bindHashes(hashes, schema, account?): PromiseEx<unknown, AccountInstance>
Parameters
- hashes: string[]
- schema: string[]
- Optional account: AccountInstance
Returns PromiseEx<unknown, AccountInstance>
Inherited from AbstractModule.bindHashes
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:39

`Protected` bindHashesInternal

bindHashesInternal(hashes, schema, account?): Promise<SchemaFields & PayloadFields & BoundWitnessFields & {
schema: "network.xyo.boundwitness";
}>
Parameters
- hashes: string[]
- schema: string[]
- Optional account: AccountInstance
Returns Promise<SchemaFields & PayloadFields & BoundWitnessFields & {
schema: "network.xyo.boundwitness";
}>
Inherited from AbstractModule.bindHashesInternal
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:40

`Protected` bindQuery

bindQuery<T>(query, payloads?, account?): PromiseEx<[SchemaFields & PayloadFields & BoundWitnessFields & {
    query: string;
    resultSet?: string;
    schema: "network.xyo.boundwitness";
}, (SchemaFields & PayloadFields & {
    schema: string;
})[]], AccountInstance>
Type Parameters
- T extends SchemaFields & PayloadFields & QueryFields & {
  schema: string;
  } | PayloadWrapper<SchemaFields & PayloadFields & QueryFields & {
  schema: string;
  }>
Parameters
- query: T
- Optional payloads: (SchemaFields & PayloadFields & {
  schema: string;
  })[]
- Optional account: AccountInstance
Returns PromiseEx<[SchemaFields & PayloadFields & BoundWitnessFields & {
    query: string;
    resultSet?: string;
    schema: "network.xyo.boundwitness";
}, (SchemaFields & PayloadFields & {
    schema: string;
})[]], AccountInstance>
Inherited from AbstractModule.bindQuery
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:41

`Protected` bindQueryInternal

bindQueryInternal<T>(query, payloads?, account?): Promise<[SchemaFields & PayloadFields & BoundWitnessFields & {
    query: string;
    resultSet?: string;
    schema: "network.xyo.boundwitness";
}, (SchemaFields & PayloadFields & {
    schema: string;
})[]]>
Type Parameters
- T extends SchemaFields & PayloadFields & QueryFields & {
  schema: string;
  } | PayloadWrapper<SchemaFields & PayloadFields & QueryFields & {
  schema: string;
  }>
Parameters
- query: T
- Optional payloads: (SchemaFields & PayloadFields & {
  schema: string;
  })[]
- Optional account: AccountInstance
Returns Promise<[SchemaFields & PayloadFields & BoundWitnessFields & {
    query: string;
    resultSet?: string;
    schema: "network.xyo.boundwitness";
}, (SchemaFields & PayloadFields & {
    schema: string;
})[]]>
Inherited from AbstractModule.bindQueryInternal
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:42

`Protected` bindQueryResult

bindQueryResult<T>(query, payloads, additionalWitnesses?): PromiseEx<ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>, AccountInstance[]>
Type Parameters
- T extends SchemaFields & PayloadFields & QueryFields & {
  schema: string;
  } | PayloadWrapper<SchemaFields & PayloadFields & QueryFields & {
  schema: string;
  }>
Parameters
- query: T
- payloads: (SchemaFields & PayloadFields & {
  schema: string;
  })[]
- Optional additionalWitnesses: AccountInstance[]
Returns PromiseEx<ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>, AccountInstance[]>
Overrides AbstractModule.bindQueryResult
- Defined in modules/packages/archivist/dist/types/ArchivingModule.d.ts:14

clearListeners

clearListeners(eventNames): void
Parameters
- eventNames: keyof TEventData | (keyof TEventData)[]
Returns void
Implementation of Module.clearListeners

Inherited from AbstractModule.clearListeners
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:7

discover

discover(): Promisable<(SchemaFields & PayloadFields & {
schema: string;
})[], never>
Returns Promisable<(SchemaFields & PayloadFields & {
schema: string;
})[], never>
Inherited from AbstractModule.discover
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:32

emit

emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>
Type Parameters
- TEventName extends string | number | symbol = keyof TEventData
- TEventArgs extends EventArgs = TEventData[TEventName]
Parameters
- eventName: TEventName
- eventArgs: TEventArgs
Returns Promise<void>
Implementation of Module.emit

Inherited from AbstractModule.emit
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:8

emitSerial

emitSerial<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>
Type Parameters
- TEventName extends string | number | symbol = keyof TEventData
- TEventArgs extends EventArgs = TEventData[TEventName]
Parameters
- eventName: TEventName
- eventArgs: TEventArgs
Returns Promise<void>
Implementation of Module.emitSerial

Inherited from AbstractModule.emitSerial
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:9

`Protected` initializeQueryAccounts

initializeQueryAccounts(): void
Returns void
Inherited from AbstractModule.initializeQueryAccounts
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:77

listenerCount

listenerCount(eventNames): number
Parameters
- eventNames: keyof TEventData | (keyof TEventData)[]
Returns number
Implementation of Module.listenerCount

Inherited from AbstractModule.listenerCount
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:10

`Protected` loadAccount

loadAccount(account?): AccountInstance
Parameters
- Optional account: AccountInstance
Returns AccountInstance
Inherited from AbstractModule.loadAccount
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:78

moduleAccountQuery

moduleAccountQuery(): Promisable<(SchemaFields & PayloadFields & {
    address: string;
    name?: string;
    schema: "network.xyo.address";
} | SchemaFields & PayloadFields & {
    address: string;
    previousHash?: string;
    schema: string;
})[], never>
Returns Promisable<(SchemaFields & PayloadFields & {
    address: string;
    name?: string;
    schema: "network.xyo.address";
} | SchemaFields & PayloadFields & {
    address: string;
    previousHash?: string;
    schema: string;
})[], never>
Inherited from AbstractModule.moduleAccountQuery
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:33

off

off<TEventName>(eventNames, listener): void
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<TEventData[TEventName]>
Returns void
Implementation of Module.off

Inherited from AbstractModule.off
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:11

offAny

offAny(listener): void
Parameters
- listener: EventAnyListener<EventArgs>
Returns void
Implementation of Module.offAny

Inherited from AbstractModule.offAny
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:12

on

on<TEventName>(eventNames, listener): (() => void)
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<TEventData[TEventName]>
Returns (() => void)
- - (): void
  - Returns void
Implementation of Module.on

Inherited from AbstractModule.on
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:13

onAny

onAny(listener): (() => void)
Parameters
- listener: EventAnyListener<EventArgs>
Returns (() => void)
- - (): void
  - Returns void
Implementation of Module.onAny

Inherited from AbstractModule.onAny
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:14

once

once<TEventName>(eventName, listener): (() => void)
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventName: TEventName
- listener: EventListener<TEventData[TEventName]>
Returns (() => void)
- - (): void
  - Returns void
Implementation of Module.once

Inherited from AbstractModule.once
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:15

query

query<T, TConfig>(query, payloads?, queryConfig?): Promise<ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>>
Type Parameters
- T extends SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  } = SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  }
- TConfig extends SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema"> = SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema">
Parameters
- query: T
- Optional payloads: (SchemaFields & PayloadFields & {
  schema: string;
  })[]
- Optional queryConfig: TConfig
Returns Promise<ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>>
Implementation of Module.query

Inherited from AbstractModule.query
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:34

`Protected` queryHandler

queryHandler<T, TConfig>(query, payloads?, queryConfig?): Promise<ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>>
Type Parameters
- T extends SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  } = SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  }
- TConfig extends SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema"> = SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema">
Parameters
- query: T
- Optional payloads: (SchemaFields & PayloadFields & {
  schema: string;
  })[]
- Optional queryConfig: TConfig
Returns Promise<ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>>
Inherited from AbstractModule.queryHandler
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:79

queryable

queryable<T, TConfig>(query, payloads?, queryConfig?): boolean
Type Parameters
- T extends SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  } = SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  }
- TConfig extends SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema"> = SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema">
Parameters
- query: T
- Optional payloads: (SchemaFields & PayloadFields & {
  schema: string;
  })[]
- Optional queryConfig: TConfig
Returns boolean
Implementation of Module.queryable

Inherited from AbstractModule.queryable
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:35

`Protected` resolve

resolve<TModule>(filter?): Promise<TModule[]>
Type Parameters
- TModule extends ModuleFields<ModuleParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>> & EventFunctions<ModuleEventData, TModule> = Module<ModuleParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>, ModuleEventData>
Parameters
- Optional filter: ModuleFilter
Returns Promise<TModule[]>
Inherited from AbstractModule.resolve
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:113

`Protected` resolveArchivists

resolveArchivists(): Promise<ArchivistWrapper<ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: string;
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<Omit<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.archivist.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<{
    parents?: ArchivistParents;
    schema: "network.xyo.archivist.config";
    storeParentReads?: boolean;
} & Omit<undefined, "schema">, "schema">, "schema"> & {
    schema: string;
}, "schema">, undefined>, ArchivistModuleEventData>>[]>
Returns Promise<ArchivistWrapper<ArchivistModule<ArchivistParams<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: string;
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<Omit<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.archivist.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<{
    parents?: ArchivistParents;
    schema: "network.xyo.archivist.config";
    storeParentReads?: boolean;
} & Omit<undefined, "schema">, "schema">, "schema"> & {
    schema: string;
}, "schema">, undefined>, ArchivistModuleEventData>>[]>
- Defined in modules/packages/archivist/dist/types/ArchivingModule.d.ts:15

start

start(_timeout?): Promisable<void, never>
Parameters
- Optional _timeout: number
Returns Promisable<void, never>
Implementation of Module.start

Inherited from AbstractModule.start
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:36

started

started(notStartedAction?): boolean
Parameters
- Optional notStartedAction: "error" | "throw" | "warn" | "log" | "none"
Returns boolean
Inherited from AbstractModule.started
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:37

`Protected` stop

stop(_timeout?): Promisable<ArchivingModule<TParams, TEventData>, never>
Parameters
- Optional _timeout: number
Returns Promisable<ArchivingModule<TParams, TEventData>, never>
Inherited from AbstractModule.stop
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:114

`Protected` storeToArchivists

storeToArchivists(payloads): Promise<(SchemaFields & PayloadFields & BoundWitnessFields & {
schema: "network.xyo.boundwitness";
})[]>
Parameters
- payloads: (SchemaFields & PayloadFields & {
  schema: string;
  })[]
Returns Promise<(SchemaFields & PayloadFields & BoundWitnessFields & {
schema: "network.xyo.boundwitness";
})[]>
- Defined in modules/packages/archivist/dist/types/ArchivingModule.d.ts:48

subscribe(_queryAccount?): void
Parameters
- Optional _queryAccount: AccountInstance
Returns void
Inherited from AbstractModule.subscribe
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:38

`Protected` validateConfig

validateConfig(config?, parents?): boolean
Parameters
- Optional config: unknown
- Optional parents: string[]
Returns boolean
Inherited from AbstractModule.validateConfig
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:115

`Static` create

create<TModule>(this, params?): Promise<TModule>
Type Parameters
- TModule extends ModuleFields<ModuleParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>> & EventFunctions<ModuleEventData, TModule>
Parameters
- this: CreatableModule<TModule>
- Optional params: TModule["params"]
Returns Promise<TModule>
Inherited from AbstractModule.create
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:30

`Static` factory

factory<TModule>(this, params?): CreatableModuleFactory<TModule>
Type Parameters
- TModule extends ModuleFields<ModuleParams<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: string;
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<Omit<SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema">, "schema"> & {
      schema: string;
  }, "schema">, undefined>> & EventFunctions<ModuleEventData, TModule>
Parameters
- this: CreatableModule<TModule>
- Optional params: TModule["params"]
Returns CreatableModuleFactory<TModule>
Inherited from AbstractModule.factory
- Defined in modules/packages/module/packages/abstract/dist/types/AbstractModule.d.ts:31

Class ArchivingModule<TParams, TEventData>Abstract

Type Parameters

TParams extends ModuleParams<ArchivingModuleConfig> = ModuleParams<ArchivingModuleConfig>

TEventData extends ModuleEventData = ModuleEventData

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

TEventData extends ModuleEventData<TEventData> = ModuleEventData

Parameters

params: TParams

Returns ArchivingModule<TParams, TEventData>

Properties

Protected Readonly _baseModuleQueryAccountPaths

Protected Readonly _queryAccounts

Protected _started

Protected Readonly account

Protected commitArchivist

Type declaration

Readonly downResolver

eventData

Protected Readonly moduleConfigQueryValidator

Readonly params

Protected readArchivist

Type declaration

Protected Readonly supportedQueryValidator

Readonly upResolver

Protected writeArchivist

Type declaration

Static configSchema

Static Optional defaultLogger

Accessors

Protected Abstract _queryAccountPaths

Returns Record<string, string>

address

Returns string

allowAnonymous

Returns boolean

config

Returns TParams["config"]

Protected logger

Returns Logger | Console

queries

Returns string[]

queryAccountPaths

Returns Readonly<Record<string, undefined | string>>

queryAccounts

Returns Readonly<Record<string, undefined | AccountInstance>>

Methods

Protected bindHashes

Parameters

hashes: string[]

schema: string[]

Optional account: AccountInstance

Returns PromiseEx<unknown, AccountInstance>

Protected bindHashesInternal

Parameters

hashes: string[]

schema: string[]

Optional account: AccountInstance

Returns Promise<SchemaFields & PayloadFields & BoundWitnessFields & { schema: "network.xyo.boundwitness"; }>

Protected bindQuery

Type Parameters

T extends SchemaFields & PayloadFields & QueryFields & { schema: string; } | PayloadWrapper<SchemaFields & PayloadFields & QueryFields & { schema: string; }>

Parameters

query: T

Optional payloads: (SchemaFields & PayloadFields & { schema: string; })[]

Optional account: AccountInstance

Returns PromiseEx<[SchemaFields & PayloadFields & BoundWitnessFields & { query: string; resultSet?: string; schema: "network.xyo.boundwitness"; }, (SchemaFields & PayloadFields & { schema: string; })[]], AccountInstance>

Protected bindQueryInternal

Type Parameters

T extends SchemaFields & PayloadFields & QueryFields & { schema: string; } | PayloadWrapper<SchemaFields & PayloadFields & QueryFields & { schema: string; }>

Parameters

query: T

Class ArchivingModule<TParams, TEventData>`Abstract`

`Protected` `Readonly` _baseModuleQueryAccountPaths

`Protected` `Readonly` _queryAccounts

`Protected` _started

`Protected` `Readonly` account

`Protected` commitArchivist

`Readonly` downResolver

`Protected` `Readonly` moduleConfigQueryValidator

`Readonly` params

`Protected` readArchivist

`Protected` `Readonly` supportedQueryValidator

`Readonly` upResolver

`Protected` writeArchivist

`Static` configSchema

`Static` `Optional` defaultLogger

`Protected` `Abstract` _queryAccountPaths

`Protected` logger

`Protected` bindHashes

`Optional` account: AccountInstance

`Protected` bindHashesInternal

`Optional` account: AccountInstance

Returns Promise<SchemaFields & PayloadFields & BoundWitnessFields & {
schema: "network.xyo.boundwitness";
}>

`Protected` bindQuery

T extends SchemaFields & PayloadFields & QueryFields & {
schema: string;
} | PayloadWrapper<SchemaFields & PayloadFields & QueryFields & {
schema: string;
}>

`Optional` payloads: (SchemaFields & PayloadFields & {
schema: string;
})[]

`Optional` account: AccountInstance

Returns PromiseEx<[SchemaFields & PayloadFields & BoundWitnessFields & {
query: string;
resultSet?: string;
schema: "network.xyo.boundwitness";
}, (SchemaFields & PayloadFields & {
schema: string;
})[]], AccountInstance>

`Protected` bindQueryInternal

T extends SchemaFields & PayloadFields & QueryFields & {
schema: string;
} | PayloadWrapper<SchemaFields & PayloadFields & QueryFields & {
schema: string;
}>

`Optional` payloads: (SchemaFields & PayloadFields & {
schema: string;
})[]

`Optional` account: AccountInstance

Returns Promise<[SchemaFields & PayloadFields & BoundWitnessFields & {
query: string;
resultSet?: string;
schema: "network.xyo.boundwitness";
}, (SchemaFields & PayloadFields & {
schema: string;
})[]]>

`Protected` bindQueryResult

T extends SchemaFields & PayloadFields & QueryFields & {
schema: string;
} | PayloadWrapper<SchemaFields & PayloadFields & QueryFields & {
schema: string;
}>

payloads: (SchemaFields & PayloadFields & {
schema: string;
})[]

`Optional` additionalWitnesses: AccountInstance[]

Returns PromiseEx<ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>, AccountInstance[]>

Returns Promisable<(SchemaFields & PayloadFields & {
schema: string;
})[], never>

`Protected` initializeQueryAccounts

`Protected` loadAccount

`Optional` account: AccountInstance

Returns Promisable<(SchemaFields & PayloadFields & {
address: string;
name?: string;
schema: "network.xyo.address";
} | SchemaFields & PayloadFields & {
address: string;
previousHash?: string;
schema: string;
})[], never>