TypeError: setup_1.agent.createVerifiableCredential is not a function

[adnan-alam-rfera]

I'm trying to create verifiable credential with the example given on the front page of https://veramo.io/. But getting this error

TypeError: setup_1.agent.createVerifiableCredential is not a function
    at /home/adnan/test_veramo/src/create-identifier.ts:18:44
    at Generator.next (<anonymous>)
    at fulfilled (/home/adnan/test_veramo/src/create-identifier.ts:5:58)

setup.ts

import { JwtMessageHandler } from '@veramo/did-jwt';
import { W3cMessageHandler } from '@veramo/credential-w3c';
import { MessageHandler } from '@veramo/message-handler';

// Core interfaces
import { createAgent, IDIDManager, IResolver, IDataStore, IKeyManager } from '@veramo/core'

// Core identity manager plugin
import { DIDManager } from '@veramo/did-manager'

// Ethr did identity provider
import { EthrDIDProvider } from '@veramo/did-provider-ethr'

// Web did identity provider
import { WebDIDProvider } from '@veramo/did-provider-web'

// Core key manager plugin
import { KeyManager } from '@veramo/key-manager'

// DataStore, DataStoreORM plugin
import { DataStore } from '@veramo/data-store'

import { DataStoreORM } from '@veramo/data-store'

// Custom key management system for RN
import { KeyManagementSystem, SecretBox } from '@veramo/kms-local'

// Custom resolvers
import { DIDResolverPlugin } from '@veramo/did-resolver'
import { Resolver } from 'did-resolver'
import { getResolver as ethrDidResolver } from 'ethr-did-resolver'
import { getResolver as webDidResolver } from 'web-did-resolver'

// Storage plugin using TypeOrm
import { Entities, KeyStore, DIDStore, IDataStoreORM, PrivateKeyStore, migrations } from '@veramo/data-store'

// TypeORM is installed with `@veramo/data-store`
import { createConnection } from 'typeorm'


// This will be the name for the local sqlite database for demo purposes
const DATABASE_FILE = 'test_veramo.sqlite'

// You will need to get a project ID from infura https://www.infura.io
const INFURA_PROJECT_ID = 'some project id'

// This will be the secret key for the KMS
const KMS_SECRET_KEY = 'some secret key'



const dbConnection = createConnection({
    type: 'sqlite',
    database: DATABASE_FILE,
    synchronize: false,
    migrations,
    migrationsRun: true,
    logging: ['error', 'info', 'warn'],
    entities: Entities,
})


export const agent = createAgent<IDIDManager & IKeyManager & IDataStore & IDataStoreORM & IResolver>({
    plugins: [
      new MessageHandler({ messageHandlers: [new JwtMessageHandler(), new W3cMessageHandler()] }),
      new DataStore(dbConnection),
      new DataStoreORM(dbConnection),

      new KeyManager({
        store: new KeyStore(dbConnection),
        kms: {
          local: new KeyManagementSystem(new PrivateKeyStore(dbConnection, new SecretBox(KMS_SECRET_KEY))),
        },
      }),
      new DIDManager({
        store: new DIDStore(dbConnection),
        defaultProvider: 'did:ethr:rinkeby',
        providers: {
          'did:ethr:rinkeby': new EthrDIDProvider({
            defaultKms: 'local',
            network: 'rinkeby',
            rpcUrl: 'https://rinkeby.infura.io/v3/' + INFURA_PROJECT_ID,
          }),
          'did:web': new WebDIDProvider({
            defaultKms: 'local',
          }),
        },
      }),
      new DIDResolverPlugin({
        resolver: new Resolver({
          ...ethrDidResolver({ infuraProjectId: INFURA_PROJECT_ID }),
          ...webDidResolver(),
        }),
      }),
    ],
})

create-identifiers.ts

import { agent } from './veramo/setup'
import { CredentialIssuer } from '@veramo/credential-w3c'

async function main() {
  // const identity = await agent.didManagerCreate()
  // console.log(`New identity created`)
  // console.log(identity)



  /* Create an identifier and optionally link to an existing user */
  const user = await agent.didManagerGetOrCreate({
    alias: 'Adnan'
  })
  console.log(user)


  const verifiableCredential = await agent.createVerifiableCredential({
    credential: {
      issuer: { id: 'did:ethr:ropsten:some hex' },
      credentialSubject: {
        id: user.did,
        tutorial: 42,
        status: 'completed'
      }
    },
    proofFormat: 'jwt',
    save: false
  })


}

main().catch(console.log)

[mirceanis]

It looks like your agent does not have the CredentialIssuer plugin installed. Can you check your setup again?

Veramo agent functionality (the methods that the agent provides) is provided entirely by plugins.

[adnan-alam-rfera]

Yes, you've got it right. I've installed CredentialIssuer plugin but couldn't figure out what should be the arguments that are needed to be passed?

export const agent = createAgent<IDIDManager & IKeyManager & IDataStore & IDataStoreORM & IResolver>({
    plugins: [
      new CredentialIssuer(),
      ....
    ],
})

Would you please give me an example?

[mirceanis]

The setup looks good, but you need to add new CredentialIssuer() to the list of plugins, just as you have added in the follow up question.

It's wise to declare the interfaces implemented by the plugins when you createAgent<plugin interfaces>(). This will help your development since it allows the IDE to give you hints about the methods and their parameters.

In your case, you can add ICredentialIssuer to the types, like so:

export const agent = createAgent<IResolver & IKeyManager & IDIDManager & IDataStore & IDataStoreORM & ICredentialIssuer>({
    plugins: [
      new CredentialIssuer(), // add this plugin to your list
      new MessageHandler({ messageHandlers: [new JwtMessageHandler(), new W3CMessageHandler()] }),
      new DataStore(dbConnection),
      new DataStoreORM(dbConnection),

      new KeyManager({
        store: new KeyStore(dbConnection),
        kms: {
          local: new KeyManagementSystem(new PrivateKeyStore(dbConnection, new SecretBox(KMS_SECRET_KEY))),
        },
      }),
      new DIDManager({
        store: new DIDStore(dbConnection),
        defaultProvider: 'did:ethr:rinkeby',
        providers: {
          'did:ethr:rinkeby': new EthrDIDProvider({
            defaultKms: 'local',
            network: 'rinkeby',
            rpcUrl: 'https://rinkeby.infura.io/v3/' + INFURA_PROJECT_ID,
          }),
          'did:web': new WebDIDProvider({
            defaultKms: 'local',
          }),
        },
      }),
      new DIDResolverPlugin({
        resolver: new Resolver({
          ...ethrDidResolver({ infuraProjectId: INFURA_PROJECT_ID }),
          ...webDidResolver(),
        }),
      }),
    ],
})

In cases where the documentation is missing from https://veramo.io, you can always take a look at the integration tests.

We are always looking for contributors; if you wish to write your own guides, or even write about your experience, please raise an issue or make a PR to https://github.com/uport-project/veramo-website

[adnan-alam-rfera]

Thanks a lot. Made it work