Add no-commented-out-code

.eslintrc

@@ -1,7 +1,7 @@
 {
   "extends": ["airbnb-base", "airbnb-typescript/base", "plugin:prettier/recommended", "plugin:eslint-comments/recommended", "plugin:sonarjs/recommended"],
   "parser": "@typescript-eslint/parser",
-  "plugins": ["@typescript-eslint", "sonarjs"],
+  "plugins": ["@typescript-eslint", "sonarjs", "etc"],
   "root": true,
   "parserOptions": {
     "project": ["./tsconfig.json", "./test/tsconfig.json"]
@@ -91,7 +91,8 @@
     "sonarjs/no-duplicate-string": "off",
     // Handled by prettier
     "@typescript-eslint/indent": ["off"],
-    "@typescript-eslint/no-floating-promises": "error"
+    "@typescript-eslint/no-floating-promises": "error",
+    "etc/no-commented-out-code": "error"
   },
 
   "overrides": [

package.json

@@ -33,7 +33,7 @@
     "eslint-config-airbnb-typescript": "^18.0.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-etc": "^2.0.2",
+    "eslint-plugin-etc": "^2.0.3",
     "eslint-plugin-import": "^2.25.2",
     "eslint-plugin-prettier": "^5.1.3",
     "eslint-plugin-sonarjs": "^0.25.1",

packages/common/src/utils.ts

@@ -91,11 +91,6 @@ export interface ToJSONableStatic {
   toJSON: (value: unknown) => any;
 }
 
-// export interface ProofTypes {
-//   publicOutputType?: ToFieldableStatic;
-//   publicInputType?: ToFieldableStatic;
-// }
-
 export type ProofTypes =
   | typeof Proof<unknown, unknown>
   | typeof DynamicProof<unknown, unknown>;

packages/library/src/hooks/RuntimeFeeAnalyzerService.ts

@@ -95,7 +95,6 @@ export class RuntimeFeeAnalyzerService extends ConfigurableModule<RuntimeFeeAnal
             // eslint-disable-next-line @typescript-eslint/no-shadow
             ([values, indexes], combinedMethodName) => {
               const { rows } = analyzedMethods[combinedMethodName];
-              // const rows = 1000;
               const [moduleName, methodName] = combinedMethodName.split(".");
               const methodId = this.runtime.methodIdResolver.getMethodId(
                 moduleName,

packages/library/src/math/UInt.ts

@@ -47,7 +47,6 @@ export abstract class UInt<BITS extends number> extends Struct({
 }) {
   public static readonly assertionFunction: (bool: Bool, msg?: string) => void =
     (bool, msg) => {
-      // const executionContext = container.resolve(RuntimeMethodExecutionContext);
       assert(bool, msg);
     };
 
@@ -82,8 +81,6 @@ export abstract class UInt<BITS extends number> extends Struct({
     if (bits === 256) {
       throw errors.usageWith256BitsForbidden();
     }
-
-    // this.checkConstant(value.value);
   }
 
   public abstract numBits(): BITS;

packages/library/src/sequencer/InMemorySequencerModules.ts

@@ -43,7 +43,6 @@ export class InMemorySequencerModules {
       BlockProducerModule,
       BlockTrigger: ManualBlockTrigger,
       TaskQueue: LocalTaskQueue,
-      // SettlementModule: SettlementModule,
       ...additionalModules,
     } satisfies InMemorySequencerModulesRecord;
   }

packages/processor/test/HandlersExecutor.test.ts

@@ -136,7 +136,6 @@ describe("HandlersModule", () => {
       onBlock: [trackBalanceOnBlockHandler],
     };
 
-    // const client = createPrismaMock<PrismaClient>();
     const client = mockDeep<PrismaClient>();
     // @ts-expect-error
     client.$transaction.mockImplementation((transaction) => {

packages/protocol/src/prover/block/BlockProver.ts

@@ -556,11 +556,6 @@ export class BlockProverProgrammable extends ZkProgrammable<
     // TODO Not possible atm bcs we can't have a seperation between protocol/runtime state roots,
     // which we would for both before and after to be able to emit STs
 
-    // stateTransitionProof.publicInput.protocolTransitionsHash.assertEquals(
-    //   beforeBlockHashList.commitment
-    // );
-    // state.stateRoot = stateTransitionProof.publicInput.protocolStateRoot;
-
     // TODO Only for now
     beforeBlockHashList.commitment.assertEquals(
       Field(0),

packages/protocol/test/StateTransition.test.ts

@@ -1,3 +1,5 @@
+/* eslint etc/no-commented-out-code:
+ */
 import "reflect-metadata";
 import { InMemoryMerkleTreeStorage } from "@proto-kit/common";
 import { Bool, Field } from "o1js";

packages/sdk/src/appChain/AppChain.ts

@@ -319,19 +319,8 @@ export class AppChain<
     this.resolve("Protocol");
     this.resolve("Sequencer");
 
-    // // Workaround to get protocol and sequencer to have
-    // // access to the same WitnessProviderReference
-    // const reference = new StateTransitionWitnessProviderReference();
-    // this.registerValue({
-    //   StateTransitionWitnessProviderReference: reference,
-    // });
-
-    // console.log("creating sequencer");
-    // this.sequencer.create(() => this.container);
-
     await this.protocol.start();
 
-    // this.runtime.start();
     await this.sequencer.start();
   }
 }

packages/sdk/test/minting-error.test.ts

@@ -62,7 +62,6 @@ describe("balances", () => {
   });
 
   it("regression - transfer from and to same account does not cause minting error", async () => {
-    // expect.assertions(2);
     const faucet = appChain.runtime.resolve("Faucet");
     const balancesRuntime = appChain.runtime.resolve("Balances");
 

packages/sdk/test/networkstate/NetworkState.test.ts

@@ -45,8 +45,6 @@ describe.skip("block production", () => {
   const tokenId = TokenId.from(0);
 
   beforeEach(async () => {
-    // container.reset();
-
     log.setLevel(log.levels.INFO);
 
     const app = TestingAppChain.fromRuntime({

packages/sequencer/src/index.ts

@@ -9,7 +9,6 @@ export * from "./sequencer/builder/SequencerModule";
 export * from "./worker/flow/Flow";
 export * from "./worker/flow/Task";
 export * from "./worker/flow/JSONTaskSerializer";
-// export * from "./worker/queue/BullQueue";
 export * from "./worker/queue/TaskQueue";
 export * from "./worker/queue/LocalTaskQueue";
 export * from "./worker/worker/FlowTaskWorker";

packages/sequencer/src/protocol/production/TransactionTraceService.ts

@@ -276,7 +276,6 @@ export class TransactionTraceService {
 
     const tree = new RollupMerkleTree(merkleStore);
     const runtimeTree = new RollupMerkleTree(runtimeSimulationMerkleStore);
-    // const runtimeTree = new RollupMerkleTree(merkleStore);
     const initialRoot = tree.getRoot();
 
     const transitionsList = new DefaultProvableHashList(

packages/sequencer/src/settlement/transactions/MinaSimulationService.ts

@@ -55,8 +55,6 @@ export class MinaSimulationService {
       .with({ error: undefined }, (v) => v.account)
       .exhaustive();
 
-    // this.ledger.addAccount(Ml.fromPublicKey(publicKey));
-
     if (account !== undefined) {
       addCachedAccount(account);
     }

packages/sequencer/test/TestingSequencer.ts

@@ -46,7 +46,6 @@ export function testingSequencerFromModules<
     Database: InMemoryDatabase,
     Mempool: PrivateMempool,
     BaseLayer: NoopBaseLayer,
-    // LocalTaskWorkerModule: taskWorkerModule,
     BatchProducerModule,
     BlockProducerModule,
     BlockTrigger: ManualBlockTrigger,

packages/sequencer/test/integration/BlockProduction.test.ts

@@ -84,17 +84,13 @@ describe("block production", () => {
       ProtocolStateTestHook: typeof ProtocolStateTestHook;
     }
   >;
-  // let protocol: Protocol<VanillaProtocolModulesRecord>;
-
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   let appChain: AppChain<any, any, any, any>;
 
   let blockTrigger: ManualBlockTrigger;
   let mempool: PrivateMempool;
 
   beforeEach(async () => {
-    // container.reset();
-
     log.setLevel(log.levels.INFO);
 
     const runtimeClass = Runtime.from({
@@ -118,7 +114,6 @@ describe("block production", () => {
       modules: VanillaProtocolModules.mandatoryModules({
         ProtocolStateTestHook,
       }),
-      // modules: VanillaProtocolModules.with({}),
     });
 
     const app = AppChain.from({
@@ -185,7 +180,6 @@ describe("block production", () => {
       })
     );
 
-    // let [block, batch] = await blockTrigger.produceBlockAndBatch();
     let block = await blockTrigger.produceBlock();
 
     expect(block).toBeDefined();

packages/sequencer/test/integration/StorageIntegration.test.ts

@@ -65,9 +65,6 @@ describe.each([["InMemory", InMemoryDatabase]])(
     let unprovenState: AsyncStateService;
     let provenState: AsyncStateService;
 
-    // let unprovenTreeStore: AsyncMerkleTreeStore;
-    // let provenTreeStore: AsyncMerkleTreeStore;
-
     const sk = PrivateKey.random();
     const pk = sk.toPublicKey();
     let pkNonce = 0;

packages/sequencer/test/integration/mocks/Balance.ts

@@ -36,9 +36,6 @@ export class Balance extends RuntimeModule<object> {
     await this.totalSupply.get();
   }
 
-  // @runtimeMethod()
-  // public test(a: UInt64, b: Signature, c: MyStruct, d: Struct<unknown>) {}
-
   @runtimeMethod()
   public async setTotalSupply() {
     await this.totalSupply.set(UInt64.from(20));

packages/sequencer/test/settlement/Settlement-unit.test.ts

@@ -1,4 +1,7 @@
 import { expect } from "@jest/globals";
+/* eslint etc/no-commented-out-code:
+ */
+
 // import { Actions } from "o1js/dist/node/lib/account_update";
 // import {
 //   ACTIONS_EMPTY_HASH,

packages/sequencer/test/settlement/Settlement.ts

@@ -241,8 +241,6 @@ export const settlementTestFn = (
         sequencerKey.toPublicKey(),
         20 * 1e9
       );
-
-      // const acc2 = await fetchAccount({ publicKey: accs[0].toPublicKey() });
     }, timeout);
 
     let nonceCounter = 0;
@@ -399,7 +397,6 @@ export const settlementTestFn = (
           }
         );
         settlementModule.signTransaction(usertx, [testAccounts[1]]);
-        // await usertx.send();
 
         await appChain.sequencer
           .resolveOrFail("TransactionSender", MinaTransactionSender)
@@ -475,7 +472,6 @@ export const settlementTestFn = (
           async () => {
             const mintAU = AccountUpdate.create(userKey.toPublicKey());
             mintAU.balance.addInPlace(amount);
-            // mintAU.requireSignature(); // TODO ?
             await settlement.redeem(mintAU);
           }
         );

packages/sequencer/test/worker/Worker.test.ts

@@ -1,3 +1,6 @@
+/* eslint etc/no-commented-out-code:
+ */
+
 import "reflect-metadata";
 
 import { beforeAll } from "@jest/globals";

packages/stack/src/scripts/graphql/server.ts

@@ -53,7 +53,6 @@ export class TestBalances extends Balances {
    * We use `satisfies` here in order to be able to access
    * presets by key in a type safe way.
    */
-  // public static presets = {} satisfies Presets<object>;
 
   @state() public totalSupply = State.from<UInt64>(UInt64);
 
@@ -101,7 +100,6 @@ export async function startServer() {
     Sequencer: Sequencer.from({
       modules: {
         Database: InMemoryDatabase,
-        // Database: PrismaRedisDatabase,
 
         Mempool: PrivateMempool,
         GraphqlServer,
@@ -113,7 +111,6 @@ export async function startServer() {
         BlockProducerModule,
         BlockTrigger: ManualBlockTrigger,
         TaskQueue: LocalTaskQueue,
-        // SettlementModule: SettlementModule,
 
         Graphql: GraphqlSequencerModule.from({
           modules: {
@@ -171,10 +168,6 @@ export async function startServer() {
         host: "0.0.0.0",
         graphiql: true,
       },
-      // SettlementModule: {
-      //   address: PrivateKey.random().toPublicKey(),
-      //   feepayer: PrivateKey.random(),
-      // },
 
       Graphql: {
         QueryGraphqlModule: {},
@@ -185,30 +178,12 @@ export async function startServer() {
         MerkleWitnessResolver: {},
       },
 
-      Database: {
-        // redis: {
-        //   host: "localhost",
-        //   port: 6379,
-        //   password: "password",
-        // },
-        // prisma: {
-        //   connection: {
-        //     host: "localhost",
-        //     password: "password",
-        //     username: "user",
-        //     port: 5432,
-        //     db: {
-        //       name: "protokit",
-        //     },
-        //   },
-        // },
-      },
+      Database: {},
 
       Mempool: {},
       BatchProducerModule: {},
       LocalTaskWorkerModule: {
         StateTransitionTask: {},
-        // SettlementProvingTask: {},
         BlockBuildingTask: {},
         BlockProvingTask: {},
         BlockReductionTask: {},
@@ -237,9 +212,6 @@ export async function startServer() {
   });
 
   await appChain.start(container.createChildContainer());
-  // const pk = PublicKey.fromBase58(
-  //   "B62qmETai5Y8vvrmWSU8F4NX7pTyPqYLMhc1pgX3wD8dGc2wbCWUcqP"
-  // );
 
   const balances = appChain.runtime.resolve("Balances");
 

packages/stack/src/scripts/worker/sequencer.ts

@@ -59,7 +59,6 @@ sequencer.configure({
     },
     TaskQueue: {
       redis: {
-        // host: "protokit-redis",
         host: "localhost",
         port: 6379,
         password: "password",

packages/stack/src/start.ts

@@ -1,4 +1,6 @@
 // TODO: ressurrect during lightnet integration
+/* eslint etc/no-commented-out-code:
+ */
 // import {
 //   Environments,
 //   Environment,