Merge pull request #105 from factchain/add_ts_to_note

[backend] add createdAt timestamp to Note
factchain · Mar 21, 2024 · f6bc48f · f6bc48f
2 parents abfc07d + 5ba8db8
commit f6bc48f
Show file tree

Hide file tree

Showing 8 changed files with 78 additions and 38 deletions.
diff --git a/fc-community-backend/apps/api/scripts/finaliseNotes.mjs b/fc-community-backend/apps/api/scripts/finaliseNotes.mjs
@@ -5,7 +5,7 @@ import { NoteService } from "../dist/factchain-core/noteService.js";
 import { config } from "../dist/factchain-core/env.js";
 import { getNetworkConfig } from "../dist/factchain-core/networks/config.js"
 
-const LOOKBACK_DAYS = parseInt(process.argv[2]) || 2;
+const LOOKBACK_DAYS = parseInt(config.LOOKBACK_DAYS);
 const MINIMUM_RATING = parseInt(config.MINIMUM_RATING);
 
 const fc = new FactChainBackend(config, getNetworkConfig("ETHEREUM_SEPOLIA"));

diff --git a/fc-community-backend/apps/api/src/factchain-core/networks/config.ts b/fc-community-backend/apps/api/src/factchain-core/networks/config.ts
@@ -6,7 +6,6 @@ export interface NetworkConfig {
   NFT_CONTRACT_ADDRESS: string;
   SFT_CONTRACT_ADDRESS: string;
   X_CONTRACT_ADDRESS?: string;
-
 }
 
 export interface NetworkConfigs {
@@ -16,21 +15,23 @@ export interface NetworkConfigs {
 
 const networks: NetworkConfigs = {
   BASE_MAINNET: {
-      INFRA_RPC_URL: "<OVERRIDE ME>",
-      MAIN_CONTRACT_ADDRESS: "0xde31FB31adeB0a97E34aCf7EF4e21Ad585F667f7",
-      NFT_CONTRACT_ADDRESS: "0x8885DC14732AE2ADd64d8C6581E722F0A88aA3Da",
-      SFT_CONTRACT_ADDRESS: "0x77840A1815f4F62a4cCCA3aBA3566fB8ff0b10D0"
+    INFRA_RPC_URL: "<OVERRIDE ME>",
+    MAIN_CONTRACT_ADDRESS: "0xde31FB31adeB0a97E34aCf7EF4e21Ad585F667f7",
+    NFT_CONTRACT_ADDRESS: "0x8885DC14732AE2ADd64d8C6581E722F0A88aA3Da",
+    SFT_CONTRACT_ADDRESS: "0x77840A1815f4F62a4cCCA3aBA3566fB8ff0b10D0",
   },
   ETHEREUM_SEPOLIA: {
-      INFRA_RPC_URL: "<OVERRIDE ME>",
-      MAIN_CONTRACT_ADDRESS: "0x3b5946b3bd79c2B211E49c3149872f1d66223AE7",
-      NFT_CONTRACT_ADDRESS: "0x5818764B4272f4eCff170216abE99D36c0c41622",
-      SFT_CONTRACT_ADDRESS: "0xF9408EB2C2219E28aEFB32035c49d491880650A2",
-      X_CONTRACT_ADDRESS: "0xaC51f5E2664aa966c678Dc935E0d853d3495A48C"
-  }
+    INFRA_RPC_URL: "<OVERRIDE ME>",
+    MAIN_CONTRACT_ADDRESS: "0x3b5946b3bd79c2B211E49c3149872f1d66223AE7",
+    NFT_CONTRACT_ADDRESS: "0x5818764B4272f4eCff170216abE99D36c0c41622",
+    SFT_CONTRACT_ADDRESS: "0xF9408EB2C2219E28aEFB32035c49d491880650A2",
+    X_CONTRACT_ADDRESS: "0xaC51f5E2664aa966c678Dc935E0d853d3495A48C",
+  },
 };
 
-export function getNetworkConfig(networkKey: keyof NetworkConfigs): NetworkConfig {
+export function getNetworkConfig(
+  networkKey: keyof NetworkConfigs,
+): NetworkConfig {
   // default to Sepolia to avoid extension breaking change
   // TODO: throw BadRequest when extension is updated
   // Only replace the networkKey if it is not set.
@@ -40,4 +41,4 @@ export function getNetworkConfig(networkKey: keyof NetworkConfigs): NetworkConfi
   console.log(`using network ${updatedNetworkKey}`, network);
   network.INFRA_RPC_URL = config[`${updatedNetworkKey}_INFRA_RPC_URL`];
   return network;
-}
+}
diff --git a/fc-community-backend/apps/api/src/factchain-core/types.ts b/fc-community-backend/apps/api/src/factchain-core/types.ts
@@ -39,6 +39,8 @@ export type Rating = {
 export type Note = {
   postUrl: string;
   creatorAddress: string;
+  // TODO: createdAt shouldn't be optional
+  createdAt?: number;
   content?: string;
   finalRating?: number;
   ratings?: Array<number>;
@@ -71,7 +73,11 @@ export type FactChainEvent =
   | "NoteFinalised";
 
 export interface NoteReader {
-  getNote: (postUrl: string, creator: string) => Promise<Note>;
+  getNote: (
+    postUrl: string,
+    creator: string,
+    timestamp?: number,
+  ) => Promise<Note>;
   getNotes: (
     predicate: (postUrl: string, creator: string) => boolean,
     lookBackDays: number,

diff --git a/fc-community-backend/apps/api/src/factchain-core/web3.ts b/fc-community-backend/apps/api/src/factchain-core/web3.ts
@@ -97,14 +97,23 @@ export class FactChainBackend implements NoteReader, NoteWriter {
     return eventLogs;
   };
 
-  getNote = async (postUrl: string, creator: string): Promise<Note> => {
+  getNote = async (
+    postUrl: string,
+    creator: string,
+    timestamp?: number,
+  ): Promise<Note> => {
+    // TODO: timestamp shouldn't be optional
     const result = await this._fcCommunity.communityNotes(postUrl, creator);
-    return {
+    const note: Note = {
       postUrl: result[0],
       content: result[1],
       creatorAddress: result[2],
       finalRating: parseInt(result[3]),
     };
+    if (timestamp !== undefined) {
+      note.createdAt = timestamp;
+    }
+    return note;
   };
 
   getNoteRaters = async (
@@ -133,8 +142,12 @@ export class FactChainBackend implements NoteReader, NoteWriter {
         predicate(e.args[0], e.args[1]),
       );
       return Promise.all(
-        relatedEvents.map((event) =>
-          this.getNote(event.args[0], event.args[1]),
+        relatedEvents.map(async (event) =>
+          this.getNote(
+            event.args[0],
+            event.args[1],
+            (await event.getBlock()).timestamp,
+          ),
         ),
       );
     });

diff --git a/fc-community-backend/apps/cli/src/index.ts b/fc-community-backend/apps/cli/src/index.ts
@@ -26,7 +26,7 @@ console.log(figlet.textSync("FactChain"));
 program.version("1.0.0").description("FactChain command line");
 
 program
-  .command("events <eventType>")
+  .command("get-events <eventType>")
   .description("get a list of events")
   .option("-f, --from <number>", "Start block", parseInt, 0)
   .option("-t, --to <number>", "End block", parseInt)

diff --git a/fc-community-backend/apps/shared/src/networks/config.ts b/fc-community-backend/apps/shared/src/networks/config.ts
@@ -6,7 +6,6 @@ export interface NetworkConfig {
   NFT_CONTRACT_ADDRESS: string;
   SFT_CONTRACT_ADDRESS: string;
   X_CONTRACT_ADDRESS?: string;
-
 }
 
 export interface NetworkConfigs {
@@ -16,21 +15,23 @@ export interface NetworkConfigs {
 
 const networks: NetworkConfigs = {
   BASE_MAINNET: {
-      INFRA_RPC_URL: "<OVERRIDE ME>",
-      MAIN_CONTRACT_ADDRESS: "0xde31FB31adeB0a97E34aCf7EF4e21Ad585F667f7",
-      NFT_CONTRACT_ADDRESS: "0x8885DC14732AE2ADd64d8C6581E722F0A88aA3Da",
-      SFT_CONTRACT_ADDRESS: "0x77840A1815f4F62a4cCCA3aBA3566fB8ff0b10D0"
+    INFRA_RPC_URL: "<OVERRIDE ME>",
+    MAIN_CONTRACT_ADDRESS: "0xde31FB31adeB0a97E34aCf7EF4e21Ad585F667f7",
+    NFT_CONTRACT_ADDRESS: "0x8885DC14732AE2ADd64d8C6581E722F0A88aA3Da",
+    SFT_CONTRACT_ADDRESS: "0x77840A1815f4F62a4cCCA3aBA3566fB8ff0b10D0",
   },
   ETHEREUM_SEPOLIA: {
-      INFRA_RPC_URL: "<OVERRIDE ME>",
-      MAIN_CONTRACT_ADDRESS: "0x3b5946b3bd79c2B211E49c3149872f1d66223AE7",
-      NFT_CONTRACT_ADDRESS: "0x5818764B4272f4eCff170216abE99D36c0c41622",
-      SFT_CONTRACT_ADDRESS: "0xF9408EB2C2219E28aEFB32035c49d491880650A2",
-      X_CONTRACT_ADDRESS: "0xaC51f5E2664aa966c678Dc935E0d853d3495A48C"
-  }
+    INFRA_RPC_URL: "<OVERRIDE ME>",
+    MAIN_CONTRACT_ADDRESS: "0x3b5946b3bd79c2B211E49c3149872f1d66223AE7",
+    NFT_CONTRACT_ADDRESS: "0x5818764B4272f4eCff170216abE99D36c0c41622",
+    SFT_CONTRACT_ADDRESS: "0xF9408EB2C2219E28aEFB32035c49d491880650A2",
+    X_CONTRACT_ADDRESS: "0xaC51f5E2664aa966c678Dc935E0d853d3495A48C",
+  },
 };
 
-export function getNetworkConfig(networkKey: keyof NetworkConfigs): NetworkConfig {
+export function getNetworkConfig(
+  networkKey: keyof NetworkConfigs,
+): NetworkConfig {
   // default to Sepolia to avoid extension breaking change
   // TODO: throw BadRequest when extension is updated
   // Only replace the networkKey if it is not set.
@@ -40,4 +41,4 @@ export function getNetworkConfig(networkKey: keyof NetworkConfigs): NetworkConfi
   console.log(`using network ${updatedNetworkKey}`, network);
   network.INFRA_RPC_URL = config[`${updatedNetworkKey}_INFRA_RPC_URL`];
   return network;
-}
+}
diff --git a/fc-community-backend/apps/shared/src/types.ts b/fc-community-backend/apps/shared/src/types.ts
@@ -39,6 +39,8 @@ export type Rating = {
 export type Note = {
   postUrl: string;
   creatorAddress: string;
+  // TODO: createdAt shouldn't be optional
+  createdAt?: number;
   content?: string;
   finalRating?: number;
   ratings?: Array<number>;
@@ -71,7 +73,11 @@ export type FactChainEvent =
   | "NoteFinalised";
 
 export interface NoteReader {
-  getNote: (postUrl: string, creator: string) => Promise<Note>;
+  getNote: (
+    postUrl: string,
+    creator: string,
+    timestamp?: number,
+  ) => Promise<Note>;
   getNotes: (
     predicate: (postUrl: string, creator: string) => boolean,
     lookBackDays: number,

diff --git a/fc-community-backend/apps/shared/src/web3.ts b/fc-community-backend/apps/shared/src/web3.ts
@@ -97,14 +97,23 @@ export class FactChainBackend implements NoteReader, NoteWriter {
     return eventLogs;
   };
 
-  getNote = async (postUrl: string, creator: string): Promise<Note> => {
+  getNote = async (
+    postUrl: string,
+    creator: string,
+    timestamp?: number,
+  ): Promise<Note> => {
+    // TODO: timestamp shouldn't be optional
     const result = await this._fcCommunity.communityNotes(postUrl, creator);
-    return {
+    const note: Note = {
       postUrl: result[0],
       content: result[1],
       creatorAddress: result[2],
       finalRating: parseInt(result[3]),
     };
+    if (timestamp !== undefined) {
+      note.createdAt = timestamp;
+    }
+    return note;
   };
 
   getNoteRaters = async (
@@ -133,8 +142,12 @@ export class FactChainBackend implements NoteReader, NoteWriter {
         predicate(e.args[0], e.args[1]),
       );
       return Promise.all(
-        relatedEvents.map((event) =>
-          this.getNote(event.args[0], event.args[1]),
+        relatedEvents.map(async (event) =>
+          this.getNote(
+            event.args[0],
+            event.args[1],
+            (await event.getBlock()).timestamp,
+          ),
         ),
       );
     });