-
Notifications
You must be signed in to change notification settings - Fork 169
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into interface-starts-with-i
- Loading branch information
Showing
15 changed files
with
471 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| warning: "This is a dynamically generated file. Do not edit manually." | ||
| layout: "default" | ||
| title: "gas-length-in-loops | Solhint" | ||
| --- | ||
|
|
||
| # gas-length-in-loops | ||
|  | ||
|  | ||
|
|
||
| ## Description | ||
| Suggest replacing object.length in a loop condition to avoid calculation on each lap | ||
|
|
||
| ## Options | ||
| This rule accepts a string option of rule severity. Must be one of "error", "warn", "off". Default to warn. | ||
|
|
||
| ### Example Config | ||
| ```json | ||
| { | ||
| "rules": { | ||
| "gas-length-in-loops": "warn" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Notes | ||
| - [source 1](https://coinsbench.com/comprehensive-guide-tips-and-tricks-for-gas-optimization-in-solidity-5380db734404) of the rule initiative (see Array Length Caching) | ||
|
|
||
| ## Examples | ||
| This rule does not have examples. | ||
|
|
||
| ## Version | ||
| This rule is introduced in the latest version. | ||
|
|
||
| ## Resources | ||
| - [Rule source](https://github.com/protofire/solhint/tree/master/lib/rules/gas-consumption/gas-length-in-loops.js) | ||
| - [Document source](https://github.com/protofire/solhint/tree/master/docs/rules/gas-consumption/gas-length-in-loops.md) | ||
| - [Test cases](https://github.com/protofire/solhint/tree/master/test/rules/gas-consumption/gas-length-in-loops.js) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| --- | ||
| warning: "This is a dynamically generated file. Do not edit manually." | ||
| layout: "default" | ||
| title: "gas-strict-inequalities | Solhint" | ||
| --- | ||
|
|
||
| # gas-strict-inequalities | ||
|  | ||
|  | ||
|
|
||
| ## Description | ||
| Suggest Strict Inequalities over non Strict ones | ||
|
|
||
| ## Options | ||
| This rule accepts a string option of rule severity. Must be one of "error", "warn", "off". Default to warn. | ||
|
|
||
| ### Example Config | ||
| ```json | ||
| { | ||
| "rules": { | ||
| "gas-strict-inequalities": "warn" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Notes | ||
| - Strict inequality does not always saves gas. It is dependent on the context of the surrounding opcodes | ||
| - [source 1](https://coinsbench.com/comprehensive-guide-tips-and-tricks-for-gas-optimization-in-solidity-5380db734404) of the rule initiative (see Less/Greater Than vs Less/Greater Than or Equal To) | ||
| - [source 2](https://www.rareskills.io/post/gas-optimization?postId=c9db474a-ff97-4fa3-a51d-fe13ccb8fe3b#viewer-7b77t) of the rule initiative | ||
|
|
||
| ## Examples | ||
| This rule does not have examples. | ||
|
|
||
| ## Version | ||
| This rule is introduced in the latest version. | ||
|
|
||
| ## Resources | ||
| - [Rule source](https://github.com/protofire/solhint/tree/master/lib/rules/gas-consumption/gas-strict-inequalities.js) | ||
| - [Document source](https://github.com/protofire/solhint/tree/master/docs/rules/gas-consumption/gas-strict-inequalities.md) | ||
| - [Test cases](https://github.com/protofire/solhint/tree/master/test/rules/gas-consumption/gas-strict-inequalities.js) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| const BaseChecker = require('../base-checker') | ||
|
|
||
| let found | ||
| const ruleId = 'gas-length-in-loops' | ||
| const meta = { | ||
| type: 'gas-consumption', | ||
|
|
||
| docs: { | ||
| description: | ||
| 'Suggest replacing object.length in a loop condition to avoid calculation on each lap', | ||
| category: 'Gas Consumption Rules', | ||
| notes: [ | ||
| { | ||
| note: '[source 1](https://coinsbench.com/comprehensive-guide-tips-and-tricks-for-gas-optimization-in-solidity-5380db734404) of the rule initiative (see Array Length Caching)', | ||
| }, | ||
| ], | ||
| }, | ||
|
|
||
| isDefault: false, | ||
| recommended: false, | ||
| defaultSetup: 'warn', | ||
|
|
||
| schema: null, | ||
| } | ||
|
|
||
| class GasLengthInLoops extends BaseChecker { | ||
| constructor(reporter) { | ||
| super(reporter, ruleId, meta) | ||
| } | ||
|
|
||
| checkConditionForMemberAccessLength(node) { | ||
| if (found) return // Return early if the condition has already been found | ||
| if (typeof node === 'object' && node !== null) { | ||
| if (node.type === 'MemberAccess' && node.memberName === 'length') { | ||
| found = true // Update the flag if the condition is met | ||
| return | ||
| } | ||
| // Recursively search through all object properties | ||
| Object.values(node).forEach((value) => this.checkConditionForMemberAccessLength(value)) | ||
| } | ||
| } | ||
|
|
||
| DoWhileStatement(node) { | ||
| found = false | ||
| this.checkConditionForMemberAccessLength(node.condition) | ||
| if (found) { | ||
| this.reportError(node) | ||
| } | ||
| } | ||
|
|
||
| WhileStatement(node) { | ||
| found = false | ||
| this.checkConditionForMemberAccessLength(node.condition) | ||
| if (found) { | ||
| this.reportError(node) | ||
| } | ||
| } | ||
|
|
||
| ForStatement(node) { | ||
| found = false | ||
| this.checkConditionForMemberAccessLength(node.conditionExpression) | ||
| if (found) { | ||
| this.reportError(node) | ||
| } | ||
| } | ||
|
|
||
| reportError(node) { | ||
| this.error( | ||
| node, | ||
| `GC: Found [ .length ] property in Loop condition. Suggestion: assign it to a variable` | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| module.exports = GasLengthInLoops |
Oops, something went wrong.