@learncard/vpqr-plugin 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Taylor Beeston <beeston.taylor@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,140 @@
+[<img src="https://user-images.githubusercontent.com/2185016/190510561-294db809-09fd-4771-9749-6c0e0f4144fd.png" width="215"/>](https://learncard.com)
+
+# @learncard/core
+
+[![npm version](https://img.shields.io/npm/v/@learncard/core)](https://www.npmjs.com/package/@learncard/core)
+[![npm downloads](https://img.shields.io/npm/dw/@learncard/core)](https://www.npmjs.com/package/@learncard/core)
+[![vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/@learncard/core)](https://www.npmjs.com/package/@learncard/core)
+
+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
+
+```bash
+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.
+
+```js
+import { initLearnCard } from "@learncard/core";
+
+const wallet = await initLearnCard({ seed: 'a'.repeat(64) });
+```
+
+### Issuing/Verifying Credentials and Presentations
+
+#### Issue a credential
+```js
+// Grab a test VC, or create your own!
+const unsignedVc = await wallet.invoke.getTestVc();
+
+const vc = await wallet.invoke.issueCredential(unsignedVc);
+```
+
+#### Verify a credential
+```js
+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
+```js
+const vp = await wallet.invoke.issuePresentation(vc);
+```
+
+#### Verify a presentation
+```js
+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.
+
+```js
+const uri = await wallet.store.Ceramic.upload(vc);
+```
+
+#### Reading From Ceramic
+
+To resolve a VC from a stream ID, simply call the `readFromCeramic` method:
+
+```js
+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
+
+```js
+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
+
+```js
+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`
+
+```js
+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)](https://www.learningeconomy.io)** 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](https://github.com/Learning-Economy-Foundation)

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+import { VpqrPlugin, VpqrPluginDependentMethods } from './types';
+import { LearnCard } from '@learncard/core';
+export * from './types';
+/**
+ * @group Plugins
+ */
+export declare const getVpqrPlugin: (learnCard: LearnCard<any, any, VpqrPluginDependentMethods>) => VpqrPlugin;

package/dist/index.js

@@ -0,0 +1,7 @@
+'use strict';
+
+if (process.env.NODE_ENV === 'production') {
+    module.exports = require('./vpqr-plugin.cjs.production.min.js');
+} else {
+    module.exports = require('./vpqr-plugin.cjs.development.js');
+}

package/dist/types.d.ts

@@ -0,0 +1,12 @@
+import { VP } from '@learncard/types';
+import { Plugin } from '@learncard/core';
+/** @group VPQR Plugin */
+export type VpqrPluginMethods = {
+    vpFromQrCode: (text: string) => Promise<VP>;
+    vpToQrCode: (vp: VP) => Promise<string>;
+};
+/** @group VPQR Plugin */
+export type VpqrPluginDependentMethods = {
+    contextLoader: (url: string) => Promise<Record<string, any>>;
+};
+export type VpqrPlugin = Plugin<'Vpqr', any, VpqrPluginMethods, any, VpqrPluginDependentMethods>;