ci: detect typos

leovct · leovct · commit 020bec0fbf22 · 2025-07-24T12:25:10.000+02:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -32,6 +32,13 @@ jobs:
         run: go install golang.org/x/tools/go/analysis/passes/shadow/cmd/shadow@latest
       - name: Run all the linter tools against code
         run: make lint
+  
+  typos:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+      - uses: crate-ci/typos@392b78fe18a52790c53f42456e46124f77346842 # v1.34.0
 
   gen-doc:
     name: Check gen-doc generated files
diff --git a/cmd/cdk/interfaces.go b/cmd/cdk/interfaces.go
@@ -92,7 +92,7 @@ type validiumContractInterface interface {
 type committeeContractInterface interface {
 	CommitteeHash(opts *bind.CallOpts) ([32]byte, error)
 	GetAmountOfMembers(opts *bind.CallOpts) (*big.Int, error)
-	GetProcotolName(opts *bind.CallOpts) (string, error)
+	GetProtocolName(opts *bind.CallOpts) (string, error)
 	Members(opts *bind.CallOpts, arg0 *big.Int) (struct {
 		Url  string
 		Addr common.Address
diff --git a/cmd/cdk/rollup.go b/cmd/cdk/rollup.go
@@ -135,7 +135,7 @@ type RollupTypeData struct {
 type CommitteeData struct {
 	CommitteeHash              common.Hash `json:"committeeHash"`
 	AmountOfMembers            *big.Int    `json:"amountOfMembers"`
-	ProcotolName               string      `json:"procotolName"`
+	ProtocolName               string      `json:"protocolName"`
 	Members                    []CommitteeMemberData
 	Owner                      common.Address `json:"owner"`
 	RequiredAmountOfSignatures *big.Int       `json:"requiredAmountOfSignatures"`
@@ -435,7 +435,7 @@ func getCommitteeData(committee committeeContractInterface) (*CommitteeData, err
 	}
 	time.Sleep(contractRequestInterval)
 
-	getProcotolName, err := committee.GetProcotolName(nil)
+	getProtocolName, err := committee.GetProtocolName(nil)
 	if err != nil {
 		return nil, err
 	}
@@ -469,7 +469,7 @@ func getCommitteeData(committee committeeContractInterface) (*CommitteeData, err
 	return &CommitteeData{
 		CommitteeHash:              committeeHash,
 		AmountOfMembers:            getAmountOfMembers,
-		ProcotolName:               getProcotolName,
+		ProtocolName:               getProtocolName,
 		Members:                    members,
 		Owner:                      owner,
 		RequiredAmountOfSignatures: requiredAmountOfSignatures,
diff --git a/cmd/fund/fund.go b/cmd/fund/fund.go
@@ -127,7 +127,7 @@ func deployOrInstantiateFunderContract(ctx context.Context, c *ethclient.Client,
 	var err error
 	if *params.FunderAddress == "" {
 		// Deploy the Funder contract.
-		// Note: `fundingAmountInWei` reprensents the amount the Funder contract will send to each newly generated wallets.
+		// Note: `fundingAmountInWei` represents the amount the Funder contract will send to each newly generated wallets.
 		fundingAmountInWei := params.FundingAmountInWei
 		contractAddress, _, _, err = funder.DeployFunder(tops, c, fundingAmountInWei)
 		if err != nil {
@@ -138,7 +138,7 @@ func deployOrInstantiateFunderContract(ctx context.Context, c *ethclient.Client,
 
 		// Fund the Funder contract.
 		// Calculate the total amount needed to fund the contract based on the number of addresses.
-		// Note: `funderContractBalanceInWei` reprensents the initial balance of the Funder contract.
+		// Note: `funderContractBalanceInWei` represents the initial balance of the Funder contract.
 		// The contract needs initial funds to be able to fund wallets.
 		funderContractBalanceInWei := new(big.Int).Mul(fundingAmountInWei, big.NewInt(int64(numAddresses)))
 		if err = util.SendTx(ctx, c, privateKey, &contractAddress, funderContractBalanceInWei, nil, uint64(30000)); err != nil {
diff --git a/cmd/loadtest/loadtest.go b/cmd/loadtest/loadtest.go
@@ -1834,7 +1834,7 @@ func loadTestBlob(ctx context.Context, c *ethclient.Client, tops *bind.TransactO
 		},
 	}
 	// appendBlobCommitment() will take in the blobTx struct and append values to blob transaction specific keys in the following steps:
-	// The function will take in blobTx with empty BlobHashses, and Blob Sidecar variables initially.
+	// The function will take in blobTx with empty BlobHashes, and Blob Sidecar variables initially.
 	// Then generateRandomBlobData() is called to generate a byte slice with random values.
 	// createBlob() is called to commit the randomly generated byte slice with KZG.
 	// generateBlobCommitment() will do the same for the Commitment and Proof.
diff --git a/cmd/loadtest/loadtestUsage.md b/cmd/loadtest/loadtestUsage.md
@@ -73,5 +73,5 @@ The codebase has a contract that used for load testing. It's written in Solidity
    - `$ solc LoadTester.sol --bin --abi -o . --overwrite`
 3. Run `abigen`
    - `$ abigen --abi LoadTester.abi --pkg contracts --type LoadTester --bin LoadTester.bin --out loadtester.go`
-4. Run the loadtester to enure it deploys and runs successfully
+4. Run the loadtester to ensure it deploys and runs successfully
    - `$ polycli loadtest --verbosity 700 --rpc-url http://127.0.0.1:8541`
diff --git a/cmd/retest/retest.go b/cmd/retest/retest.go
@@ -207,14 +207,14 @@ func (wr *WrappedData) ToSlice() []*WrappedData {
 	if v.Len() == 0 {
 		return []*WrappedData{}
 	}
-	wrappedDatas := make([]*WrappedData, v.Len())
+	wrappedData := make([]*WrappedData, v.Len())
 	for i := 0; i < v.Len(); i = i + 1 {
 		nwd := new(WrappedData)
 		nwd.raw = v.Index(i).Interface().(EthTestData)
-		wrappedDatas[i] = nwd
+		wrappedData[i] = nwd
 
 	}
-	return wrappedDatas
+	return wrappedData
 }
 func (wn *WrappedNumeric) IsSlice() bool {
 	v := reflect.ValueOf(wn.raw)
@@ -229,14 +229,14 @@ func (wn *WrappedNumeric) ToSlice() []*WrappedNumeric {
 	if v.Len() == 0 {
 		return []*WrappedNumeric{}
 	}
-	wrappedDatas := make([]*WrappedNumeric, v.Len())
+	wrappedData := make([]*WrappedNumeric, v.Len())
 	for i := 0; i < v.Len(); i = i + 1 {
 		nwd := new(WrappedNumeric)
 		nwd.raw = v.Index(i).Interface().(EthTestData)
-		wrappedDatas[i] = nwd
+		wrappedData[i] = nwd
 
 	}
-	return wrappedDatas
+	return wrappedData
 }
 func EthTestNumericToBigInt(num EthTestNumeric) *big.Int {
 	if num == nil {
diff --git a/cmd/signer/signer.go b/cmd/signer/signer.go
@@ -700,7 +700,7 @@ func (g *GCPKMS) Sign(ctx context.Context, tx *ethtypes.Transaction) error {
 	ethSig = append(ethSig, bigIntTo32Bytes(parsedSig.S)...)
 	ethSig = append(ethSig, 0)
 
-	// Feels like a hack, but I cna't figure out a better way to determine the recovery ID than this since google isn't returning it. More research is required
+	// Feels like a hack, but I can't figure out a better way to determine the recovery ID than this since google isn't returning it. More research is required
 	pubKey, err := crypto.Ecrecover(digest.Bytes(), ethSig)
 	if err != nil || !bytes.Equal(pubKey, gcpPubKey.PublicKey.Bytes) {
 		ethSig[64] = 1
diff --git a/cmd/ulxly/proofUsage.md b/cmd/ulxly/proofUsage.md
@@ -67,7 +67,7 @@ This is the proof response from polycli:
 ![Sample Tree](./tree-diagram.png)
 
 When we're creating the proof here, we're essentially storing the paths to the
-various leafs. When we want to generate a proof, we find the appropriate sibling
+various leaves. When we want to generate a proof, we find the appropriate sibling
 node in the tree to prove that the leaf is part of the given merkle root.
 
 ## Full example
diff --git a/cmd/ulxly/rollupsProofUsage.md b/cmd/ulxly/rollupsProofUsage.md
@@ -61,5 +61,5 @@ This is the proof response from polycli:
 ![Sample Tree](./tree-diagram.png)
 
 When we're creating the proof here, we're essentially storing the paths to the
-various leafs. When we want to generate a proof, we find the appropriate sibling
+various leaves. When we want to generate a proof, we find the appropriate sibling
 node in the tree to prove that the leaf is part of the given merkle root.
diff --git a/cmd/ulxly/ulxly.go b/cmd/ulxly/ulxly.go
@@ -171,7 +171,7 @@ func DecodeGlobalIndex(globalIndex *big.Int) (bool, uint32, uint32, error) {
 	var buf [32]byte
 	gIBytes := globalIndex.FillBytes(buf[:])
 	if len(gIBytes) != lengthGlobalIndexInBytes {
-		return false, 0, 0, fmt.Errorf("invalid globaIndex length. Should be 32. Current length: %d", len(gIBytes))
+		return false, 0, 0, fmt.Errorf("invalid globalIndex length. Should be 32. Current length: %d", len(gIBytes))
 	}
 	mainnetFlag := big.NewInt(0).SetBytes([]byte{gIBytes[23]}).Uint64() == 1
 	rollupIndex := big.NewInt(0).SetBytes(gIBytes[24:28])
diff --git a/contracts/src/asm/deploy-header.easm b/contracts/src/asm/deploy-header.easm
@@ -1,6 +1,6 @@
         ;; 0x12 is the number of instructions in our runtime code
         PUSH 0x68
-        ;; this is the position of the runtime code in the paylod
+        ;; this is the position of the runtime code in the payload
         PUSH 0x0C
         ;; this is the slot where we'll store this data
         PUSH 0x00
diff --git a/doc/polycli_loadtest.md b/doc/polycli_loadtest.md
@@ -94,7 +94,7 @@ The codebase has a contract that used for load testing. It's written in Solidity
    - `$ solc LoadTester.sol --bin --abi -o . --overwrite`
 3. Run `abigen`
    - `$ abigen --abi LoadTester.abi --pkg contracts --type LoadTester --bin LoadTester.bin --out loadtester.go`
-4. Run the loadtester to enure it deploys and runs successfully
+4. Run the loadtester to ensure it deploys and runs successfully
    - `$ polycli loadtest --verbosity 700 --rpc-url http://127.0.0.1:8541`
 
 ## Flags
diff --git a/doc/polycli_ulxly_proof.md b/doc/polycli_ulxly_proof.md
@@ -88,7 +88,7 @@ This is the proof response from polycli:
 ![Sample Tree](./tree-diagram.png)
 
 When we're creating the proof here, we're essentially storing the paths to the
-various leafs. When we want to generate a proof, we find the appropriate sibling
+various leaves. When we want to generate a proof, we find the appropriate sibling
 node in the tree to prove that the leaf is part of the given merkle root.
 
 ## Full example
diff --git a/doc/polycli_ulxly_rollups-proof.md b/doc/polycli_ulxly_rollups-proof.md
@@ -82,7 +82,7 @@ This is the proof response from polycli:
 ![Sample Tree](./tree-diagram.png)
 
 When we're creating the proof here, we're essentially storing the paths to the
-various leafs. When we want to generate a proof, we find the appropriate sibling
+various leaves. When we want to generate a proof, we find the appropriate sibling
 node in the tree to prove that the leaf is part of the given merkle root.
 
 ## Flags
diff --git a/rpctypes/jsonschemas/openrpc.json b/rpctypes/jsonschemas/openrpc.json
@@ -4377,7 +4377,7 @@
 				},
 				{
 					"name": "rewardPercentiles",
-					"description": "A monotonically increasing list of percentile values. For each block in the requested range, the transactions will be sorted in ascending order by effective tip per gas and the coresponding effective tip for the percentile will be determined, accounting for gas consumed.",
+					"description": "A monotonically increasing list of percentile values. For each block in the requested range, the transactions will be sorted in ascending order by effective tip per gas and the corresponding effective tip for the percentile will be determined, accounting for gas consumed.",
 					"required": true,
 					"schema": {
 						"title": "rewardPercentiles",
diff --git a/typos.toml b/typos.toml
@@ -0,0 +1,12 @@
+[default]
+extend-ignore-re = [
+  "Selector:0.*Signature:.*", # polycli abi
+]
+
+[default.extend-words]
+AIMD = "AIMD" # accronym for Additive Increase Multiplicative Decrease
+BLOK = "BLOK" # accronym for block
+THR = "THR"   # accronym for throughput
+
+[files]
+extend-exclude = ["contracts/lib*", "hdwallet/hdwallet_test.go"]

Original file line number	Diff line number	Diff line change
`@@ -1834,7 +1834,7 @@ func loadTestBlob(ctx context.Context, c ethclient.Client, tops bind.TransactO`
`1834`	`1834`	`},`
`1835`	`1835`	`}`
`1836`	`1836`	`// appendBlobCommitment() will take in the blobTx struct and append values to blob transaction specific keys in the following steps:`
`1837`		`- // The function will take in blobTx with empty BlobHashses, and Blob Sidecar variables initially.`
	`1837`	`+ // The function will take in blobTx with empty BlobHashes, and Blob Sidecar variables initially.`
`1838`	`1838`	`// Then generateRandomBlobData() is called to generate a byte slice with random values.`
`1839`	`1839`	`// createBlob() is called to commit the randomly generated byte slice with KZG.`
`1840`	`1840`	`// generateBlobCommitment() will do the same for the Commitment and Proof.`
Original file line number	Diff line number	Diff line change
`@@ -207,14 +207,14 @@ func (wr WrappedData) ToSlice() []WrappedData {`
`207`	`207`	`if v.Len() == 0 {`
`208`	`208`	`return []*WrappedData{}`
`209`	`209`	`}`
`210`		`- wrappedDatas := make([]*WrappedData, v.Len())`
	`210`	`+ wrappedData := make([]*WrappedData, v.Len())`
`211`	`211`	`for i := 0; i < v.Len(); i = i + 1 {`
`212`	`212`	`nwd := new(WrappedData)`
`213`	`213`	`nwd.raw = v.Index(i).Interface().(EthTestData)`
`214`		`- wrappedDatas[i] = nwd`
	`214`	`+ wrappedData[i] = nwd`
`215`	`215`
`216`	`216`	`}`
`217`		`- return wrappedDatas`
	`217`	`+ return wrappedData`
`218`	`218`	`}`
`219`	`219`	`func (wn *WrappedNumeric) IsSlice() bool {`
`220`	`220`	`v := reflect.ValueOf(wn.raw)`
`@@ -229,14 +229,14 @@ func (wn WrappedNumeric) ToSlice() []WrappedNumeric {`
`229`	`229`	`if v.Len() == 0 {`
`230`	`230`	`return []*WrappedNumeric{}`
`231`	`231`	`}`
`232`		`- wrappedDatas := make([]*WrappedNumeric, v.Len())`
	`232`	`+ wrappedData := make([]*WrappedNumeric, v.Len())`
`233`	`233`	`for i := 0; i < v.Len(); i = i + 1 {`
`234`	`234`	`nwd := new(WrappedNumeric)`
`235`	`235`	`nwd.raw = v.Index(i).Interface().(EthTestData)`
`236`		`- wrappedDatas[i] = nwd`
	`236`	`+ wrappedData[i] = nwd`
`237`	`237`
`238`	`238`	`}`
`239`		`- return wrappedDatas`
	`239`	`+ return wrappedData`
`240`	`240`	`}`
`241`	`241`	`func EthTestNumericToBigInt(num EthTestNumeric) *big.Int {`
`242`	`242`	`if num == nil {`