@learncard/network-plugin 3.2.2 → 4.0.0

package/README.md

@@ -1,12 +1,11 @@
 [<img src="https://user-images.githubusercontent.com/2185016/190510561-294db809-09fd-4771-9749-6c0e0f4144fd.png" width="215"/>](https://learncard.com)
 
-# @learncard/core
+# @learncard/network-plugin
 
-[![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)
+[![npm version](https://img.shields.io/npm/v/@learncard/network-plugin)](https://www.npmjs.com/package/@learncard/network-plugin)
+[![npm downloads](https://img.shields.io/npm/dw/@learncard/network-plugin)](https://www.npmjs.com/package/@learncard/network-plugin)
 
-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.
+Connects a LearnCard to LearnCard Network (profiles, connections, boosts, consent flows) and adds Boost verification against a trusted registry.
 
 ## Documentation
 
@@ -16,131 +15,31 @@ https://docs.learncard.com
 ## Install
 
 ```bash
-bun add @learncard/core
+bun add @learncard/init @learncard/network-plugin
 ```
 
 ## Usage
 
-### Instantiation
+This package exports `getLearnCardNetworkPlugin` and `getVerifyBoostPlugin`.
 
-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 { getLearnCardNetworkPlugin, getVerifyBoostPlugin } from '@learncard/network-plugin';
 
-```js
-import { initLearnCard } from '@learncard/core';
+const learnCard = await initLearnCard({ seed: 'a'.repeat(64) });
 
-const wallet = await initLearnCard({ seed: 'a'.repeat(64) });
-```
-
-### Acting as a Managed Profile
-
-Pass `actAs` (a managed profile ID or `did:web`) to `getLearnCardNetworkPlugin`/`initLearnCard` to
-send every network request on behalf of a profile you manage, via the `X-LearnCard-Act-As` header.
-Token scope is unchanged, and the server returns `403` if you don't manage that profile.
-
-```js
-const wallet = await initLearnCard({ seed: 'a'.repeat(64), network: true, actAs: childProfileId });
-// or, from an existing wallet:
-const asChild = await wallet.invoke.actAs(childProfileId);
-```
-
-### 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
+// Verify Boost credentials against a trusted registry (URL optional)
+const verifyLearnCard = await learnCard.addPlugin(await getVerifyBoostPlugin(learnCard));
 
-After receiving a streamID, you can _persist_ that streamID by calling `addCredential`, and giving
-the credential a bespoke title
+// Talk to LearnCard Network
+const networkLearnCard = await verifyLearnCard.addPlugin(
+    await getLearnCardNetworkPlugin(verifyLearnCard, 'https://network.learncard.com/trpc')
+);
 
-```js
-await wallet.index.IDX.add({ uri, id: 'Test VC' });
+const profile = await networkLearnCard.invoke.getProfile();
 ```
 
-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)));
-```
+Most apps don't wire this by hand: `initLearnCard({ seed, network: true })` (or `{ apiKey, network: true }`) adds both plugins and points at `https://network.learncard.com/trpc`. `getLearnCardNetworkPlugin` also takes an options object (e.g. `actAs`) or an API token as its third argument.
 
 ## Contributing
 
@@ -148,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)