feat(plugins): implement unchecked return value detection plugin (#16)

packages/scanner-core/package.json

@@ -20,6 +20,7 @@
   },
   "dependencies": {
     "@veridion/logger": "workspace:*",
+    "@veridion/plugin-unchecked-return": "workspace:*",
     "@veridion/scanner-types": "workspace:*",
     "@veridion/shared": "workspace:*"
   },

packages/scanner-core/src/plugin-registry.test.ts

@@ -2,7 +2,8 @@ import type { IRulePlugin, PluginMetadata } from '@veridion/scanner-types';
 import { FindingSeverity } from '@veridion/shared';
 import { beforeEach, describe, expect, it } from 'vitest';
 
-import { PluginRegistry } from './plugin-registry';
+import { createDefaultRegistry, PluginRegistry } from './plugin-registry';
+import { Scanner } from './scanner';
 
 function createMockPlugin(
   id: string,
@@ -67,8 +68,7 @@ describe('PluginRegistry', () => {
     });
 
     expect(matching).toHaveLength(1);
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    expect(matching[0]!.metadata.id).toBe('eth');
+    expect(matching[0]?.metadata.id).toBe('eth');
   });
 
   it('should unregister a plugin', () => {
@@ -85,3 +85,43 @@ describe('PluginRegistry', () => {
     expect(allMeta).toHaveLength(2);
   });
 });
+
+describe('createDefaultRegistry', () => {
+  it('should register unchecked-return plugin by default', () => {
+    const registry = createDefaultRegistry();
+    expect(registry.size).toBe(1);
+    const plugin = registry.get('unchecked-return');
+    expect(plugin).toBeDefined();
+    expect(plugin?.metadata.id).toBe('unchecked-return');
+    expect(plugin?.metadata.category).toBe('UNCHECKED_RETURN');
+    expect(plugin?.metadata.severity).toBe(FindingSeverity.HIGH);
+  });
+
+  it('should list unchecked-return in all metadata', () => {
+    const registry = createDefaultRegistry();
+    const ids = registry.getAllMetadata().map((m) => m.id);
+    expect(ids).toContain('unchecked-return');
+  });
+
+  it('should execute end-to-end scan through Scanner', async () => {
+    const registry = createDefaultRegistry();
+    const scanner = new Scanner(registry);
+    const result = await scanner.scan({
+      contractName: 'TestVault',
+      sourceCode: `
+contract TestVault {
+    function withdraw(address payable recipient) public {
+        recipient.call("");
+    }
+}`,
+      chain: 'ethereum',
+      language: 'solidity',
+      compilerVersion: '0.8.20',
+      metadata: {},
+    });
+
+    expect(result.findings).toHaveLength(1);
+    expect(result.findings[0]?.pluginId).toBe('unchecked-return');
+    expect(result.findings[0]?.lineStart).toBe(4);
+  });
+});

packages/scanner-core/src/plugin-registry.ts

@@ -1,6 +1,9 @@
 import { logger } from '@veridion/logger';
+import { UncheckedReturnPlugin } from '@veridion/plugin-unchecked-return';
 import type { AnalysisContext, IRulePlugin, PluginMetadata } from '@veridion/scanner-types';
 
+export const defaultPlugins: IRulePlugin[] = [new UncheckedReturnPlugin()];
+
 export class PluginRegistry {
   private plugins = new Map<string, IRulePlugin>();
 
@@ -21,6 +24,10 @@ export class PluginRegistry {
     }
   }
 
+  registerDefaultPlugins(): void {
+    this.registerAll(defaultPlugins);
+  }
+
   unregister(pluginId: string): boolean {
     return this.plugins.delete(pluginId);
   }
@@ -70,3 +77,9 @@ export class PluginRegistry {
     return this.plugins.size;
   }
 }
+
+export function createDefaultRegistry(): PluginRegistry {
+  const registry = new PluginRegistry();
+  registry.registerDefaultPlugins();
+  return registry;
+}

plugins/unchecked-return/.eslintrc.js

@@ -0,0 +1,4 @@
+const { createConfig } = require('@veridion/eslint-config/base');
+
+/** @type {import('eslint').Linter.Config} */
+module.exports = createConfig(__dirname);

plugins/unchecked-return/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@veridion/plugin-unchecked-return",
+  "version": "0.1.0",
+  "private": true,
+  "description": "Unchecked return value detection plugin for Veridion scanner",
+  "main": "./src/index.ts",
+  "types": "./src/index.ts",
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src/ --max-warnings 0",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "clean": "rm -rf dist"
+  },
+  "dependencies": {
+    "@veridion/logger": "workspace:*",
+    "@veridion/scanner-types": "workspace:*",
+    "@veridion/shared": "workspace:*"
+  },
+  "devDependencies": {
+    "@veridion/eslint-config": "workspace:*",
+    "@veridion/tsconfig": "workspace:*",
+    "eslint": "^8.57.0",
+    "typescript": "^5.4.5",
+    "vitest": "^1.6.0"
+  }
+}