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

     1  // Copyright 2018 The klaytn Authors
     2  // Copyright 2014 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 miner/miner.go (2018/06/04).
    19  // Modified and improved for the klaytn development.
    20  
    21  /*
    22  Package work implements Klaytn block creation and mining.
    23  
    24  work package is in charge of generating blocks and it contains `miner`, `worker` and `agents` which performs building blocks with transactions.
    25  `miner` contains `worker` and a consensus engine, so it controls the worker and passes the result to the consensus engine.
    26  `worker` contains `agent`s and each `agent` performs mining activity.
    27  
    28  Source Files
    29   - agent.go		: Provides CpuAgent and accompanying functions which works as an agent of a miner. Agent is in charge of creating a block
    30   - remote_agent.go	: Provides RemoteAgent working as an another agent for a miner and can be controlled by RPC calls
    31   - work.go		: Provides Miner struct and interfaces through which the miner communicate with other objects
    32   - worker.go		: Provides Worker and performs the main part of block creation
    33  */
    34  package work