EdgeAgentSDK/org.hyperledger.identus.walletsdk.edgeagent/EdgeAgent

EdgeAgent

EdgeAgent class is responsible for handling the connection to other agents in the network using a provided Mediator Service Endpoint and seed data.

Constructors

EdgeAgent

constructor(apollo: Apollo, castor: Castor, pluto: Pluto, mercury: Mercury, pollux: Pollux, connectionManager: ConnectionManager, seed: Seed?, api: Api?, logger: PrismLogger = PrismLoggerImpl(LogComponent.PRISM_AGENT), agentOptions: AgentOptions = AgentOptions())

Initializes the EdgeAgent with the given dependencies.

constructor(apollo: Apollo, castor: Castor, pluto: Pluto, mercury: Mercury, pollux: Pollux, seed: Seed? = null, api: Api? = null, mediatorHandler: MediationHandler, logger: PrismLogger = PrismLoggerImpl(LogComponent.PRISM_AGENT), agentOptions: AgentOptions = AgentOptions())

Initializes the EdgeAgent constructor.

Types

State

enum State : Enum<EdgeAgent.State>

Enumeration representing the current state of the agent.

Properties

apollo

val apollo: Apollo

castor

val castor: Castor

flowState

val flowState: MutableSharedFlow<EdgeAgent.State>

val mercury: Mercury

val pluto: Pluto

val pollux: Pollux

val seed: Seed

var state: EdgeAgent.State

Functions

acceptInvitation

suspend fun acceptInvitation(invitation: PrismOnboardingInvitation)

Accepts a Prism Onboarding invitation and performs the onboarding process

acceptOutOfBandInvitation

suspend fun acceptOutOfBandInvitation(invitation: OutOfBandInvitation)

Accepts an Out-of-Band (DIDComm), verifies if it contains attachments or not. If it does contain attachments means is a contactless request presentation. If it does not, it just creates a pair and establishes a connection.

backupWallet

suspend fun backupWallet(plutoBackupTask: PlutoBackupTask = PlutoBackupTask(pluto)): String

Performs a backup operation.

createNewPeerDID

open suspend fun createNewPeerDID(services: Array<DIDDocument.Service> = emptyArray(), updateMediator: Boolean): DID

This function creates a new Peer DID, stores it in pluto database and updates the mediator if requested.

createNewPrismDID

suspend fun createNewPrismDID(keyPathIndex: Int? = null, alias: String? = null, services: Array<DIDDocument.Service> = emptyArray()): DID

This method create a new Prism DID, that can be used to identify the agent and interact with other agents.

getAllCredentials

fun getAllCredentials(): Flow<List<Credential>>

This method returns a list of all the VerifiableCredentials stored locally.

getAllDIDPairs

suspend fun getAllDIDPairs(): List<DIDPair>

This method returns all DID pairs

getAllRegisteredPeerDIDs

suspend fun getAllRegisteredPeerDIDs(): List<PeerDID>

This method returns all registered PeerDIDs.

getDIDInfo

suspend fun getDIDInfo(did: DID): PrismDIDInfo?

This method fetches a DIDInfo from local storage.

handleMessagesEvents

fun handleMessagesEvents(): Flow<List<Message>>

Handles the messages events and return a publisher of the messages.

handlePresentation

suspend fun handlePresentation(msg: Message): Boolean

handleReceivedMessagesEvents

fun handleReceivedMessagesEvents(): Flow<List<Message>>

Handles the received messages events and return a publisher of the messages.

initiatePresentationRequest

suspend fun initiatePresentationRequest(type: CredentialType, toDID: DID, presentationClaims: PresentationClaims, domain: String? = null, challenge: String? = null)

isCredentialRevoked

suspend fun isCredentialRevoked(credential: Credential)

observeRevokedCredentials

fun observeRevokedCredentials(): Flow<List<Credential>>

This method provides a channel to listen for credentials that are revoked. As long as there is an observer collecting from this flow the updates will keep happening.

parseInvitation

suspend fun parseInvitation(str: String): InvitationType

Parses the given string as an invitation

preparePresentationForRequestProof

suspend fun <T : Credential, ProvableCredential> preparePresentationForRequestProof(request: RequestPresentation, credential: T): Presentation

This function creates a Presentation from a request verification.

prepareRequestCredentialWithIssuer

suspend fun prepareRequestCredentialWithIssuer(did: DID, offer: OfferCredential): RequestCredential

This function prepares a request credential from an offer given the subject DID.

processIssuedCredentialMessage

suspend fun processIssuedCredentialMessage(message: IssueCredential): Credential

This function parses an issued credential message, stores, and returns the verifiable credential.

recoverWallet

suspend fun recoverWallet(jwe: String)

Restores a Pluto instance from a JWE (JSON Web Encryption) string.

registerDIDPair

fun registerDIDPair(pair: DIDPair)

This method registers a DID pair into the local database.

registerPeerDID

suspend fun registerPeerDID(did: DID, keyAgreementKeyPair: KeyPair, authenticationKeyPair: KeyPair, updateMediator: Boolean)

Registers a peer DID with the specified DID and private keys.

sendMessage

suspend fun sendMessage(message: Message): Message?

Sends a DIDComm message through HTTP using mercury and returns a message if this is returned immediately by the REST endpoint.

setupMediatorDID

fun setupMediatorDID(did: DID)

Sets up a mediator DID for communication with the specified DID.

setupMediatorHandler

fun setupMediatorHandler(mediatorHandler: MediationHandler)

signWith

suspend fun signWith(did: DID, message: ByteArray): Signature

This function will use the provided DID to sign a given message.

start

suspend fun start()

Start the EdgeAgent and Mediator services.

startFetchingMessages

fun startFetchingMessages(requestInterval: Int = 5)

Start fetching the messages from the mediator.

stop

fun stop()

Stops the EdgeAgent. The function sets the state of EdgeAgent to State.STOPPING. All ongoing events that was created by the EdgeAgent are stopped. After all the events are stopped the state of the EdgeAgent is set to State.STOPPED.

stopFetchingMessages

fun stopFetchingMessages()

Stop fetching messages

updateMediatorWithDID

suspend fun updateMediatorWithDID(did: DID)

Updates the mediator with the specified DID by updating the key list with the given DID.