Class Agent

constructor

• new Agent(apollo, castor, pluto, mercury, mediationHandler, connectionManager, seed?, api?): Agent

• Creates an instance of Agent.

  Parameters

  • apollo: Domain.Apollo

  • castor: Domain.Castor

  • pluto: Pluto

  • mercury: Domain.Mercury

  • mediationHandler: MediatorHandler

  • connectionManager: ConnectionsManager

  • Optional seed: Seed = ...

  • Optional api: Api = ...

  Returns Agent

Readonly api

Readonly apollo

Readonly castor

Readonly connectionManager

Readonly mediationHandler

Readonly mercury

Readonly pluto

Readonly seed

state

currentMediatorDID

• get currentMediatorDID(): undefined | DID

• Get current mediator DID if available or null

  Returns undefined | DID

acceptDIDCommInvitation

• acceptDIDCommInvitation(invitation): Promise<void>

• Asyncronously accept a didcomm v2 invitation, will create a pair between the Agent its connecting with and the current owner's did

  Parameters

  • invitation: OutOfBandInvitation

  Returns Promise<void>

  Deprecated

  • use acceptInvitation

  Async

acceptInvitation

• acceptInvitation(invitation): Promise<void>

• Handle an invitation to create a connection

  Parameters

  • invitation: InvitationType

    an OOB or PrismOnboarding invitation

  Returns Promise<void>

  Async

addListener

• addListener(eventName, callback): void

• Add an event listener to get notified from an Event "MESSAGE"

  Parameters

  • eventName: ListenerKey

  • callback: EventCallback

  Returns void

createNewPeerDID

• createNewPeerDID(services?, updateMediator?): Promise<DID>

• Asyncronously Create a new PeerDID

  Parameters

  • Optional services: Service[] = []

  • Optional updateMediator: boolean = true

  Returns Promise<DID>

  Async

createNewPrismDID

• createNewPrismDID(alias, services?, keyPathIndex?): Promise<DID>

• Asyncronously create a new PrismDID

  Parameters

  • alias: string

  • Optional services: Service[] = []

  • Optional keyPathIndex: number

  Returns Promise<DID>

  Async

createPresentationForRequestProof

• createPresentationForRequestProof(request, credential): Promise<Presentation>

• Asyncronously create a verifiablePresentation from a valid stored verifiableCredential This is used when the verified requests a specific verifiable credential, this will create the actual instance of the presentation which we can share with the verifier.

  Parameters

  • request: RequestPresentation

  • credential: Domain.Credential

  Returns Promise<Presentation>

  Async

parseInvitation

• parseInvitation(str): Promise<InvitationType>

• Asyncronously parse an invitation from a valid json string

  Parameters

  • str: string

  Returns Promise<InvitationType>

  Async

parseOOBInvitation

• parseOOBInvitation(str): Promise<OutOfBandInvitation>

• Asyncronously parse an out of band invitation from a URI as the oob come in format of valid URL

  Parameters

  • str: URL

  Returns Promise<OutOfBandInvitation>

  Async

parsePrismInvitation

• parsePrismInvitation(str): Promise<PrismOnboardingInvitation>

• Asyncronously parse a prismOnboarding invitation from a string

  Parameters

  • str: string

  Returns Promise<PrismOnboardingInvitation>

  Async

prepareRequestCredentialWithIssuer

• prepareRequestCredentialWithIssuer(offer): Promise<RequestCredential>

• Asyncronously prepare a request credential message from a valid offerCredential for now supporting w3c verifiable credentials offers.

  Parameters

  • offer: OfferCredential

  Returns Promise<RequestCredential>

  Async

processIssuedCredentialMessage

• processIssuedCredentialMessage(message): Promise<Domain.Credential>

• Extract the verifiableCredential object from the Issue credential message asyncronously

  Parameters

  • message: IssueCredential

  Returns Promise<Domain.Credential>

  Async

removeListener

• removeListener(eventName, callback): void

• Remove event listener, used by stop procedure

  Parameters

  • eventName: ListenerKey

  • callback: EventCallback

  Returns void

  Date

  20/06/2023 - 14:31:30

sendMessage

• sendMessage(message): Promise<undefined | Message>

• Asyncronously send a didcomm Message

  Parameters

  • message: Message

  Returns Promise<undefined | Message>

signWith

• signWith(did, message): Promise<Signature>

• Asyncronously sign a message with a DID

  Parameters

  • did: DID

  • message: Uint8Array

  Returns Promise<Signature>

  Async

start

• start(): Promise<AgentState>

• Asyncronously start the agent

  Returns Promise<AgentState>

  Async

startFetchingMessages

• startFetchingMessages(iterationPeriod): void

• Start fetching for new messages in such way that it can be stopped at any point in time without causing memory leaks

  Parameters

  • iterationPeriod: number

  Returns void

stop

• stop(): Promise<void>

• Asyncronously stop the agent and any side task that is running

  Returns Promise<void>

  Async

stopFetchingMessages

• stopFetchingMessages(): void

• Stops fetching messages

  Returns void

verifiableCredentials

• verifiableCredentials(): Promise<Domain.Credential[]>

• Asyncronously get all verifiable credentials

  Returns Promise<Domain.Credential[]>

Static initialize

• initialize(params): Agent

• Convenience initializer for Agent allowing default instantiation, omitting all but the absolute necessary parameters

  Parameters

  • params: {
        api?: Api;
        apollo?: Domain.Apollo;
        castor?: Domain.Castor;
        mediatorDID: string | DID;
        mercury?: Domain.Mercury;
        pluto: Pluto;
        seed?: Seed;
    }

    dependencies object

    • Optional api?: Api

    • Optional apollo?: Domain.Apollo

    • Optional castor?: Domain.Castor

    • mediatorDID: string | DID

      did of the mediator to be used

    • Optional mercury?: Domain.Mercury

    • pluto: Pluto

      storage implementation

    • Optional seed?: Seed

  Returns Agent

Static instanceFromConnectionManager

• instanceFromConnectionManager(apollo, castor, pluto, mercury, connectionManager, seed?, api?): Agent

• Mainly for testing purposes but instantiating the Agent from a ConnectionManager directly

  Parameters

  • apollo: Apollo

  • castor: Castor

  • pluto: Pluto

  • mercury: Mercury

  • connectionManager: ConnectionsManager

  • Optional seed: Seed

  • Optional api: Api

  Returns Agent

  Static