learn-card-core

Install

pnpm i learn-card-core

Usage

Instantiation

Instantiate a wallet using walletFromKey. This method accepts a unique identifier string that is up to 64 characters long. If it is less than 64 characters, walletFromKey will pad the start of the string with 0's until it is 64 characters long.

import { walletFromKey } from "learn-card-core";

const wallet = await walletFromKey('unique-identifier-that-is-up-to-and-preferably64-characters-long');

Issuing/Verifying Credentials and Presentations

Issue a credential

// Grab a test VC, or create your own!
const unsignedVc = await wallet.getTestVc();

const vc = await wallet.issueCredential(unsignedVc);

Verify a credential

const result = await wallet.verifyCredential(vc);

if (result.warnings.length > 0) console.error('Verification warnings:', result.warnings);

if (result.errors.length > 0) console.error('This credential is not valid!', result.errors);
else console.log('This credential is valid!');

Issue a presentation

const vp = await wallet.issuePresentation(vc);

Verify a presentation

const result = await wallet.verifyPresentation(vp);

if (result.warnings.length > 0) console.error('Verification warnings:', result.warnings);

if (result.errors.length > 0) console.error('This presentation is not valid!', result.errors);
else console.log('This presentation is valid!');

Storing/Retrieving/Sending Credentials

Ceramic/IDX

To maintain co-ownership of credentials, it is best to store credentials in a public place, and then store references to that public place. While this is not the only way to store credentials (and is also definitely not a silver bullet! E.g. credentials containing private data), it is the opinion of this library that it should be used by default. As a result, instantiating a wallet, will automatically connect you to WeLibrary's ceramic node, and allow you to publish and retrieve credentials there using IDX.

Publish Credential

After signing a VC, you may choose to publish that credential to Ceramic. Doing so will return a stream ID, which you may share to the recipient. That stream ID can then be used to resolve the issued credential. This means both the issuer and recipient may store the stream ID instead of the credential itself.

const streamId = await wallet.publishCredential(vc);

Reading From Ceramic

To resolve a VC from a stream ID, simply call the readFromCeramic method:

const vcFromCeramic = await wallet.readFromCeramic(streamId);

Adding a Credential to a Wallet

After receiving a streamID, you can persist that streamID by calling addCredential, and giving the credential a bespoke title

await wallet.addCredential({ id: streamId, title: 'Test VC' });

This will add the streamId, which can be used to resolve the verifiable credential to IDX using the wallet's secret key. You can think of this as acting like the wallet's personal storage.

Getting a credential from the Wallet

After calling addCredential, you can use the bespoke title to retrieve that credential at any time

const vcFromIdx = await wallet.getCredential('Test VC');

Alternatively, you can get an array of all credentials you have added using getCredentials

const vcs = await wallet.getCredentials();

Further Reading

Read the official docs here!

License

MIT © Taylor Beeston [email protected]

Created with aqu 🌊