github.com/klaytn/klaytn@v1.12.1/fork/fork.go (about)

     1  // Copyright 2019 The klaytn Authors
     2  // This file is part of the klaytn library.
     3  //
     4  // The klaytn library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The klaytn library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the klaytn library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package fork
    18  
    19  import (
    20  	"errors"
    21  	"math/big"
    22  
    23  	"github.com/klaytn/klaytn/log"
    24  	"github.com/klaytn/klaytn/params"
    25  )
    26  
    27  var (
    28  	// hardForkBlockNumberConfig contains only hardFork block number
    29  	hardForkBlockNumberConfig *params.ChainConfig
    30  
    31  	logger = log.NewModuleLogger(log.FORK)
    32  )
    33  
    34  // Rules returns the hard fork information
    35  // CAUTIOUS: Use it when chainConfig value is not reachable
    36  func Rules(blockNumber *big.Int) *params.Rules {
    37  	if hardForkBlockNumberConfig == nil {
    38  		logger.Crit("fork.Rules should never be called before hardForkBlockNumberConfig initialization.")
    39  	}
    40  	rules := hardForkBlockNumberConfig.Rules(blockNumber)
    41  	return &rules
    42  }
    43  
    44  // SetHardForkBlockNumberConfig sets values in HardForkConfig if it is not nil.
    45  // CAUTIOUS: Calling this function is can be dangerous, so avoid using it except tests
    46  func SetHardForkBlockNumberConfig(h *params.ChainConfig) error {
    47  	// ensure that the allocation is done only when h is not nil
    48  	if h == nil {
    49  		return errors.New("hardForkBlockNumberConfig cannot be initialized as nil")
    50  	}
    51  	hardForkBlockNumberConfig = h
    52  	return nil
    53  }
    54  
    55  // ClearHardForkBlockNumberConfig sets nil
    56  // Use only in tests
    57  func ClearHardForkBlockNumberConfig() {
    58  	hardForkBlockNumberConfig = nil
    59  }