Agent
The main Agent class that extends BaseAgent and provides initialization and lifecycle management.
Constructor
import { Agent } from '@credo-ts/core'
const agent = new Agent({
config: initConfig,
modules: {
// Module configuration
},
dependencies: agentDependencies
})
Configuration options for the agent. See AgentConfig for details. Module configuration for extending agent functionality
options.dependencies
AgentDependencies
required
Platform-specific dependencies (React Native, Node.js, etc.)
Methods
initialize()
Initializes the agent and all registered modules. Must be called before using the agent.
Returns: Promise<void>
Throws: CredoError if agent is already initialized or storage is not up to date
shutdown()
Shuts down the agent and all registered modules.
Returns: Promise<void>
Properties
events
Access to the event emitter for listening to agent events.
agent.events.on(CredentialEventTypes.CredentialStateChanged, (event) => {
console.log('Credential state changed:', event.payload.credentialRecord.state)
})
EventEmitter
BaseAgent
Base class that provides access to all agent APIs. The Agent class extends this.
Properties
All APIs are available directly on the agent instance:
dids
DID management API. See DidsApi.
const { didDocument } = await agent.dids.resolve('did:key:...')
DidsApi
w3cCredentials
W3C Verifiable Credentials API. See W3cCredentialsApi.
const signedCredential = await agent.w3cCredentials.signCredential({ ... })
W3cCredentialsApi
sdJwtVc
SD-JWT VC API. See SdJwtVcApi.
const sdJwt = await agent.sdJwtVc.sign({ ... })
SdJwtVcApi
mdoc
Mobile document (mdoc) API. See MdocApi.
const mdoc = await agent.mdoc.sign({ ... })
MdocApi
didcomm
DIDComm APIs (connections, credentials, proofs). Only available if DIDComm module is registered. See DIDComm APIs.
const connection = await agent.didcomm.connections.acceptOutOfBandInvitation({ ... })
DidCommApi | undefined
openid4vc
OpenID4VC APIs (issuer, verifier, holder). Only available if OpenID4VC module is registered. See OpenId4VcApi.
const credential = await agent.openid4vc.holder.requestCredential({ ... })
OpenId4VcApi | undefined
modules
Access to custom registered modules.
// Access custom module
const result = await agent.modules.myCustomModule.someMethod()
AgentApi<WithoutDefaultModules<AgentModules>>
config
Agent configuration.
const logger = agent.config.logger
AgentConfig
context
Agent context for dependency injection.
const storageService = agent.context.resolve(StorageService)
AgentContext
isInitialized
Whether the agent has been initialized.
if (agent.isInitialized) {
// Agent is ready to use
}
boolean
Example Usage
import { Agent, InitConfig } from '@credo-ts/core'
import { agentDependencies } from '@credo-ts/node'
import { AskarModule } from '@credo-ts/askar'
import { ariesAskar } from '@hyperledger/aries-askar-nodejs'
const config: InitConfig = {
logger: new ConsoleLogger(LogLevel.info),
autoUpdateStorageOnStartup: true,
}
const agent = new Agent({
config,
dependencies: agentDependencies,
modules: {
askar: new AskarModule({ ariesAskar }),
},
})
await agent.initialize()
// Use agent APIs
const { didDocument } = await agent.dids.create({
method: 'key',
options: { keyType: KeyType.Ed25519 },
})
// Shutdown when done
await agent.shutdown()