@learncard/core 1.0.0

package/dist/didkit/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`*

package/dist/didkit/didkit_wasm.d.ts

@@ -0,0 +1,222 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+* @returns {string}
+*/
+export function getVersion(): string;
+/**
+* @param {string} did
+* @param {string} input_metadata
+* @returns {Promise<any>}
+*/
+export function resolveDID(did: string, input_metadata: string): Promise<any>;
+/**
+* @returns {string}
+*/
+export function generateEd25519Key(): string;
+/**
+* @param {Uint8Array} bytes
+* @returns {string}
+*/
+export function generateEd25519KeyFromBytes(bytes: Uint8Array): string;
+/**
+* @param {string} method_pattern
+* @param {string} jwk
+* @returns {string}
+*/
+export function keyToDID(method_pattern: string, jwk: string): string;
+/**
+* @param {string} method_pattern
+* @param {string} jwk
+* @returns {Promise<any>}
+*/
+export function keyToVerificationMethod(method_pattern: string, jwk: string): Promise<any>;
+/**
+* @param {string} credential
+* @param {string} proof_options
+* @param {string} key
+* @returns {Promise<any>}
+*/
+export function issueCredential(credential: string, proof_options: string, key: string): Promise<any>;
+/**
+* @param {string} credential
+* @param {string} linked_data_proof_options
+* @param {string} public_key
+* @returns {Promise<any>}
+*/
+export function prepareIssueCredential(credential: string, linked_data_proof_options: string, public_key: string): Promise<any>;
+/**
+* @param {string} credential
+* @param {string} preparation
+* @param {string} signature
+* @returns {Promise<any>}
+*/
+export function completeIssueCredential(credential: string, preparation: string, signature: string): Promise<any>;
+/**
+* @param {string} vc
+* @param {string} proof_options
+* @returns {Promise<any>}
+*/
+export function verifyCredential(vc: string, proof_options: string): Promise<any>;
+/**
+* @param {string} presentation
+* @param {string} proof_options
+* @param {string} key
+* @returns {Promise<any>}
+*/
+export function issuePresentation(presentation: string, proof_options: string, key: string): Promise<any>;
+/**
+* @param {string} presentation
+* @param {string} linked_data_proof_options
+* @param {string} public_key
+* @returns {Promise<any>}
+*/
+export function prepareIssuePresentation(presentation: string, linked_data_proof_options: string, public_key: string): Promise<any>;
+/**
+* @param {string} presentation
+* @param {string} preparation
+* @param {string} signature
+* @returns {Promise<any>}
+*/
+export function completeIssuePresentation(presentation: string, preparation: string, signature: string): Promise<any>;
+/**
+* @param {string} vp
+* @param {string} proof_options
+* @returns {Promise<any>}
+*/
+export function verifyPresentation(vp: string, proof_options: string): Promise<any>;
+/**
+* @param {string} holder
+* @param {string} linked_data_proof_options
+* @param {string} key
+* @returns {Promise<any>}
+*/
+export function DIDAuth(holder: string, linked_data_proof_options: string, key: string): Promise<any>;
+/**
+* @param {string} tz
+* @returns {Promise<any>}
+*/
+export function JWKFromTezos(tz: string): Promise<any>;
+/**
+* @param {string} capability
+* @param {string} linked_data_proof_options
+* @param {string} parents
+* @param {string} key
+* @returns {Promise<any>}
+*/
+export function delegateCapability(capability: string, linked_data_proof_options: string, parents: string, key: string): Promise<any>;
+/**
+* @param {string} capability
+* @param {string} linked_data_proof_options
+* @param {string} parents
+* @param {string} public_key
+* @returns {Promise<any>}
+*/
+export function prepareDelegateCapability(capability: string, linked_data_proof_options: string, parents: string, public_key: string): Promise<any>;
+/**
+* @param {string} capability
+* @param {string} preparation
+* @param {string} signature
+* @returns {Promise<any>}
+*/
+export function completeDelegateCapability(capability: string, preparation: string, signature: string): Promise<any>;
+/**
+* @param {string} delegation
+* @returns {Promise<any>}
+*/
+export function verifyDelegation(delegation: string): Promise<any>;
+/**
+* @param {string} invocation
+* @param {string} target_id
+* @param {string} linked_data_proof_options
+* @param {string} key
+* @returns {Promise<any>}
+*/
+export function invokeCapability(invocation: string, target_id: string, linked_data_proof_options: string, key: string): Promise<any>;
+/**
+* @param {string} invocation
+* @param {string} target_id
+* @param {string} linked_data_proof_options
+* @param {string} public_key
+* @returns {Promise<any>}
+*/
+export function prepareInvokeCapability(invocation: string, target_id: string, linked_data_proof_options: string, public_key: string): Promise<any>;
+/**
+* @param {string} invocation
+* @param {string} preparation
+* @param {string} signature
+* @returns {Promise<any>}
+*/
+export function completeInvokeCapability(invocation: string, preparation: string, signature: string): Promise<any>;
+/**
+* @param {string} invocation
+* @returns {Promise<any>}
+*/
+export function verifyInvocationSignature(invocation: string): Promise<any>;
+/**
+* @param {string} invocation
+* @param {string} delegation
+* @returns {Promise<any>}
+*/
+export function verifyInvocation(invocation: string, delegation: string): Promise<any>;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+  readonly memory: WebAssembly.Memory;
+  readonly getVersion: (a: number) => void;
+  readonly resolveDID: (a: number, b: number, c: number, d: number) => number;
+  readonly generateEd25519Key: (a: number) => void;
+  readonly generateEd25519KeyFromBytes: (a: number, b: number, c: number) => void;
+  readonly keyToDID: (a: number, b: number, c: number, d: number, e: number) => void;
+  readonly keyToVerificationMethod: (a: number, b: number, c: number, d: number) => number;
+  readonly issueCredential: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
+  readonly prepareIssueCredential: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
+  readonly completeIssueCredential: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
+  readonly verifyCredential: (a: number, b: number, c: number, d: number) => number;
+  readonly issuePresentation: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
+  readonly prepareIssuePresentation: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
+  readonly completeIssuePresentation: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
+  readonly verifyPresentation: (a: number, b: number, c: number, d: number) => number;
+  readonly DIDAuth: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
+  readonly JWKFromTezos: (a: number, b: number) => number;
+  readonly delegateCapability: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => number;
+  readonly prepareDelegateCapability: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => number;
+  readonly completeDelegateCapability: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
+  readonly verifyDelegation: (a: number, b: number) => number;
+  readonly invokeCapability: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => number;
+  readonly prepareInvokeCapability: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => number;
+  readonly completeInvokeCapability: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
+  readonly verifyInvocationSignature: (a: number, b: number) => number;
+  readonly verifyInvocation: (a: number, b: number, c: number, d: number) => number;
+  readonly didkit_error_message: () => number;
+  readonly didkit_error_code: () => number;
+  readonly SHA1DCUpdate: (a: number, b: number, c: number) => void;
+  readonly sha1_compression_states: (a: number, b: number, c: number, d: number) => void;
+  readonly SHA1DCInit: (a: number) => void;
+  readonly SHA1DCSetSafeHash: (a: number, b: number) => void;
+  readonly SHA1DCSetUseUBC: (a: number, b: number) => void;
+  readonly SHA1DCSetUseDetectColl: (a: number, b: number) => void;
+  readonly SHA1DCSetDetectReducedRoundCollision: (a: number, b: number) => void;
+  readonly SHA1DCSetCallback: (a: number, b: number) => void;
+  readonly ubc_check: (a: number, b: number) => void;
+  readonly SHA1DCFinal: (a: number, b: number) => number;
+  readonly __wbindgen_malloc: (a: number) => number;
+  readonly __wbindgen_realloc: (a: number, b: number, c: number) => number;
+  readonly __wbindgen_export_2: WebAssembly.Table;
+  readonly _dyn_core__ops__function__FnMut__A____Output___R_as_wasm_bindgen__closure__WasmClosure___describe__invoke__h91a8814f66f14b17: (a: number, b: number, c: number) => void;
+  readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+  readonly __wbindgen_free: (a: number, b: number) => void;
+  readonly __wbindgen_exn_store: (a: number) => void;
+  readonly wasm_bindgen__convert__closures__invoke2_mut__h3ecfeb7a01c1be81: (a: number, b: number, c: number, d: number) => void;
+}
+
+/**
+* If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+* for everything else, calls `WebAssembly.instantiate` directly.
+*
+* @param {InitInput | Promise<InitInput>} module_or_path
+*
+* @returns {Promise<InitOutput>}
+*/
+export default function init (module_or_path?: InitInput | Promise<InitInput>): Promise<InitOutput>;