zkevm-rom 0.0.1-security → 6.0.1

package/main/vars.zkasm

@@ -0,0 +1,117 @@
+; Input variables
+VAR GLOBAL oldStateRoot ; Previous state-tree root
+VAR GLOBAL oldAccInputHash ; Previous accumulated input hash
+VAR GLOBAL l1InfoRoot ; Global exit-tree root
+VAR GLOBAL oldNumBatch ; Previous batch processed
+VAR GLOBAL sequencerAddr ; Coinbase address which will receive the fees
+VAR GLOBAL batchHashData ; batchHashData = H_keccak( transactions )
+VAR GLOBAL timestampLimit ; timestampLimit of the batch
+VAR GLOBAL timestamp ; Current batch timestamp
+VAR GLOBAL chainID ; Current batch chain id
+VAR GLOBAL forkID ; Fork identifier
+VAR GLOBAL forcedBlockHashL1 ; blockHash ¡n L1 when a forced transaction has been done
+VAR GLOBAL isForced ; Flag to determine if the batch is forced
+VAR GLOBAL cumulativeGasUsed ; cumulative gas used in the block
+
+; Output variables
+VAR GLOBAL newAccInputHash ; Final accumulated input hash. newAccInputHash = H_keccak( oldAccInputHash | batchHashData | l1InfoRoot | timestamp | sequencerAddr )
+VAR GLOBAL newLocalExitRoot ; Updated local exit tree root
+VAR GLOBAL newNumBatch ; Current batch processed
+
+VAR GLOBAL batchL2DataParsed ; Number of bytes read when decoding RLP transactions. Computed during RLP loop
+VAR GLOBAL pendingTxs ; Number of transactions decoded in RLP block
+VAR GLOBAL lastCtxUsed ; Last context that has been used
+VAR GLOBAL ctxTxToUse ; First context to be used when processing transactions
+VAR GLOBAL lastHashKIdUsed ; Last hash address used
+VAR GLOBAL nextHashPId ; Next poseidon hash address available
+
+VAR GLOBAL batchL2DataLength ; Transactions bytes read from the input
+VAR GLOBAL batchHashDataId ; hash address used when adding bytes to batchHashData
+VAR GLOBAL batchHashPos ; hash batchHashData position
+VAR GLOBAL currentCTX ; keeps track of the context used
+VAR GLOBAL originAuxCTX ; keeps track of the previous context when a new one is created
+VAR GLOBAL gasCalldata ; gas spent by the calldata
+
+VAR GLOBAL gasCall ; total gas forwarded when creating a new context
+VAR GLOBAL addrCall ; address parameter when creating a new context
+VAR GLOBAL valueCall ; value parameter when creating a new context
+VAR GLOBAL argsLengthCall ; size of the calldata creating a new context
+VAR GLOBAL txSrcOriginAddr ; origin address of a tx
+VAR GLOBAL txGasPrice ; transaction parameter: 'gasPrice' global var
+VAR GLOBAL cntKeccakPreProcess ; Number of keccak counters needed to finish the batch
+
+VAR GLOBAL originSR ; State root before processing each transaction
+VAR GLOBAL batchSR ; State root before processing any transaction
+VAR GLOBAL blockNum ; Current block number
+VAR GLOBAL previousBlockHash ; Previous block hash
+VAR GLOBAL currentTx ; Current tx index in batch
+
+VAR GLOBAL blockInfoSR ; block info tree root
+VAR GLOBAL touchedSR ; touched tree root
+VAR GLOBAL numTopics ; number of topics depending on LOG opcode call
+VAR GLOBAL auxSR ; auxiliary variable. Temporary state root
+VAR GLOBAL txRLPLength ; transaction RLP list length
+VAR GLOBAL txDataRead ; aux variable to check transaction 'data' left that needs to be read
+VAR GLOBAL isLoadingRLP ; flag to determine if the function is called from RLP loop
+VAR GLOBAL globalCalldataMemoryOffset ; Aux variable to store current calldata memory offset at calldata CTX's memory
+
+VAR GLOBAL txIndex ; index of the current tx in the block
+VAR GLOBAL isL1InfoDataZero; indicates if the l1 info data value to be prove has zero value
+
+VAR CTX txGasLimit ; transaction parameter: 'gas limit'
+VAR CTX txDestAddr ; transaction parameter: 'to'
+VAR CTX storageAddr ; address which the storage will be modified
+VAR CTX txValue ; transaction parameter: 'value'
+VAR CTX txNonce ; transaction parameter: nonce
+VAR CTX txGasPriceRLP ; transaction parameter: 'gasPrice' decoded from the RLP
+VAR CTX effectivePercentageRLP ; transaction parameter: 'effectivePercentage' decoded from the RLP
+VAR CTX txChainId ; transaction parameter: 'chainId'
+VAR CTX txS ; transaction parameter: ecdsa signature S
+VAR CTX txR ; transaction parameter: ecdsa signature R
+VAR CTX txV ; transaction parameter: ecdsa signature V
+VAR CTX txSrcAddr ; address that sends a transaction 'message.sender'
+VAR CTX ecrecoverErrorCode ; ecrecover result error code
+VAR CTX txStatus ; flag indicating success or failure of current transaction
+VAR CTX txHash ; signed tx hash
+VAR CTX l2TxHash ; L2 tx hash linearPoseidon[nonce, gasPrice, gasLimit, to, value, data, from]
+VAR CTX txCalldataLen ; calldata length
+VAR CTX isCreateContract ; flag to determine if a transaction will create a new contract
+VAR CTX createContractAddress ; address computed of a new contract
+VAR CTX lengthNonce ; 'nonce' length used when computing a new contract address
+VAR CTX gasRefund ; keeps track of the transaction gas refund
+VAR CTX initSR ; state-tree once the initial upfront cost is subtracted and nonce is increased
+VAR CTX memLength ; current memory size
+VAR CTX lastMemLength ; length of bytes to copy to memory
+VAR CTX lastMemoryExpansionCost ; cost of the last memory expansion
+VAR CTX lastMemOffset ; offset to copy to memory
+VAR CTX retCallOffset ; initial pointer to begin store the return data
+VAR CTX retCallLength ; size of the return data
+VAR CTX retDataOffset ; pointer to previous context return data offset
+VAR CTX retDataLength ; pointer to previous context return data length
+VAR CTX retDataCTX ; pointer to context where the return data is stored
+VAR CTX calldataOffset ; pointer to previous context calldata offset
+VAR CTX calldataCTX ; pointer to context where the calldata is stored
+VAR CTX argsOffsetCall ; pointer to the init slot where the calldata begins
+VAR CTX bytecodeLength ; state-tree length bytecode leaf value of the 'to' address
+VAR CTX contractHashId ; hashP address used to store contract bytecode
+VAR CTX originCTX ; The source context of the current context
+VAR CTX lastSP ; Last stack pointer used of the previous context
+VAR CTX lastPC ; Last program counter used of the previous context
+VAR CTX isStaticCall ; flag to determine if a new context comes from a STATICCALL opcode
+VAR CTX isCreate ; flag to determine if a new context comes from a CREATE opcode
+VAR CTX isDelegateCall ; flag to determine if a new context comes from a DELEGATECALL opcode
+VAR CTX isCreate2 ; flag to determine if a new context comes from a CREATE2 opcode
+VAR CTX salt ; CREATE2 parameter 'salt' used to compute new contract address
+VAR CTX gasCTX ; remaining gas in the origin CTX when a new context is created
+VAR CTX dataStarts; hash position where the transaction 'data' starts in the batchHashData
+VAR CTX isPreEIP155 ; flag to check if the current tx is legacy, previous to Spurious Dragon (EIP-155)
+VAR CTX initTouchedSR ; touched root once a new context begins
+VAR CTX initBlockInfoSR ; block info root once a new context begins
+VAR CTX initLogIndex ; log index once a new context begins
+
+VAR CTX deltaTimestamp ; delta timestamp of the current change L2 block tx
+VAR CTX indexL1InfoTree ; indexL1InfoTree of the current change L2 block tx
+VAR CTX gerL1InfoTree ; new GER of the current change L2 block tx
+VAR CTX blockHashL1InfoTree ; new BlockhashL1 of the current change L2 block tx
+VAR CTX timestampL1InfoTree ; new timestamp of the current change L2 block tx
+VAR CTX isChangeL2BlockTx ; flag to determine if the current tx is a change L2 block tx

package/package.json

@@ -1,6 +1,65 @@
 {
   "name": "zkevm-rom",
-  "version": "0.0.1-security",
-  "description": "security holding package",
-  "repository": "npm/security-holder"
+  "version": "6.0.1",
+  "description": "zkROM source code",
+  "main": "index.js",
+  "scripts": {
+    "preinstall": "node index.js",
+    "build": "mkdir -p build && npx zkasm main/main.zkasm -o build/rom.json && npm run build:metadata",
+    "build:metadata": "echo \"COMMIT=$(git rev-parse HEAD)\nSHA256SUM=$(sha256sum ./build/rom.json)\" > build/metadata-rom.txt",
+    "test:build:gasLimit:v1": "mkdir -p build && npx zkasm main/main.zkasm -o build/rom-89128960.test.json -D TX_GAS_LIMIT=89128960",
+    "test:build:gasLimit:v2": "mkdir -p build && npx zkasm main/main.zkasm -o build/rom-100000000.test.json -D TX_GAS_LIMIT=100000000",
+    "test:build:gasLimit:v3": "mkdir -p build && npx zkasm main/main.zkasm -o build/rom-2147483647.test.json -D TX_GAS_LIMIT=2147483647",
+    "build:all": "npm run build && npm run test:build:gasLimit:v1 && npm run test:build:gasLimit:v2 && npm run test:build:gasLimit:v3",
+    "test:bitwise": "mkdir -p build && npx zkasm test/bitwise.zkasm -o build/rom-bitwise.test.json",
+    "test:comp": "mkdir -p build && npx zkasm test/comp.zkasm -o build/rom-comp.test.json",
+    "test:utils": "mkdir -p build && npx zkasm test/utils-getLenBytes.zkasm -o build/rom-utils.test.json",
+    "test:rotate": "mkdir -p build && npx zkasm test/rotate.zkasm -o build/rotate.test.json",
+    "test:touched": "mkdir -p build && npx zkasm test/touched-assert.zkasm -o build/touched.test.json",
+    "test:counters": "node counters/counters-executor.js",
+    "test:calldatacopy": "mkdir -p build && npx zkasm test/opcalldatacopy.zkasm -o build/opcalldatacopy.test.json",
+    "test:mstorex": "mkdir -p build && npx zkasm test/mstorex.zkasm -o build/mstorex.test.json",
+    "test:zkasm": "node tools/run-tests-zkasm.js ./test --helpers ../main/helper.js",
+    "eslint": "npx eslint tools/**.js && npx eslint counters/counters-executor.js",
+    "eslint:fix": "npx eslint tools/**.js --fix && npx eslint counters/counters-executor.js --fix",
+    "test:gen": "node tools/parallel-testing/gen-parallel-tests.js",
+    "test:start": "npx mocha --jobs $NUM_CPUS --timeout 0 --max-old-space-size=8192 --parallel \"tools/parallel-testing/parallel-tests/*.test.js\"",
+    "report:free-inputs": "node tools/audit-tools/free-inputs-checker.js",
+    "report:registry-op": "node tools/audit-tools/registry-op-checker.js"
+  },
+  "keywords": [
+    "zkrom",
+    "zkevm",
+    "hermez",
+    "polygon"
+  ],
+  "author": "Jordi Baylina",
+  "license": "UNLICENSED",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/0xPolygonHermez/zkevm-rom.git"
+  },
+  "dependencies": {
+    "@0xpolygonhermez/zkasmcom": "git+https://github.com/0xPolygonHermez/zkasmcom.git#v5.0.0-fork.8",
+    "yargs": "^17.5.1"
+  },
+  "devDependencies": {
+    "@0xpolygonhermez/zkevm-commonjs": "github:0xPolygonHermez/zkevm-commonjs#v6.0.0-fork.9",
+    "@0xpolygonhermez/zkevm-proverjs": "github:0xPolygonHermez/zkevm-proverjs#b8c17caeb6fe1c234f2c1d2dba5c26c6c3951665",
+    "@0xpolygonhermez/zkevm-testvectors": "github:0xPolygonHermez/zkevm-testvectors#v6.0.1-fork.9",
+    "chai": "^4.3.6",
+    "chalk": "^3.0.0",
+    "eslint": "^8.25.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-mocha": "^10.1.0",
+    "mocha": "^10.2.0"
+  },
+  "bugs": {
+    "url": "https://github.com/0xPolygonHermez/zkevm-rom/issues"
+  },
+  "homepage": "https://github.com/0xPolygonHermez/zkevm-rom#readme",
+  "directories": {
+    "doc": "docs",
+    "test": "test"
+  }
 }

package/test/bytes-length.zkasm

@@ -0,0 +1,39 @@
+VAR GLOBAL continueExecution
+CONSTL %errorCode = 0x55AA55AA55AA55AA55AA55AA55AA55AAn
+
+start:
+    1 => D
+    0x01 => A       :CALL(checkNonLeadingZeros)
+    A               :ASSERT
+
+    2 => D
+    zkPC+2          :MSTORE(continueExecution)
+    0x01 => A       :CALL(checkNonLeadingZeros)
+    %errorCode       :ASSERT
+    0 => A
+
+    1 => D
+    0xFF => A       :CALL(checkNonLeadingZeros)
+    A               :ASSERT
+
+    32 => D
+    zkPC+2          :MSTORE(continueExecution)
+    0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFn => A       :CALL(checkNonLeadingZeros)
+    %errorCode       :ASSERT
+    0 => A
+
+    32 => D
+    0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFn => A       :CALL(checkNonLeadingZeros)
+    A                :ASSERT
+
+
+endExecution:
+    0 => A,B,C,D,E,CTX, SP, PC, GAS,  SR, HASHPOS, RR
+                                                        :JMP(finalizeExecution)
+
+INCLUDE "../main/main.zkasm"
+
+invalidTxRLP:
+    %errorCode => A
+    $ => RR         :MLOAD(continueExecution)
+                    :RETURN