Interface Pluto

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.

Hierarchy

Pluto

Methods

fetchCredentialMetadata

fetchCredentialMetadata(linkSecretName): Promise<null | CredentialRequestMeta>
Fetch the AnonCreds Credential Metadata by its linkSecret name
Parameters
- linkSecretName: string
Returns Promise<null | CredentialRequestMeta>
- Defined in src/domain/buildingBlocks/Pluto.ts:29

getAllCredentials

getAllCredentials(): Promise<Domain.Credential[]>
Retrieve all the stored credentials

Returns Promise<Domain.Credential[]>
- Defined in src/domain/buildingBlocks/Pluto.ts:202

getAllDidPairs

getAllDidPairs(): Promise<DIDPair[]>
Retrieve all stored DID pairs (DIDComm connections).

Returns Promise<DIDPair[]>
- Defined in src/domain/buildingBlocks/Pluto.ts:132

getAllMediators

getAllMediators(): Promise<Mediator[]>
Retrieve all stored mediators.

Returns Promise<Mediator[]>
- Defined in src/domain/buildingBlocks/Pluto.ts:197

getAllMessages

getAllMessages(): Promise<Message[]>
Retrieve all stored DIDComm messages.

Returns Promise<Message[]>
- Defined in src/domain/buildingBlocks/Pluto.ts:147

getAllMessagesByDID

getAllMessagesByDID(did): Promise<Message[]>
Retrieve all stored DIDComm messages, received from or sent to a given DID
Parameters
- did: DID
Returns Promise<Message[]>
- Defined in src/domain/buildingBlocks/Pluto.ts:152

getAllMessagesByFromToDID

getAllMessagesByFromToDID(from, to): Promise<Message[]>
Retrieve all DIDComm messages containing given "from" AND "to" DIDs.
Parameters
- from: DID
- to: DID
Returns Promise<Message[]>
- Defined in src/domain/buildingBlocks/Pluto.ts:187

getAllMessagesOfType

getAllMessagesOfType(type, relatedWithDID?): Promise<Message[]>
Retrieve all stored DIDComm messages with given message type, and optionally, related to a given DID. "Related" means that message should contain a given DID in either "from" or "to" field.
Parameters
- type: string
- Optional relatedWithDID: DID
Returns Promise<Message[]>
- Defined in src/domain/buildingBlocks/Pluto.ts:179

getAllMessagesReceived

getAllMessagesReceived(): Promise<Message[]>
Retrieve all stored, received DIDComm messages.

Returns Promise<Message[]>
- Defined in src/domain/buildingBlocks/Pluto.ts:162

getAllMessagesReceivedFrom

getAllMessagesReceivedFrom(did): Promise<Message[]>
Retrieve all stored DIDComm messages, received from a given DID.
Parameters
- did: DID
Returns Promise<Message[]>
- Defined in src/domain/buildingBlocks/Pluto.ts:172

getAllMessagesSent

getAllMessagesSent(): Promise<Message[]>
Retrieve all stored, sent DIDComm messages.

Returns Promise<Message[]>
- Defined in src/domain/buildingBlocks/Pluto.ts:157

getAllMessagesSentTo

getAllMessagesSentTo(did): Promise<Message[]>
Retrieve all stored DIDComm messages, sent to a given DID.
Parameters
- did: DID
Returns Promise<Message[]>
- Defined in src/domain/buildingBlocks/Pluto.ts:167

getAllPeerDIDs

getAllPeerDIDs(): Promise<PeerDID[]>
Retrieve all stored Peer DIDs.

Returns Promise<PeerDID[]>
- Defined in src/domain/buildingBlocks/Pluto.ts:117

getAllPrismDIDs

getAllPrismDIDs(): Promise<PrismDIDInfo[]>
Retrieve all stored PRISM DIDs.

Returns Promise<PrismDIDInfo[]>
- Defined in src/domain/buildingBlocks/Pluto.ts:92

getDIDInfoByAlias

getDIDInfoByAlias(alias): Promise<PrismDIDInfo[]>
Retrieve DID information for a given DID alias.
Parameters
- alias: string
Returns Promise<PrismDIDInfo[]>
- Defined in src/domain/buildingBlocks/Pluto.ts:102

getDIDInfoByDID

getDIDInfoByDID(did): Promise<null | PrismDIDInfo>
Retrieve DID information for a given DID.
Parameters
- did: DID
Returns Promise<null | PrismDIDInfo>
- Defined in src/domain/buildingBlocks/Pluto.ts:97

getDIDPrivateKeyByID

getDIDPrivateKeyByID(id): Promise<null | PrivateKey>
Retrieve private key for a given key ID.
Parameters
- id: string
Returns Promise<null | PrivateKey>
- Defined in src/domain/buildingBlocks/Pluto.ts:127

getDIDPrivateKeysByDID

getDIDPrivateKeysByDID(did): Promise<PrivateKey[]>
Retrieve available private keys for a given DID.
Parameters
- did: DID
Returns Promise<PrivateKey[]>
- Defined in src/domain/buildingBlocks/Pluto.ts:122

getLinkSecret

getLinkSecret(linkSecretName?): Promise<null | string>
Retrieve the anoncreds stored link secret by its name
Parameters
- Optional linkSecretName: string
Returns Promise<null | string>
- Defined in src/domain/buildingBlocks/Pluto.ts:207

getMessage

getMessage(id): Promise<null | Message>
Retrieve a DIDComm message by ID.
Parameters
- id: string
Returns Promise<null | Message>
- Defined in src/domain/buildingBlocks/Pluto.ts:192

getPairByDID

getPairByDID(did): Promise<null | DIDPair>
Retrieve a DID pair containing a given DID as either host or receiver.
Parameters
- did: DID
Returns Promise<null | DIDPair>
- Defined in src/domain/buildingBlocks/Pluto.ts:137

getPairByName

getPairByName(name): Promise<null | DIDPair>
Retrieve a DID pair by a given pair name.
Parameters
- name: string
Returns Promise<null | DIDPair>
- Defined in src/domain/buildingBlocks/Pluto.ts:142

getPrismDIDKeyPathIndex

getPrismDIDKeyPathIndex(did): Promise<null | number>
Retrieve a PRISM DID key path index for a given DID.
Parameters
- did: DID
Returns Promise<null | number>
- Defined in src/domain/buildingBlocks/Pluto.ts:107

getPrismLastKeyPathIndex

getPrismLastKeyPathIndex(): Promise<number>
Get the last used PRISM key path index.

Returns Promise<number>
- Defined in src/domain/buildingBlocks/Pluto.ts:112

start

start(): Promise<void>
Pluto initialise function

Returns Promise<void>
- Defined in src/domain/buildingBlocks/Pluto.ts:36

storeCredential

storeCredential(credential): Promise<void>
Store a Credential into the Database
Parameters
- credential: Domain.Credential
Returns Promise<void>
- Defined in src/domain/buildingBlocks/Pluto.ts:87

storeCredentialMetadata

storeCredentialMetadata(metadata, linkSecret): Promise<void>
Store the AnonCreds Credential Metadata referencing its linkSecret name
Parameters
- metadata: CredentialRequestMeta
- linkSecret: string
Returns Promise<void>
- Defined in src/domain/buildingBlocks/Pluto.ts:21

storeDIDPair

storeDIDPair(host, receiver, name): Promise<void>
Store a named pair of DIDs representing a DIDComm connection.
Parameters
- host: DID
- receiver: DID
- name: string
Returns Promise<void>
- Defined in src/domain/buildingBlocks/Pluto.ts:57

storeLinkSecret

storeLinkSecret(linkSecret, linkSecretName): Promise<void>
Store a new anoncreds linkSecret
Parameters
- linkSecret: string
- linkSecretName: string
Returns Promise<void>
- Defined in src/domain/buildingBlocks/Pluto.ts:212

storeMediator

storeMediator(mediator, host, routing): Promise<void>
Store a mediator information.
Parameters
- mediator: DID
- host: DID
- routing: DID
Returns Promise<void>
- Defined in src/domain/buildingBlocks/Pluto.ts:82

storeMessage

storeMessage(message): Promise<void>
Store a DIDComm message.
Parameters
- message: Message
Returns Promise<void>
- Defined in src/domain/buildingBlocks/Pluto.ts:62

storeMessages

storeMessages(messages): Promise<void>
Store an array of DIDComm messages
Parameters
- messages: Message[]
Returns Promise<void>
- Defined in src/domain/buildingBlocks/Pluto.ts:67

storePeerDID

storePeerDID(did, privateKeys): Promise<void>
Store a Peer DID and an array of its privateKeys.
Parameters
- did: DID
- privateKeys: PrivateKey[]
Returns Promise<void>
- Defined in src/domain/buildingBlocks/Pluto.ts:52

storePrismDID

storePrismDID(did, keyPathIndex, privateKey, privateKeyMetaId, alias?): Promise<void>
Store a PRISM DID and its private key with given metadata.
Parameters
- did: DID
- keyPathIndex: number
- privateKey: PrivateKey
- privateKeyMetaId: null | string
- Optional alias: string
Returns Promise<void>
- Defined in src/domain/buildingBlocks/Pluto.ts:41

storePrivateKeys

storePrivateKeys(privateKey, did, keyPathIndex, metaId): Promise<void>
Store a list of private keys with its metadata and a reference to the DID it belongs to.
Parameters
- privateKey: PrivateKey
- did: DID
- keyPathIndex: number
- metaId: null | string
Returns Promise<void>
- Defined in src/domain/buildingBlocks/Pluto.ts:72