siphon-library 1.0.0

package/out/code_reference.d.ts

@@ -0,0 +1,11 @@
+interface CodeReference {
+    fileName: string;
+    contractName: string;
+    functionName: string;
+    lines?: {
+        start: number;
+        end: number;
+    };
+}
+declare function createCodeReference(code: string, fileName: string, contractName: string, functionName: string): CodeReference;
+export { createCodeReference, CodeReference };

package/out/code_reference.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCodeReference = createCodeReference;
+function createCodeReference(code, fileName, contractName, functionName) {
+    const linesArray = code.split("\n");
+    let contractLine = -1;
+    for (let i = 0; i < linesArray.length; i++) {
+        if (linesArray[i].includes(`contract ${contractName}`)) {
+            contractLine = i + 1;
+            break;
+        }
+    }
+    if (contractLine === -1) {
+        console.log(`Contract "${contractName}" not found in the code.`);
+        return { fileName, contractName, functionName };
+    }
+    let functionStartLine = -1;
+    let functionEndLine = -1;
+    for (let i = contractLine; i < linesArray.length; i++) {
+        if (linesArray[i].includes(`function ${functionName}(`)) {
+            functionStartLine = i + 1;
+            let openBraces = 0;
+            let foundOpening = false;
+            for (let j = i; j < linesArray.length; j++) {
+                const line = linesArray[j];
+                for (const char of line) {
+                    if (char === "{") {
+                        openBraces++;
+                        foundOpening = true;
+                    }
+                    else if (char === "}") {
+                        openBraces--;
+                    }
+                }
+                if (foundOpening && openBraces === 0) {
+                    functionEndLine = j + 1;
+                    break;
+                }
+            }
+            break;
+        }
+    }
+    const codeReference = {
+        fileName,
+        contractName,
+        functionName,
+    };
+    if (functionEndLine !== -1) {
+        codeReference.lines = {
+            start: functionStartLine,
+            end: functionEndLine,
+        };
+    }
+    return codeReference;
+}
+//# sourceMappingURL=code_reference.js.map

package/out/code_reference.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"code_reference.js","sourceRoot":"","sources":["../src/code_reference.ts"],"names":[],"mappings":";;AA2ES,kDAAmB;AAjE5B,SAAS,mBAAmB,CAC1B,IAAY,EACZ,QAAgB,EAChB,YAAoB,EACpB,YAAoB;IAEpB,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAEpC,IAAI,YAAY,GAAG,CAAC,CAAC,CAAC;IACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3C,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,YAAY,EAAE,CAAC,EAAE,CAAC;YACvD,YAAY,GAAG,CAAC,GAAG,CAAC,CAAC;YACrB,MAAM;QACR,CAAC;IACH,CAAC;IAED,IAAI,YAAY,KAAK,CAAC,CAAC,EAAE,CAAC;QACxB,OAAO,CAAC,GAAG,CAAC,aAAa,YAAY,0BAA0B,CAAC,CAAC;QACjE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,iBAAiB,GAAG,CAAC,CAAC,CAAC;IAC3B,IAAI,eAAe,GAAG,CAAC,CAAC,CAAC;IAEzB,KAAK,IAAI,CAAC,GAAG,YAAY,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtD,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,YAAY,GAAG,CAAC,EAAE,CAAC;YACxD,iBAAiB,GAAG,CAAC,GAAG,CAAC,CAAC;YAC1B,IAAI,UAAU,GAAG,CAAC,CAAC;YACnB,IAAI,YAAY,GAAG,KAAK,CAAC;YACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC3C,MAAM,IAAI,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;gBAE3B,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;oBACxB,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;wBACjB,UAAU,EAAE,CAAC;wBACb,YAAY,GAAG,IAAI,CAAC;oBACtB,CAAC;yBAAM,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;wBACxB,UAAU,EAAE,CAAC;oBACf,CAAC;gBACH,CAAC;gBAED,IAAI,YAAY,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;oBACrC,eAAe,GAAG,CAAC,GAAG,CAAC,CAAC;oBACxB,MAAM;gBACR,CAAC;YACH,CAAC;YACD,MAAM;QACR,CAAC;IACH,CAAC;IAED,MAAM,aAAa,GAAkB;QACnC,QAAQ;QACR,YAAY;QACZ,YAAY;KACb,CAAC;IAEF,IAAI,eAAe,KAAK,CAAC,CAAC,EAAE,CAAC;QAC3B,aAAa,CAAC,KAAK,GAAG;YACpB,KAAK,EAAE,iBAAiB;YACxB,GAAG,EAAE,eAAe;SACrB,CAAC;IACJ,CAAC;IACD,OAAO,aAAa,CAAC;AACvB,CAAC"}

package/out/pattern.d.ts

@@ -0,0 +1,17 @@
+export declare enum PatternType {
+    RedundantCode = "REDUNDANT_CODE",
+    OpaquePredicates = "OPAQUE_PREDICATES",
+    ExpensiveOperationsInsideLoop = "EXPENSIVE_OPERATIONS_INSIDE_LOOP",
+    LoopInvariantOperations = "LOOP_INVARIANT_OPERATIONS",
+    LoopInvariantConditions = "LOOP_INVARIANT_CONDITIONS"
+}
+export type Severity = "low" | "medium" | "high" | "critical";
+export interface PatternInfo {
+    name: string;
+    description: string;
+    severity: Severity;
+}
+export declare const PatternDefinitions: Record<PatternType, PatternInfo>;
+export interface DetectedPattern extends PatternInfo {
+    type: PatternType;
+}

package/out/pattern.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PatternDefinitions = exports.PatternType = void 0;
+// Define an enum for pattern types.
+var PatternType;
+(function (PatternType) {
+    PatternType["RedundantCode"] = "REDUNDANT_CODE";
+    PatternType["OpaquePredicates"] = "OPAQUE_PREDICATES";
+    PatternType["ExpensiveOperationsInsideLoop"] = "EXPENSIVE_OPERATIONS_INSIDE_LOOP";
+    PatternType["LoopInvariantOperations"] = "LOOP_INVARIANT_OPERATIONS";
+    PatternType["LoopInvariantConditions"] = "LOOP_INVARIANT_CONDITIONS";
+})(PatternType || (exports.PatternType = PatternType = {}));
+// This constant maps each PatternType to its corresponding info.
+exports.PatternDefinitions = {
+    [PatternType.RedundantCode]: {
+        name: "Redundant Code",
+        description: "Identifies unreachable code branches that can be eliminated to reduce bytecode size.",
+        severity: "low",
+    },
+    [PatternType.OpaquePredicates]: {
+        name: "Opaque Predicates",
+        description: "Detects conditions that always evaluate to the same value regardless of input.",
+        severity: "low",
+    },
+    [PatternType.ExpensiveOperationsInsideLoop]: {
+        name: "Expensive Operations Inside Loop",
+        description: "Flags high-cost operations (e.g., storage accesses) performed inside loops.",
+        severity: "high",
+    },
+    [PatternType.LoopInvariantOperations]: {
+        name: "Loop Invariant Operations",
+        description: "Identifies operations inside loops that yield the same result on every iteration.",
+        severity: "medium",
+    },
+    [PatternType.LoopInvariantConditions]: {
+        name: "Loop Invariant Conditions",
+        description: "Recognizes condition checks in loops that remain constant across iterations.",
+        severity: "medium",
+    },
+};
+//# sourceMappingURL=pattern.js.map

package/out/pattern.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pattern.js","sourceRoot":"","sources":["../src/pattern.ts"],"names":[],"mappings":";;;AAAA,oCAAoC;AACpC,IAAY,WAMX;AAND,WAAY,WAAW;IACrB,+CAAgC,CAAA;IAChC,qDAAsC,CAAA;IACtC,iFAAkE,CAAA;IAClE,oEAAqD,CAAA;IACrD,oEAAqD,CAAA;AACvD,CAAC,EANW,WAAW,2BAAX,WAAW,QAMtB;AAYD,iEAAiE;AACpD,QAAA,kBAAkB,GAAqC;IAClE,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE;QAC3B,IAAI,EAAE,gBAAgB;QACtB,WAAW,EACT,sFAAsF;QACxF,QAAQ,EAAE,KAAK;KAChB;IACD,CAAC,WAAW,CAAC,gBAAgB,CAAC,EAAE;QAC9B,IAAI,EAAE,mBAAmB;QACzB,WAAW,EACT,gFAAgF;QAClF,QAAQ,EAAE,KAAK;KAChB;IACD,CAAC,WAAW,CAAC,6BAA6B,CAAC,EAAE;QAC3C,IAAI,EAAE,kCAAkC;QACxC,WAAW,EACT,6EAA6E;QAC/E,QAAQ,EAAE,MAAM;KACjB;IACD,CAAC,WAAW,CAAC,uBAAuB,CAAC,EAAE;QACrC,IAAI,EAAE,2BAA2B;QACjC,WAAW,EACT,mFAAmF;QACrF,QAAQ,EAAE,QAAQ;KACnB;IACD,CAAC,WAAW,CAAC,uBAAuB,CAAC,EAAE;QACrC,IAAI,EAAE,2BAA2B;QACjC,WAAW,EACT,8EAA8E;QAChF,QAAQ,EAAE,QAAQ;KACnB;CACF,CAAC"}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "siphon-library",
+  "version": "1.0.0",
+  "description": "A library for ...",
+  "main": "out/index.js",
+  "types": "out/index.d.ts",
+  "files": [
+    "out"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "jest"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.0.0",
+    "jest": "^29.0.0",
+    "ts-jest": "^29.0.0",
+    "typescript": "5.8.2"
+  }
+}