github.com/klaytn/klaytn@v1.10.2/consensus/istanbul/backend/doc.go (about) 1 // Copyright 2018 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 /* 18 Package backend defines backend struct which implements Backend interface of Istanbul consensus engine. 19 backend struct works as a backbone of the consensus engine having Istanbul core, 20 required objects to get information for making a consensus, recent messages and a broadcaster to send its message to peer nodes. 21 22 Source Files 23 24 Implementation of Backend interface and APIs are included in this package 25 - `api.go`: Implements APIs which provide the states of Istanbul 26 - `backend.go`: Defines backend struct which implements Backend interface working as a backbone of the consensus engine 27 - `engine.go`: Implements various backend methods especially for verifying and building header information 28 - `handler.go`: Implements backend methods for handling messages and broadcaster 29 - `snapshot.go`: Defines snapshot struct which handles votes from nodes and makes governance changes 30 31 */ 32 package backend