feat: 🎸 add a sign method to append signed proofs (#92)

Open-Attestation · May 4, 2020 · 4fbc2c2 · 4fbc2c2
1 parent b5f8242
commit 4fbc2c2
Show file tree

Hide file tree

Showing 10 changed files with 649 additions and 428 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -66,6 +66,7 @@
   "dependencies": {
     "ajv": "6.10.2",
     "debug": "^4.1.1",
+    "ethers": "^4.0.47",
     "flatley": "^5.2.0",
     "js-sha3": "^0.8.0",
     "lodash": "^4.17.15",

diff --git a/src/@types/document.ts b/src/@types/document.ts
@@ -12,6 +12,13 @@ export interface Signature {
   merkleRoot: string;
 }
 
+export interface ProofSigningOptions {
+  privateKey: string;
+  verificationMethod: string;
+  type: ProofType;
+  proofPurpose?: ProofPurpose;
+}
+
 export interface ObfuscationMetadata {
   obfuscatedData?: string[];
 }
@@ -30,6 +37,22 @@ export interface WrappedDocument<T = any> {
   schema?: string;
   privacy?: ObfuscationMetadata;
 }
+export enum ProofType {
+  EcdsaSecp256k1Signature2019 = "EcdsaSecp256k1Signature2019"
+}
+export enum ProofPurpose {
+  AssertionMethod = "assertionMethod"
+}
+export interface Proof {
+  type: ProofType;
+  created: string;
+  proofPurpose: ProofPurpose;
+  verificationMethod: string;
+  signature: string;
+}
+export interface SignedWrappedDocument<T = any> extends WrappedDocument<T> {
+  proof: Proof;
+}
 
 // feel free to improve, as long as this project compile without changes :)
 // once salted, every property is turned into a string

diff --git a/src/index.ts b/src/index.ts
@@ -62,6 +62,7 @@ export const validateSchema = (document: WrappedDocument): boolean => {
 
 export { digestDocument } from "./digest";
 export { obfuscateDocument } from "./privacy";
+export { sign } from "./sign";
 export { checkProof, MerkleTree, wrap, verify as verifySignature } from "./signature";
 export { utils, isSchemaValidationError };
 export * from "./@types/document";

diff --git a/src/schema/2.0/schema.json b/src/schema/2.0/schema.json
@@ -18,33 +18,34 @@
       "required": ["type", "location"],
       "additionalProperties": false
     },
-    "documentStore": {
+    "issuer": {
       "type": "object",
       "properties": {
         "name": {
           "type": "string",
           "description": "Issuer's name"
         },
-        "documentStore": {
-          "type": "string",
-          "pattern": "^0x[a-fA-F0-9]{40}$",
-          "description": "Smart contract address of document store"
-        },
         "identityProof": { "$ref": "#/definitions/identityProof" }
       },
-      "required": ["name", "documentStore", "identityProof"],
-      "not": {
-        "anyOf": [
-          {
-            "required": ["certificateStore"]
-          },
-          {
-            "required": ["tokenRegistry"]
-          }
-        ]
-      },
+      "required": ["name", "identityProof"],
       "additionalProperties": true
     },
+    "documentStore": {
+      "allOf": [
+        { "$ref": "#/definitions/issuer" },
+        {
+          "type": "object",
+          "properties": {
+            "documentStore": {
+              "type": "string",
+              "pattern": "^0x[a-fA-F0-9]{40}$",
+              "description": "Smart contract address of document store"
+            }
+          },
+          "required": ["documentStore"]
+        }
+      ]
+    },
     "certificateStore": {
       "type": "object",
       "properties": {
@@ -60,44 +61,23 @@
         }
       },
       "required": ["name", "certificateStore"],
-      "not": {
-        "anyOf": [
-          {
-            "required": ["documentStore"]
-          },
-          {
-            "required": ["tokenRegistry"]
-          }
-        ]
-      },
       "additionalProperties": true
     },
     "tokenRegistry": {
-      "type": "object",
-      "properties": {
-        "name": {
-          "type": "string",
-          "description": "Issuer's name"
-        },
-        "tokenRegistry": {
-          "type": "string",
-          "pattern": "^0x[a-fA-F0-9]{40}$",
-          "description": "Smart contract address of token registry"
-        },
-        "identityProof": { "$ref": "#/definitions/identityProof" }
-      },
-      "required": ["name", "tokenRegistry", "identityProof"],
-      "not": {
-        "anyOf": [
-          {
-            "required": ["documentStore"]
+      "allOf": [
+        { "$ref": "#/definitions/issuer" },
+        {
+          "type": "object",
+          "properties": {
+            "tokenRegistry": {
+              "type": "string",
+              "pattern": "^0x[a-fA-F0-9]{40}$",
+              "description": "Smart contract address of token registry"
+            }
           },
-          {
-            "required": ["certificateStore"]
-          }
-        ]
-      },
-      "additionalProperties": true
+          "required": ["tokenRegistry"]
+        }
+      ]
     }
   },
   "type": "object",
@@ -150,6 +130,26 @@
           },
           {
             "$ref": "#/definitions/certificateStore"
+          },
+          {
+            "allOf": [
+              { "$ref": "#/definitions/issuer" },
+              {
+                "not": {
+                  "anyOf": [
+                    {
+                      "required": ["certificateStore"]
+                    },
+                    {
+                      "required": ["tokenRegistry"]
+                    },
+                    {
+                      "required": ["documentStore"]
+                    }
+                  ]
+                }
+              }
+            ]
           }
         ]
       },