github.com/klaytn/klaytn@v1.10.2/cmd/kbn/doc.go (about)

     1  // Copyright 2018 The klaytn Authors
     2  // Copyright 2015 The go-ethereum Authors
     3  // This file is part of go-ethereum.
     4  //
     5  // go-ethereum is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU 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  // go-ethereum 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 General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU General Public License
    16  // along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
    17  //
    18  // This file is derived from cmd/bootnode/main.go (2018/06/04).
    19  // Modified and improved for the klaytn development.
    20  
    21  /*
    22  kbn runs a bootstrap node for the Klaytn Node Discovery Protocol.
    23  
    24  A bootstrap node is a kind of registry service which has every nodes' information and delivers it to a querying node to help the node to join the network.
    25  
    26  Source Files
    27  
    28  Each file contains the following contents
    29   - api.go	: Provides various APIs to use bootnode services
    30   - backend.go	: Provides supporting functions for APIs
    31   - config.go	: Provides `bootnodeConfig` which contains a configuration and accompanying setter and parser functions
    32   - main.go	: Main entry point of the application
    33   - node.go	: Provides `Node` struct which defines what kind of APIs can be provided through which port and protocols
    34  
    35  */
    36  package main