Fix a minor subscription API issue

SouthbankSoftware · Jul 10, 2020 · cf536a5 · cf536a5
1 parent 93bc39c
commit cf536a5
Show file tree

Hide file tree

Showing 11 changed files with 41 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -118,6 +118,10 @@ tpCH, errCH := api.SubscribeTrieProof(ctx, cli, id, triePf.GetId())
 for tp := range tpCH {
     log.Printf("Anchoring proof: %s\n", tp.GetStatus())
     triePf = tp
+
+    if tp.GetStatus() == anchorPB.Batch_ERROR {
+        return errors.New(tp.GetError())
+    }
 }
 
 // always check error from the error channel

diff --git a/cmd/proofable-cli/cmd/cmd_create_proof.go b/cmd/proofable-cli/cmd/cmd_create_proof.go
@@ -19,14 +19,15 @@
  * @Author: guiguan
  * @Date:   2019-09-16T16:21:53+10:00
  * @Last modified by:   guiguan
- * @Last modified time: 2020-07-07T10:40:57+10:00
+ * @Last modified time: 2020-07-10T15:08:44+10:00
  */
 
 package cmd
 
 import (
 	"bytes"
 	"context"
+	"errors"
 	"fmt"
 	"time"
 
@@ -167,6 +168,10 @@ By default, if the path is a directory, the proof will be created under the dire
 					for tp := range tpCH {
 						colorcli.Printf("Anchoring proof: %s\n", tp.GetStatus())
 						triePf = tp
+
+						if tp.GetStatus() == anchorPB.Batch_ERROR {
+							return errors.New(tp.GetError())
+						}
 					}
 
 					err = <-errCH

diff --git a/docs/example.go b/docs/example.go
@@ -19,14 +19,15 @@
  * @Author: guiguan
  * @Date:   2020-03-31T12:29:46+11:00
  * @Last modified by:   guiguan
- * @Last modified time: 2020-07-09T13:48:44+10:00
+ * @Last modified time: 2020-07-10T15:31:33+10:00
  */
 
 package main
 
 import (
 	"context"
 	"encoding/hex"
+	"errors"
 	"fmt"
 	"log"
 	"time"
@@ -84,6 +85,10 @@ func main() {
 				for tp := range tpCH {
 					log.Printf("Anchoring proof: %s\n", tp.GetStatus())
 					triePf = tp
+
+					if tp.GetStatus() == anchorPB.Batch_ERROR {
+						return errors.New(tp.GetError())
+					}
 				}
 
 				// always check error from the error channel

diff --git a/node_sdk/docs/example.md b/node_sdk/docs/example.md
@@ -86,6 +86,10 @@ for await (const tp of client.subscribeTrieProof(
 )) {
   console.log("Anchoring proof: %s", Batch.StatusName[tp.getStatus()]);
   trieProof = tp;
+
+  if (tp.getStatus() === Batch.Status.ERROR) {
+    throw new Error(tp.getError());
+  }
 }
 ```
 

diff --git a/node_sdk/docs/reference/interfaces/_index_.proofverificationresult.html b/node_sdk/docs/reference/interfaces/_index_.proofverificationresult.html
@@ -95,7 +95,7 @@ <h3>key<wbr>Values</h3>
 					<div class="tsd-signature tsd-kind-icon">key<wbr>Values<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>changed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>missing<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>passed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>total<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>untracked<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> }</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/SouthbankSoftware/proofable/blob/master/node_sdk/src/api/helpers.ts#L126">src/api/helpers.ts:126</a></li>
+							<li>Defined in <a href="https://github.com/SouthbankSoftware/proofable/blob/master/node_sdk/src/api/helpers.ts#L130">src/api/helpers.ts:130</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-type-declaration">
@@ -125,7 +125,7 @@ <h3>proof</h3>
 					<div class="tsd-signature tsd-kind-icon">proof<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>anchorType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>blockNumber<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>blockTime<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>blockTimeNano<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>blockTimeString<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>root<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>txnId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>txnUri<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>verified<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/SouthbankSoftware/proofable/blob/master/node_sdk/src/api/helpers.ts#L113">src/api/helpers.ts:113</a></li>
+							<li>Defined in <a href="https://github.com/SouthbankSoftware/proofable/blob/master/node_sdk/src/api/helpers.ts#L117">src/api/helpers.ts:117</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-type-declaration">
@@ -173,7 +173,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> trie</h3>
 					<div class="tsd-signature tsd-kind-icon">trie<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>root<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/SouthbankSoftware/proofable/blob/master/node_sdk/src/api/helpers.ts#L109">src/api/helpers.ts:109</a></li>
+							<li>Defined in <a href="https://github.com/SouthbankSoftware/proofable/blob/master/node_sdk/src/api/helpers.ts#L113">src/api/helpers.ts:113</a></li>
 						</ul>
 					</aside>
 				</section>

diff --git a/node_sdk/package-lock.json b/node_sdk/package-lock.json
diff --git a/node_sdk/package.json b/node_sdk/package.json
@@ -1,6 +1,6 @@
 {
   "name": "proofable",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "Proofable Node SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

diff --git a/node_sdk/src/api/helpers.ts b/node_sdk/src/api/helpers.ts
@@ -19,7 +19,7 @@
  * @Author: guiguan
  * @Date:   2020-07-02T11:42:17+10:00
  * @Last modified by:   guiguan
- * @Last modified time: 2020-07-07T11:09:21+10:00
+ * @Last modified time: 2020-07-10T15:22:06+10:00
  */
 
 import util from "util";
@@ -100,6 +100,10 @@ export async function anchorTrie(
     outputProgress &&
       console.log("Anchoring proof: %s", Batch.StatusName[tp.getStatus()]);
     trieProof = tp;
+
+    if (tp.getStatus() === Batch.Status.ERROR) {
+      throw new Error(tp.getError());
+    }
   }
 
   return trieProof;

diff --git a/node_sdk/src/examples/javascript.js b/node_sdk/src/examples/javascript.js
@@ -20,7 +20,7 @@
  * @Author: Koustubh Gaikwad
  * @Date:   2020-06-19T09:26:20+10:00
  * @Last modified by:   guiguan
- * @Last modified time: 2020-07-08T10:51:08+10:00
+ * @Last modified time: 2020-07-10T15:28:33+10:00
  */
 
 const {
@@ -89,6 +89,10 @@ const client = newAPIClient(API_PROOFABLE_ENDPOINT);
     )) {
       console.log("Anchoring proof: %s", Batch.StatusName[tp.getStatus()]);
       trieProof = tp;
+
+      if (tp.getStatus() === Batch.Status.ERROR) {
+        throw new Error(tp.getError());
+      }
     }
 
     // verify the proof

diff --git a/node_sdk/src/examples/typescript.ts b/node_sdk/src/examples/typescript.ts
@@ -19,7 +19,7 @@
  * @Author: Koustubh Gaikwad
  * @Date:   2020-06-19T09:26:20+10:00
  * @Last modified by:   guiguan
- * @Last modified time: 2020-07-08T10:51:08+10:00
+ * @Last modified time: 2020-07-10T15:27:56+10:00
  */
 
 import {
@@ -89,6 +89,10 @@ const client = newAPIClient(API_PROOFABLE_ENDPOINT);
     )) {
       console.log("Anchoring proof: %s", Batch.StatusName[tp.getStatus()]);
       trieProof = tp;
+
+      if (tp.getStatus() === Batch.Status.ERROR) {
+        throw new Error(tp.getError());
+      }
     }
 
     // verify the proof

diff --git a/node_sdk/src/examples/typescript_basic.ts b/node_sdk/src/examples/typescript_basic.ts
@@ -19,7 +19,7 @@
  * @Author: guiguan
  * @Date:   2020-07-02T23:16:27+10:00
  * @Last modified by:   guiguan
- * @Last modified time: 2020-07-08T10:51:09+10:00
+ * @Last modified time: 2020-07-10T15:26:32+10:00
  */
 
 import _ from "lodash";