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

     1  // Copyright 2018 The klaytn Authors
     2  // Copyright 2015 The go-ethereum Authors
     3  // This file is part of the go-ethereum library.
     4  //
     5  // The go-ethereum library is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU Lesser General Public License as published by
     7  // the Free Software Foundation, either version 3 of the License, or
     8  // (at your option) any later version.
     9  //
    10  // The go-ethereum library is distributed in the hope that it will be useful,
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    13  // GNU Lesser General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU Lesser General Public License
    16  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    17  //
    18  // This file is derived from common/bytes.go (2018/06/04).
    19  // Modified and improved for the klaytn development.
    20  
    21  /*
    22  Package common contains various helper functions, commonly used data types and constants.
    23  
    24  Source Files
    25  
    26  Each source file provides functions and types as listed below
    27    - big.go   		: Defines common big integers often used such as Big1
    28    - bytes.go		: Provides conversion functions between a byte slice and other types such as string in Hex format and int
    29    - cache.go		: Defines Cache interface and constants such as CacheType
    30    - debug.go		: Provides a function to let an user know where to report a bug. It is being used by datasync/downloader
    31    - format.go		: Provides a function to print a time.Duration in more readable format
    32    - path.go  		: Provides functions to check a file's existence and to get an absolute path
    33    - size.go 		: Provides StorageSize type and its stringer functions
    34    - types.go		: Provides commonly used Hash and Address types and its methods
    35    - utils.go		: Provides LoadJSON function to read a JSON file
    36    - variables.go	: Provides configuration values
    37  */
    38  package common