Merge pull request #405 from icon-project/release-1.6.0

Release 1.6.0

VERSION

@@ -1 +1 @@
-1.5.20
+1.6.0

iconservice/base/ComponentBase.py

@@ -33,6 +33,9 @@ def open(self, *args, **kwargs):
     def close(self):
         pass
 
+    def rollback(self, context: 'IconScoreContext', block_height: int, block_hash: bytes):
+        pass
+
 
 class StorageBase(ABC):
 
@@ -54,3 +57,6 @@ def close(self, context: 'IconScoreContext'):
         if self._db:
             self._db.close(context)
             self._db = None
+
+    def rollback(self, context: 'IconScoreContext', block_height: int, block_hash: bytes):
+        pass

iconservice/base/type_converter_templates.py

@@ -41,6 +41,7 @@ class ParamType(IntEnum):
 
     WRITE_PRECOMMIT = 400
     REMOVE_PRECOMMIT = 500
+    ROLLBACK = 501
 
     VALIDATE_TRANSACTION = 600
 
@@ -325,6 +326,11 @@ class ConstantKeys:
 
 type_convert_templates[ParamType.REMOVE_PRECOMMIT] = type_convert_templates[ParamType.WRITE_PRECOMMIT]
 
+type_convert_templates[ParamType.ROLLBACK] = {
+    ConstantKeys.BLOCK_HEIGHT: ValueType.INT,
+    ConstantKeys.BLOCK_HASH: ValueType.BYTES
+}
+
 type_convert_templates[ParamType.VALIDATE_TRANSACTION] = {
     ConstantKeys.METHOD: ValueType.STRING,
     ConstantKeys.PARAMS: type_convert_templates[ParamType.TRANSACTION_PARAMS_DATA]

iconservice/database/wal.py

@@ -19,12 +19,15 @@
 from ..iiss.reward_calc.storage import Storage, get_rc_version
 from ..utils.msgpack_for_db import MsgPackForDB
 
-__all__ = ("WriteAheadLogWriter", "WriteAheadLogReader", "WALogable", "StateWAL", "IissWAL", "WALState")
+__all__ = (
+    "WriteAheadLogWriter", "WriteAheadLogReader", "WALogable", "StateWAL", "IissWAL", "WALState", "WALDBType"
+)
 
 import struct
 from abc import ABCMeta
 from typing import Optional, Tuple, Iterable, List
 import os
+from enum import Enum
 
 import msgpack
 from iconcommons.logger import Logger
@@ -52,6 +55,11 @@
 _OFFSET_LOG_START_OFFSETS = _OFFSET_LOG_COUNT + 4
 
 
+class WALDBType(Enum):
+    RC = 0
+    STATE = 1
+
+
 class WALState(Flag):
     CALC_PERIOD_START_BLOCK = auto()
     # Write WAL to rc_db
@@ -63,6 +71,9 @@ class WALState(Flag):
     # Send CALCULATE message to rc
     SEND_CALCULATE = auto()
 
+    # Means All flags are on
+    ALL = 0xFFFFFFFF
+
 
 def tx_batch_value_to_bytes(tx_batch_value: 'TransactionBatchValue') -> Optional[bytes]:
     if not isinstance(tx_batch_value, TransactionBatchValue):

iconservice/icon_config.py

@@ -12,8 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from .icon_constant import ConfigKey, ICX_IN_LOOP, TERM_PERIOD, IISS_DAY_BLOCK, PREP_MAIN_PREPS, \
-    PREP_MAIN_AND_SUB_PREPS, PENALTY_GRACE_PERIOD, LOW_PRODUCTIVITY_PENALTY_THRESHOLD, BLOCK_VALIDATION_PENALTY_THRESHOLD
+from .icon_constant import (
+    ConfigKey, ICX_IN_LOOP, TERM_PERIOD, IISS_DAY_BLOCK, PREP_MAIN_PREPS,
+    PREP_MAIN_AND_SUB_PREPS, PENALTY_GRACE_PERIOD, LOW_PRODUCTIVITY_PENALTY_THRESHOLD,
+    BLOCK_VALIDATION_PENALTY_THRESHOLD, BACKUP_FILES
+)
 
 default_icon_config = {
     "log": {
@@ -57,5 +60,6 @@
     ConfigKey.LOW_PRODUCTIVITY_PENALTY_THRESHOLD: LOW_PRODUCTIVITY_PENALTY_THRESHOLD,
     ConfigKey.BLOCK_VALIDATION_PENALTY_THRESHOLD: BLOCK_VALIDATION_PENALTY_THRESHOLD,
     ConfigKey.STEP_TRACE_FLAG: False,
-    ConfigKey.PRECOMMIT_DATA_LOG_FLAG: False
+    ConfigKey.PRECOMMIT_DATA_LOG_FLAG: False,
+    ConfigKey.BACKUP_FILES: BACKUP_FILES
 }

iconservice/icon_constant.py

@@ -26,6 +26,8 @@
 IISS_LOG_TAG = "IISS"
 STEP_LOG_TAG = "STEP"
 WAL_LOG_TAG = "WAL"
+ROLLBACK_LOG_TAG = "ROLLBACK"
+BACKUP_LOG_TAG = "BACKUP"
 
 JSONRPC_VERSION = '2.0'
 CHARSET_ENCODING = 'utf-8'
@@ -121,7 +123,6 @@ class Revision(Enum):
 RC_DB_VERSION_0 = 0
 RC_DB_VERSION_2 = 2
 
-
 # The case that version is updated but not revision, set the version to the current revision
 # The case that both version and revision is updated, add revision field to the version table
 # The case that only revision is changed, do not update this table
@@ -181,6 +182,9 @@ class ConfigKey:
     LOW_PRODUCTIVITY_PENALTY_THRESHOLD = "lowProductivityPenaltyThreshold"
     BLOCK_VALIDATION_PENALTY_THRESHOLD = "blockValidationPenaltyThreshold"
 
+    # The maximum number of backup files for rollback
+    BACKUP_FILES = "backupFiles"
+
 
 class EnableThreadFlag(IntFlag):
     INVOKE = 1
@@ -252,7 +256,8 @@ class DeployState(IntEnum):
     "getMainPReps",
     "getSubPReps",
     "getPReps",
-    "getPRepTerm"
+    "getPRepTerm",
+    "getInactivePReps"
 ]
 
 DEBUG_METHOD_TABLE = [
@@ -292,13 +297,15 @@ class DeployState(IntEnum):
 
 PENALTY_GRACE_PERIOD = IISS_DAY_BLOCK * 2
 
-LOW_PRODUCTIVITY_PENALTY_THRESHOLD = 85     # Unit: Percent
-BLOCK_VALIDATION_PENALTY_THRESHOLD = 660    # Unit: Blocks
+LOW_PRODUCTIVITY_PENALTY_THRESHOLD = 85  # Unit: Percent
+BLOCK_VALIDATION_PENALTY_THRESHOLD = 660  # Unit: Blocks
 
 BASE_TRANSACTION_VERSION = 3
 
 PREP_PENALTY_SIGNATURE = "PenaltyImposed(Address,int,int)"
 
+BACKUP_FILES = 10
+
 
 class RCStatus(IntEnum):
     NOT_READY = 0

iconservice/icon_inner_service.py

@@ -67,8 +67,8 @@ def _check_icon_service_ready(self):
 
     @staticmethod
     def _log_exception(e: BaseException, tag: str = ICON_INNER_LOG_TAG) -> None:
-        Logger.exception(e, tag)
-        Logger.error(e, tag)
+        Logger.exception(str(e), tag)
+        Logger.error(str(e), tag)
 
     @message_queue_task
     async def hello(self):
@@ -331,7 +331,7 @@ def _remove_precommit_state(self, request: dict):
             block_height, instant_block_hash, _ = \
                 self._get_block_info_for_precommit_state(converted_block_params)
 
-            self._icon_service_engine.rollback(block_height, instant_block_hash)
+            self._icon_service_engine.remove_precommit_state(block_height, instant_block_hash)
             response = MakeResponse.make_response(ExceptionCode.OK)
         except FatalException as e:
             self._log_exception(e, ICON_SERVICE_LOG_TAG)
@@ -347,6 +347,53 @@ def _remove_precommit_state(self, request: dict):
             Logger.info(f'remove_precommit_state response with {response}', ICON_INNER_LOG_TAG)
             return response
 
+    @message_queue_task
+    async def rollback(self, request: dict):
+        """Go back to the state of the given previous block
+
+        :param request:
+        :return:
+        """
+
+        Logger.info(tag=ICON_INNER_LOG_TAG, msg=f"rollback() start: {request}")
+
+        self._check_icon_service_ready()
+
+        if self._is_thread_flag_on(EnableThreadFlag.INVOKE):
+            loop = asyncio.get_event_loop()
+            response = await loop.run_in_executor(self._thread_pool[THREAD_INVOKE], self._rollback, request)
+        else:
+            response = self._rollback(request)
+
+        Logger.info(tag=ICON_INNER_LOG_TAG, msg=f"rollback() end: {response}")
+
+        return response
+
+    def _rollback(self, request: dict) -> dict:
+        Logger.info(tag=ICON_INNER_LOG_TAG, msg=f"_rollback() start: {request}")
+
+        response = {}
+        try:
+            converted_params = TypeConverter.convert(request, ParamType.ROLLBACK)
+            block_height: int = converted_params[ConstantKeys.BLOCK_HEIGHT]
+            block_hash: bytes = converted_params[ConstantKeys.BLOCK_HASH]
+
+            response: dict = self._icon_service_engine.rollback(block_height, block_hash)
+            response = MakeResponse.make_response(response)
+        except FatalException as e:
+            self._log_exception(e, ICON_SERVICE_LOG_TAG)
+            response = MakeResponse.make_error_response(ExceptionCode.SYSTEM_ERROR, str(e))
+            self._close()
+        except IconServiceBaseException as icon_e:
+            self._log_exception(icon_e, ICON_SERVICE_LOG_TAG)
+            response = MakeResponse.make_error_response(icon_e.code, icon_e.message)
+        except BaseException as e:
+            self._log_exception(e, ICON_SERVICE_LOG_TAG)
+            response = MakeResponse.make_error_response(ExceptionCode.SYSTEM_ERROR, str(e))
+        finally:
+            Logger.info(tag=ICON_INNER_LOG_TAG, msg=f"_rollback() end: {response}")
+            return response
+
     @message_queue_task
     async def validate_transaction(self, request: dict):
         Logger.debug(f'pre_validate_check request with {request}', ICON_INNER_LOG_TAG)
@@ -382,7 +429,7 @@ def _validate_transaction(self, request: dict):
             return response
 
     @message_queue_task
-    async def change_block_hash(self, params):
+    async def change_block_hash(self, _params):
 
         self._check_icon_service_ready()