@credo-ts/didcomm-drpc
v0.8.0
Published
DIDComm DRPC protocol implementation for Credo
Keywords
Readme
DRPC module for Credo. Implements Aries RFC 0804.
Quick start
In order for this module to work, we have to inject it into the agent to access agent functionality. See the example for more information.
Example of usage
import { DidCommDrpcModule } from '@credo-ts/didcomm-drpc'
const agent = new Agent({
config: {
/* config */
},
dependencies: agentDependencies,
modules: {
drpc: new DidCommDrpcModule(),
/* other custom modules */
},
})
await agent.initialize()
// Send a request to the specified connection
const responseListener = await senderAgent.modules.drpc.sendRequest(connectionId, {
jsonrpc: '2.0',
method: 'hello',
id: 1,
})
// Listen for any incoming requests
const { request, sendResponse } = await receiverAgent.modules.drpc.recvRequest()
// Process the received request and create a response
const result =
request.method === 'hello'
? { jsonrpc: '2.0', result: 'Hello world!', id: request.id }
: { jsonrpc: '2.0', error: { code: DidCommDrpcErrorCode.METHOD_NOT_FOUND, message: 'Method not found' } }
// Send the response back
await sendResponse(result)Drizzle storage
The package provides a drizzle record bundle for @credo-ts/drizzle-storage under the /drizzle subpath. Install @credo-ts/drizzle-storage and drizzle-orm, and register the bundle together with the didcomm bundle:
import { didcommDrpcBundle } from '@credo-ts/didcomm-drpc/drizzle'
import { DrizzleStorageModule } from '@credo-ts/drizzle-storage'
import { didcommBundle } from '@credo-ts/drizzle-storage/didcomm'
const storage = new DrizzleStorageModule({
database,
bundles: [didcommBundle, didcommDrpcBundle],
})Pass the subpath to the --bundle option of the drizzle-storage CLI to apply the migrations:
pnpm drizzle-storage --bundle core --bundle didcomm --bundle @credo-ts/didcomm-drpc/drizzle migrate --dialect sqlite --database-url "file:./agent.db"In React Native, import the SQLite migrations from @credo-ts/didcomm-drpc/drizzle/migrations/sqlite and pass them to applyReactNativeMigrations.
The bundle replaces the drpc bundle of @credo-ts/drizzle-storage. The bundle name, the table name, and the migrations did not change, so an existing database keeps working.
