docs(all): fix upstream typos (WIP)

accounts/abi/abi_test.go

@@ -1059,7 +1059,7 @@ func TestABI_EventById(t *testing.T) {
 			t.Fatalf("Failed to look up ABI method: %v, test #%d", err, testnum)
 		}
 		if event == nil {
-			t.Errorf("We should find a event for topic %s, test #%d", topicID.Hex(), testnum)
+			t.Errorf("We should find an event for topic %s, test #%d", topicID.Hex(), testnum)
 		} else if event.ID != topicID {
 			t.Errorf("Event id %s does not match topic %s, test #%d", event.ID.Hex(), topicID.Hex(), testnum)
 		}

accounts/abi/bind/template.go

@@ -114,7 +114,7 @@ var (
 
 {{$structs := .Structs}}
 {{range $structs}}
-	// {{.Name}} is an auto generated low-level Go binding around an user-defined struct.
+	// {{.Name}} is an auto generated low-level Go binding around a user-defined struct.
 	type {{.Name}} struct {
 	{{range $field := .Fields}}
 	{{$field.Name}} {{$field.Type}}{{end}}

accounts/keystore/keystore.go

@@ -258,7 +258,7 @@ func (ks *KeyStore) Delete(a accounts.Account, passphrase string) error {
 	return err
 }
 
-// SignHash calculates a ECDSA signature for the given hash. The produced
+// SignHash calculates an ECDSA signature for the given hash. The produced
 // signature is in the [R || S || V] format where V is 0 or 1.
 func (ks *KeyStore) SignHash(a accounts.Account, hash []byte) ([]byte, error) {
 	// Look up the key to sign with and abort if it cannot be found

accounts/usbwallet/wallet.go

@@ -442,7 +442,7 @@ func (w *wallet) selfDerive() {
 
 // Contains implements accounts.Wallet, returning whether a particular account is
 // or is not pinned into this wallet instance. Although we could attempt to resolve
-// unpinned accounts, that would be an non-negligible hardware operation.
+// unpinned accounts, that would be a non-negligible hardware operation.
 func (w *wallet) Contains(account accounts.Account) bool {
 	w.stateLock.RLock()
 	defer w.stateLock.RUnlock()

beacon/types/header.go

@@ -65,7 +65,7 @@ type headerMarshaling struct {
 
 // Hash calculates the block root of the header.
 //
-// TODO(zsfelfoldi): Remove this when an SSZ encoder lands.
+// TODO(zsfelfoldi): Remove this when a SSZ encoder lands.
 func (h *Header) Hash() common.Hash {
 	var values [16]merkle.Value // values corresponding to indices 8 to 15 of the beacon header tree
 	binary.LittleEndian.PutUint64(values[headerIndexSlot][:8], h.Slot)

cmd/clef/main.go

@@ -129,7 +129,7 @@ var (
 	stdiouiFlag = &cli.BoolFlag{
 		Name: "stdio-ui",
 		Usage: "Use STDIN/STDOUT as a channel for an external UI. " +
-			"This means that an STDIN/STDOUT is used for RPC-communication with a e.g. a graphical user " +
+			"This means that a STDIN/STDOUT is used for RPC-communication with a e.g. a graphical user " +
 			"interface, and can be used when Clef is started by an external process.",
 	}
 	testFlag = &cli.BoolFlag{

cmd/evm/internal/t8ntool/tracewriter.go

@@ -27,7 +27,7 @@ import (
 	"github.com/ava-labs/libevm/log"
 )
 
-// traceWriter is an vm.EVMLogger which also holds an inner logger/tracer.
+// traceWriter is a vm.EVMLogger which also holds an inner logger/tracer.
 // When the TxEnd event happens, the inner tracer result is written to the file, and
 // the file is closed.
 type traceWriter struct {

cmd/utils/flags.go

@@ -544,7 +544,7 @@ var (
 	// Logging and debug settings
 	EthStatsURLFlag = &cli.StringFlag{
 		Name:     "ethstats",
-		Usage:    "Reporting URL of a ethstats service (nodename:secret@host:port)",
+		Usage:    "Reporting URL of an ethstats service (nodename:secret@host:port)",
 		Category: flags.MetricsCategory,
 	}
 	NoCompactionFlag = &cli.BoolFlag{

common/lru/lru.go

@@ -25,7 +25,7 @@ type Cache[K comparable, V any] struct {
 	mu    sync.Mutex
 }
 
-// NewCache creates an LRU cache.
+// NewCache creates a LRU cache.
 func NewCache[K comparable, V any](capacity int) *Cache[K, V] {
 	return &Cache[K, V]{cache: NewBasicLRU[K, V](capacity)}
 }

consensus/clique/api.go

@@ -205,7 +205,7 @@ func (sb *blockNumberOrHashOrRLP) UnmarshalJSON(data []byte) error {
 }
 
 // GetSigner returns the signer for a specific clique block.
-// Can be called with a block number, a block hash or a rlp encoded blob.
+// Can be called with a block number, a block hash or an rlp encoded blob.
 // The RLP encoded blob can either be a block or a header.
 func (api *API) GetSigner(rlpOrBlockNr *blockNumberOrHashOrRLP) (common.Address, error) {
 	if len(rlpOrBlockNr.RLP) == 0 {

consensus/clique/clique.go

@@ -114,7 +114,7 @@ var (
 	// errInvalidMixDigest is returned if a block's mix digest is non-zero.
 	errInvalidMixDigest = errors.New("non-zero mix digest")
 
-	// errInvalidUncleHash is returned if a block contains an non-empty uncle list.
+	// errInvalidUncleHash is returned if a block contains a non-empty uncle list.
 	errInvalidUncleHash = errors.New("non empty uncle hash")
 
 	// errInvalidDifficulty is returned if the difficulty of a block neither 1 or 2.

consensus/ethash/ethash.go

@@ -40,7 +40,7 @@ func NewFaker() *Ethash {
 	return new(Ethash)
 }
 
-// NewFakeFailer creates a ethash consensus engine with a fake PoW scheme that
+// NewFakeFailer creates an ethash consensus engine with a fake PoW scheme that
 // accepts all blocks as valid apart from the single one specified, though they
 // still have to conform to the Ethereum consensus rules.
 func NewFakeFailer(fail uint64) *Ethash {
@@ -49,7 +49,7 @@ func NewFakeFailer(fail uint64) *Ethash {
 	}
 }
 
-// NewFakeDelayer creates a ethash consensus engine with a fake PoW scheme that
+// NewFakeDelayer creates an ethash consensus engine with a fake PoW scheme that
 // accepts all blocks as valid, but delays verifications by some time, though
 // they still have to conform to the Ethereum consensus rules.
 func NewFakeDelayer(delay time.Duration) *Ethash {

core/rawdb/accessors_snapshot.go

@@ -92,20 +92,20 @@ func DeleteAccountSnapshot(db ethdb.KeyValueWriter, hash common.Hash) {
 	}
 }
 
-// ReadStorageSnapshot retrieves the snapshot entry of an storage trie leaf.
+// ReadStorageSnapshot retrieves the snapshot entry of a storage trie leaf.
 func ReadStorageSnapshot(db ethdb.KeyValueReader, accountHash, storageHash common.Hash) []byte {
 	data, _ := db.Get(storageSnapshotKey(accountHash, storageHash))
 	return data
 }
 
-// WriteStorageSnapshot stores the snapshot entry of an storage trie leaf.
+// WriteStorageSnapshot stores the snapshot entry of a storage trie leaf.
 func WriteStorageSnapshot(db ethdb.KeyValueWriter, accountHash, storageHash common.Hash, entry []byte) {
 	if err := db.Put(storageSnapshotKey(accountHash, storageHash), entry); err != nil {
 		log.Crit("Failed to store storage snapshot", "err", err)
 	}
 }
 
-// DeleteStorageSnapshot removes the snapshot entry of an storage trie leaf.
+// DeleteStorageSnapshot removes the snapshot entry of a storage trie leaf.
 func DeleteStorageSnapshot(db ethdb.KeyValueWriter, accountHash, storageHash common.Hash) {
 	if err := db.Delete(storageSnapshotKey(accountHash, storageHash)); err != nil {
 		log.Crit("Failed to delete storage snapshot", "err", err)

core/rawdb/freezer_table.go

@@ -239,7 +239,7 @@ func (t *freezerTable) repair() error {
 	firstIndex.unmarshalBinary(buffer)
 
 	// Assign the tail fields with the first stored index.
-	// The total removed items is represented with an uint32,
+	// The total removed items is represented with a uint32,
 	// which is not enough in theory but enough in practice.
 	// TODO: use uint64 to represent total removed items.
 	t.tailId = firstIndex.filenum

core/rlp_test.go

@@ -133,7 +133,7 @@ func testRlpIterator(t *testing.T, txs, uncles, datasize int) {
 	}
 }
 
-// BenchmarkHashing compares the speeds of hashing a rlp raw data directly
+// BenchmarkHashing compares the speeds of hashing an rlp raw data directly
 // without the unmarshalling/marshalling step
 func BenchmarkHashing(b *testing.B) {
 	// Make a pretty fat block

core/state/database.go

@@ -20,7 +20,6 @@ import (
 	"errors"
 	"fmt"
 
-	"github.com/crate-crypto/go-ipa/banderwagon"
 	"github.com/ava-labs/libevm/common"
 	"github.com/ava-labs/libevm/common/lru"
 	"github.com/ava-labs/libevm/core/rawdb"
@@ -31,6 +30,7 @@ import (
 	"github.com/ava-labs/libevm/trie/trienode"
 	"github.com/ava-labs/libevm/trie/utils"
 	"github.com/ava-labs/libevm/triedb"
+	"github.com/crate-crypto/go-ipa/banderwagon"
 )
 
 const (
@@ -71,7 +71,7 @@ type Database interface {
 	TrieDB() *triedb.Database
 }
 
-// Trie is a Ethereum Merkle Patricia trie.
+// Trie is an Ethereum Merkle Patricia trie.
 type Trie interface {
 	// GetKey returns the sha3 preimage of a hashed key that was previously used
 	// to store a value.

core/state/iterator.go

@@ -46,7 +46,7 @@ type nodeIterator struct {
 	Error error // Failure set in case of an internal error in the iterator
 }
 
-// newNodeIterator creates an post-order state node iterator.
+// newNodeIterator creates a post-order state node iterator.
 func newNodeIterator(state *StateDB) *nodeIterator {
 	return &nodeIterator{
 		state: state,

core/state/snapshot/context.go

@@ -46,7 +46,7 @@ type generatorStats struct {
 	storage  common.StorageSize // Total account and storage slot size(generation or recovery)
 }
 
-// Log creates an contextual log with the given message and the context pulled
+// Log creates a contextual log with the given message and the context pulled
 // from the internally maintained statistics.
 func (gs *generatorStats) Log(msg string, root common.Hash, marker []byte) {
 	var ctx []interface{}

core/state/snapshot/iterator_binary.go

@@ -68,7 +68,7 @@ func (dl *diffLayer) initBinaryStorageIterator(account common.Hash) Iterator {
 	parent, ok := dl.parent.(*diffLayer)
 	if !ok {
 		// If the storage in this layer is already destructed, discard all
-		// deeper layers but still return an valid single-branch iterator.
+		// deeper layers but still return a valid single-branch iterator.
 		a, destructed := dl.StorageIterator(account, common.Hash{})
 		if destructed {
 			l := &binaryIterator{
@@ -92,7 +92,7 @@ func (dl *diffLayer) initBinaryStorageIterator(account common.Hash) Iterator {
 		return l
 	}
 	// If the storage in this layer is already destructed, discard all
-	// deeper layers but still return an valid single-branch iterator.
+	// deeper layers but still return a valid single-branch iterator.
 	a, destructed := dl.StorageIterator(account, common.Hash{})
 	if destructed {
 		l := &binaryIterator{

core/state/snapshot/snapshot.go

@@ -863,7 +863,7 @@ func (t *Tree) generating() (bool, error) {
 	return layer.genMarker != nil, nil
 }
 
-// DiskRoot is a external helper function to return the disk layer root.
+// DiskRoot is an external helper function to return the disk layer root.
 func (t *Tree) DiskRoot() common.Hash {
 	t.lock.Lock()
 	defer t.lock.Unlock()

core/state/trie_prefetcher.go

@@ -203,7 +203,7 @@ func (p *triePrefetcher) used(owner common.Hash, root common.Hash, used [][]byte
 	}
 }
 
-// trieID returns an unique trie identifier consists the trie owner and root hash.
+// trieID returns a unique trie identifier consists the trie owner and root hash.
 func (p *triePrefetcher) trieID(owner common.Hash, root common.Hash) string {
 	trieID := make([]byte, common.HashLength*2)
 	copy(trieID, owner.Bytes())

core/vm/contracts.libevm_test.go

@@ -702,7 +702,7 @@ func TestPrecompileMakeCall(t *testing.T) {
 func TestPrecompileCallWithTracer(t *testing.T) {
 	// The native pre-state tracer, when logging storage, assumes an invariant
 	// that is broken by a precompile calling another contract. This is a test
-	// of the fix, ensuring that an SLOADed value is properly handled by the
+	// of the fix, ensuring that a SLOADed value is properly handled by the
 	// tracer.
 
 	rng := ethtest.NewPseudoRand(42 * 142857)

crypto/secp256k1/curve.go

@@ -262,7 +262,7 @@ func (BitCurve *BitCurve) Marshal(x, y *big.Int) []byte {
 	return ret
 }
 
-// Unmarshal converts a point, serialised by Marshal, into an x, y pair. On
+// Unmarshal converts a point, serialised by Marshal, into a x, y pair. On
 // error, x = nil.
 func (BitCurve *BitCurve) Unmarshal(data []byte) (x, y *big.Int) {
 	byteLen := (BitCurve.BitSize + 7) >> 3

crypto/secp256k1/libsecp256k1/src/scalar.h

@@ -72,7 +72,7 @@ static int secp256k1_scalar_is_zero(const secp256k1_scalar *a);
 /** Check whether a scalar equals one. */
 static int secp256k1_scalar_is_one(const secp256k1_scalar *a);
 
-/** Check whether a scalar, considered as an nonnegative integer, is even. */
+/** Check whether a scalar, considered as a nonnegative integer, is even. */
 static int secp256k1_scalar_is_even(const secp256k1_scalar *a);
 
 /** Check whether a scalar is higher than the group order divided by 2. */

eth/catalyst/queue.go

@@ -107,7 +107,7 @@ func (q *payloadQueue) has(id engine.PayloadID) bool {
 	return false
 }
 
-// headerQueueItem represents an hash->header tuple to store until it's retrieved
+// headerQueueItem represents a hash->header tuple to store until it's retrieved
 // or evicted.
 type headerQueueItem struct {
 	hash   common.Hash

eth/fetcher/block_fetcher_test.go

@@ -286,7 +286,7 @@ func verifyFetchingEvent(t *testing.T, fetching chan []common.Hash, arrive bool)
 	}
 }
 
-// verifyCompletingEvent verifies that one single event arrive on an completing channel.
+// verifyCompletingEvent verifies that one single event arrive on a completing channel.
 func verifyCompletingEvent(t *testing.T, completing chan []common.Hash, arrive bool) {
 	t.Helper()
 

eth/fetcher/tx_fetcher.go

@@ -171,7 +171,7 @@ type TxFetcher struct {
 
 	// Stage 1: Waiting lists for newly discovered transactions that might be
 	// broadcast without needing explicit request/reply round trips.
-	waitlist  map[common.Hash]map[string]struct{}    // Transactions waiting for an potential broadcast
+	waitlist  map[common.Hash]map[string]struct{}    // Transactions waiting for a potential broadcast
 	waittime  map[common.Hash]mclock.AbsTime         // Timestamps when transactions were added to the waitlist
 	waitslots map[string]map[common.Hash]*txMetadata // Waiting announcements grouped by peer (DoS protection)
 

eth/fetcher/tx_fetcher_test.go

@@ -562,7 +562,7 @@ func TestTransactionFetcherFailedRescheduling(t *testing.T) {
 					"A": {{0x01}, {0x02}},
 				},
 			},
-			// While the original peer is stuck in the request, push in an second
+			// While the original peer is stuck in the request, push in a second
 			// data source.
 			doTxNotify{peer: "B", hashes: []common.Hash{{0x02}}},
 			isWaiting(nil),

eth/protocols/snap/protocol.go

@@ -113,7 +113,7 @@ func (p *AccountRangePacket) Unpack() ([]common.Hash, [][]byte, error) {
 	return hashes, accounts, nil
 }
 
-// GetStorageRangesPacket represents an storage slot query.
+// GetStorageRangesPacket represents a storage slot query.
 type GetStorageRangesPacket struct {
 	ID       uint64        // Request ID to match up responses with
 	Root     common.Hash   // Root hash of the account trie to serve

ethstats/ethstats.go

@@ -419,7 +419,7 @@ func (s *Service) readLoop(conn *connWrapper) {
 			if !ok {
 				log.Warn("Invalid stats history request", "msg", msg["emit"][1])
 				select {
-				case s.histCh <- nil: // Treat it as an no indexes request
+				case s.histCh <- nil: // Treat it as a no indexes request
 				default:
 				}
 				continue

internal/ethapi/api.go

@@ -1478,7 +1478,7 @@ func (s *BlockChainAPI) CreateAccessList(ctx context.Context, args TransactionAr
 
 // AccessList creates an access list for the given transaction.
 // If the accesslist creation fails an error is returned.
-// If the transaction itself fails, an vmErr is returned.
+// If the transaction itself fails, a vmErr is returned.
 func AccessList(ctx context.Context, b Backend, blockNrOrHash rpc.BlockNumberOrHash, args TransactionArgs) (acl types.AccessList, gasUsed uint64, vmErr error, err error) {
 	// Retrieve the execution context
 	db, header, err := b.StateAndHeaderByNumberOrHash(ctx, blockNrOrHash)
@@ -1857,7 +1857,7 @@ func (s *TransactionAPI) Sign(addr common.Address, data hexutil.Bytes) (hexutil.
 	return signature, err
 }
 
-// SignTransactionResult represents a RLP encoded signed transaction.
+// SignTransactionResult represents an RLP encoded signed transaction.
 type SignTransactionResult struct {
 	Raw hexutil.Bytes      `json:"raw"`
 	Tx  *types.Transaction `json:"tx"`

metrics/opentsdb.go

@@ -37,7 +37,7 @@ func OpenTSDB(r Registry, d time.Duration, prefix string, addr *net.TCPAddr) {
 }
 
 // OpenTSDBWithConfig is a blocking exporter function just like OpenTSDB,
-// but it takes a OpenTSDBConfig instead.
+// but it takes an OpenTSDBConfig instead.
 func OpenTSDBWithConfig(c OpenTSDBConfig) {
 	for range time.Tick(c.FlushInterval) {
 		if err := openTSDB(&c); nil != err {

p2p/enode/nodedb_test.go

@@ -242,7 +242,7 @@ var nodeDBSeedQueryNodes = []struct {
 }
 
 func TestDBSeedQuery(t *testing.T) {
-	// Querying seeds uses seeks an might not find all nodes
+	// Querying seeds uses seeks and might not find all nodes
 	// every time when the database is small. Run the test multiple
 	// times to avoid flakes.
 	const attempts = 15

p2p/util_test.go

@@ -48,7 +48,7 @@ func TestExpHeap(t *testing.T) {
 		t.Fatal("wrong nextExpiry")
 	}
 	if h.contains("a") {
-		t.Fatal("heap contains a even though it has already expired")
+		t.Fatal("heap contains an even though it has already expired")
 	}
 	if !h.contains("b") || !h.contains("c") {
 		t.Fatal("heap doesn't contain all live items")

rpc/testservice_test.go

@@ -185,7 +185,7 @@ func (s *notificationTestService) SomeSubscription(ctx context.Context, n, val i
 		return nil, ErrNotificationsUnsupported
 	}
 
-	// By explicitly creating an subscription we make sure that the subscription id is send
+	// By explicitly creating a subscription we make sure that the subscription id is send
 	// back to the client before the first subscription.Notify is called. Otherwise the
 	// events might be send before the response for the *_subscribe method.
 	subscription := notifier.CreateSubscription()

signer/core/gnosis_safe.go

@@ -50,7 +50,7 @@ type GnosisSafeTx struct {
 	ChainId        *math.HexOrDecimal256   `json:"chainId,omitempty"`
 }
 
-// ToTypedData converts the tx to a EIP-712 Typed Data structure for signing
+// ToTypedData converts the tx to an EIP-712 Typed Data structure for signing
 func (tx *GnosisSafeTx) ToTypedData() apitypes.TypedData {
 	var data hexutil.Bytes
 	if tx.Data != nil {

trie/proof.go

@@ -372,7 +372,7 @@ func unset(parent node, child node, key []byte, pos int, removeLeft bool) error
 		return unset(cld, cld.Children[key[pos]], key, pos+1, removeLeft)
 	case *shortNode:
 		if len(key[pos:]) < len(cld.Key) || !bytes.Equal(cld.Key, key[pos:pos+len(cld.Key)]) {
-			// Find the fork point, it's an non-existent branch.
+			// Find the fork point, it's a non-existent branch.
 			if removeLeft {
 				if bytes.Compare(cld.Key, key[pos:]) < 0 {
 					// The key of fork shortnode is less than the path

trie/trie_reader.go

@@ -54,7 +54,7 @@ func newEmptyReader() *trieReader {
 }
 
 // node retrieves the rlp-encoded trie node with the provided trie node
-// information. An MissingNodeError will be returned in case the node is
+// information. A MissingNodeError will be returned in case the node is
 // not found or any error is encountered.
 func (r *trieReader) node(path []byte, hash common.Hash) ([]byte, error) {
 	// Perform the logics in tests for preventing trie node access.