@taquito/michelson-encoder - npm Package Compare versions

Comparing version 11.2.0-beta-RC.0 to 11.2.0

dist/lib/version.js

@@ -6,5 +6,5 @@ "use strict";
 exports.VERSION = {
-    "commitHash": "e03d983c780c7f96d8291ddd1251ea82f4581858",
-    "version": "11.2.0-beta-RC.0"
+    "commitHash": "81f0a5b103f867f57fbe5d526315c375a3788346",
+    "version": "11.2.0"
 };
 //# sourceMappingURL=version.js.map

package.json

 {
   "name": "@taquito/michelson-encoder",
-  "version": "11.2.0-beta-RC.0",
+  "version": "11.2.0",
   "description": "converts michelson data and types into convenient JS/TS objects",
@@ -71,4 +71,4 @@ "keywords": [
   "dependencies": {
-    "@taquito/rpc": "^11.2.0-beta-RC.0",
-    "@taquito/utils": "^11.2.0-beta-RC.0",
+    "@taquito/rpc": "^11.2.0",
+    "@taquito/utils": "^11.2.0",
     "bignumber.js": "^9.0.2",
@@ -107,3 +107,3 @@ "fast-json-stable-stringify": "^2.1.0"
   },
-  "gitHead": "7cc9152cdad01bacca4a1b682c7cb0a33a24f544"
+  "gitHead": "7323157124742e8f2fdb11642f6b779cfb15df43"
 }

README.md

 
 # 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" },
+```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);
+```
+
+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"
+        },
+        [
           {
-            "prim": "Pair",
-            "args": [
-              { "int": "1000" },
-              {
-                "prim": "Pair",
-                "args": [
-                  { "string": "Token B" },
-                  {
-                    "prim": "Pair",
-                    "args": [
-                      { "string": "B" },
-                      { "string": "tz1ccqAEwfPgeoipnXtjAv1iucrpQv3DFmmS" }
-                    ]
-                  }
-                ]
-              }
-            ]
+            "string": "edpkvS5QFv7KRGfa3b87gg9DBpxSm3NpSwnjhUjNBQrRUUR66F7C9g"
+          },
+          {
+            "string": "edpkuLxx9PQD8fZ45eUzrK3BhfDZJHhBuK4Zi49DcEGANwd2rpX82t"
           }
         ]
-      }
-    ]
-  }
-}
+      ]
+    }
+  ]
+};
+
+const data = storageSchema.Execute(dataMichelson);
+console.log(data);
+
+/* output:
+{
+  "stored_counter": "10",
+  "threshold": "5",
+  "keys": [
+    "edpkvS5QFv7KRGfa3b87gg9DBpxSm3NpSwnjhUjNBQrRUUR66F7C9g",
+    "edpkuLxx9PQD8fZ45eUzrK3BhfDZJHhBuK4Zi49DcEGANwd2rpX82t"
+  ]
+} 
+*/
 ```
 
-`@taquito/michelson-encoder` will generate an abstraction in the form of a plain old javascript object:
+Note that the Michelson type annotations represent the javascript object's keys.
 
-```javascript
+
+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:
 {
-  accounts: {},
-  version: '1',
-  totalSupply: '1000',
-  name: 'Token B',
-  symbol: 'B',
-  owner: 'tz1ccqAEwfPgeoipnXtjAv1iucrpQv3DFmmS'
-}
+  "prim": "Pair",
+  "args": [
+    {
+      "int": "10"
+    },
+    {
+      "prim": "Pair",
+      "args": [
+        {
+          "int": "5"
+        },
+        [
+          {
+            "string": "edpkvS5QFv7KRGfa3b87gg9DBpxSm3NpSwnjhUjNBQrRUUR66F7C9g"
+          },
+          {
+            "string": "edpkuLxx9PQD8fZ45eUzrK3BhfDZJHhBuK4Zi49DcEGANwd2rpX82t"
+          }
+        ]
+      ]
+    }
+  ]
+} 
+*/
 ```
+## Additional info
 
-## API Documentation
+See the top-level [https://github.com/ecadlabs/taquito](https://github.com/ecadlabs/taquito) file for details on reporting issues, contributing and versioning.
 
-TypeDoc style documentation is available on-line [here](https://tezostaquito.io/typedoc/modules/_taquito_michelson_encoder.html)
-
 ## Disclaimer
 
 THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

924040

increased by0.23%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

139

increased by104.41%

Dependency changes

• Updated@taquito/rpc@^11.2.0

• Updated@taquito/utils@^11.2.0