@learncard/didkit-plugin 1.10.8 → 1.10.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -114
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,12 +1,11 @@
|
|
|
1
1
|
[<img src="https://user-images.githubusercontent.com/2185016/190510561-294db809-09fd-4771-9749-6c0e0f4144fd.png" width="215"/>](https://learncard.com)
|
|
2
2
|
|
|
3
|
-
# @learncard/
|
|
3
|
+
# @learncard/didkit-plugin
|
|
4
4
|
|
|
5
|
-
[](https://www.npmjs.com/package/@learncard/core)
|
|
5
|
+
[](https://www.npmjs.com/package/@learncard/didkit-plugin)
|
|
6
|
+
[](https://www.npmjs.com/package/@learncard/didkit-plugin)
|
|
8
7
|
|
|
9
|
-
|
|
8
|
+
Wraps the [DIDKit](https://github.com/spruceid/didkit) WASM build to sign and verify credentials and presentations and resolve DIDs.
|
|
10
9
|
|
|
11
10
|
## Documentation
|
|
12
11
|
|
|
@@ -16,63 +15,26 @@ https://docs.learncard.com
|
|
|
16
15
|
## Install
|
|
17
16
|
|
|
18
17
|
```bash
|
|
19
|
-
bun add @learncard/
|
|
18
|
+
bun add @learncard/init @learncard/didkit-plugin
|
|
20
19
|
```
|
|
21
20
|
|
|
22
21
|
## Usage
|
|
23
22
|
|
|
24
|
-
|
|
23
|
+
This package exports `getDidKitPlugin`.
|
|
25
24
|
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
25
|
+
```ts
|
|
26
|
+
import { initLearnCard } from '@learncard/init';
|
|
27
|
+
import { getDidKitPlugin } from '@learncard/didkit-plugin';
|
|
29
28
|
|
|
30
|
-
|
|
31
|
-
import { initLearnCard } from '@learncard/core';
|
|
29
|
+
const learnCard = await initLearnCard({ custom: true });
|
|
32
30
|
|
|
33
|
-
|
|
31
|
+
// Optional args: a custom WASM URL/module, and allowRemoteContexts (default false)
|
|
32
|
+
const didkitLearnCard = await learnCard.addPlugin(await getDidKitPlugin());
|
|
34
33
|
```
|
|
35
34
|
|
|
36
|
-
|
|
35
|
+
On Node, prefer [`@learncard/didkit-plugin-node`](../didkit-plugin-node) (or `initLearnCard({ seed, didkit: 'node' })`). Seed-based `initLearnCard` wallets already include a DIDKit plugin.
|
|
37
36
|
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
```js
|
|
41
|
-
// Grab a test VC, or create your own!
|
|
42
|
-
const unsignedVc = await wallet.invoke.getTestVc();
|
|
43
|
-
|
|
44
|
-
const vc = await wallet.invoke.issueCredential(unsignedVc);
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
#### Verify a credential
|
|
48
|
-
|
|
49
|
-
```js
|
|
50
|
-
const result = await wallet.invoke.verifyCredential(vc, {}, true);
|
|
51
|
-
|
|
52
|
-
if (result.warnings.length > 0) console.error('Verification warnings:', result.warnings);
|
|
53
|
-
|
|
54
|
-
if (result.errors.length > 0) console.error('This credential is not valid!', result.errors);
|
|
55
|
-
else console.log('This credential is valid!');
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
#### Issue a presentation
|
|
59
|
-
|
|
60
|
-
```js
|
|
61
|
-
const vp = await wallet.invoke.issuePresentation(vc);
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
#### Verify a presentation
|
|
65
|
-
|
|
66
|
-
```js
|
|
67
|
-
const result = await wallet.invoke.verifyPresentation(vp);
|
|
68
|
-
|
|
69
|
-
if (result.warnings.length > 0) console.error('Verification warnings:', result.warnings);
|
|
70
|
-
|
|
71
|
-
if (result.errors.length > 0) console.error('This presentation is not valid!', result.errors);
|
|
72
|
-
else console.log('This presentation is valid!');
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
#### Final P-256 Data Integrity proofs
|
|
37
|
+
### Final P-256 Data Integrity proofs
|
|
76
38
|
|
|
77
39
|
The native and WASM engines support explicit `ecdsa-rdfc-2019` proofs with P-256/ES256
|
|
78
40
|
keys. Verification accepts equivalent P-256 JWKs and validated compressed P-256
|
|
@@ -95,64 +57,6 @@ document. Signing-only P-256 `did:key` holders can use generic claim links, but
|
|
|
95
57
|
claims; an unsupported delivery key leaves the pending credential and challenge available
|
|
96
58
|
for retry.
|
|
97
59
|
|
|
98
|
-
### Storing/Retrieving/Sending Credentials
|
|
99
|
-
|
|
100
|
-
#### Ceramic/IDX
|
|
101
|
-
|
|
102
|
-
To maintain co-ownership of credentials, it is best to store credentials in a public place, and then
|
|
103
|
-
store references to that public place. While this is not the only way to store credentials (and is
|
|
104
|
-
also definitely not a silver bullet! E.g. credentials containing private data), it is the opinion of
|
|
105
|
-
this library that it should be used by default. As a result, instantiating a wallet, will
|
|
106
|
-
automatically connect you to WeLibrary's ceramic node, and allow you to publish and retrieve
|
|
107
|
-
credentials there using IDX.
|
|
108
|
-
|
|
109
|
-
#### Publish Credential
|
|
110
|
-
|
|
111
|
-
After signing a VC, you may choose to publish that credential to Ceramic. Doing so will return a
|
|
112
|
-
stream ID, which you may share to the recipient. That stream ID can then be used to resolve the
|
|
113
|
-
issued credential. This means both the issuer and recipient may store the _stream ID_ instead of the
|
|
114
|
-
credential itself.
|
|
115
|
-
|
|
116
|
-
```js
|
|
117
|
-
const uri = await wallet.store.Ceramic.upload(vc);
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
#### Reading From Ceramic
|
|
121
|
-
|
|
122
|
-
To resolve a VC from a stream ID, simply call the `readFromCeramic` method:
|
|
123
|
-
|
|
124
|
-
```js
|
|
125
|
-
const vcFromCeramic = await wallet.read.get(uri);
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
#### Adding a Credential to a Wallet
|
|
129
|
-
|
|
130
|
-
After receiving a streamID, you can _persist_ that streamID by calling `addCredential`, and giving
|
|
131
|
-
the credential a bespoke title
|
|
132
|
-
|
|
133
|
-
```js
|
|
134
|
-
await wallet.index.IDX.add({ uri, id: 'Test VC' });
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
This will add the streamId, which can be used to resolve the verifiable credential to IDX using the
|
|
138
|
-
wallet's secret key. You can think of this as acting like the wallet's personal storage.
|
|
139
|
-
|
|
140
|
-
#### Getting a credential from the Wallet
|
|
141
|
-
|
|
142
|
-
After calling `addCredential`, you can use the bespoke title to retrieve that credential at any time
|
|
143
|
-
|
|
144
|
-
```js
|
|
145
|
-
const record = (await wallet.index.all.get()).find(record => record.id === 'Test VC');
|
|
146
|
-
const vcFromIdx = await wallet.read.get(record.uri);
|
|
147
|
-
```
|
|
148
|
-
|
|
149
|
-
Alternatively, you can get an array of _all_ credentials you have added using `getCredentials`
|
|
150
|
-
|
|
151
|
-
```js
|
|
152
|
-
const uris = (await wallet.index.all.get()).map(record => record.uri);
|
|
153
|
-
const vcs = await Promise.all(uris.map(async uri => wallet.read.get(uri)));
|
|
154
|
-
```
|
|
155
|
-
|
|
156
60
|
## Contributing
|
|
157
61
|
|
|
158
62
|
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
|
@@ -171,10 +75,6 @@ separate WASM graph. The committed WASM/glue pair and hosted URL are retained un
|
|
|
171
75
|
the normal source-update workflow builds, tests, and publishes a matching artifact
|
|
172
76
|
pair and updates the URL and bridge integrity pin.
|
|
173
77
|
|
|
174
|
-
## Who is Learning Economy Foundation?
|
|
175
|
-
|
|
176
|
-
**[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:
|
|
177
|
-
|
|
178
78
|
## License
|
|
179
79
|
|
|
180
80
|
MIT © [Learning Economy Foundation](https://github.com/Learning-Economy-Foundation)
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@learncard/didkit-plugin",
|
|
3
|
-
"version": "1.10.
|
|
4
|
-
"description": "",
|
|
3
|
+
"version": "1.10.10",
|
|
4
|
+
"description": "DIDKit (WASM) plugin for signing and verifying credentials and resolving DIDs.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
7
7
|
"module": "./dist/didkit-plugin.esm.js",
|
|
@@ -56,8 +56,8 @@
|
|
|
56
56
|
},
|
|
57
57
|
"types": "./dist/index.d.ts",
|
|
58
58
|
"dependencies": {
|
|
59
|
-
"@learncard/core": "9.4.
|
|
60
|
-
"@learncard/types": "
|
|
59
|
+
"@learncard/core": "9.4.44",
|
|
60
|
+
"@learncard/types": "6.0.0"
|
|
61
61
|
},
|
|
62
62
|
"sideEffects": false
|
|
63
63
|
}
|