@learncard/core 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,128 @@
+# learn-card-core
+
+> 
+
+[![npm version](https://img.shields.io/npm/v/learn-card-core)](https://www.npmjs.com/package/learn-card-core)
+[![npm downloads](https://img.shields.io/npm/dw/learn-card-core)](https://www.npmjs.com/package/learn-card-core)
+[![vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/learn-card-core)](https://www.npmjs.com/package/learn-card-core)
+
+## Install
+
+```bash
+pnpm i learn-card-core
+```
+
+## Usage
+
+### Instantiation
+
+Instantiate a wallet using `walletFromKey`. This method accepts a unique identifier string that is 
+up to 64 characters long. If it is less than 64 characters, `walletFromKey` will pad the start of
+the string with 0's until it is 64 characters long.
+
+```js
+import { walletFromKey } from "learn-card-core";
+
+const wallet = await walletFromKey('unique-identifier-that-is-up-to-and-preferably64-characters-long');
+```
+
+### Issuing/Verifying Credentials and Presentations
+
+#### Issue a credential
+```js
+// Grab a test VC, or create your own!
+const unsignedVc = await wallet.getTestVc();
+
+const vc = await wallet.issueCredential(unsignedVc);
+```
+
+#### Verify a credential
+```js
+const result = await wallet.verifyCredential(vc);
+
+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.issuePresentation(vc);
+```
+
+#### Verify a presentation
+```js
+const result = await wallet.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 streamId = await wallet.publishCredential(vc);
+```
+
+#### Reading From Ceramic
+
+To resolve a VC from a stream ID, simply call the `readFromCeramic` method:
+
+```js
+const vcFromCeramic = await wallet.readFromCeramic(streamId);
+```
+
+#### 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.addCredential({ id: streamId, title: '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 vcFromIdx = await wallet.getCredential('Test VC');
+```
+
+Alternatively, you can get an array of _all_ credentials you have added using `getCredentials`
+
+```js
+const vcs = await wallet.getCredentials();
+```
+
+## Further Reading
+
+[Read the official docs here!](https://app.gitbook.com/o/6uDv1QDlxaaZC7i8EaGb/s/FXvEJ9j3Vf3FW5Nc557n/)
+
+## License
+
+MIT © [Taylor Beeston <beeston.taylor@gmail.com>](https://github.com/TaylorBeeston)
+
+[Created with aqu 🌊](https://github.com/ArtiomTr/aqu#readme)

package/dist/README.md

@@ -0,0 +1,89 @@
+[![](https://img.shields.io/npm/v/@spruceid/didkit-wasm?label=%40spruceid%2Fdidkit-wasm&logo=npm)](https://www.npmjs.com/package/@spruceid/didkit-wasm) [![](https://img.shields.io/npm/v/@spruceid/didkit-wasm-node?label=%40spruceid%2Fdidkit-wasm-node&logo=npm)](https://www.npmjs.com/package/@spruceid/didkit-wasm-node)
+<!-- Might want those badge in the main README. -->
+
+# DIDKit WASM
+
+## Prerequisites to Build from Source
+
+NPM packages are available but if you would like to compile DIDKit yourself
+(e.g. to enable different cryptographic backends) you will need the WASM
+compiler toolchain as well as a specific build tool:
+
+```bash
+$ rustup target add wasm32-unknown-unknown
+$ cargo install wasm-pack
+# OR
+# $ curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
+```
+
+## Installation and Usage
+
+### Node
+
+WASM can be used in Node.js (any recent version):
+```bash
+$ npm i @spruceid/didkit-wasm-node
+```
+
+Or build it from source:
+```bash
+$ wasm-pack build --target nodejs
+```
+
+### Web Frameworks (Bundled)
+
+WASM can be used with web frameworks and bundlers like Webpack:
+```bash
+$ npm i @spruceid/didkit-wasm
+```
+
+Or build it from source:
+```bash
+$ wasm-pack build
+```
+
+> If Webpack doesn't work with the default configuration, you can have a look at
+> our configuration for
+> [tzprofiles](https://github.com/spruceid/tzprofiles/blob/main/dapp/webpack.config.js).
+
+### Vanilla Javascript
+
+WASM can be used with plain Javascript with newer browsers. As it cannot be used
+as a NPM package you have to build it manually:
+```bash
+$ wasm-pack build --target web
+```
+
+The manual tests in `test/` serve as an example on how to import DIDKit.
+
+## Tests
+
+The `test/` directory contains manual tests to run in the browser. Instructions
+are in the README of the directory.
+
+## Non-Default Compilation
+
+_**The current version of the `ring` crate does not provide all the symbols
+needed to run on the browser, see DEPS.md**_
+
+To compile all features plus `wasm32_c` on `ring`, a C compiler is needed, see
+[spruceid/ssi](https://github.com/spruceid/didkit/tree/wasm):
+
+On Ubuntu this one option is to install `clang` and `llvm`:
+```bash
+sudo apt install clang-10 llvm-10
+```
+
+Then to compile with all features:
+```bash
+TARGET_CC=clang-10 TARGET_AR=llvm-ar-10 wasm-pack build --out-dir pkg
+```
+
+To use a custom subset of features:
+```bash
+wasm-pack build --out-dir pkg -- --no-default-features --features=issue        # issue credential/presentation
+wasm-pack build --out-dir pkg -- --no-default-features --features=verify       # verify credential/presentation
+wasm-pack build --out-dir pkg -- --no-default-features --features=credential   # issue/verify credential
+wasm-pack build --out-dir pkg -- --no-default-features --features=presentation # issue/verify presentation
+```
+*don't forget to add `TARGET_CC` and `TARGET_AR` if using `ring` with `wasm32_c`*