Tweaks to comments (#1444)

* Tweaks to comments

* change comment to decreaseStake in staker.sol

* Update packer/packer.go

* Fixed multiplier

* chore: update scheduler comment (#1445)

* update comment in engine

* decode err

---------

Co-authored-by: paologalligit <paolo.galli@vechain.org>
Co-authored-by: Darren Kelly <107671032+darrenvechain@users.noreply.github.com>
Co-authored-by: tony <liboliqi@gmail.com>

Author: 4 people

bft/engine.go

@@ -305,6 +305,7 @@ func (engine *Engine) computeState(header *block.Header) (*bftState, error) {
 		js = (entry.Value).(*justifier)
 		end = header.Number()
 	} else {
+		// create a new vote set if cache missed or new block is checkpoint
 		var err error
 		js, err = engine.newJustifier(header.ParentID())
 		if err != nil {
@@ -340,7 +341,7 @@ func (engine *Engine) computeState(header *block.Header) (*bftState, error) {
 				}
 				weight = validator.Weight
 			}
-			// If PoS is not active or error occurred, weight remains nil
+			// If PoS is not active or error occurred, weight remains 0
 			js.AddBlock(signer, h.COM(), weight)
 		} else {
 			js.AddBlock(signer, h.COM(), 0)

bft/justifier.go

@@ -124,6 +124,7 @@ func (js *justifier) AddBlock(signer thor.Address, isCOM bool, weight uint64) {
 	}
 }
 
+// Summarize summarizes the state of vote set.
 func (js *justifier) Summarize() *bftState {
 	var justified, committed bool
 

builtin/gen/compiled/Staker.bin-runtime

@@ -72,7 +72,8 @@ contract Staker {
     }
 
     /**
-     * @dev decreaseStake removes VET from the current stake of an active validator
+     * @dev decreaseStake removes VET from the current stake of an active validator but do not change
+     the effectiveVET since it will require withdrawStake.
      */
     function decreaseStake(
         address validator,
@@ -107,7 +108,7 @@ contract Staker {
      */
     function addDelegation(
         address validator,
-        uint8 multiplier // (% of msg.value) 100 for x1, 200 for x2, etc. This enforces a maximum of 2.56x multiplier
+        uint8 multiplier // (% of msg.value) 100 for x1, 200 for x2, etc. This enforces a maximum of 2.55x multiplier
     )
         external
         payable

builtin/gen/staker.sol

@@ -201,7 +201,7 @@ var (
 	// solo mode only flags
 	hayabusaFlag = cli.BoolFlag{
 		Name:  "hayabusa",
-		Usage: "start solo immidetaly as hayabusa",
+		Usage: "start solo immediately as hayabusa",
 	}
 	onDemandFlag = cli.BoolFlag{
 		Name:  "on-demand",

cmd/thor/flags.go

@@ -113,8 +113,8 @@ func decodeAndWarmupBatches(ctx context.Context, rawBatches <-chan rawBlockBatch
 		for batch := range rawBatches {
 			for i, raw := range batch.rawBlocks {
 				var blk block.Block
-				if decodeErr := rlp.DecodeBytes(raw, &blk); err != nil {
-					err = errors.Wrap(decodeErr, "invalid block")
+				if err = rlp.DecodeBytes(raw, &blk); err != nil {
+					err = errors.Wrap(err, "invalid block")
 					return
 				}
 

comm/sync.go

@@ -37,7 +37,7 @@ type Scheduler struct {
 
 // NewScheduler create a Scheduler object.
 // `addr` is the proposer to be scheduled.
-// If `addr` is not listed in `proposers` or not active, an error returned.
+// If `addr` is not listed in `proposers`, an error is returned.
 func NewScheduler(
 	addr thor.Address,
 	proposers []Proposer,

pos/sched.go

@@ -16,7 +16,6 @@ import (
 	"net/http"
 	"strconv"
 	"strings"
-	"sync/atomic"
 
 	"github.com/vechain/thor/v2/api"
 	"github.com/vechain/thor/v2/api/transactions"
@@ -36,9 +35,8 @@ const (
 // Client represents the HTTP client for interacting with the VeChainThor blockchain.
 // It manages communication via HTTP requests.
 type Client struct {
-	url     string
-	c       *http.Client
-	genesis atomic.Pointer[api.JSONCollapsedBlock]
+	url string
+	c   *http.Client
 }
 
 // New creates a new Client with the provided URL.
@@ -48,9 +46,8 @@ func New(url string) *Client {
 
 func NewWithHTTP(url string, c *http.Client) *Client {
 	return &Client{
-		url:     url,
-		c:       c,
-		genesis: atomic.Pointer[api.JSONCollapsedBlock]{},
+		url: url,
+		c:   c,
 	}
 }
 
@@ -220,9 +217,6 @@ func (c *Client) SendTransaction(obj *api.RawTx) (*api.SendTxResult, error) {
 
 // GetBlock retrieves a block by its block ID.
 func (c *Client) GetBlock(blockID string) (*api.JSONCollapsedBlock, error) {
-	if blockID == "0" && c.genesis.Load() != nil {
-		return c.genesis.Load(), nil
-	}
 	body, err := c.httpGET(c.url + "/blocks/" + blockID)
 	if err != nil {
 		return nil, fmt.Errorf("unable to retrieve block - %w", err)
@@ -237,11 +231,6 @@ func (c *Client) GetBlock(blockID string) (*api.JSONCollapsedBlock, error) {
 		return nil, fmt.Errorf("unable to unmarshal block - %w", err)
 	}
 
-	if block.Number == 0 {
-		// Cache the genesis block for future requests
-		c.genesis.Store(&block)
-	}
-
 	return &block, nil
 }