add comments & increase version

0xPolygonHermez · Nov 24, 2022 · 28240c9 · 28240c9
1 parent f687038
commit 28240c9
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@0xpolygonhermez/zkevm-commonjs",
   "description": "Javascript library implementing common utilities for zkevm",
-  "version": "0.5.0.0",
+  "version": "0.5.0.1",
   "main": "index.js",
   "scripts": {
     "setup": "npm i",

diff --git a/src/processor.js b/src/processor.js
@@ -32,6 +32,8 @@ module.exports = class Processor {
      * @param {Number} timestamp - Timestamp of the batch
      * @param {Number} chainID - L2 chainID
      * @param {Object} vm - vm instance
+     * @param {Object} options - batch options
+     * @param {Bool} options.skipUpdateSystemStorage Skips updates on system smrt contract at the end of processable transactions
      */
     constructor(
         db,

diff --git a/src/zkevm-db.js b/src/zkevm-db.js
@@ -42,6 +42,8 @@ class ZkEVMDB {
      * @param {String} sequencerAddress - ethereum address represented as hex
      * @param {Array[Field]} globalExitRoot - global exit root
      * @param {Scalar} maxNTx - Maximum number of transactions (optional)
+     * @param {Object} options - additional batch options
+     * @param {Bool} options.skipUpdateSystemStorage - Skips updates on system smrt contract at the end of processable transactions
      */
     async buildBatch(timestamp, sequencerAddress, globalExitRoot, maxNTx = Constants.DEFAULT_MAX_TX, options = {}) {
         return new Processor(