BackupManager

@hyperledger/identus-sdk v8.0.0

---

@hyperledger/identus-sdk / overview / BackupManager

Class: BackupManager

Defined in: packages/lib/sdk/src/pluto/backup/BackupManager.ts:13

BackupManager handle the different versions of backup and restore

Constructors

Constructor

new BackupManager(Pluto: Pluto, Repositories: { CredentialMetadata: CredentialMetadataRepository; Credentials: CredentialRepository; DIDKeyLinks: DIDKeyLinkRepository; DIDLinks: DIDLinkRepository; DIDs: DIDRepository; Keys: KeyRepository; LinkSecrets: LinkSecretRepository; Messages: MessageRepository; }): BackupManager

Defined in: packages/lib/sdk/src/pluto/backup/BackupManager.ts:14

Parameters

Parameter	Type
Pluto	Pluto
Repositories	{ CredentialMetadata: CredentialMetadataRepository; Credentials: CredentialRepository; DIDKeyLinks: DIDKeyLinkRepository; DIDLinks: DIDLinkRepository; DIDs: DIDRepository; Keys: KeyRepository; LinkSecrets: LinkSecretRepository; Messages: MessageRepository; }
Repositories.CredentialMetadata	CredentialMetadataRepository
Repositories.Credentials	CredentialRepository
Repositories.DIDKeyLinks	DIDKeyLinkRepository
Repositories.DIDLinks	DIDLinkRepository
Repositories.DIDs	DIDRepository
Repositories.Keys	KeyRepository
Repositories.LinkSecrets	LinkSecretRepository
Repositories.Messages	MessageRepository

Returns

BackupManager

Methods

backup()

backup(version?: "0.0.1"): Promise<{ credentials: { data: string; recovery_id: string; }[]; did_pairs: { alias: string; holder: string; recipient: string; }[]; dids: { alias?: string; did: string; }[]; keys: { did?: string; index?: number; key: string; recovery_id: string; }[]; link_secret?: string; mediators: { holder_did: string; mediator_did: string; routing_did: string; }[]; messages: string[]; version?: "0.0.1"; }>

Defined in: packages/lib/sdk/src/pluto/backup/BackupManager.ts:25

convert stored data to JSON

Parameters

Parameter	Type	Description
version?	"0.0.1"	backup schema version

Returns

Promise<{ credentials: { data: string; recovery_id: string; }[]; did_pairs: { alias: string; holder: string; recipient: string; }[]; dids: { alias?: string; did: string; }[]; keys: { did?: string; index?: number; key: string; recovery_id: string; }[]; link_secret?: string; mediators: { holder_did: string; mediator_did: string; routing_did: string; }[]; messages: string[]; version?: "0.0.1"; }>

---

restore()

restore(backup: { credentials: { data: string; recovery_id: string; }[]; did_pairs: { alias: string; holder: string; recipient: string; }[]; dids: { alias?: string; did: string; }[]; keys: { did?: string; index?: number; key: string; recovery_id: string; }[]; link_secret?: string; mediators: { holder_did: string; mediator_did: string; routing_did: string; }[]; messages: string[]; version?: "0.0.1"; }): Promise<void>

Defined in: packages/lib/sdk/src/pluto/backup/BackupManager.ts:35

convert JSON to stored data

Parameters

Parameter	Type	Description
backup	{ credentials: { data: string; recovery_id: string; }[]; did_pairs: { alias: string; holder: string; recipient: string; }[]; dids: { alias?: string; did: string; }[]; keys: { did?: string; index?: number; key: string; recovery_id: string; }[]; link_secret?: string; mediators: { holder_did: string; mediator_did: string; routing_did: string; }[]; messages: string[]; version?: "0.0.1"; }	-
backup.credentials	{ data: string; recovery_id: string; }[]	-
backup.did_pairs	{ alias: string; holder: string; recipient: string; }[]	-
backup.dids	{ alias?: string; did: string; }[]	-
backup.keys	{ did?: string; index?: number; key: string; recovery_id: string; }[]	-
backup.link_secret?	string	-
backup.mediators	{ holder_did: string; mediator_did: string; routing_did: string; }[]	-
backup.messages	string[]	-
backup.version?	"0.0.1"	-

Returns

Promise<void>