@learncard/network-plugin
TypeScript icon, indicating that this package has built-in type declarations

1.7.8 • Public • Published

@learncard/core

npm version npm downloads vulnerabilities

The LearnCard Core is a pluggable, open-source, universal digital wallet to enable any individual or organization to seamlessly issue, earn, store, share, and spend currency and credentials built for the future of education and work.

Documentation

All LearnCard documentation can be found at: https://docs.learncard.com

Install

pnpm i @learncard/core

Usage

Instantiation

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

import { initLearnCard } from "@learncard/core";

const wallet = await initLearnCard({ seed: 'a'.repeat(64) });

Issuing/Verifying Credentials and Presentations

Issue a credential

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

const vc = await wallet.invoke.issueCredential(unsignedVc);

Verify a credential

const result = await wallet.invoke.verifyCredential(vc, {}, true);

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.invoke.issuePresentation(vc);

Verify a presentation

const result = await wallet.invoke.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 uri = await wallet.store.Ceramic.upload(vc);

Reading From Ceramic

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

const vcFromCeramic = await wallet.read.get(uri);

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.index.IDX.add({ uri, id: '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 record = (await wallet.index.all.get()).find(record => record.id === 'Test VC');
const vcFromIdx = await wallet.read.get(record.uri);

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

const uris = (await wallet.index.all.get()).map(record => record.uri);
const vcs = await Promise.all(uris.map(async uri => wallet.read.get(uri)));

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Who is Learning Economy Foundation?

Learning Economy Foundation (LEF) is a 501(c)(3) non-profit organization leveraging global standards and web3 protocols to bring quality skills and equal opportunity to every human on earth, and address the persistent inequities that exist around the globe in education and employment. We help you build the future of education and work with:

License

MIT © Learning Economy Foundation

Readme

Keywords

none

Package Sidebar

Install

npm i @learncard/network-plugin

Weekly Downloads

198

Version

1.7.8

License

MIT

Unpacked Size

1.43 MB

Total Files

20

Last publish

Collaborators

  • gerardopar
  • jonny2lips
  • taylorbeeston
  • smurflo2
  • custard7