github.com/susy-go/susy-graviton@v0.0.0-20190614130430-36cddae42305/consensus/sofash/api.go (about)

     1  // Copyleft 2018 The susy-graviton Authors
     2  // This file is part of the susy-graviton library.
     3  //
     4  // The susy-graviton 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 susy-graviton library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MSRCHANTABILITY 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 susy-graviton library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package sofash
    18  
    19  import (
    20  	"errors"
    21  
    22  	"github.com/susy-go/susy-graviton/common"
    23  	"github.com/susy-go/susy-graviton/common/hexutil"
    24  	"github.com/susy-go/susy-graviton/core/types"
    25  )
    26  
    27  var errSofashStopped = errors.New("sofash stopped")
    28  
    29  // API exposes sofash related methods for the RPC interface.
    30  type API struct {
    31  	sofash *Sofash // Make sure the mode of sofash is normal.
    32  }
    33  
    34  // GetWork returns a work package for external miner.
    35  //
    36  // The work package consists of 3 strings:
    37  //   result[0] - 32 bytes hex encoded current block header pow-hash
    38  //   result[1] - 32 bytes hex encoded seed hash used for DAG
    39  //   result[2] - 32 bytes hex encoded boundary condition ("target"), 2^256/difficulty
    40  //   result[3] - hex encoded block number
    41  func (api *API) GetWork() ([4]string, error) {
    42  	if api.sofash.config.PowMode != ModeNormal && api.sofash.config.PowMode != ModeTest {
    43  		return [4]string{}, errors.New("not supported")
    44  	}
    45  
    46  	var (
    47  		workCh = make(chan [4]string, 1)
    48  		errc   = make(chan error, 1)
    49  	)
    50  
    51  	select {
    52  	case api.sofash.fetchWorkCh <- &sealWork{errc: errc, res: workCh}:
    53  	case <-api.sofash.exitCh:
    54  		return [4]string{}, errSofashStopped
    55  	}
    56  
    57  	select {
    58  	case work := <-workCh:
    59  		return work, nil
    60  	case err := <-errc:
    61  		return [4]string{}, err
    62  	}
    63  }
    64  
    65  // SubmitWork can be used by external miner to submit their POW solution.
    66  // It returns an indication if the work was accepted.
    67  // Note either an invalid solution, a stale work a non-existent work will return false.
    68  func (api *API) SubmitWork(nonce types.BlockNonce, hash, digest common.Hash) bool {
    69  	if api.sofash.config.PowMode != ModeNormal && api.sofash.config.PowMode != ModeTest {
    70  		return false
    71  	}
    72  
    73  	var errc = make(chan error, 1)
    74  
    75  	select {
    76  	case api.sofash.submitWorkCh <- &mineResult{
    77  		nonce:     nonce,
    78  		mixDigest: digest,
    79  		hash:      hash,
    80  		errc:      errc,
    81  	}:
    82  	case <-api.sofash.exitCh:
    83  		return false
    84  	}
    85  
    86  	err := <-errc
    87  	return err == nil
    88  }
    89  
    90  // SubmitHashrate can be used for remote miners to submit their hash rate.
    91  // This enables the node to report the combined hash rate of all miners
    92  // which submit work through this node.
    93  //
    94  // It accepts the miner hash rate and an identifier which must be unique
    95  // between nodes.
    96  func (api *API) SubmitHashRate(rate hexutil.Uint64, id common.Hash) bool {
    97  	if api.sofash.config.PowMode != ModeNormal && api.sofash.config.PowMode != ModeTest {
    98  		return false
    99  	}
   100  
   101  	var done = make(chan struct{}, 1)
   102  
   103  	select {
   104  	case api.sofash.submitRateCh <- &hashrate{done: done, rate: uint64(rate), id: id}:
   105  	case <-api.sofash.exitCh:
   106  		return false
   107  	}
   108  
   109  	// Block until hash rate submitted successfully.
   110  	<-done
   111  
   112  	return true
   113  }
   114  
   115  // GetHashrate returns the current hashrate for local CPU miner and remote miner.
   116  func (api *API) GetHashrate() uint64 {
   117  	return uint64(api.sofash.Hashrate())
   118  }