@0xpolygonid/js-sdk 1.0.0-beta.0

package/dist/types/verifiable/credential.d.ts

@@ -0,0 +1,123 @@
+import { BJJSignatureProof2021, Iden3SparseMerkleTreeProof } from './proof';
+import { Claim } from '@iden3/js-iden3-core';
+import { CredentialStatusType, ProofType } from './constants';
+import { Proof } from '@iden3/js-merkletree';
+import { Merkelizer } from '@iden3/js-jsonld-merklization';
+/**
+ * W3C Verifiable credential
+ *
+ * https://www.w3.org/2018/credentials/v1
+ * @export
+ * @beta
+ * @class W3CCredential
+ */
+export declare class W3CCredential {
+    id: string;
+    '@context': string[];
+    type: string[];
+    expirationDate?: string;
+    issuanceDate?: string;
+    credentialSubject: {
+        [key: string]: object | string | number;
+    };
+    credentialStatus: CredentialStatus | RHSCredentialStatus;
+    issuer: string;
+    credentialSchema: CredentialSchema;
+    proof?: object;
+    /**
+     * merklization of the verifiable credential
+     *
+     * @returns `Promise<Merkelizer>`
+     */
+    merklize(): Promise<Merkelizer>;
+    /**
+     * gets core claim representation from credential proof
+     *
+     * @param {ProofType} proofType
+     * @returns {*}  {(Claim | undefined)}
+     */
+    getCoreClaimFromProof(proofType: ProofType): Claim | undefined;
+    /**
+     * checks BJJSignatureProof2021 in W3C VC
+     *
+     * @returns BJJSignatureProof2021 | undefined
+     */
+    getBJJSignature2021Proof(): BJJSignatureProof2021 | undefined;
+    /**
+     * checks Iden3SparseMerkleTreeProof in W3C VC
+     *
+     * @returns {*}  {(Iden3SparseMerkleTreeProof | undefined)}
+     */
+    getIden3SparseMerkleTreeProof(): Iden3SparseMerkleTreeProof | undefined;
+}
+/**
+ * extracts core claim from Proof and returns Proof Type
+ *
+ * @export
+ * @param {object} proof - proof of vc
+ * @returns {*}  {{ claim: Claim; proofType: ProofType }}
+ */
+export declare function extractProof(proof: object): {
+    claim: Claim;
+    proofType: ProofType;
+};
+/**
+ * Credential schema vc
+ *
+ * @export
+ * @beta
+ * @interface   CredentialSchema
+ */
+export interface CredentialSchema {
+    id: string;
+    type: string;
+}
+/**
+ * RHSCredentialStatus contains type, url to fetch RHS info, issuer ID and revocation nonce and backup option to fetch credential status
+ *
+ * @export
+ * @beta
+ * @interface   RHSCredentialStatus
+ */
+export interface RHSCredentialStatus {
+    id: string;
+    type: CredentialStatusType;
+    revocationNonce: number;
+    statusIssuer?: CredentialStatus;
+}
+/**
+ *
+ * CredentialStatus contains type and revocation Url
+ * @export
+ * @beta
+ * @interface   CredentialStatus
+ */
+export interface CredentialStatus {
+    id: string;
+    type: CredentialStatusType;
+    revocationNonce?: number;
+}
+/**
+ * Issuer tree information
+ *
+ * @export
+ * @beta
+ * @interface   Issuer
+ */
+export interface Issuer {
+    state?: string;
+    rootOfRoots?: string;
+    claimsTreeRoot?: string;
+    revocationTreeRoot?: string;
+}
+/**
+ *
+ * RevocationStatus status of revocation nonce. Info required to check revocation state of claim in circuits
+ * @export
+ * @beta
+ * @interface   RevocationStatus
+ */
+export interface RevocationStatus {
+    mtp: Proof;
+    issuer: Issuer;
+}

package/dist/types/verifiable/index.d.ts

@@ -0,0 +1,4 @@
+export * from './credential';
+export * from './proof';
+export * from './schema';
+export * from './constants';

package/dist/types/verifiable/proof.d.ts

@@ -0,0 +1,123 @@
+import { Proof } from '@iden3/js-merkletree';
+import { ProofType } from './constants';
+import { TreeState } from '../circuits';
+/**
+ * Represents the published state of the issuer
+ *
+ * @export
+ * @beta
+ * @interface   State
+ */
+export interface State {
+    txId?: string;
+    blockTimestamp?: number;
+    blockNumber?: number;
+    rootOfRoots: string;
+    claimsTreeRoot: string;
+    revocationTreeRoot: string;
+    value: string;
+    status?: string;
+}
+/**
+ *  IssuerData is the data that is used to create a proof
+ *
+ * @export
+ * @beta
+ * @class   IssuerData
+ */
+export declare class IssuerData {
+    id: string;
+    state: State;
+    authCoreClaim?: string;
+    mtp?: Proof;
+    credentialStatus?: object;
+    /**
+     * Creates an instance ofIssuerData .
+     * @param {object} obj
+     */
+    constructor(obj?: object);
+    /**
+     *
+     *
+     * @returns `string`
+     */
+    toJSON(): this & {
+        mtp: {
+            existence: boolean;
+            siblings: import("@iden3/js-merkletree").Siblings;
+            nodeAux: import("@iden3/js-merkletree").NodeAux;
+        };
+    };
+}
+/**
+ * Iden3SparseMerkleProof is a iden3 protocol merkle tree proof
+ *
+ * @export
+ * @beta
+ * @class Iden3SparseMerkleTreeProof
+ */
+export declare class Iden3SparseMerkleTreeProof {
+    type: ProofType;
+    issuerData: IssuerData;
+    mtp: Proof;
+    coreClaim: string;
+    /**
+     * Creates an instance of Iden3SparseMerkleTreeProof.
+     * @param {object} obj
+     */
+    constructor(obj?: object);
+    /**
+     *
+     *
+     * @returns `string`
+     */
+    toJSON(): this & {
+        mtp: {
+            existence: boolean;
+            siblings: import("@iden3/js-merkletree").Siblings;
+            nodeAux: import("@iden3/js-merkletree").NodeAux;
+        };
+    };
+}
+/**
+ *
+ * BJJSignatureProof2021 is a signature of core claim by BJJ key
+ * @export
+ * @beta
+ * @class BJJSignatureProof2021
+ */
+export declare class BJJSignatureProof2021 {
+    type: ProofType;
+    issuerData: IssuerData;
+    signature: string;
+    coreClaim: string;
+}
+/**
+ *  Query represents structure for query to atomic circuit
+ *
+ * @export
+ * @beta
+ * @interface   ProofQuery
+ */
+export interface ProofQuery {
+    allowedIssuers?: string[];
+    credentialSubject?: {
+        [key: string]: unknown;
+    };
+    schema?: string;
+    claimId?: string;
+    credentialSubjectId?: string;
+    context?: string;
+    type?: string;
+}
+/**
+ * Proof with MerkleTree info
+ *
+ * @export
+ * @beta
+ * @interface   MerkleTreeProofWithTreeState
+ */
+export interface MerkleTreeProofWithTreeState {
+    proof: Proof;
+    treeState: TreeState;
+}

package/dist/types/verifiable/schema.d.ts

@@ -0,0 +1,2 @@
+/** DIDDocumentJSONSchema is a basic schema of did document */
+export declare const DIDDocumentJSONSchema = "{\n  \"type\": \"object\",\n  \"$defs\": {\n    \"serviceEndpoint\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"id\": {\n          \"type\": \"string\"\n        },\n        \"type\": {\n          \"type\": \"string\"\n        },\n        \"serviceEndpoint\": {\n          \"type\": \"string\"\n        },\n        \"metadata\": {\n          \"type\": \"object\"\n        }\n      },\n      \"required\": [\n        \"id\",\n        \"type\",\n        \"serviceEndpoint\"\n      ]\n    },\n    \"jsonWebKey\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"alg\": {\n          \"type\": \"string\"\n        },\n        \"crv\": {\n          \"type\": \"string\"\n        },\n        \"e\": {\n          \"type\": \"string\"\n        },\n        \"ext\": {\n          \"type\": \"boolean\"\n        },\n        \"key_ops\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"string\"\n          }\n        },\n        \"kid\": {\n          \"type\": \"string\"\n        },\n        \"kty\": {\n          \"type\": \"string\"\n        },\n        \"n\": {\n          \"type\": \"string\"\n        },\n        \"use\": {\n          \"type\": \"string\"\n        },\n        \"x\": {\n          \"type\": \"string\"\n        },\n        \"y\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"kty\"\n      ],\n      \"description\": \"Public parts of JSON web key\"\n    },\n    \"verificationMethod\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"id\": {\n          \"type\": \"string\"\n        },\n        \"type\": {\n          \"type\": \"string\"\n        },\n        \"controller\": {\n          \"type\": \"string\"\n        },\n        \"publicKeyBase58\": {\n          \"type\": \"string\"\n        },\n        \"publicKeyBase64\": {\n          \"type\": \"string\"\n        },\n        \"publicKeyJwk\": {\n          \"$ref\": \"#/$defs/jsonWebKey\"\n        },\n        \"publicKeyHex\": {\n          \"type\": \"string\"\n        },\n        \"publicKeyMultibase\": {\n          \"type\": \"string\"\n        },\n        \"blockchainAccountId\": {\n          \"type\": \"string\"\n        },\n        \"ethereumAddress\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"id\",\n        \"type\",\n        \"controller\"\n      ]\n    }\n  },\n  \"properties\": {\n    \"authentication\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"anyOf\": [\n          {\n            \"type\": \"string\"\n          },\n          {\n            \"$ref\": \"#/$defs/verificationMethod\"\n          }\n        ]\n      }\n    },\n    \"assertionMethod\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"anyOf\": [\n          {\n            \"type\": \"string\"\n          },\n          {\n            \"$ref\": \"#/$defs/verificationMethod\"\n          }\n        ]\n      }\n    },\n    \"keyAgreement\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"anyOf\": [\n          {\n            \"type\": \"string\"\n          },\n          {\n            \"$ref\": \"#/$defs/verificationMethod\"\n          }\n        ]\n      }\n    },\n    \"capabilityInvocation\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"anyOf\": [\n          {\n            \"type\": \"string\"\n          },\n          {\n            \"$ref\": \"#/$defs/verificationMethod\"\n          }\n        ]\n      }\n    },\n    \"capabilityDelegation\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"anyOf\": [\n          {\n            \"type\": \"string\"\n          },\n          {\n            \"$ref\": \"#/$defs/verificationMethod\"\n          }\n        ]\n      }\n    },\n    \"@context\": {\n      \"anyOf\": [\n        {\n          \"type\": \"string\",\n          \"const\": \"https://www.w3.org/ns/did/v1\"\n        },\n        {\n          \"type\": \"string\"\n        },\n        {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"string\"\n          }\n        }\n      ]\n    },\n    \"id\": {\n      \"type\": \"string\"\n    },\n    \"alsoKnownAs\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"string\"\n      }\n    },\n    \"controller\": {\n      \"anyOf\": [\n        {\n          \"type\": \"string\"\n        },\n        {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"string\"\n          }\n        }\n      ]\n    },\n    \"verificationMethod\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"$ref\": \"#/$defs/verificationMethod\"\n      }\n    },\n    \"service\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"$ref\": \"#/$defs/serviceEndpoint\"\n      }\n    },\n    \"publicKey\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"$ref\": \"#/$defs/verificationMethod\"\n      },\n      \"deprecated\": true\n    }\n  },\n  \"required\": [\n    \"id\"\n  ]\n}";