Registry / ai-ml / eslint-plugin-o1js

eslint-plugin-o1js

library0.4.0jsnpmunverified

ESLint plugin with rules for o1js (formerly SnarkyJS) Smart Contract development. Version 0.4.0 is stable, released via npm. It detects invalid patterns such as throws, if/ternary statements, use of JSON/random functions in circuits, state variable limit (max 8), and constructor overriding. Designed for TypeScript projects using o1js to build zero-knowledge smart contracts on Mina Protocol. Alternative to manual code review for o1js circuit constraints.

ai-ml testing

npm install eslint-plugin-o1js

package ↗

INSTALL

IMPORT

SIG · ESLINT-PLUGIN-O1JS

eslint-plugin-o1js

ai-mljavascriptv0.4.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

plugin

✓ import plugin from 'eslint-plugin-o1js'

✗ const plugin = require('eslint-plugin-o1js')

ESM-only; use dynamic import if using CommonJS.

rules

✓ import { rules } from 'eslint-plugin-o1js'

Named export for accessing individual rule definitions.

configs

✓ import { configs } from 'eslint-plugin-o1js'

Use configs.recommended in extends array.

Shows how to configure ESLint with o1js plugin and demonstrates rule violations for excessive state variables, if statements, and throw in circuits.

// .eslintrc.cjs module.exports = { parser: '@typescript-eslint/parser', plugins: ['o1js'], extends: ['plugin:o1js/recommended'], }; // Example smart contract that violates rules import { SmartContract, state, State, method } from 'o1js'; export class MyContract extends SmartContract { @state({ type: Field }) privateField = State<Field>(); @state({ type: Field }) privateField2 = State<Field>(); @state({ type: Field }) privateField3 = State<Field>(); @state({ type: Field }) privateField4 = State<Field>(); @state({ type: Field }) privateField5 = State<Field>(); @state({ type: Field }) privateField6 = State<Field>(); @state({ type: Field }) privateField7 = State<Field>(); @state({ type: Field }) privateField8 = State<Field>(); @state({ type: Field }) privateField9 = State<Field>(); // error: too many state variables @method init() { super.init(); if (this.someCondition) { // error: if statement in circuit throw new Error('fail'); // error: throw in circuit } } }

Debug

Known issues

gotchaPlugin only works with TypeScript projects using @typescript-eslint/parser. Plain JavaScript is not supported.

fix

Ensure your ESLint config uses parser: '@typescript-eslint/parser' and enable TypeScript parsing.

affects: >=0.1.0

breakingPlugin enforces that SmartContract constructor cannot be overridden. This may break existing code that defines custom constructors.

fix

Move constructor logic to a @method or use a deployment pattern that does not override the constructor.

affects: >=0.4.0

deprecatedIn future versions, rules may be renamed or removed. The 'recommended' config is the stable path forward.

fix

Use 'plugin:o1js/recommended' and avoid referencing individual rules by name unless necessary.

affects: >=0.4.0

gotchaState variable limit rule checks only the number of @state decorated properties. Non-decorated properties are not counted but may still cause issues.

fix

Manually verify that total internal state objects do not exceed 8, including those without @state decorator.

affects: >=0.1.0

gotchaESLint plugin does not detect dynamic method calls (e.g., this['someMethod']()) in circuits; only static analysis is performed.

fix

Avoid using computed property names or dynamic method calls in circuit methods.

affects: >=0.1.0

Errors

Common errors & fixes

Failed to load plugin 'o1js': Cannot find module 'eslint-plugin-o1js'

Plugin not installed or missing from node_modules.

fix

Run 'npm install eslint-plugin-o1js --save-dev' or the equivalent for your package manager.

Parsing error: The keyword 'const' is reserved

ESLint is not configured to parse TypeScript.

fix

Install '@typescript-eslint/parser' and set 'parser: '@typescript-eslint/parser'' in your ESLint config.

Definition for rule 'o1js/no-throw-in-circuit' was not found

Rule name is incorrect or plugin not loaded properly.

fix

Ensure plugin is listed in 'plugins: ["o1js"]' and rule name matches one of the available rules (e.g., 'o1js/no-throw-in-circuit').

Upgrade

Version history

0.4.0latest on npm

Audit

Dependencies

@typescript-eslint/parserrequiredRequired to parse TypeScript smart contract code

eslintrequiredPeer dependency for plugin functionality

Agent activity

11 hits · last 30 days

node

OpenAI (training)

Resources

packagehttps://www.npmjs.com/package/eslint-plugin-o1js ↗