@taquito/michelson-encoder 11.2.0-beta-RC.0 → 12.0.0

package/README.md

@@ -1,66 +1,137 @@
 
 # Taquito Michelson Encoder package
+*Documentation can be found [here](https://tezostaquito.io/docs/michelson_encoder)*  
+*TypeDoc style documentation is available on-line [here](https://tezostaquito.io/typedoc/modules/_taquito_michelson_encoder.html)*
 
-`@taquito/michelson-encoder` provides a JavaScript abstraction based on a Tezos Smart contracts code, parameters and storage.
+`@taquito/michelson-encoder` provides a JavaScript abstraction based on a Tezos Smart contracts code, parameters, storage, and views.
 
-See the top-level project [https://github.com/ecadlabs/taquito](https://github.com/ecadlabs/taquito) for details on reporting issues, contributing and versioning.
+## General Information
+
+The Michelson-Encoder package aims to create an abstraction over the Michelson Language. It allows converting Michelson data into javascript-looking objects which are easier to use and reason about.
+
+Its integration into the main Taquito package makes it easier to write the storage when deploying a contract and the parameter when calling a contract entry-point or executing a view. It also provides an abstraction on the storage read value of the contract. 
+
+The `Schema` class is intended to represent the contract storage, while the `ParameterSchema` represents its entry points. The `Execute` method takes a parameter in Michelson format and converts it into the JavaScript abstraction. The `Encode` method does the opposite; it takes a JavaScript object as a parameter and converts it into Michelson data.
+
+## Install 
+```
+npm i --save @taquito/michelson-encoder
+```
+
+## Usage
 
 ## Example
 
-Given the following michelson smart contract data, retrieved from a Tezos Nodes RPC:
+The constructor of the `Schema` class takes a Michelson type as a parameter which is retrieved from a Tezos Nodes RPC:
 
-```json
-{
-  "storage": {
-    "prim": "Pair",
-    "args": [
-      [],
-      {
-        "prim": "Pair",
-        "args": [
-          { "int": "1" },
-          {
-            "prim": "Pair",
-            "args": [
-              { "int": "1000" },
-              {
-                "prim": "Pair",
-                "args": [
-                  { "string": "Token B" },
-                  {
-                    "prim": "Pair",
-                    "args": [
-                      { "string": "B" },
-                      { "string": "tz1ccqAEwfPgeoipnXtjAv1iucrpQv3DFmmS" }
-                    ]
-                  }
-                ]
-              }
+```ts
+const storageType = {
+    prim: 'pair',
+    args: [
+        { prim: 'nat', annots: [ '%stored_counter' ] },
+        {
+            prim: 'pair',
+            args: [
+                { prim: 'nat', annots: [ '%threshold' ] },
+                { prim: 'list', args: [ { prim: 'key' } ], annots: [ '%keys' ] }
             ]
-          }
-        ]
-      }
+        }
     ]
-  }
-}
+};
+const storageSchema = new Schema(storageType);
 ```
 
-`@taquito/michelson-encoder` will generate an abstraction in the form of a plain old javascript object:
+The `Execute` method takes a Michelson value as a parameter and generates an abstraction in the form of a plain old javascript object:
+
+```ts
+// dataMichelson is the storage of a contract retrieved from the RPC
+const dataMichelson = {
+  "prim": "Pair",
+  "args": [
+    {
+      "int": "10"
+    },
+    {
+      "prim": "Pair",
+      "args": [
+        {
+          "int": "5"
+        },
+        [
+          {
+            "string": "edpkvS5QFv7KRGfa3b87gg9DBpxSm3NpSwnjhUjNBQrRUUR66F7C9g"
+          },
+          {
+            "string": "edpkuLxx9PQD8fZ45eUzrK3BhfDZJHhBuK4Zi49DcEGANwd2rpX82t"
+          }
+        ]
+      ]
+    }
+  ]
+};
+
+const data = storageSchema.Execute(dataMichelson);
+console.log(data);
 
-```javascript
+/* output:
 {
-  accounts: {},
-  version: '1',
-  totalSupply: '1000',
-  name: 'Token B',
-  symbol: 'B',
-  owner: 'tz1ccqAEwfPgeoipnXtjAv1iucrpQv3DFmmS'
-}
+  "stored_counter": "10",
+  "threshold": "5",
+  "keys": [
+    "edpkvS5QFv7KRGfa3b87gg9DBpxSm3NpSwnjhUjNBQrRUUR66F7C9g",
+    "edpkuLxx9PQD8fZ45eUzrK3BhfDZJHhBuK4Zi49DcEGANwd2rpX82t"
+  ]
+} 
+*/
 ```
 
-## API Documentation
+Note that the Michelson type annotations represent the javascript object's keys.
+
+
+The `Encode` method takes a javascript object as a parameter and converts it into Michelson:
+
+```ts
+const data = storageSchema.Encode({
+  "stored_counter": "10",
+  "threshold": "5",
+  "keys": [
+    "edpkvS5QFv7KRGfa3b87gg9DBpxSm3NpSwnjhUjNBQrRUUR66F7C9g",
+    "edpkuLxx9PQD8fZ45eUzrK3BhfDZJHhBuK4Zi49DcEGANwd2rpX82t"
+  ]
+});
+
+console.log(data);
+
+/* output:
+{
+  "prim": "Pair",
+  "args": [
+    {
+      "int": "10"
+    },
+    {
+      "prim": "Pair",
+      "args": [
+        {
+          "int": "5"
+        },
+        [
+          {
+            "string": "edpkvS5QFv7KRGfa3b87gg9DBpxSm3NpSwnjhUjNBQrRUUR66F7C9g"
+          },
+          {
+            "string": "edpkuLxx9PQD8fZ45eUzrK3BhfDZJHhBuK4Zi49DcEGANwd2rpX82t"
+          }
+        ]
+      ]
+    }
+  ]
+} 
+*/
+```
+## Additional info
 
-TypeDoc style documentation is available on-line [here](https://tezostaquito.io/typedoc/modules/_taquito_michelson_encoder.html)
+See the top-level [https://github.com/ecadlabs/taquito](https://github.com/ecadlabs/taquito) file for details on reporting issues, contributing and versioning.
 
 ## Disclaimer
 

package/dist/lib/version.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
 // IMPORTANT: THIS FILE IS AUTO GENERATED! DO NOT MANUALLY EDIT OR CHECKIN!
 exports.VERSION = {
-    "commitHash": "e03d983c780c7f96d8291ddd1251ea82f4581858",
-    "version": "11.2.0-beta-RC.0"
+    "commitHash": "222db56e9550fff784a819406d8bdc1110787440",
+    "version": "12.0.0"
 };
 //# sourceMappingURL=version.js.map

package/dist/lib/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":";;;AACA,2EAA2E;AAC9D,QAAA,OAAO,GAAG;IACnB,YAAY,EAAE,0CAA0C;IACxD,SAAS,EAAE,kBAAkB;CAChC,CAAC"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":";;;AACA,2EAA2E;AAC9D,QAAA,OAAO,GAAG;IACnB,YAAY,EAAE,0CAA0C;IACxD,SAAS,EAAE,QAAQ;CACtB,CAAC"}

package/dist/taquito-michelson-encoder.es6.js

@@ -3318,8 +3318,8 @@ class ViewSchema {
 
 // IMPORTANT: THIS FILE IS AUTO GENERATED! DO NOT MANUALLY EDIT OR CHECKIN!
 const VERSION = {
-    "commitHash": "e03d983c780c7f96d8291ddd1251ea82f4581858",
-    "version": "11.2.0-beta-RC.0"
+    "commitHash": "222db56e9550fff784a819406d8bdc1110787440",
+    "version": "12.0.0"
 };
 
 /**