fix(cli): create veramo instance async in CLI (#1126)

fixes #1125
decentralized-identity · Feb 17, 2023 · 05ab106 · Eengineer1 · Feb 17, 2023 · mirceanis
1 parent cee8d2e
commit 05ab106
Show file tree

Hide file tree

Showing 13 changed files with 32 additions and 29 deletions.
diff --git a/packages/cli/src/config.ts b/packages/cli/src/config.ts
@@ -72,7 +72,7 @@ config
   .option('-f, --filename <string>', 'Config file name', './agent.yml')
   .option('-m, --method <string>', 'Check that a specific method is exposed by the agent.', 'execute')
   .action(async (options) => {
-    const agent = getAgent(options.filename)
+    const agent = await getAgent(options.filename)
     if (!agent) {
       console.error(
         'unknown error while creating the agent from your config. Consider running `veramo config create` to generate a new configuration file, or to manually compare differences.',

diff --git a/packages/cli/src/credential.ts b/packages/cli/src/credential.ts
@@ -18,7 +18,7 @@ credential
   .option('-j, --json', 'Output in JSON')
   .option('-q, --qrcode', 'Show qrcode')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
     const identifiers = await agent.didManagerFind()
 
     const knownDids = await agent.dataStoreORMGetIdentifiers()
@@ -170,7 +170,7 @@ credential
   .option('-f, --filename <string>', 'Optional. Read the credential from a file instead of stdin')
   .option('-r, --raw <string>', 'Optional. Specify the credential as a parameter instead of file or stdin')
   .action(async (options) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
     let raw: string = ''
     if (options.raw) {
       raw = options.raw
@@ -206,7 +206,7 @@ credential
   .command('output')
   .description('Print W3C Verifiable Credential to stdout')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     const credentials = await agent.dataStoreORMGetVerifiableCredentials()
 

diff --git a/packages/cli/src/did.ts b/packages/cli/src/did.ts
@@ -10,7 +10,7 @@ did
   .command('providers')
   .description('list available identifier providers')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     const providers = await agent.didManagerGetProviders()
     const list = providers.map((provider) => ({ provider }))
@@ -26,7 +26,7 @@ did
   .command('list', { isDefault: true })
   .description('list managed identifiers')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     const list = await agent.didManagerFind()
 
@@ -42,7 +42,7 @@ did
   .command('create')
   .description('create an identifier')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     try {
       const providers = await agent.didManagerGetProviders()
@@ -80,7 +80,7 @@ did
   .command('delete')
   .description('delete an identifier')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     try {
       const identifiers = await agent.didManagerFind()
@@ -107,7 +107,7 @@ did
   .command('add-service')
   .description('add a service endpoint to did document')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     try {
       const identifiers = await agent.didManagerFind()
@@ -155,7 +155,7 @@ did
   .command('remove-service')
   .description('remove a service endpoint from did document')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     try {
       const identifiers = await agent.didManagerFind()
@@ -188,7 +188,7 @@ did
   .command('add-key')
   .description('create and add a public key to did document')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     try {
       const identifiers = await agent.didManagerFind()
@@ -234,7 +234,7 @@ did
   .command('remove-key')
   .description('remove a key from did document')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     try {
       const identifiers = await agent.didManagerFind()
@@ -267,7 +267,7 @@ did
   .command('export')
   .description('export an identifier')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     try {
       const identifiers = await agent.didManagerFind()
@@ -295,7 +295,7 @@ did
   .command('import')
   .description('import an identifier')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     try {
       const answers = await inquirer.prompt([
@@ -317,7 +317,7 @@ did
   .command('resolve <didUrl>')
   .description('Resolve DID Document')
   .action(async (didUrl) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
     try {
       const ddo = await agent.resolveDid({ didUrl })
       console.log(JSON.stringify(ddo, null, 2))

diff --git a/packages/cli/src/discover.ts b/packages/cli/src/discover.ts
@@ -10,7 +10,7 @@ discover
   .option('-q, --query <string>', 'Query string')
 
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     const response = await agent.discoverDid({ query: cmd.query })
     const list: any = []

diff --git a/packages/cli/src/execute.ts b/packages/cli/src/execute.ts
@@ -12,7 +12,7 @@ program
   .option('-a, --argsJSON <string>', 'Method arguments')
   .option('-f, --argsFile <string>', 'Path to a file containing method arguments in a JSON string')
   .action(async (options) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     try {
       let method = options.method

diff --git a/packages/cli/src/explore/index.ts b/packages/cli/src/explore/index.ts
@@ -7,6 +7,6 @@ program
   .command('explore')
   .description('launch Verifiable Data explorer')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await (program.opts().config)
     await renderMainScreen(agent)
   })
diff --git a/packages/cli/src/lib/agentCreator.ts b/packages/cli/src/lib/agentCreator.ts
@@ -1,8 +1,8 @@
 import { TAgent, IPluginMethodMap } from '@veramo/core-types'
 import { createObjects } from './objectCreator.js'
 
-export function createAgentFromConfig<T extends IPluginMethodMap>(config: object): TAgent<T> {
+export async function createAgentFromConfig<T extends IPluginMethodMap>(config: object): Promise<TAgent<T>> {
   //@ts-ignore
-  const { agent } = createObjects(config, { agent: '/agent' })
+  const { agent } = await createObjects(config, { agent: '/agent' })
   return agent
 }
diff --git a/packages/cli/src/message.ts b/packages/cli/src/message.ts
@@ -12,7 +12,7 @@ message
   .option('--save <boolean>', 'Save message', true)
 
   .action(async (options) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
     try {
       let raw
 

diff --git a/packages/cli/src/presentation.ts b/packages/cli/src/presentation.ts
@@ -16,7 +16,7 @@ presentation
   .option('-s, --send', 'Send')
   .option('-q, --qrcode', 'Show qrcode')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
     const myIdentifiers = await agent.didManagerFind()
     if (myIdentifiers.length === 0) {
       console.error('No dids')
@@ -179,7 +179,7 @@ presentation
   .option('-f, --filename <string>', 'Optional. Read the presentation from a file instead of stdin')
   .option('-r, --raw <string>', 'Optional. Presentation as a parameter string instead of a file or stdin.')
   .action(async (options) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
     let raw: string = ''
     if (options.raw) {
       raw = options.raw
@@ -216,7 +216,7 @@ presentation
   .description('Print W3C Verifiable Presentation to stdout')
   .option('-t, --tag <string>', 'Optional. Specify the tag for the presentation.')
   .action(async (options) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     const presentations: UniqueVerifiablePresentation[] = await agent.dataStoreORMGetVerifiablePresentations({})
 

diff --git a/packages/cli/src/sdr.ts b/packages/cli/src/sdr.ts
@@ -15,7 +15,7 @@ sdr
   .command('create', { isDefault: true })
   .description('create Selective Disclosure Request')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
     const identifiers = await agent.didManagerFind()
 
     const knownDids = await agent.dataStoreORMGetIdentifiers()
@@ -265,7 +265,7 @@ sdr
   .command('respond')
   .description('respond to Selective Disclosure Request')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
     const sdrMessages = await agent.dataStoreORMGetMessages({
       where: [{ column: 'type', value: ['sdr'] }],
       order: [{ column: 'createdAt', direction: 'DESC' }],

diff --git a/packages/cli/src/setup.ts b/packages/cli/src/setup.ts
@@ -45,9 +45,9 @@ export type EnabledInterfaces = IDIDManager &
 
 export type ConfiguredAgent = TAgent<EnabledInterfaces>
 
-export function getAgent(fileName: string): ConfiguredAgent {
+export async function getAgent(fileName: string): Promise<ConfiguredAgent> {
   try {
-    return createAgentFromConfig<EnabledInterfaces>(getConfig(fileName))
+    return await createAgentFromConfig<EnabledInterfaces>(getConfig(fileName))
   } catch (e: any) {
     console.log('Unable to create agent from ' + fileName + '.', e.message)
     process.exit(1)

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -14,6 +14,7 @@
   },
   "dependencies": {
     "@veramo/core-types": "^5.0.0",
+    "debug": "^4.3.4",
     "events": "^3.2.0",
     "z-schema": "^5.0.5"
   },

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml