@learncard/ceramic-plugin 1.1.42 → 1.1.44

package/README.md

@@ -4,9 +4,8 @@
 
 [![npm version](https://img.shields.io/npm/v/@learncard/ceramic-plugin)](https://www.npmjs.com/package/@learncard/ceramic-plugin)
 [![npm downloads](https://img.shields.io/npm/dw/@learncard/ceramic-plugin)](https://www.npmjs.com/package/@learncard/ceramic-plugin)
-[![vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/@learncard/ceramic-plugin)](https://www.npmjs.com/package/@learncard/ceramic-plugin)
 
-The Ceramic Plugin provides Ceramic Network integration for LearnCard, allowing for decentralized storage of Verifiable Credentials. Note: LearnCloud is now the recommended storage solution for LearnCard.
+**Legacy.** Publishes and reads credentials on [Ceramic](https://ceramic.network) streams. LearnCard's default storage is now LearnCloud and LearnCard Network; IDX/Ceramic support is kept for older wallets.
 
 ## Documentation
 
@@ -16,119 +15,31 @@ https://docs.learncard.com
 ## Install
 
 ```bash
-bun add @learncard/core
+bun add @learncard/init @learncard/ceramic-plugin
 ```
 
 ## Usage
 
-### Instantiation
+This package exports `getCeramicPlugin`.
 
-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.
+```ts
+import { initLearnCard } from '@learncard/init';
+import { getCeramicPlugin } from '@learncard/ceramic-plugin';
 
-```js
-import { initLearnCard } from '@learncard/core';
+const learnCard = await initLearnCard({ seed: 'a'.repeat(64) });
+const ceramicLearnCard = await learnCard.addPlugin(
+    await getCeramicPlugin(learnCard, {
+        ceramicEndpoint: '<Ceramic node URL>',
+        defaultContentFamily: 'SuperSkills',
+    })
+);
 
-const wallet = await initLearnCard({ seed: 'a'.repeat(64) });
+const vc = await ceramicLearnCard.invoke.issueCredential(ceramicLearnCard.invoke.getTestVc());
+const uri = await ceramicLearnCard.store.Ceramic.upload(vc);
+const resolved = await ceramicLearnCard.read.get(uri);
 ```
 
-### 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)));
-```
+The second argument is optional and defaults to the plugin's built-in Ceramic args. The old `wallet.index.IDX` flow lives in the deprecated [`@learncard/idx-plugin`](../idx).
 
 ## Contributing
 
@@ -136,10 +47,6 @@ Pull requests are welcome. For major changes, please open an issue first to disc
 
 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/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@learncard/ceramic-plugin",
-    "version": "1.1.42",
-    "description": "",
+    "version": "1.1.44",
+    "description": "Legacy plugin that publishes and reads credentials on Ceramic streams.",
     "type": "module",
     "main": "./dist/index.cjs",
     "module": "./dist/ceramic-plugin.esm.js",
@@ -39,7 +39,7 @@
         "url": "https://github.com/learningeconomy/LearnCard/issues"
     },
     "devDependencies": {
-        "@learncard/didkit-plugin": "1.10.8",
+        "@learncard/didkit-plugin": "1.10.10",
         "@types/lodash": "^4.14.191",
         "@types/node": "^17.0.31",
         "aqu": "0.4.3",
@@ -53,8 +53,8 @@
         "@ceramicnetwork/http-client": "2.7.0",
         "@ceramicnetwork/stream-tile": "2.9.0",
         "@glazed/tile-loader": "0.2.1",
-        "@learncard/core": "9.4.42",
-        "@learncard/types": "5.24.1",
+        "@learncard/core": "9.4.44",
+        "@learncard/types": "6.0.0",
         "did-jwt": "5.9.0",
         "dids": "^3.2.0",
         "hex-lite": "^1.5.0",