Class VaultManager

Readonly efsPath

Readonly vaultsPath

cloneVault

• cloneVault(nodeId, vaultNameOrId, tran?, ctx?): Promise<VaultId>

• Clones the contents of a remote vault into a new local vault instance

  Parameters

  • nodeId: NodeId

  • vaultNameOrId: string | VaultId

  • Optional tran: DBTransaction

  • Optional ctx: Partial<ContextTimedInput>

  Returns Promise<VaultId>

closeVault

• closeVault(vaultId, tran?, ctx?): Promise<void>

• Removes a vault from the vault map.

  Parameters

  • vaultId: VaultId

  • Optional tran: DBTransaction

  • Optional ctx: Partial<ContextTimedInput>

  Returns Promise<void>

createVault

• createVault(vaultName, tran?, ctx?): Promise<VaultId>

• Constructs a new Vault instance with a given name and stores it in memory.

  Parameters

  • vaultName: string

  • Optional tran: DBTransaction

  • Optional ctx: Partial<ContextTimedInput>

  Returns Promise<VaultId>

destroyVault

• destroyVault(vaultId, tran?, ctx?): Promise<void>

• Removes the metadata and EFS state of a vault using a given VaultId.

  Parameters

  • vaultId: VaultId

  • Optional tran: DBTransaction

  • Optional ctx: Partial<ContextTimed>

  Returns Promise<void>

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>

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>

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>

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

handleInfoRequest

• handleInfoRequest(vaultId, tran?, ctx?): AsyncGenerator<Buffer, void, void>

• Handler for receiving http GET requests when being cloned or pulled from.

  Parameters

  • vaultId: VaultId

  • Optional tran: DBTransaction

  • Optional ctx: Partial<ContextTimedInput>

  Returns AsyncGenerator<Buffer, void, void>

handlePackRequest

• handlePackRequest(vaultId, body, tran?, ctx?): AsyncGenerator<Buffer, void, void>

• Handler for receiving http POST requests when being cloned or pulled from.

  Parameters

  • vaultId: VaultId

  • body: Buffer[]

  • Optional tran: DBTransaction

  • Optional ctx: Partial<ContextTimedInput>

  Returns AsyncGenerator<Buffer, void, void>

handleScanVaults

• handleScanVaults(nodeId, tran?, ctx?): AsyncGenerator<{
      vaultId: VaultId;
      vaultName: string;
      vaultPermissions: ("clone" | "pull")[];
  }, any, unknown>

• Returns all the shared vaults for a NodeId.

  Parameters

  • nodeId: NodeId

  • Optional tran: DBTransaction

  • Optional ctx: Partial<ContextTimedInput>

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

listVaults

• listVaults(ctx?, tran?): Promise<VaultList>

• Lists the vault name and associated VaultId of all the stored vaults.

  Parameters

  • Optional ctx: Partial<ContextTimed>

  • Optional tran: DBTransaction

  Returns Promise<VaultList>

pullVault

• pullVault(__namedParameters, tran?, ctx?): Promise<void>

• Pulls the contents of a remote vault into an existing vault instance.

  Parameters

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

    • Optional pullNodeId?: NodeId

    • Optional pullVaultNameOrId?: string | VaultId

    • vaultId: VaultId

  • Optional tran: DBTransaction

  • Optional ctx: Partial<ContextTimed>

  Returns Promise<void>

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>

scanVaults

• scanVaults(targetNodeId, ctx?): AsyncGenerator<{
      vaultIdEncoded: VaultIdEncoded;
      vaultName: string;
      vaultPermissions: ("clone" | "pull")[];
  }, any, unknown>

• Retrieves all the vaults for a peer's node.

  Parameters

  • targetNodeId: NodeId

  • Optional ctx: Partial<ContextTimedInput>

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

setWorkerManager

• setWorkerManager(workerManager): void

• Parameters

  • workerManager: PolykeyWorkerManagerInterface

  Returns void

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>

unsetWorkerManager

• unsetWorkerManager(): void

• Returns void

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>

withVaults

• withVaults<T>(vaultIds, f, tran?, ctx?): 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

  • Optional ctx: Partial<ContextTimedInput>

  Returns Promise<T>

withVaultsG

• withVaultsG<T, TReturn, TNext>(vaultIds, g, tran?, ctx?): AsyncGenerator<T, TReturn, TNext>

• Takes a generator and runs it with the listed vaults. Locking is handled automatically.

  Type Parameters

  • T

  • TReturn

  • TNext

  Parameters

  • vaultIds: VaultId[]

    List of vault ID for vaults you wish to use

  • g: ((...args) => AsyncGenerator<T, TReturn, TNext>)

    Generator you wish to run with the provided vaults

    • • (...args): AsyncGenerator<T, TReturn, TNext>

      • Parameters

        • Rest ...args: Vault[]

        Returns AsyncGenerator<T, TReturn, TNext>

  • Optional tran: DBTransaction

  • Optional ctx: Partial<ContextTimedInput>

  Returns AsyncGenerator<T, TReturn, TNext>

Static createVaultManager

• createVaultManager(__namedParameters): Promise<VaultManager>

• Parameters

  • __namedParameters: {
        acl: ACL;
        db: DB;
        fresh?: boolean;
        fs?: FileSystem;
        gestaltGraph: GestaltGraph;
        keyRing: KeyRing;
        logger?: Logger;
        nodeManager: NodeManager;
        notificationsManager: NotificationsManager;
        vaultsPath: string;
    }

    • acl: ACL

    • db: DB

    • Optional fresh?: boolean

    • Optional fs?: FileSystem

    • gestaltGraph: GestaltGraph

    • keyRing: KeyRing

    • Optional logger?: Logger

    • nodeManager: NodeManager

    • notificationsManager: NotificationsManager

    • vaultsPath: string

  Returns Promise<VaultManager>