# @selfkey/agent > Node js lib for selfkey ssi agent Latest version **0.0.4** (published 2021-04-28) · MIT license · 0 weekly downloads ## Install ```sh npm install @selfkey/agent pnpm add @selfkey/agent yarn add @selfkey/agent bun add @selfkey/agent ``` Provides the command `sagent-gen-pk`. ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.0.4 | | Published | 2021-04-28 | | First published | 2021-04-09 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 17 | | Unpacked size | 41.7 KB | | Known vulnerabilities | 0 (+1 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 0 | | Author | Maxim Kovalov | | Maintainers | andrecgoncalves, altninja, max.kovalov | ## Links - npm: https://www.npmjs.com/package/@selfkey/agent - Repository: https://github.com/SelfKeyFoundation/selfkey-ssi - Homepage: https://github.com/SelfKeyFoundation/selfkey-ssi#readme - Issues: https://github.com/SelfKeyFoundation/selfkey-ssi/issues - npm.io page: https://npm.io/package/@selfkey/agent ## Dependencies (17) - [did-jwt-vc](https://npm.io/package/did-jwt-vc.md) ^2.1.0 - [@veramo/core](https://npm.io/package/@veramo/core.md) ^1.1.1-next.29 - [did-resolver](https://npm.io/package/did-resolver.md) ^3.1.0 - [@veramo/did-comm](https://npm.io/package/@veramo/did-comm.md) ^1.1.1-next.29 - [web-did-resolver](https://npm.io/package/web-did-resolver.md) 2.0.4 - [@veramo/kms-local](https://npm.io/package/@veramo/kms-local.md) ^1.1.1-next.29 - [ethr-did-resolver](https://npm.io/package/ethr-did-resolver.md) 4.0.1 - [@veramo/data-store](https://npm.io/package/@veramo/data-store.md) ^1.1.1-next.29 - [@veramo/did-manager](https://npm.io/package/@veramo/did-manager.md) ^1.1.1-next.29 - [@veramo/key-manager](https://npm.io/package/@veramo/key-manager.md) ^1.1.1-next.29 - [@veramo/did-resolver](https://npm.io/package/@veramo/did-resolver.md) ^1.1.1-next.29 - [@veramo/remote-server](https://npm.io/package/@veramo/remote-server.md) ^1.1.1-next.29 - [@veramo/credential-w3c](https://npm.io/package/@veramo/credential-w3c.md) ^1.1.1-next.29 - [@veramo/message-handler](https://npm.io/package/@veramo/message-handler.md) ^1.1.1-next.29 - [@veramo/did-provider-web](https://npm.io/package/@veramo/did-provider-web.md) ^1.1.1-next.29 - [@veramo/did-provider-ethr](https://npm.io/package/@veramo/did-provider-ethr.md) ^1.1.1-next.29 - [@veramo/selective-disclosure](https://npm.io/package/@veramo/selective-disclosure.md) ^1.1.1-next.29 ## Recent versions - 0.0.4 (latest) — 2021-04-28 - 0.0.3 — 2021-04-26 - 0.0.2 — 2021-04-21 - 0.0.1 — 2021-04-09 ## README # Selfkey Agent A Selfkey SSI agent library. Utilizes heavily the veramo framework and did-jwt-vc library For storage typeorm is used. ## Usage ```sh yarn add @selfkey/agent ``` ### Agent example: ```js const Entities = require('@selfkey/agent/lib/entities').default; const SelfkeyAgent = require('@selfkey/agent').default; const {createConnection} = require('typeorm'); async function main(){ const infuraId = 'INSERT PROJECT ID'; const dbConnection = createConnection({ type: 'sqlite', database: 'db.sqlite', synchronize: true, logging: ['error', 'info', 'warn'], entities: Entities }); const kmsKey = await SelfkeyAgent.generateKMSKey(); const agent = new SelfkeyAgent({ dbConnection, infuraId, kmsKey, agentName: 'example.com, didProvider: 'did:web' }); const did = await agent.ensureAgentDID(); // 'did:web:example.com const didDoc = await agent.generateDIDDoc(did); /* { "@context": "https://w3id.org/did/v1", "id": "did:web:example.com", "publicKey": [ { "id": "did:web:example.com#0409e2da3624c81b9116c9da841b786cef96b7f4af09107d11c16b39fc5607bbf12be877b6fa7e8c570b3fa736e2d98958981403acba77130ce401ef9056bad5ca", "type": "Secp256k1VerificationKey2018", "controller": "did:web:example.com", "publicKeyHex": "0409e2da3624c81b9116c9da841b786cef96b7f4af09107d11c16b39fc5607bbf12be877b6fa7e8c570b3fa736e2d98958981403acba77130ce401ef9056bad5ca" } ], "authentication": [ { "id": "did:web:example.com#0409e2da3624c81b9116c9da841b786cef96b7f4af09107d11c16b39fc5607bbf12be877b6fa7e8c570b3fa736e2d98958981403acba77130ce401ef9056bad5ca", "type": "Secp256k1SignatureAuthentication2018", "publicKey": "did:web:example.com#0409e2da3624c81b9116c9da841b786cef96b7f4af09107d11c16b39fc5607bbf12be877b6fa7e8c570b3fa736e2d98958981403acba77130ce401ef9056bad5ca", "controller": "did:web:example.com" } ], "service": [] } */ const credentialSubject = { firstName: 'First', lastName: 'Last', nationality: 'Armenia', id: 'did:ethr:0xsdasda2dsadasdas...' }; const credential = await agent.issueCredential({credentialSubject}); const verifiedCredential = await agent.verifyCredential(credential); const presentation = await agent.issuePresentation([credential], 'did:web:verifier.com'); // agent with did 'did:web:verifier.com' await agent.verifyPresentation(presentation); } ``` ## Binary When installing the library, a script executable will be installed as well into `node_modules/.bin` You can generate a Secret Box private key with it ```sh sagent-gen-pk ``` ## API ```ts interface ISelfkeyAgentOptions { dbConnection: Promise; infuraId?: string; kmsKey?: string; kmsName?: string; agentName?: string; didProvider: 'did:web' | 'did:ethr' | 'did:ethr:ropsten'; } ``` ```ts interface IUnsignedCredential { '@context'?: string[]; id?: string; type?: string[]; issuer?: { id: string; [x: string]: any }; issuanceDate?: string; expirationDate?: string; credentialSubject: { id?: string; [x: string]: any; }; credentialStatus?: { id: string; type: string; }; [x: string]: any; } ``` ```ts constructor(private options: ISelfkeyAgentOptions) ``` ```ts static async generateKMSKey(): string ``` Generates a private key that can be used as an input for KMS Secret Box Used in the `sagent-gen-pk` bin script. ```ts async importIdentifier(identifier: IIdentifier) ``` Pass trough function for veramo import method https://github.com/uport-project/veramo/blob/358208519d019d7d90cbefb98911979376c7c056/packages/data-store/src/identifier/did-store.ts#L67 Allows to import an existing identifier to the agent. If you are importing main agent identifier, please specify the `alias` options the same as `agentName` as provided in constructor. If no agent name was provided, specify the default `selfkey-agent` ```ts async ensureAgentDID(options?: object) ``` Returns agent did. If no existing did found, creates a new one. Please make sure to use `importIdentifier` before calling this function if you want to use an existing key for your agent. ```ts sync getAgentDIDDocument(options?: object): Promise ``` Generates a DID document for the agent ```ts async resolveDIDDoc(didUrl: string): Promise ``` Uses DID resolver to resolve a DID doc ```ts async generateDIDDoc(did: string): Promise ``` Generates a DID doc for a did that is stored in the local store. Useful for generating DID Documents for non resolvable DID's ```ts async issueCredential( credential: IUnsignedCredential, options: { save?: boolean; proofFormat?: string; } = { save: false, proofFormat: 'JWT' } ): Promise ``` Issues a new JWT Verifiable credential ```ts async issuePresentation( credentials: VerifiableCredential[], verifierDID: string, holderDid?: string, options?: { save: boolean } ): Promise ``` Issues a new JWT verifiable presentation ```ts async verifyCredential( vc: string | VerifiableCredential, options?: object ): Promise ``` Verifies a JWT verifiable credential. A VC object or a JWT string can be provided ```ts async verifyPresentation( vp: string | VerifiablePresentation, options?: object ): Promise ``` Verifies a JWT verifiable presentation. A VP object or a JWT string can be provided ```ts async listCredentials(): Promise ``` List all credentials stored in local store ```ts async listCredentialsForSubjectId(id: string): Promise ``` Lists credentials from local store filtered by subject id ```ts async listCredentialsForIssuerId(id: string | string[]): Promise ``` Lists credentials from local store filtered by issuer id ## Tests From monorepo root directory run `jest agent` NOTE: verify presentation / credential tests might fail sporadically because they rely on network requests to resolve DID. They should be mocked instead. ## Deploy Navigate to `packages/agent` Run `yarn version` to update the package version Run `git push --tags` to push the new version and tag to the github repo Then run `yarn publish` to publish the new version to npm TODO: Deploy process should happen automatically from CI. Also, versioning and deploy should be managed by lerna on the root of the monorepo. --- _Source: https://npm.io/package/@selfkey/agent · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._