Merge pull request #290 from 0xPolygonHermez/feature/effective-gas-price

Effective gas implementation
0xPolygonHermez · May 31, 2023 · eb376cc · eb376cc
2 parents 7ceecfd + fcb8126
commit eb376cc
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 9 deletions.
diff --git a/main/load-tx-rlp.zkasm b/main/load-tx-rlp.zkasm
@@ -285,6 +285,11 @@ vREADTx:
         A                               :MSTORE(txV)
         C + D => C                      :CALL(addBatchHashData)
 
+;; read effective percentage
+effectivePercentageTx:
+        1 => D                          :CALL(getTxBytes)
+        A                               :MSTORE(effectivePercentageRLP)
+        C + D => C                      :CALL(addBatchHashData)
 ;;;;;;;;;
 ;; D - Finish RLP parsing
 ;;;;;;;;;

diff --git a/main/opcodes/stack-operations.zkasm b/main/opcodes/stack-operations.zkasm
@@ -1,21 +1,31 @@
 /**
- * @link [https://www.evm.codes/#60?fork=berlin]
+ * @link [https://www.evm.codes/#5f?fork=shanghai]
  * @zk-counters
- *  - 100 steps (stack) || 400 steps (calldata)
- *  - 1 binary (stack) || 0 binary (calldata)
+ *  - 100 steps
  * @process-opcode
  *  - stack input: none
- *  - stack output: [pushed_value]
+ *  - stack output: [0]
  */
-
 opPUSH0:
+    ; checks zk-counters
+    %MAX_CNT_STEPS - STEP - 100     :JMPN(outOfCountersStep)
+
     ; check out-of-gas
     GAS - %GAS_QUICK_STEP => GAS    :JMPN(outOfGas)
     ; store stack output
     0                               :MSTORE(SP++); [0 => SP]
     ; check stack overflow
     %CALLDATA_OFFSET - SP           :JMPN(stackOverflow, readCode)
 
+/**
+ * @link [https://www.evm.codes/#60?fork=berlin]
+ * @zk-counters
+ *  - 100 steps (stack) || 400 steps (calldata)
+ *  - 1 binary (stack) || 0 binary (calldata)
+ * @process-opcode
+ *  - stack input: none
+ *  - stack output: [pushed_value]
+ */
 opPUSH1:
     ; number of bytes to push to D
     1 => D

diff --git a/main/process-tx.zkasm b/main/process-tx.zkasm
@@ -32,6 +32,8 @@ processTx:
         ; Minimum of 100000 steps left to process a tx
         %MAX_CNT_STEPS - STEP - 100000 :JMPN(outOfCountersStep)
         %MAX_CNT_BINARY - CNT_BINARY - 100   :JMPN(outOfCountersBinary)
+        %MAX_CNT_ARITH - CNT_ARITH - 2  :JMPN(outOfCountersArith)
+
         $ => A                          :MLOAD(txHash)
         ; Check the signature
         $ => B                          :MLOAD(txR)
@@ -68,9 +70,33 @@ endCheckChainId:
                                         :CALL(isColdAddress) ; add tx.origin to touched addresses
         0                               :MSTORE(depth) ; Initial depth is 0
 
-;; Set gasPrice global var
+;; Set gasPrice global var depending on effectivePercentage [0-255] -> txGasPrice = Floor((gasPrice * (effectivePercentage + 1)) / 256)
+        ; gasPrice => A
         $ => A                          :MLOAD(txGasPriceRLP)
-        A                               :MSTORE(txGasPrice)
+        ; effectivePercentage => B
+        $ => B                          :MLOAD(effectivePercentageRLP)
+        ; B -> [1, 256]
+        B + 1 => B
+        ; A*B + C = D * 2**256 + op(E)
+        0 => C
+        ; _effGasPriceShifted = gasPrice * (effectivePercentage + 1)
+        $${var _effGasPriceShifted = A * B}
+        ; get value above 256 bits
+        ${_effGasPriceShifted >> 256} => D
+        ; compute ARITH
+        ${_effGasPriceShifted} => E              :ARITH
+
+        ; txGasPrice = _effGasPriceShifted / 256
+        256 => B
+        ; (_effGasPriceShifted / 256)(A) * 256(B) + (_effGasPriceShifted % 256)(C) = D * 2**256 + op(E)
+        ${_effGasPriceShifted / 256} => A        :MSTORE(txGasPrice)
+        ${_effGasPriceShifted % 256} => C
+        ; compute ARITH
+        E                                       :ARITH
+        ; check divisor > remainder
+        C => A
+        1                                       :LT
+
 ;;;;;;;;;;;;;;;;;;
 ;; D - Verify and increase nonce
 ;;;;;;;;;;;;;;;;;;

diff --git a/main/utils.zkasm b/main/utils.zkasm
@@ -928,6 +928,8 @@ handleError:
 handleBatchError:
     ; restore init state root and finish batch
     $ => SR         :MLOAD(batchSR)
+    ; if batch error is triggered while parsing the RLP, it jumps to 'invalidTxRLP'
+    ; to fill the missing bytes to complete 'batchDataHash'
     $               :MLOAD(isLoadingRLP),JMPNZ(invalidTxRLP)
     $${eventLog(onFinishTx)}
     $${eventLog(onFinishBatch)} :JMP(processTxsEnd)

diff --git a/main/vars.zkasm b/main/vars.zkasm
@@ -56,6 +56,7 @@ 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

diff --git a/package.json b/package.json
@@ -42,8 +42,8 @@
   },
   "devDependencies": {
     "@0xpolygonhermez/zkevm-proverjs": "github:0xPolygonHermez/zkevm-proverjs#3bc0368dd67caf92d38e3cbebe7b030e78c54e35",
-    "@0xpolygonhermez/zkevm-testvectors": "github:0xPolygonHermez/zkevm-testvectors#v1.2.0-rc.1-fork.5",
-    "@0xpolygonhermez/zkevm-commonjs": "github:0xPolygonHermez/zkevm-commonjs#v1.0.1-rc.3",
+    "@0xpolygonhermez/zkevm-testvectors": "github:0xPolygonHermez/zkevm-testvectors#feature/effective-gas-price",
+    "@0xpolygonhermez/zkevm-commonjs": "github:0xPolygonHermez/zkevm-commonjs#feature/effective-gas-price",
     "chai": "^4.3.6",
     "chalk": "^3.0.0",
     "eslint": "^8.25.0",