feat: shanghai hard fork (#647)

Signed-off-by: F Bojarski <[email protected]>
Signed-off-by: François Bojarski <[email protected]>
Co-authored-by: Olivier Bégassat <[email protected]>
Co-authored-by: David Pearce <[email protected]>
Co-authored-by: DavePearce <[email protected]>
Co-authored-by: amkCha <[email protected]>

Author: 4 people

.github/workflows/check.yml

@@ -15,7 +15,7 @@ jobs:
 
     - name: Install Go Corset
       shell: bash
-      run: go install github.com/consensys/go-corset/cmd/[email protected].1
+      run: go install github.com/consensys/go-corset/cmd/[email protected].7
 
     - name: Build Constraints
       run: make -B zkevm.bin

Makefile

@@ -29,7 +29,19 @@ EXP := exp
 
 GAS := gas
 
-HUB :=  hub
+HUB_LON :=  $(wildcard hub/london/*.lisp) \
+			$(wildcard hub/london/**/*.lisp) \
+			$(wildcard hub/london/**/**/*.lisp) \
+			$(wildcard hub/london/**/**/**/*.lisp) \
+			$(wildcard hub/london/**/**/**/**/*.lisp) \
+			$(wildcard hub/london/**/**/**/**/**/*.lisp)
+
+HUB_SHAN :=  $(wildcard hub/shanghai/*.lisp) \
+	 		 $(wildcard hub/shanghai/**/*.lisp) \
+	 		 $(wildcard hub/shanghai/**/**/*.lisp) \
+			 $(wildcard hub/shanghai/**/**/**/*.lisp) \
+			 $(wildcard hub/shanghai/**/**/**/**/*.lisp) \
+			 $(wildcard hub/shanghai/**/**/**/**/**/*.lisp)
 
 LIBRARY := library
 
@@ -43,7 +55,13 @@ MMIO := mmio
 
 MXP := mxp
 
-OOB := oob
+OOB_LON := $(wildcard oob/london/*.lisp) \
+	       $(wildcard oob/london/**/*.lisp) \
+	       $(wildcard oob/london/**/**/*.lisp)
+
+OOB_SHAN := $(wildcard oob/shanghai/*.lisp) \
+	        $(wildcard oob/shanghai/**/*.lisp) \
+	        $(wildcard oob/shanghai/**/**/*.lisp)
 
 RLP_ADDR := rlpaddr
 
@@ -65,12 +83,15 @@ TABLES := reftables
 
 TRM := trm
 
-TXN_DATA := txndata
+TXN_DATA_LON := $(wildcard txndata/london/*.lisp) \
+                $(wildcard txndata/london/**/*.lisp)
+
+TXN_DATA_SHAN := $(wildcard txndata/shanghai/*.lisp) \
+                 $(wildcard txndata/shanghai/**/*.lisp)
 
 WCP := wcp
 
-# Corset is order sensitive - to compile, we load the constants first
-ZKEVM_MODULES := ${CONSTANTS} \
+ZKEVM_MODULES_COMMON := ${CONSTANTS} \
 		 ${ALU} \
 		 ${BIN} \
 		 ${BLAKE2f_MODEXP_DATA} \
@@ -80,14 +101,12 @@ ZKEVM_MODULES := ${CONSTANTS} \
 		 ${EUC} \
 		 ${EXP} \
 		 ${GAS} \
-		 ${HUB} \
 		 ${LIBRARY} \
 		 ${LOG_DATA} \
 		 ${LOG_INFO} \
 		 ${MMIO} \
 		 ${MMU} \
 		 ${MXP} \
-		 ${OOB} \
 		 ${RLP_ADDR} \
 		 ${RLP_TXN} \
 		 ${RLP_TXRCPT} \
@@ -98,8 +117,12 @@ ZKEVM_MODULES := ${CONSTANTS} \
 		 ${STP} \
 		 ${TABLES} \
 		 ${TRM} \
-		 ${TXN_DATA} \
 		 ${WCP}
 
+ZKEVM_MODULES_LON := ${ZKEVM_MODULES_COMMON} \
+					 ${HUB_LON} \
+					 ${OOB_LON} \
+					 ${TXN_DATA_LON}
+
 zkevm.bin: ${ZKEVM_MODULES}
-	${GO_CORSET_COMPILE} -o $@ ${ZKEVM_MODULES}
+	${GO_CORSET_COMPILE} -o $@ ${ZKEVM_MODULES_LON}

constants/constants.lisp

@@ -1,4 +1,16 @@
 (defconst
+  ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+  ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;                  ;;
+  ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; EVM Forks        ;;
+  ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;                  ;;
+  ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+  EVM_LONDON                             14
+  EVM_PARIS                 (+ 1 EVM_LONDON)
+  EVM_SHANGHAI              (+ 2 EVM_LONDON)
+  EVM_CANCUN                (+ 3 EVM_LONDON)
+  EVM_PRAGUE                (+ 4 EVM_LONDON)
+  ;; Default fork
+  (EVM_FORK :i8 :extern)         EVM_LONDON
   ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
   ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;                  ;;
   ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; EVM INSTRUCTIONS ;;

debug.bin

@@ -53,7 +53,7 @@
 
 		 ;; OOB columns
 		 (OOB_INST                 :i16  )
-		 (OOB_DATA                 :array[1:10] :i128 ) ;; TODO: only 9 for LONDON
+		 (OOB_DATA                 :array[1:9] :i128 )
 
 		 ;; STP columns
 		 ( STP_INSTRUCTION               :byte )

hub/columns/account.lisp renamed to hub/london/columns/account.lisp

@@ -0,0 +1,62 @@
+(module hub)
+
+(defperspective account
+
+  ;; selector
+  PEEK_AT_ACCOUNT
+
+  ;; account-row columns
+  ((ADDRESS_HI                  :i32)
+   (ADDRESS_LO                  :i128)
+   (NONCE                       :i64  :display :dec)
+   (NONCE_NEW                   :i64  :display :dec)
+   (BALANCE                     :i128 :display :dec)
+   (BALANCE_NEW                 :i128 :display :dec)
+   (CODE_SIZE                   :i32  :display :dec)
+   (CODE_SIZE_NEW               :i32  :display :dec)
+   (CODE_HASH_HI                :i128)
+   (CODE_HASH_LO                :i128)
+   (CODE_HASH_HI_NEW            :i128)
+   (CODE_HASH_LO_NEW            :i128)
+   (HAS_CODE                    :binary) ;; rmk1: explicitly set on every account row, de facto binary
+   (HAS_CODE_NEW                :binary) ;; rmk1
+   (CODE_FRAGMENT_INDEX         :i32 :display :dec)
+   (ROMLEX_FLAG                 :binary@prove)
+   (EXISTS                      :binary) ;; rmk1
+   (EXISTS_NEW                  :binary) ;; rmk1
+   (WARMTH                      :binary@prove) ;; rmk2: should be binary even without the explicit constraint; we keep it as a safety;
+   (WARMTH_NEW                  :binary@prove) ;; rmk2
+   (MARKED_FOR_SELFDESTRUCT     :binary@prove) ;; rmk2
+   (MARKED_FOR_SELFDESTRUCT_NEW :binary@prove) ;; rmk2
+   (DEPLOYMENT_NUMBER           :i32 :display :dec)
+   (DEPLOYMENT_NUMBER_NEW       :i32 :display :dec)
+   (DEPLOYMENT_STATUS           :binary@prove) ;; rmk2
+   (DEPLOYMENT_STATUS_NEW       :binary@prove) ;; rmk2
+
+   ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+   ;;                               ;;
+   ;;   TRM module lookup columns   ;;
+   ;;                               ;;
+   ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+   (TRM_FLAG           :binary@prove)
+   (IS_PRECOMPILE      :binary@prove) ;; rmk: this flag is set from the TRM module the very first time an address is encountered in a conflation, and is conflation-constant; the @prove is redundant; we keep it for safety;
+   (TRM_RAW_ADDRESS_HI :i128)
+
+   ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+   ;;                                   ;;
+   ;;   RLPADDR module lookup columns   ;;
+   ;;                                   ;;
+   ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+   (RLPADDR_FLAG        :binary@prove)
+   (RLPADDR_RECIPE      :i8)
+   (RLPADDR_DEP_ADDR_HI :i32)
+   (RLPADDR_DEP_ADDR_LO :i128)
+   (RLPADDR_SALT_HI     :i128)
+   (RLPADDR_SALT_LO     :i128)
+   (RLPADDR_KEC_HI      :i128)
+   (RLPADDR_KEC_LO      :i128)
+   ))
+
+

hub/columns/context.lisp renamed to hub/london/columns/context.lisp

@@ -0,0 +1,45 @@
+(module hub)
+
+(defperspective context
+
+		;; selector
+		PEEK_AT_CONTEXT
+
+		;; context-row columns
+		(
+		 ;; (immutable) context data
+		 ( CONTEXT_NUMBER                    :i32          ) ;; rmk: deduced from the HUB_STAMP; could likely be reduced to :i24 (i.e. ~ 16M); though: limitless prover ...
+		 ( CALL_STACK_DEPTH                  :i11          ) ;; in the range [0 .. 1024] (inclusive)
+		 ( IS_ROOT                           :binary@prove ) ;; rmk: set at the creation of the context explicitly to 0 or 1; imposed to be context-constant; the @prove is therefore redundant; we keep it for now as a safet;
+		 ( IS_STATIC                         :binary@prove ) ;; rmk: same remark 
+
+		 ;; (immutable) account
+		 ( ACCOUNT_ADDRESS_HI                :i32  )
+		 ( ACCOUNT_ADDRESS_LO                :i128 )
+		 ( ACCOUNT_DEPLOYMENT_NUMBER         :i32  )
+
+		 ;; (immutable) account whose bytecode is being executed
+		 ( BYTE_CODE_ADDRESS_HI              :i32  )
+		 ( BYTE_CODE_ADDRESS_LO              :i128 )
+		 ( BYTE_CODE_DEPLOYMENT_NUMBER       :i32  )
+		 ( BYTE_CODE_DEPLOYMENT_STATUS       :i32  )
+		 ( BYTE_CODE_CODE_FRAGMENT_INDEX     :i32  )
+
+		 ;; (immutable) caller account
+		 ( CALL_DATA_CONTEXT_NUMBER          :i32  )
+		 ( CALLER_ADDRESS_HI                 :i32  )
+		 ( CALLER_ADDRESS_LO                 :i128 )
+		 ( CALL_VALUE                        :i128 )
+
+		 ;; (immutable) parameters set at CALL
+		 ( CALL_DATA_OFFSET                  :i32  )
+		 ( CALL_DATA_SIZE                    :i32  )
+		 ( RETURN_AT_OFFSET                  :i32  )
+		 ( RETURN_AT_CAPACITY                :i32  )
+
+		 ;; (mutable) parameters set when execution resumes after a CALL / CREATE
+		 ( UPDATE                            :binary@prove )
+		 ( RETURN_DATA_OFFSET                :i32 )
+		 ( RETURN_DATA_SIZE                  :i32 )
+		 ( RETURN_DATA_CONTEXT_NUMBER        :i32 )
+		 ))

hub/columns/miscellaneous.lisp renamed to hub/london/columns/miscellaneous.lisp

@@ -0,0 +1,75 @@
+(module hub)
+
+(defperspective misc
+		;; selector
+		PEEK_AT_MISCELLANEOUS
+
+		;; miscellaneous-row columns
+		(
+		 ( EXP_FLAG   :binary@prove )
+		 ( MMU_FLAG   :binary@prove )
+		 ( MXP_FLAG   :binary@prove )
+		 ( OOB_FLAG   :binary@prove )
+		 ( STP_FLAG   :binary@prove )
+
+		 ;; EXP columns (DONE)
+		 ( EXP_INST                :i16 )
+		 ( EXP_DATA                :array [5] :i128 )
+
+		 ;; MMU columns (DONE)
+		 ( MMU_INST                :i16   :display :hex)
+		 ( MMU_SRC_ID              :i32   )
+		 ( MMU_TGT_ID              :i32   )
+		 ( MMU_AUX_ID              :i32   )
+		 ( MMU_SRC_OFFSET_LO       :i128  )
+		 ( MMU_SRC_OFFSET_HI       :i128  )
+		 ( MMU_TGT_OFFSET_LO       :i128  )
+		 ( MMU_SIZE                :i32   )
+		 ( MMU_REF_OFFSET          :i32   )
+		 ( MMU_REF_SIZE            :i32   )
+		 ( MMU_SUCCESS_BIT         :binary@prove )
+		 ( MMU_LIMB_1              :i128  )
+		 ( MMU_LIMB_2              :i128  )
+		 ( MMU_PHASE               :i32   )
+		 ( MMU_EXO_SUM             :i32   )
+
+		 ;; MXP colummns
+		 ( MXP_INST                     :byte   )
+		 ( MXP_MXPX                     :binary ) 
+		 ( MXP_DEPLOYS                  :binary ) 
+		 ( MXP_OFFSET_1_HI              :i128 )
+		 ( MXP_OFFSET_1_LO              :i128 )
+		 ( MXP_OFFSET_2_HI              :i128 )
+		 ( MXP_OFFSET_2_LO              :i128 )
+		 ( MXP_SIZE_1_HI                :i128 )
+		 ( MXP_SIZE_1_LO                :i128 )
+		 ( MXP_SIZE_2_HI                :i128 )
+		 ( MXP_SIZE_2_LO                :i128 )
+		 ( MXP_WORDS                    :i128 )
+		 ( MXP_GAS_MXP                  :i128 )
+		 ( MXP_MTNTOP                   :binary@prove )
+		 ( MXP_SIZE_1_NONZERO_NO_MXPX   :binary@prove )
+		 ( MXP_SIZE_2_NONZERO_NO_MXPX   :binary@prove )
+
+		 ;; OOB columns
+		 (OOB_INST                 :i16  )
+		 (OOB_DATA                 :array[1:10] :i128 )
+
+		 ;; STP columns
+		 ( STP_INSTRUCTION               :byte )
+		 ( STP_GAS_HI                    :i128 )
+		 ( STP_GAS_LO                    :i128 )
+		 ( STP_VALUE_HI                  :i128 )
+		 ( STP_VALUE_LO                  :i128 )
+		 ( STP_EXISTS                    :binary)  
+		 ( STP_WARMTH                    :binary)  
+		 ( STP_OOGX                      :binary)  
+		 ( STP_GAS_MXP                   :i64 )
+		 ( STP_GAS_UPFRONT_GAS_COST      :i64 )
+		 ( STP_GAS_PAID_OUT_OF_POCKET    :i64 )
+		 ( STP_GAS_STIPEND               :i12 )   
+
+		 ;; ``truly'' miscellaneous columns
+		 ( CCSR_FLAG                           :binary)  ;; Child Context Self Reverts Flag; 
+		 ( CCRS_STAMP                          :i32 )    ;; Child Context Revert Stamp
+		 ))

hub/columns/scenario.lisp renamed to hub/london/columns/scenario.lisp

@@ -0,0 +1,77 @@
+(module hub)
+
+(defperspective scenario
+
+  ;; selector
+  PEEK_AT_SCENARIO
+
+  ;; scenario columns
+  (;; CALL related scenario columns
+   (CALL_EXCEPTION                                   :binary@prove)
+   (CALL_ABORT_WILL_REVERT                           :binary@prove)
+   (CALL_ABORT_WONT_REVERT                           :binary@prove)
+   ;; call to precompiles related
+   (CALL_PRC_FAILURE                                 :binary@prove)
+   (CALL_PRC_SUCCESS_CALLER_WILL_REVERT              :binary@prove)
+   (CALL_PRC_SUCCESS_CALLER_WONT_REVERT              :binary@prove)
+   ;; call to smart contract related
+   (CALL_SMC_FAILURE_CALLER_WILL_REVERT              :binary@prove)
+   (CALL_SMC_FAILURE_CALLER_WONT_REVERT              :binary@prove)
+   (CALL_SMC_SUCCESS_CALLER_WILL_REVERT              :binary@prove)
+   (CALL_SMC_SUCCESS_CALLER_WONT_REVERT              :binary@prove)
+   ;; call to externally owned accounts related
+   (CALL_EOA_SUCCESS_CALLER_WILL_REVERT              :binary@prove)
+   (CALL_EOA_SUCCESS_CALLER_WONT_REVERT              :binary@prove)
+
+   ;; Create related
+   (CREATE_EXCEPTION                                 :binary@prove)
+   (CREATE_ABORT                                     :binary@prove)
+   (CREATE_FAILURE_CONDITION_WILL_REVERT             :binary@prove)
+   (CREATE_FAILURE_CONDITION_WONT_REVERT             :binary@prove)
+   (CREATE_EMPTY_INIT_CODE_WILL_REVERT               :binary@prove)
+   (CREATE_EMPTY_INIT_CODE_WONT_REVERT               :binary@prove)
+   (CREATE_NONEMPTY_INIT_CODE_FAILURE_WILL_REVERT    :binary@prove)
+   (CREATE_NONEMPTY_INIT_CODE_FAILURE_WONT_REVERT    :binary@prove)
+   (CREATE_NONEMPTY_INIT_CODE_SUCCESS_WILL_REVERT    :binary@prove)
+   (CREATE_NONEMPTY_INIT_CODE_SUCCESS_WONT_REVERT    :binary@prove)
+
+   ;; Return related
+   (RETURN_EXCEPTION                                 :binary@prove)
+   (RETURN_FROM_MESSAGE_CALL_WILL_TOUCH_RAM          :binary@prove)
+   (RETURN_FROM_MESSAGE_CALL_WONT_TOUCH_RAM          :binary@prove)
+   (RETURN_FROM_DEPLOYMENT_EMPTY_CODE_WILL_REVERT    :binary@prove)
+   (RETURN_FROM_DEPLOYMENT_EMPTY_CODE_WONT_REVERT    :binary@prove)
+   (RETURN_FROM_DEPLOYMENT_NONEMPTY_CODE_WILL_REVERT :binary@prove)
+   (RETURN_FROM_DEPLOYMENT_NONEMPTY_CODE_WONT_REVERT :binary@prove)
+
+   ;; precompile related
+   ;; precompile flags
+   (PRC_ECRECOVER                                    :binary@prove)
+   (PRC_SHA2-256                                     :binary@prove)
+   (PRC_RIPEMD-160                                   :binary@prove)
+   (PRC_IDENTITY                                     :binary@prove)
+   (PRC_MODEXP                                       :binary@prove)
+   (PRC_ECADD                                        :binary@prove)
+   (PRC_ECMUL                                        :binary@prove)
+   (PRC_ECPAIRING                                    :binary@prove)
+   (PRC_BLAKE2f                                      :binary@prove)
+   ;; execution paths
+   (PRC_SUCCESS_CALLER_WILL_REVERT                   :binary@prove)
+   (PRC_SUCCESS_CALLER_WONT_REVERT                   :binary@prove)
+   (PRC_FAILURE_KNOWN_TO_HUB                         :binary@prove)
+   (PRC_FAILURE_KNOWN_TO_RAM                         :binary@prove)
+   ;; gas parameters (RETURN_GAS is a prediction)
+   (PRC_CALLER_GAS                                   :i64)
+   (PRC_CALLEE_GAS                                   :i64)
+   (PRC_RETURN_GAS                                   :i64)
+   ;; duplicate values for precompile calls
+   (PRC_CDO                                          :i32)
+   (PRC_CDS                                          :i32)
+   (PRC_RAO                                          :i32)
+   (PRC_RAC                                          :i32)
+
+   ;; SELFDESTRUCT related
+   (SELFDESTRUCT_EXCEPTION                           :binary@prove)
+   (SELFDESTRUCT_WILL_REVERT                         :binary@prove)
+   (SELFDESTRUCT_WONT_REVERT_ALREADY_MARKED          :binary@prove)
+   (SELFDESTRUCT_WONT_REVERT_NOT_YET_MARKED          :binary@prove)))