Class VaultManager

Hierarchy

CreateDestroyStartStop
- VaultManager

Constructors

constructor

new VaultManager(__namedParameters): VaultManager
Parameters
- __namedParameters: {
      acl: ACL;
      db: DB;
      fs: FileSystem;
      gestaltGraph: GestaltGraph;
      keyRing: KeyRing;
      logger: Logger;
      nodeConnectionManager: NodeConnectionManager;
      notificationsManager: NotificationsManager;
      vaultsPath: string;
  }
  - acl: ACL
  - db: DB
  - fs: FileSystem
  - gestaltGraph: GestaltGraph
  - keyRing: KeyRing
  - logger: Logger
  - nodeConnectionManager: NodeConnectionManager
  - notificationsManager: NotificationsManager
  - vaultsPath: string
Returns VaultManager
Inherited from CreateDestroyStartStop.constructor
- Defined in src/vaults/VaultManager.ts:134

Properties

`Readonly` [initLock]

[initLock]: RWLockWriter

`Protected` acl

acl: ACL

`Protected` db

db: DB

`Protected` efs

efs: EncryptedFS

`Protected` efsDb

efsDb: DB

`Readonly` efsPath

efsPath: string

`Protected` fs

fs: FileSystem

`Protected` gestaltGraph

gestaltGraph: GestaltGraph

`Protected` keyRing

keyRing: KeyRing

`Protected` logger

logger: Logger

`Protected` nodeConnectionManager

nodeConnectionManager: NodeConnectionManager

`Protected` notificationsManager

notificationsManager: NotificationsManager

`Protected` vaultIdGenerator

vaultIdGenerator: (() => VaultId) = ...

Type declaration

- (): VaultId
- Returns VaultId

`Protected` vaultKey

vaultKey: Buffer

`Protected` vaultLocks

vaultLocks: LockBox<RWLockWriter> = ...

`Protected` vaultMap

vaultMap: VaultMap = ...

`Protected` vaultsDbPath

vaultsDbPath: readonly (string | Buffer)[] = ...

`Protected` vaultsNamesDbPath

vaultsNamesDbPath: readonly (string | Buffer)[] = ...

`Readonly` vaultsPath

vaultsPath: string

Accessors

[destroyed]

get [destroyed](): boolean
Returns boolean
Inherited from CreateDestroyStartStop.[destroyed]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:7

[eventHandled]

get [eventHandled](): ReadonlyWeakSet<Event>
Returns ReadonlyWeakSet<Event>
Inherited from CreateDestroyStartStop.[eventHandled]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:7

[eventHandlers]

get [eventHandlers](): ReadonlyMap<string, Set<EventHandlerInfo>>
Returns ReadonlyMap<string, Set<EventHandlerInfo>>
Inherited from CreateDestroyStartStop.[eventHandlers]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:6

[eventTarget]

get [eventTarget](): EventTarget
Returns EventTarget
Inherited from CreateDestroyStartStop.[eventTarget]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:5

[handleEventError]

get [handleEventError](): ((evt) => void)
Returns ((evt) => void)
- - (evt): void
  - Parameters
    - evt: EventError
    Returns void
Inherited from CreateDestroyStartStop.[handleEventError]
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:8

[running]

get [running](): boolean
Returns boolean
Inherited from CreateDestroyStartStop.[running]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:6

[statusP]

get [statusP](): Promise<Status>
Returns Promise<Status>
Inherited from CreateDestroyStartStop.[statusP]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:9

[status]

get [status](): Status
Returns Status
Inherited from CreateDestroyStartStop.[status]
- Defined in node_modules/@matrixai/async-init/dist/CreateDestroyStartStop.d.ts:8

Methods

addEventListener

addEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from CreateDestroyStartStop.addEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:9

cloneVault

cloneVault(nodeId, vaultNameOrId, tran?): Promise<VaultId>
Clones the contents of a remote vault into a new local vault instance
Parameters
- nodeId: NodeId
- vaultNameOrId: string | VaultId
- Optional tran: DBTransaction
Returns Promise<VaultId>
- Defined in src/vaults/VaultManager.ts:684

closeVault

closeVault(vaultId, tran?): Promise<void>
Removes vault from the vault map
Parameters
- vaultId: VaultId
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/vaults/VaultManager.ts:454

createVault

createVault(vaultName, tran?): Promise<VaultId>
Constructs a new vault instance with a given name and stores it in memory
Parameters
- vaultName: string
- Optional tran: DBTransaction
Returns Promise<VaultId>
- Defined in src/vaults/VaultManager.ts:317

destroy

destroy(): Promise<void>
Returns Promise<void>
Inherited from CreateDestroyStartStop.destroy
- Defined in src/vaults/VaultManager.ts:270

destroyVault

destroyVault(vaultId, tran?): Promise<void>
Removes the metadata and EFS state of a vault using a given VaultId
Parameters
- vaultId: VaultId
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/vaults/VaultManager.ts:410

dispatchEvent

dispatchEvent(event): boolean
Parameters
- event: Event
Returns boolean
Inherited from CreateDestroyStartStop.dispatchEvent
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:11

`Protected` existsEFS

existsEFS(): Promise<boolean>
Returns Promise<boolean>
- Defined in src/vaults/VaultManager.ts:1074

`Protected` generateVaultId

generateVaultId(): Promise<VaultId>
Returns Promise<VaultId>
- Defined in src/vaults/VaultManager.ts:974

`Protected` getVault

getVault(vaultId, tran): Promise<VaultInternal>
Parameters
- vaultId: VaultId
- tran: DBTransaction
Returns Promise<VaultInternal>
- Defined in src/vaults/VaultManager.ts:990

getVaultId

getVaultId(vaultName, tran?): Promise<undefined | VaultId>
Retrieves the VaultId associated with a vault name
Parameters
- vaultName: string
- Optional tran: DBTransaction
Returns Promise<undefined | VaultId>
- Defined in src/vaults/VaultManager.ts:563

getVaultMeta

getVaultMeta(vaultId, tran?): Promise<undefined | VaultMetadata>
Retrieves the vault metadata using the VaultId and parses it to return the associated vault name
Parameters
- vaultId: VaultId
- Optional tran: DBTransaction
Returns Promise<undefined | VaultMetadata>
- Defined in src/vaults/VaultManager.ts:370

getVaultName

getVaultName(vaultId, tran?): Promise<undefined | string>
Retrieves the vault name associated with a VaultId
Parameters
- vaultId: VaultId
- Optional tran: DBTransaction
Returns Promise<undefined | string>
- Defined in src/vaults/VaultManager.ts:586

getVaultPermission

getVaultPermission(vaultId, tran?): Promise<Record<NodeId, Partial<Record<"clone" | "pull", null>>>>
Returns a dictionary of VaultActions for each node
Parameters
- vaultId: VaultId
- Optional tran: DBTransaction
Returns Promise<Record<NodeId, Partial<Record<"clone" | "pull", null>>>>
- Defined in src/vaults/VaultManager.ts:603

handleInfoRequest

handleInfoRequest(vaultId, tran?): AsyncGenerator<Buffer, any, unknown>
Handler for receiving http GET requests when being cloned or pulled from
Parameters
- vaultId: VaultId
- Optional tran: DBTransaction
Returns AsyncGenerator<Buffer, any, unknown>
- Defined in src/vaults/VaultManager.ts:802

handlePackRequest

handlePackRequest(vaultId, body, tran?): Promise<[PassThrough, PassThrough]>
Handler for receiving http POST requests when being cloned or pulled from
Parameters
- vaultId: VaultId
- body: Buffer
- Optional tran: DBTransaction
Returns Promise<[PassThrough, PassThrough]>
- Defined in src/vaults/VaultManager.ts:844

handleScanVaults

handleScanVaults(nodeId, tran?): AsyncGenerator<{
    vaultId: VaultId;
    vaultName: string;
    vaultPermissions: ("clone" | "pull")[];
}, any, unknown>
Returns all the shared vaults for a NodeId.
Parameters
- nodeId: NodeId
- Optional tran: DBTransaction
Returns AsyncGenerator<{
    vaultId: VaultId;
    vaultName: string;
    vaultPermissions: ("clone" | "pull")[];
}, any, unknown>
- Defined in src/vaults/VaultManager.ts:924

listVaults

listVaults(tran?): Promise<VaultList>
Lists the vault name and associated VaultId of all the vaults stored
Parameters
- Optional tran: DBTransaction
Returns Promise<VaultList>
- Defined in src/vaults/VaultManager.ts:482

pullVault

pullVault(__namedParameters): Promise<void>
Pulls the contents of a remote vault into an existing vault instance
Parameters
- __namedParameters: {
      pullNodeId?: NodeId;
      pullVaultNameOrId?: string | VaultId;
      tran?: DBTransaction;
      vaultId: VaultId;
  }
  - Optional pullNodeId?: NodeId
  - Optional pullVaultNameOrId?: string | VaultId
  - Optional tran?: DBTransaction
  - vaultId: VaultId
Returns Promise<void>
- Defined in src/vaults/VaultManager.ts:765

removeEventListener

removeEventListener(type, callback, options?): void
Parameters
- type: string
- callback: null | EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from CreateDestroyStartStop.removeEventListener
- Defined in node_modules/@matrixai/events/dist/Evented.d.ts:10

renameVault

renameVault(vaultId, newVaultName, tran?): Promise<void>
Changes the vault name metadata of a VaultId
Parameters
- vaultId: VaultId
- newVaultName: string
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/vaults/VaultManager.ts:503

scanVaults

scanVaults(targetNodeId): AsyncGenerator<{
    vaultIdEncoded: VaultIdEncoded;
    vaultName: string;
    vaultPermissions: ("clone" | "pull")[];
}, any, unknown>
Retrieves all the vaults for a peers node
Parameters
- targetNodeId: NodeId
Returns AsyncGenerator<{
    vaultIdEncoded: VaultIdEncoded;
    vaultName: string;
    vaultPermissions: ("clone" | "pull")[];
}, any, unknown>
- Defined in src/vaults/VaultManager.ts:896

setWorkerManager

setWorkerManager(workerManager): void
Parameters
- workerManager: PolykeyWorkerManagerInterface
Returns void
- Defined in src/vaults/VaultManager.ts:305

`Protected` setupKey

setupKey(tran): Promise<Buffer>
Parameters
- tran: DBTransaction
Returns Promise<Buffer>
- Defined in src/vaults/VaultManager.ts:1058

shareVault

shareVault(vaultId, nodeId, tran?): Promise<void>
Sets clone, pull and scan permissions of a vault for a gestalt and send a notification to this gestalt
Parameters
- vaultId: VaultId
- nodeId: NodeId
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/vaults/VaultManager.ts:627

start

start(__namedParameters?): Promise<void>
Parameters
- __namedParameters: {
  fresh?: boolean;
  } = {}
  - Optional fresh?: boolean
Returns Promise<void>
Inherited from CreateDestroyStartStop.start
- Defined in src/vaults/VaultManager.ts:167

stop

stop(): Promise<void>
Returns Promise<void>
Inherited from CreateDestroyStartStop.stop
- Defined in src/vaults/VaultManager.ts:243

unsetWorkerManager

unsetWorkerManager(): void
Returns void
- Defined in src/vaults/VaultManager.ts:309

unshareVault

unshareVault(vaultId, nodeId, tran?): Promise<void>
Unsets clone, pull and scan permissions of a vault for a gestalt
Parameters
- vaultId: VaultId
- nodeId: NodeId
- Optional tran: DBTransaction
Returns Promise<void>
- Defined in src/vaults/VaultManager.ts:661

withVaults

withVaults<T>(vaultIds, f, tran?): Promise<T>
Takes a function and runs it with the listed vaults. locking is handled automatically
Type Parameters
- T
Parameters
- vaultIds: VaultId[]
  
  List of vault ID for vaults you wish to use
- f: ((...args) => Promise<T>)
  
  Function you wish to run with the provided vaults
  - - (...args): Promise<T>
    - Parameters
      
      Rest ...args: Vault[]
      
      Returns Promise<T>
- Optional tran: DBTransaction
Returns Promise<T>
- Defined in src/vaults/VaultManager.ts:1028

`Static` createVaultManager

createVaultManager(__namedParameters): Promise<VaultManager>
Parameters
- __namedParameters: {
      acl: ACL;
      db: DB;
      fresh?: boolean;
      fs?: FileSystem;
      gestaltGraph: GestaltGraph;
      keyRing: KeyRing;
      logger?: Logger;
      nodeConnectionManager: NodeConnectionManager;
      notificationsManager: NotificationsManager;
      vaultsPath: string;
  }
  - acl: ACL
  - db: DB
  - Optional fresh?: boolean
  - Optional fs?: FileSystem
  - gestaltGraph: GestaltGraph
  - keyRing: KeyRing
  - Optional logger?: Logger
  - nodeConnectionManager: NodeConnectionManager
  - notificationsManager: NotificationsManager
  - vaultsPath: string
Returns Promise<VaultManager>
- Defined in src/vaults/VaultManager.ts:72

Class VaultManager

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { acl: ACL; db: DB; fs: FileSystem; gestaltGraph: GestaltGraph; keyRing: KeyRing; logger: Logger; nodeConnectionManager: NodeConnectionManager; notificationsManager: NotificationsManager; vaultsPath: string; }

acl: ACL

db: DB

fs: FileSystem

gestaltGraph: GestaltGraph

keyRing: KeyRing

logger: Logger

nodeConnectionManager: NodeConnectionManager

notificationsManager: NotificationsManager

vaultsPath: string

Returns VaultManager

Properties

Readonly [initLock]

Protected acl

Protected db

Protected efs

Protected efsDb

Readonly efsPath

Protected fs

Protected gestaltGraph

Protected keyRing

Protected logger

Protected nodeConnectionManager

Protected notificationsManager

Protected vaultIdGenerator

Type declaration

Returns VaultId

Protected vaultKey

Protected vaultLocks

Protected vaultMap

Protected vaultsDbPath

Protected vaultsNamesDbPath

Readonly vaultsPath

Accessors

[destroyed]

Returns boolean

[eventHandled]

Returns ReadonlyWeakSet<Event>

[eventHandlers]

Returns ReadonlyMap<string, Set<EventHandlerInfo>>

[eventTarget]

Returns EventTarget

[handleEventError]

Returns ((evt) => void)

Parameters

evt: EventError

Returns void

[running]

Returns boolean

[statusP]

Returns Promise<Status>

[status]

Returns Status

Methods

addEventListener

Parameters

type: string

callback: null | EventListenerOrEventListenerObject

Optional options: boolean | AddEventListenerOptions

Returns void

cloneVault

Parameters

nodeId: NodeId

vaultNameOrId: string | VaultId

Optional tran: DBTransaction

Returns Promise<VaultId>

closeVault

Parameters

vaultId: VaultId

Optional tran: DBTransaction

__namedParameters: {
acl: ACL;
db: DB;
fs: FileSystem;
gestaltGraph: GestaltGraph;
keyRing: KeyRing;
logger: Logger;
nodeConnectionManager: NodeConnectionManager;
notificationsManager: NotificationsManager;
vaultsPath: string;
}

`Readonly` [initLock]

`Protected` acl

`Protected` db

`Protected` efs

`Protected` efsDb

`Readonly` efsPath

`Protected` fs

`Protected` gestaltGraph

`Protected` keyRing

`Protected` logger

`Protected` nodeConnectionManager

`Protected` notificationsManager

`Protected` vaultIdGenerator

`Protected` vaultKey

`Protected` vaultLocks

`Protected` vaultMap

`Protected` vaultsDbPath

`Protected` vaultsNamesDbPath

`Readonly` vaultsPath

`Optional` options: boolean | AddEventListenerOptions

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Protected` existsEFS

`Protected` generateVaultId

`Protected` getVault

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

`Optional` tran: DBTransaction

Returns AsyncGenerator<{
vaultId: VaultId;
vaultName: string;
vaultPermissions: ("clone" | "pull")[];
}, any, unknown>

`Optional` tran: DBTransaction

__namedParameters: {
pullNodeId?: NodeId;
pullVaultNameOrId?: string | VaultId;
tran?: DBTransaction;
vaultId: VaultId;
}

`Optional` pullNodeId?: NodeId