o1-labs/eslint-plugin-o1js

ESLint rules for o1js

eslint-plugin-o1js

o1js rules for ESLint to detect bugs and invalid patterns in your Smart Contract code.

Rules

• The maximum allowed state variables in a Smart Contract is 8
• Throw statements should not be used in a Circuit method
• If statements should not be used in a Circuit method
• Ternary statements should not be used in a Circuit method
• JavaScript JSON functions should not be used in a Circuit method
• JavaScript random functions should not be used in a Circuit method
• Overriding the constructor in a SmartContract is disallowed

Installation

# npm
npm install eslint-plugin-o1js --save-dev

# yarn
yarn add eslint-plugin-o1js --dev

Add eslint-plugin-o1js to the plugins option in your eslint config:

{
  "plugins": ["o1js"]
}

• Then extend the recommended eslint config:

{
  extends: ['plugin:o1js/recommended'],
}

• You can enable specific rules manually:

{
  "rules": {
    "o1js/no-greater-storage-limit-in-circuit": "error",
    "o1js/no-throw-in-circuit": "error"
    ...
  }
}

• An example ESLint configuration looks like:

module.exports = {
  parser: '@typescript-eslint/parser',
  plugins: ['o1js'],
  extends: ['plugin:o1js/recommended'],
};

Valid and Invalid Examples

Please refer to the project tests to learn more about the usage of the rules.

eslint-plugin-o1js's Issues

"snarkyjs/no-greater-storage-limit-in-circuit" crashes

Crash experienced here: https://github.com/jackryanservia/mastermind
on this version of the source file: https://github.com/jackryanservia/mastermind/blob/2fdf3f6b7f8f09edf29a2c87c7f464c59782d629/src/Mastermind-recursive.ts

Oops! Something went wrong! :(

ESLint: 8.7.0

TypeError: Cannot read properties of undefined (reading 'size')
Occurred while linting /home/gregor/o1/mastermind/src/Mastermind-recursive.ts:37
Rule: "snarkyjs/no-greater-storage-limit-in-circuit"
    at Object.enter (/home/gregor/o1/mastermind/node_modules/eslint-plugin-snarkyjs/build/src/rules/no-greater-storage-limit-in-circuit.js:110:91)
    at SimpleTraverser.traverse (/home/gregor/o1/mastermind/node_modules/@typescript-eslint/typescript-estree/dist/simple-traverse.js:28:28)
    at SimpleTraverser.traverse (/home/gregor/o1/mastermind/node_modules/@typescript-eslint/typescript-estree/dist/simple-traverse.js:41:26)
    at SimpleTraverser.traverse (/home/gregor/o1/mastermind/node_modules/@typescript-eslint/typescript-estree/dist/simple-traverse.js:45:22)
    at simpleTraverse (/home/gregor/o1/mastermind/node_modules/@typescript-eslint/typescript-estree/dist/simple-traverse.js:51:53)
    at ClassDeclaration:has(Identifier[name="CircuitValue"]) (/home/gregor/o1/mastermind/node_modules/eslint-plugin-snarkyjs/build/src/rules/no-greater-storage-limit-in-circuit.js:101:56)
    at ruleErrorHandler (/home/gregor/o1/mastermind/node_modules/eslint/lib/linter/linter.js:1079:28)
    at /home/gregor/o1/mastermind/node_modules/eslint/lib/linter/safe-emitter.js:45:58
    at Array.forEach (<anonymous>)
    at Object.emit (/home/gregor/o1/mastermind/node_modules/eslint/lib/linter/safe-emitter.js:45:38)
husky - pre-commit hook exited with code 1 (error)

Suggestion - add a rule to detect type mismatches

for example:

@arrayProp(Field, 10) scopes: CircuitString[];

should fail the linter on type mismatch

[BUG] - no-greater-storage-limit-in-circuit rule does not count state for transitive CircuitValues

Description
When users define @state in a Smart Contract that is defined on a CircuitValue and that CircuitValue that is defined in another CircuitValue, the state counting algorithm does not work.
A -> B -> C

Minimal code to reproduce

class C extends CircuitValue {
    @prop prop1: Field;
    @prop prop2: Field;

}
class B extends CircuitValue {
    @arrayProp(C, 1) values: C[];
}
class A extends SmartContract {
    @state(B) state1: State<B>;
}

using CircuitString crashes the linter

I'm positive it's because it's missing from the types..
https://github.com/o1-labs/eslint-plugin-snarkyjs/blob/main/src/types.ts