@taquito/local-forging - 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

dist/taquito-local-forging.es6.js

@@ -970,4 +970,4 @@ import { Prefix, prefixLength, b58cencode, prefix, buf2hex, b58cdecode } from '@taquito/utils';
 const VERSION = {
-    "commitHash": "e03d983c780c7f96d8291ddd1251ea82f4581858",
-    "version": "11.2.0-beta-RC.0"
+    "commitHash": "81f0a5b103f867f57fbe5d526315c375a3788346",
+    "version": "11.2.0"
 };
@@ -974,0 +974,0 @@

dist/taquito-local-forging.umd.js

@@ -977,4 +977,4 @@ (function (global, factory) {
   const VERSION = {
-      "commitHash": "e03d983c780c7f96d8291ddd1251ea82f4581858",
-      "version": "11.2.0-beta-RC.0"
+      "commitHash": "81f0a5b103f867f57fbe5d526315c375a3788346",
+      "version": "11.2.0"
   };
@@ -981,0 +981,0 @@

package.json

 {
   "name": "@taquito/local-forging",
-  "version": "11.2.0-beta-RC.0",
+  "version": "11.2.0",
   "description": "Provide local forging functionality to be with taquito",
@@ -70,7 +70,7 @@ "keywords": [
   "dependencies": {
-    "@taquito/utils": "^11.2.0-beta-RC.0",
+    "@taquito/utils": "^11.2.0",
     "bignumber.js": "^9.0.2"
   },
   "devDependencies": {
-    "@taquito/taquito": "^11.2.0-beta-RC.0",
+    "@taquito/taquito": "^11.2.0",
     "@types/bluebird": "^3.5.36",
@@ -104,3 +104,3 @@ "@types/jest": "^26.0.23",
   },
-  "gitHead": "7cc9152cdad01bacca4a1b682c7cb0a33a24f544"
+  "gitHead": "7323157124742e8f2fdb11642f6b779cfb15df43"
 }

README.md

 
-# Taquito Local forging package
+# Taquito Local Forging package
+*TypeDoc style documentation is available [here](https://tezostaquito.io/typedoc/modules/_taquito_local_forging.html)*
 
-`@taquito/local-forging` is an npm package that provides developers with local forging functionality for Taquito. It can be injected as follows:
+## General Information
 
+_Forging_ is the act of encoding your operation shell into its binary representation. Forging can be done either remotely by the RPC node, or locally. `@taquito/local-forging` is an npm package that provides developers with local forging functionality.
+
+
+Operations must be _forged_ and _signed_ before it gets injected to the blockchain.
+
+Example of an unforged operation:
+```
+{
+  branch: 'BLzyjjHKEKMULtvkpSHxuZxx6ei6fpntH2BTkYZiLgs8zLVstvX',
+    contents: [
+        {
+          kind: 'origination',
+          counter: '1',
+          source: 'tz1QZ6KY7d3BuZDT1d19dUxoQrtFPN2QJ3hn',
+          fee: '10000',
+          gas_limit: '10',
+          storage_limit: '10',
+          balance: '0',
+          script: [Object]
+        }
+    ]
+}
+```
+
+A forged operation:
+```
+a99b946c97ada0f42c1bdeae0383db7893351232a832d00d0cd716eb6f66e5616d0035e993d8c7aaa42b5e3ccd86a33390ececc73abd904e010a0a000000000011020000000c0500036c0501036c0502038d00000002030b
+```
+
+The forged values can then be parsed back into its JSON counterpart
+
+## Install
+Install the package as follows
+```
+npm install @taquito/local-forging
+```
+## Usage
 ```ts
@@ -14,10 +52,7 @@ import { TezosToolkit } from '@taquito/taquito'
 
+## Additional Info
 See the top-level [https://github.com/ecadlabs/taquito](https://github.com/ecadlabs/taquito) file for details on reporting issues, contributing and versioning.
 
-## API Documentation
-
-TypeDoc style documentation is available on-line [here](https://tezostaquito.io/typedoc/modules/_taquito_local_forging.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

318007

increased by0.28%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

58

increased by152.17%

Dependency changes

• Updated@taquito/utils@^11.2.0