Skip to content

Commit 2fe30bb

Browse files
committed
chore: fix some comments to improve readability
Signed-off-by: stringscut <stringscut@outlook.jp>
1 parent c335c85 commit 2fe30bb

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

cmd/ethkit/block.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ func init() {
3333
type block struct {
3434
}
3535

36-
// NewBlockCommand returns a new build command to retrieve a block.
36+
// NewBlockCmd returns a new build command to retrieve a block.
3737
func NewBlockCmd() *cobra.Command {
3838
c := &block{}
3939
cmd := &cobra.Command{

ethcoder/abi_helpers.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ func ABIMarshalStringValues(argTypes []string, input []byte) ([]string, error) {
9898
return StringifyValues(values)
9999
}
100100

101-
// AbiUnmarshalStringValuesAny will take an array of ethereum types as string values, and decode
101+
// ABIUnmarshalStringValuesAny will take an array of ethereum types as string values, and decode
102102
// the string values to runtime objects. This allows simple string value input from an app
103103
// or user, and converts them to the appropriate runtime objects.
104104
//
@@ -563,7 +563,7 @@ func ABIUnmarshalStringValuesAny(argTypes []string, stringValues []any) ([]any,
563563
return values, nil
564564
}
565565

566-
// AbiUnmarshalStringValues will take an array of ethereum types as string values, and decode
566+
// ABIUnmarshalStringValues will take an array of ethereum types as string values, and decode
567567
// the string values to runtime objects. This allows simple string value input from an app
568568
// or user, and converts them to the appropriate runtime objects.
569569
//

ethcoder/abi_sig_parser.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ type abiSignatureTree struct {
8282
right []abiSignatureTree
8383
}
8484

85-
// parseEventArgs parses the event arguments and returns a tree structure
86-
// ie. "address indexed from, address indexed to, uint256 value".
85+
// parseABISignatureArgs parses the event arguments and returns a tree structure
86+
// e.g. "address indexed from, address indexed to, uint256 value".
8787
func parseABISignatureArgs(eventArgs string, iteration int) (abiSignatureTree, error) {
8888
args := strings.TrimSpace(eventArgs)
8989
// if iteration == 0 {

ethmonitor/ethmonitor.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1133,8 +1133,8 @@ func (m *Monitor) GetBlock(blockHash common.Hash) *Block {
11331133
return m.chain.GetBlock(blockHash)
11341134
}
11351135

1136-
// GetBlock will search within the retained canonical chain for the txn hash. Passing `optMined true`
1137-
// will only return transaction which have not been removed from the chain via a reorg.
1136+
// GetTransaction will search within the retained canonical chain for the given transaction hash
1137+
// and will only return transactions which have not been removed from the chain via a reorg.
11381138
func (m *Monitor) GetTransaction(txnHash common.Hash) (*types.Transaction, Event) {
11391139
return m.chain.GetTransaction(txnHash)
11401140
}

0 commit comments

Comments
 (0)