Pluto

@hyperledger/identus-sdk v8.1.3

---

@hyperledger/identus-sdk / overview / Domain / Pluto

Interface: Pluto

Defined in: packages/shared/domain/build/index.d.ts:394

Pluto is a storage interface describing storage requirements of the edge agents which will be implemented using this SDK. Implement this interface using your preferred underlying storage technology, most appropriate for your use case.

Extends

• IController

Properties

Property	Type	Description	Inherited from	Defined in
state	State	current status of the entity	IController.state	packages/shared/domain/build/index.d.ts:2311

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/shared/domain/build/index.d.ts:417

create a Backup object from the stored data

Parameters

Parameter	Type
version?	"0.0.1"

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"; }>

---

deleteMessage()

deleteMessage(uuid: string): Promise<void>

Defined in: packages/shared/domain/build/index.d.ts:527

Delete a previously stored messages

Parameters

Parameter	Type
uuid	string

Returns

Promise<void>

---

getAllCredentials()

getAllCredentials(): Promise<Credential[]>

Defined in: packages/shared/domain/build/index.d.ts:511

Retrieve all the stored credentials

Returns

Promise<Credential[]>

---

getAllDidPairs()

getAllDidPairs(): Promise<DIDPair[]>

Defined in: packages/shared/domain/build/index.d.ts:487

Retrieve all stored DID pairs (DIDComm connections).

Returns

Promise<DIDPair[]>

---

getAllMediators()

getAllMediators(): Promise<Mediator[]>

Defined in: packages/shared/domain/build/index.d.ts:507

Retrieve all stored mediators.

Returns

Promise<Mediator[]>

---

getAllMessages()

getAllMessages(): Promise<Message[]>

Defined in: packages/shared/domain/build/index.d.ts:499

Retrieve all stored DIDComm messages.

Returns

Promise<Message[]>

---

getAllPeerDIDs()

getAllPeerDIDs(): Promise<PeerDID[]>

Defined in: packages/shared/domain/build/index.d.ts:479

Retrieve all stored Peer DIDs.

Returns

Promise<PeerDID[]>

---

getAllPrismDIDs()

getAllPrismDIDs(): Promise<PrismDID[]>

Defined in: packages/shared/domain/build/index.d.ts:475

Retrieve all stored PRISM DIDs.

Returns

Promise<PrismDID[]>

---

getCredentialMetadata()

getCredentialMetadata(name: string): Promise<CredentialMetadata | null>

Defined in: packages/shared/domain/build/index.d.ts:431

Fetch the Credential Metadata by its name

Parameters

Parameter	Type	Description
name	string	-

Returns

Promise<CredentialMetadata | null>

---

getDIDByDIDOrAlias()

getDIDByDIDOrAlias(didOrAlias: string): Promise<DID | null>

Defined in: packages/shared/domain/build/index.d.ts:471

Parameters

Parameter	Type
didOrAlias	string

Returns

Promise<DID | null>

---

getDIDPrivateKeysByDID()

getDIDPrivateKeysByDID(did: DID): Promise<PrivateKey[]>

Defined in: packages/shared/domain/build/index.d.ts:483

Retrieve available private keys for a given DID.

Parameters

Parameter	Type
did	DID

Returns

Promise<PrivateKey[]>

---

getLinkSecret()

getLinkSecret(name?: string): Promise<LinkSecret | null>

Defined in: packages/shared/domain/build/index.d.ts:515

Retrieve the stored link secret by its name

Parameters

Parameter	Type
name?	string

Returns

Promise<LinkSecret | null>

---

getMessage()

getMessage(id: string): Promise<Message | null>

Defined in: packages/shared/domain/build/index.d.ts:503

Retrieve a DIDComm message by ID.

Parameters

Parameter	Type
id	string

Returns

Promise<Message | null>

---

getPairByDID()

getPairByDID(did: DID): Promise<DIDPair | null>

Defined in: packages/shared/domain/build/index.d.ts:491

Retrieve a DID pair containing a given DID as either host or receiver.

Parameters

Parameter	Type
did	DID

Returns

Promise<DIDPair | null>

---

getPairByName()

getPairByName(name: string): Promise<DIDPair | null>

Defined in: packages/shared/domain/build/index.d.ts:495

Retrieve a DID pair by a given pair name.

Parameters

Parameter	Type
name	string

Returns

Promise<DIDPair | null>

---

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/shared/domain/build/index.d.ts:422

load the given data into the store

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>

---

revokeCredential()

revokeCredential(credential: Credential): Promise<void>

Defined in: packages/shared/domain/build/index.d.ts:523

Revoke a Credential

Parameters

Parameter	Type
credential	Credential

Returns

Promise<void>

---

start()

start(): Promise<State>

Defined in: packages/shared/domain/build/index.d.ts:2319

handle the startup of an entity

updates state according to lifecycle

Returns

Promise<State>

Inherited from

IController.start

---

stop()

stop(): Promise<State>

Defined in: packages/shared/domain/build/index.d.ts:2327

handle the teardown of an entity

updates state according to lifecycle

Returns

Promise<State>

Inherited from

IController.stop

---

storeCredential()

storeCredential(credential: Credential): Promise<void>

Defined in: packages/shared/domain/build/index.d.ts:470

Store a Credential into the Database

Parameters

Parameter	Type
credential	Credential

Returns

Promise<void>

---

storeCredentialMetadata()

storeCredentialMetadata(metadata: CredentialMetadata): Promise<void>

Defined in: packages/shared/domain/build/index.d.ts:426

Store the Credential Metadata

Parameters

Parameter	Type
metadata	CredentialMetadata

Returns

Promise<void>

---

storeDID()

storeDID(did: DID, keys?: Arrayable<PrivateKey>, alias?: string): Promise<void>

Defined in: packages/shared/domain/build/index.d.ts:436

Store a DID with optional private key(s) and alias

Parameters

Parameter	Type
did	DID
keys?	Arrayable<PrivateKey>
alias?	string

Returns

Promise<void>

---

storeDIDPair()

storeDIDPair(host: DID, receiver: DID, name: string): Promise<void>

Defined in: packages/shared/domain/build/index.d.ts:450

Store a named pair of DIDs representing a DIDComm connection.

Parameters

Parameter	Type
host	DID
receiver	DID
name	string

Returns

Promise<void>

---

storeLinkSecret()

storeLinkSecret(linkSecret: LinkSecret): Promise<void>

Defined in: packages/shared/domain/build/index.d.ts:519

Store a new linkSecret

Parameters

Parameter	Type
linkSecret	LinkSecret

Returns

Promise<void>

---

storeMediator()

storeMediator(mediator: Mediator): Promise<void>

Defined in: packages/shared/domain/build/index.d.ts:466

Store a mediator information.

Parameters

Parameter	Type
mediator	Mediator

Returns

Promise<void>

---

storeMessage()

storeMessage(message: Message): Promise<void>

Defined in: packages/shared/domain/build/index.d.ts:454

Store a DIDComm message.

Parameters

Parameter	Type
message	Message

Returns

Promise<void>

---

storeMessages()

storeMessages(messages: Message[]): Promise<void>

Defined in: packages/shared/domain/build/index.d.ts:458

Store an array of DIDComm messages

Parameters

Parameter	Type
messages	Message[]

Returns

Promise<void>

---

storePeerDID()

storePeerDID(did: DID, privateKeys: PrivateKey[]): Promise<void>

Defined in: packages/shared/domain/build/index.d.ts:446

Store a Peer DID and an array of its privateKeys.

Parameters

Parameter	Type
did	DID
privateKeys	PrivateKey[]

Returns

Promise<void>

Deprecated

use storeDID instead

---

storePrismDID()

storePrismDID(did: DID, privateKey: PrivateKey, alias?: string): Promise<void>

Defined in: packages/shared/domain/build/index.d.ts:441

Store a PRISM DID and its private key with given metadata.

Parameters

Parameter	Type
did	DID
privateKey	PrivateKey
alias?	string

Returns

Promise<void>

Deprecated

use storeDID instead

---

storePrivateKey()

storePrivateKey(privateKey: PrivateKey): Promise<void>

Defined in: packages/shared/domain/build/index.d.ts:462

Store a list of private keys with its metadata and a reference to the DID it belongs to.

Parameters

Parameter	Type
privateKey	PrivateKey

Returns

Promise<void>