feat: wrap document individually with --batched flag (#95)

Author: Nebulis

README.md

@@ -86,6 +86,13 @@ open-attestation wrap ./examples/raw-documents/example.0.json --output-file ./ex
 open-attestation wrap ./examples/wrapped-documents/example.0.json --of ./examples/wrapped-documents/example.1.json --unwrap
 ```
 
+You can disable the `--batched` option to wrap multiple documents individually (i.e. they will not have the same merkle root):
+
+```bash
+open-attestation wrap ./examples/raw-documents/ --output-dir ./examples/wrapped-documents/ --batched false
+✔  success   All documents have been individually wrapped
+```
+
 By default the CLI will use open-attestation schema v2 but you can opt in for open-attestation schema v3 using `open-attestation-v3` option:
 
 ```bash

src/__tests__/wrap.e2e.test.ts

@@ -109,7 +109,12 @@ describe("batchIssue", () => {
         throw new Error(`unhandled ${path} in spy`);
       });
 
-      const root = await appendProofToDocuments("DIR", hashMap, Output.Directory, "DIR");
+      const root = await appendProofToDocuments({
+        intermediateDir: "DIR",
+        hashMap,
+        outputPathType: Output.Directory,
+        digestedDocumentPath: "DIR",
+      });
 
       expect(root).toStrictEqual("e");
     });

src/__tests__/wrap.test.ts

@@ -13,6 +13,7 @@ interface WrapCommand {
   openAttestationV3: boolean;
   unwrap: boolean;
   silent?: boolean;
+  batched: boolean;
 }
 
 export const command = "wrap <raw-documents-path> [options]";
@@ -61,9 +62,14 @@ export const builder = (yargs: Argv): Argv =>
       alias: "silent",
       description: "Disable console outputs when outputting to stdout",
       type: "boolean",
+    })
+    .option("batched", {
+      description: "Indicate whether documents must be wrap together or individually",
+      type: "boolean",
+      default: true,
     });
 
-export const handler = async (args: WrapCommand): Promise<string> => {
+export const handler = async (args: WrapCommand): Promise<string | undefined> => {
   try {
     const outputPathType = args.outputDir ? Output.Directory : args.outputFile ? Output.File : Output.StdOut;
     const outputPath = args.outputDir || args.outputFile; // undefined when we use std out
@@ -83,16 +89,27 @@ export const handler = async (args: WrapCommand): Promise<string> => {
       signale.disable();
     }
 
+    // if output to a file or stdout, we handle only one file. In that case we disable the batch mode
+    const batched = outputPathType !== Output.Directory ? false : args.batched;
+    if (!batched && args.batched) {
+      signale.warn("Detected single file: batch mode disabled.");
+    }
+
     const merkleRoot = await wrap({
       inputPath: args.rawDocumentsPath,
       outputPath,
       schemaPath: args.schema,
       version: args.openAttestationV3 ? SchemaId.v3 : SchemaId.v2,
       unwrap: args.unwrap,
       outputPathType,
+      batched,
     });
 
-    signale.success(`Batch Document Root: 0x${merkleRoot}`);
+    if (merkleRoot) {
+      signale.success(`Batch Document Root: 0x${merkleRoot}`);
+    } else {
+      signale.success("All documents have been individually wrapped");
+    }
 
     return merkleRoot;
   } catch (err) {

src/commands/wrap.ts

@@ -19,6 +19,8 @@ describe("document-store", () => {
     const documentStoreFactory: any = DocumentStoreFactory;
     const mockedDocumentStoreFactory: jest.Mock<DocumentStoreFactory> = documentStoreFactory;
     const mockedDeploy: jest.Mock = mockedDocumentStoreFactory.prototype.deploy;
+    // increase timeout because ethers is throttling
+    jest.setTimeout(30000);
 
     // eslint-disable-next-line jest/no-hooks
     beforeEach(() => {

src/implementations/deploy/document-store/document-store.test.ts

@@ -18,6 +18,8 @@ describe("token-registry", () => {
     const tokenFactory: any = TitleEscrowCreatorFactory;
     const mockedTokenFactory: jest.Mock<TitleEscrowCreatorFactory> = tokenFactory;
     const mockedDeploy: jest.Mock = mockedTokenFactory.prototype.deploy;
+    // increase timeout because ethers is throttling
+    jest.setTimeout(30000);
 
     // eslint-disable-next-line jest/no-hooks
     beforeEach(() => {

src/implementations/deploy/title-escrow-creator/title-escrow-creator.test.ts

@@ -22,6 +22,8 @@ describe("token-registry", () => {
     const tokenFactory: any = TitleEscrowFactory;
     const mockedTokenFactory: jest.Mock<TitleEscrowFactory> = tokenFactory;
     const mockedDeploy: jest.Mock = mockedTokenFactory.prototype.deploy;
+    // increase timeout because ethers is throttling
+    jest.setTimeout(30000);
 
     // eslint-disable-next-line jest/no-hooks
     beforeEach(() => {

src/implementations/deploy/title-escrow/title-escrow.test.ts

@@ -20,6 +20,8 @@ describe("token-registry", () => {
     const tokenFactory: any = TradeTrustErc721Factory;
     const mockedTokenFactory: jest.Mock<TradeTrustErc721Factory> = tokenFactory;
     const mockedDeploy: jest.Mock = mockedTokenFactory.prototype.deploy;
+    // increase timeout because ethers is throttling
+    jest.setTimeout(30000);
 
     // eslint-disable-next-line jest/no-hooks
     beforeEach(() => {

src/implementations/deploy/token-registry/token-registry.test.ts

@@ -18,6 +18,8 @@ const deployParams: DocumentStoreIssueCommand = {
 // TODO the following test is very fragile and might break on every interface change of DocumentStoreFactory
 // ideally must setup ganache, and run the function over it
 describe("document-store", () => {
+  // increase timeout because ethers is throttling
+  jest.setTimeout(30000);
   describe("issueDocumentStore", () => {
     const mockedDocumentStoreFactory: jest.Mock<DocumentStoreFactory> = DocumentStoreFactory as any;
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment

src/implementations/document-store/issue.test.ts

@@ -18,6 +18,8 @@ const deployParams: DocumentStoreRevokeCommand = {
 // TODO the following test is very fragile and might break on every interface change of DocumentStoreFactory
 // ideally must setup ganache, and run the function over it
 describe("document-store", () => {
+  // increase timeout because ethers is throttling
+  jest.setTimeout(30000);
   describe("revokeDocumentStore", () => {
     const mockedDocumentStoreFactory: jest.Mock<DocumentStoreFactory> = DocumentStoreFactory as any;
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment