add chain id source to finding

forta-network · Jul 27, 2023 · 4e073b1 · 4e073b1
1 parent 416d1da
commit 4e073b1
Show file tree

Hide file tree

Showing 2 changed files with 68 additions and 16 deletions.
diff --git a/cli/commands/run/server/alert.proto b/cli/commands/run/server/alert.proto
@@ -91,6 +91,43 @@ message Label {
   repeated string metadata = 8;
 }
 
+message Source {
+  message TransactionSource {
+    uint64 chainId = 1;
+    string hash = 2;
+  }
+
+  message BlockSource {
+    uint64 chainId = 1;
+    string hash = 2;
+    uint64 number = 3;
+  }
+
+  message URLSource {
+    string url = 1;
+  }
+
+  message ChainSource {
+    uint64 chainId = 1;
+  }
+
+  message AlertSource {
+    string id = 1;
+  }
+
+  message CustomSource {
+    string name = 1;
+    string value = 2;
+  }
+
+  repeated TransactionSource transactions = 1;
+  repeated BlockSource blocks = 2;
+  repeated URLSource urls = 3;
+  repeated ChainSource chains = 4;
+  repeated AlertSource alerts = 5;
+  repeated CustomSource customSources = 6;
+}
+
 message Finding {
   enum Severity {
     UNKNOWN = 0;
@@ -117,10 +154,12 @@ message Finding {
   string alertId = 5;
   string name = 6;
   string description = 7;
-  string everestId = 8;
+  reserved 8;
   bool private = 9;
   repeated string addresses = 10;
   map<string, double> indicators = 11;
   repeated Label labels = 12;
   repeated string relatedAlerts = 13;
-}
+  string uniqueKey = 14;
+  Source source = 15;
+}
diff --git a/sdk/finding.ts b/sdk/finding.ts
@@ -1,5 +1,5 @@
-import { EntityType, Label } from "./label"
-import { assertIsFromEnum, assertIsNonEmptyString } from "./utils"
+import {EntityType, Label} from "./label"
+import {assertIsFromEnum, assertIsNonEmptyString} from "./utils"
 
 export enum FindingSeverity {
   Unknown,
@@ -19,31 +19,40 @@ export enum FindingType {
   Scam
 }
 
+type FindingSourceChain = {
+  chainId: number
+}
+type FindingSources = {
+  chainSource: FindingSourceChain
+}
+
 type FindingInput = {
   name: string,
   description: string,
   alertId: string,
   protocol?: string,
   severity: FindingSeverity,
   type: FindingType,
-  metadata?: { [key: string]: string},
+  metadata?: { [key: string]: string },
   addresses?: string[],
   labels?: Label[],
   uniqueKey?: string,
+  chainId?: number
 }
 
 export class Finding {
   private constructor(
-    readonly name: string,
-    readonly description: string,
-    readonly alertId: string,
-    readonly protocol: string,
-    readonly severity: FindingSeverity,
-    readonly type: FindingType,
-    readonly metadata: { [key: string]: string},
-    readonly addresses: string[],
-    readonly labels: Label[],
-    readonly uniqueKey: string,
+   readonly name: string,
+   readonly description: string,
+   readonly alertId: string,
+   readonly protocol: string,
+   readonly severity: FindingSeverity,
+   readonly type: FindingType,
+   readonly metadata: { [key: string]: string },
+   readonly addresses: string[],
+   readonly labels: Label[],
+   readonly uniqueKey: string,
+   readonly sources: FindingSources,
   ) {}
 
   toString() {
@@ -71,6 +80,7 @@ export class Finding {
     addresses = [],
     labels = [],
     uniqueKey = '',
+    chainId = -1,
   }: FindingInput) {
     assertIsNonEmptyString(name, 'name')
     assertIsNonEmptyString(description, 'description')
@@ -81,6 +91,9 @@ export class Finding {
     // TODO assert metadata keys and values are strings
 
     labels = labels.map(l => l instanceof Label ? l : Label.fromObject(l))
-    return new Finding(name, description, alertId, protocol, severity, type, metadata, addresses, labels, uniqueKey)
+    const sources = {chainSource: {chainId: chainId}}
+
+
+    return new Finding(name, description, alertId, protocol, severity, type, metadata, addresses, labels, uniqueKey, sources)
   }
 }