Update docs and abi.json

everx-labs · Nov 9, 2020 · af9f1a6 · af9f1a6
1 parent e6eea9f
commit af9f1a6
Show file tree

Hide file tree

Showing 3 changed files with 116 additions and 0 deletions.
diff --git a/docs/mod_boc.md b/docs/mod_boc.md
@@ -14,6 +14,8 @@
 
 [get_blockchain_config](#get_blockchain_config)
 
+[get_boc_hash](#get_boc_hash) – Calculates BOC root hash
+
 ## Types
 [ParamsOfParse](#ParamsOfParse)
 
@@ -25,6 +27,10 @@
 
 [ResultOfGetBlockchainConfig](#ResultOfGetBlockchainConfig)
 
+[ParamsOfGetBocHash](#ParamsOfGetBocHash)
+
+[ResultOfGetBocHash](#ResultOfGetBocHash)
+
 
 # Functions
 ## parse_message
@@ -183,6 +189,30 @@ function get_blockchain_config(
 - `config_boc`: _string_ – Blockchain config BOC encoded as base64
 
 
+## get_boc_hash
+
+Calculates BOC root hash
+
+```ts
+type ParamsOfGetBocHash = {
+    boc: string
+};
+
+type ResultOfGetBocHash = {
+    hash: string
+};
+
+function get_boc_hash(
+    params: ParamsOfGetBocHash,
+): Promise<ResultOfGetBocHash>;
+```
+### Parameters
+- `boc`: _string_ – BOC encoded as base64
+### Result
+
+- `hash`: _string_ – BOC root hash encoded with hex
+
+
 # Types
 ## ParamsOfParse
 ```ts
@@ -233,3 +263,21 @@ type ResultOfGetBlockchainConfig = {
 - `config_boc`: _string_ – Blockchain config BOC encoded as base64
 
 
+## ParamsOfGetBocHash
+```ts
+type ParamsOfGetBocHash = {
+    boc: string
+};
+```
+- `boc`: _string_ – BOC encoded as base64
+
+
+## ResultOfGetBocHash
+```ts
+type ResultOfGetBocHash = {
+    hash: string
+};
+```
+- `hash`: _string_ – BOC root hash encoded with hex
+
+
diff --git a/docs/modules.md b/docs/modules.md
@@ -103,6 +103,8 @@
 
 [get_blockchain_config](mod_boc.md#get_blockchain_config)
 
+[get_boc_hash](mod_boc.md#get_boc_hash) – Calculates BOC root hash
+
 ## [processing](mod_processing.md) – Message processing module.
 
 [send_message](mod_processing.md#send_message) – Sends message to the network

diff --git a/tools/api.json b/tools/api.json
@@ -4125,6 +4125,34 @@
           ],
           "summary": null,
           "description": null
+        },
+        {
+          "name": "ParamsOfGetBocHash",
+          "type": "Struct",
+          "struct_fields": [
+            {
+              "name": "boc",
+              "type": "String",
+              "summary": " BOC encoded as base64",
+              "description": " BOC encoded as base64"
+            }
+          ],
+          "summary": null,
+          "description": null
+        },
+        {
+          "name": "ResultOfGetBocHash",
+          "type": "Struct",
+          "struct_fields": [
+            {
+              "name": "hash",
+              "type": "String",
+              "summary": " BOC root hash encoded with hex",
+              "description": " BOC root hash encoded with hex"
+            }
+          ],
+          "summary": null,
+          "description": null
         }
       ],
       "functions": [
@@ -4355,6 +4383,44 @@
             ]
           },
           "errors": null
+        },
+        {
+          "name": "get_boc_hash",
+          "summary": " Calculates BOC root hash",
+          "description": " Calculates BOC root hash",
+          "params": [
+            {
+              "name": "_context",
+              "type": "Generic",
+              "generic_name": "Arc",
+              "generic_args": [
+                {
+                  "type": "Ref",
+                  "ref_name": "ClientContext"
+                }
+              ],
+              "summary": null,
+              "description": null
+            },
+            {
+              "name": "params",
+              "type": "Ref",
+              "ref_name": "boc.ParamsOfGetBocHash",
+              "summary": null,
+              "description": null
+            }
+          ],
+          "result": {
+            "type": "Generic",
+            "generic_name": "ClientResult",
+            "generic_args": [
+              {
+                "type": "Ref",
+                "ref_name": "boc.ResultOfGetBocHash"
+              }
+            ]
+          },
+          "errors": null
         }
       ]
     },