Merge pull request #31 from windingtree/feat/deals-db

Deals database class

Author: kostysh

package.json

@@ -112,7 +112,8 @@
     "@trpc/client": "^10.32.0",
     "jsonwebtoken": "^9.0.0",
     "zod": "^3.21.4",
-    "bcryptjs": "^2.4.3"
+    "bcryptjs": "^2.4.3",
+    "superjson": "^1.12.4"
   },
   "scripts": {
     "clean": "rm -rf ./lib",

src/client/dealsManager.ts

@@ -14,6 +14,7 @@ import {
   GenericOfferOptions,
   GenericQuery,
   OfferData,
+  DealRecord,
 } from '../shared/types.js';
 import {
   DealStatus,
@@ -26,31 +27,6 @@ import { parseSeconds } from '../utils/time.js';
 
 const logger = createLogger('ClientDealsManager');
 
-/**
- * Deals registry record
- */
-export interface DealRecord<
-  CustomRequestQuery extends GenericQuery = GenericQuery,
-  CustomOfferOptions extends GenericOfferOptions = GenericOfferOptions,
-> {
-  /** Network chain Id */
-  chainId: number;
-  /** Deal creation time in seconds */
-  created: bigint;
-  /** Offer */
-  offer: OfferData<CustomRequestQuery, CustomOfferOptions>;
-  /** Deal retailer Id */
-  retailerId: string;
-  /** Deal owner */
-  buyer: Address;
-  /** Deal price */
-  price: bigint;
-  /** Deal asset */
-  asset: Address;
-  /** Current deal status */
-  status: DealStatus;
-}
-
 export interface DealCurrentStatus {
   offerId: Hash;
   status: DealStatus;

src/node/api/index.ts

@@ -1,4 +1,4 @@
-export * from './db.js';
+export * from '../db/users.js';
 export * from './server.js';
 export * from './router/admin.js';
 export * from './router/user.js';

src/node/api/router/admin.ts

@@ -2,7 +2,7 @@ import { TRPCError } from '@trpc/server';
 import { Address, Hash, verifyTypedData } from 'viem';
 import { TypedDataDomain } from 'abitype';
 import { Account } from '../../../index.js';
-import { User, UserInputSchema } from '../db.js';
+import { User, UserInputSchema } from '../../db/users.js';
 import { router, procedure } from '../index.js';
 import { createLogger } from '../../../utils/logger.js';
 

src/node/api/router/user.ts

@@ -1,5 +1,5 @@
 import { TRPCError } from '@trpc/server';
-import { User, UserInputSchema, comparePassword } from '../db.js';
+import { User, UserInputSchema, comparePassword } from '../../db/users.js';
 import {
   APIContext,
   router,

src/node/api/server.ts

@@ -9,7 +9,7 @@ import {
 import * as jwt from 'jsonwebtoken';
 import { Address } from 'viem';
 import { Storage } from '../../storage/index.js';
-import { User, UsersDb } from './db.js';
+import { User, UsersDb } from '../db/users.js';
 import { createLogger } from '../../utils/logger.js';
 
 const logger = createLogger('NodeApiServer');

src/node/db/deals.ts

@@ -0,0 +1,114 @@
+import { Hash } from 'viem';
+import { Storage } from '../../storage/index.js';
+import { DealRecord, PaginationOptions } from '../../shared/types.js';
+import { createLogger } from '../../utils/logger.js';
+
+const logger = createLogger('DealsDb');
+
+/**
+ * Interface defining the properties of a Deal.
+ */
+// export interface Deal {}
+
+/**
+ * Interface defining the properties of DealsDb initialization options.
+ */
+export interface DealsDbOptions {
+  /** Instance of storage used for persisting the state of the API server */
+  storage: Storage;
+  /** Prefix used for the storage key to avoid potential key collisions */
+  prefix: string;
+}
+
+/**
+ * Class that implements an API to the deals records storage
+ *
+ * @export
+ * @class UsersDb
+ */
+export class DealsDb {
+  /** Storage instance for persisting the state of the API server */
+  storage: Storage;
+  /** Specific key prefix for the storage key to avoid potential key collisions */
+  prefix: string;
+
+  /**
+   * Creates an instance of DealsDb.
+   * Initializes an instance of DealsDb with given options.
+   *
+   * @param {UsersDbOptions} options
+   * @memberof DealsDb
+   */
+  constructor(options: DealsDbOptions) {
+    const { storage, prefix } = options;
+
+    // TODO Validate DealsDbOptions
+
+    this.prefix = `${prefix}_api_deals_`;
+    this.storage = storage;
+  }
+
+  /**
+   * Adds/Updates the record of the deal in the storage
+   *
+   * @param {DealRecord} deal The deal object
+   * @returns {Promise<void>}
+   * @memberof UsersDb
+   */
+  async set(deal: DealRecord): Promise<void> {
+    await this.storage.set<DealRecord>(`${this.prefix}${deal.offer.id}`, deal);
+  }
+
+  /**
+   * Retrieves the deal from storage.
+   *
+   * @param {Hash} offerId The Id (offerId) of the deal to be retrieved
+   * @returns {Promise<DealRecord>} The deal object associated with the given Id
+   * @throws Will throw an error if the user is not found
+   * @memberof UsersDb
+   */
+  async get(offerId: Hash): Promise<DealRecord> {
+    const deal = await this.storage.get<DealRecord>(`${this.prefix}${offerId}`);
+
+    if (!deal) {
+      throw new Error(`Deal ${offerId} not found`);
+    }
+
+    return deal;
+  }
+
+  /**
+   * Retrieves all the deals from storage.
+   *
+   * @param {PaginationOptions} [pagination] Pagination options
+   * @returns {Promise<DealRecord[]>} Deals records
+   * @memberof DealsDb
+   */
+  async getAll(pagination?: PaginationOptions): Promise<DealRecord[]> {
+    return new Promise((resolve, reject) => {
+      try {
+        pagination = pagination ?? {
+          start: 0,
+          skip: 10,
+        };
+        let cursor = 0;
+        const from = pagination.start >= 0 ? pagination.start : 0;
+        const to = from + pagination.skip ?? 0;
+        const records: DealRecord[] = [];
+
+        for (const record of this.storage.entries<DealRecord>()) {
+          if (to > 0 && cursor >= from && cursor < to) {
+            records.push(record[1]);
+          }
+
+          cursor++;
+        }
+
+        resolve(records);
+      } catch (error) {
+        logger.error('getAll', error);
+        reject(error);
+      }
+    });
+  }
+}

src/node/api/db.ts renamed to src/node/db/users.ts

@@ -43,6 +43,12 @@ export interface UsersDbOptions {
   prefix: string;
 }
 
+/**
+ * Class that implements an API to the users records storage
+ *
+ * @export
+ * @class UsersDb
+ */
 export class UsersDb {
   /** Storage instance for persisting the state of the API server */
   storage: Storage;
@@ -54,12 +60,12 @@ export class UsersDb {
    * Initializes an instance of UsersDb with given options.
    *
    * @param {UsersDbOptions} options
-   * @memberof NodeApiServer
+   * @memberof UsersDb
    */
   constructor(options: UsersDbOptions) {
     const { storage, prefix } = options;
 
-    // TODO Validate NodeApiServerOptions
+    // TODO Validate UsersDbOptions
 
     this.prefix = `${prefix}_api_users_`;
     this.storage = storage;
@@ -77,18 +83,6 @@ export class UsersDb {
     return await hash(password, 10);
   }
 
-  /**
-   * Generates a prefixed login key
-   *
-   * @private
-   * @param {string} login The login for which the key is generated
-   * @returns {string} The prefixed login key
-   * @memberof UsersDb
-   */
-  private loginKey(login: string): string {
-    return `${this.prefix}${login}`;
-  }
-
   /**
    * Retrieves the user with the given login from storage.
    *
@@ -98,7 +92,7 @@ export class UsersDb {
    * @memberof UsersDb
    */
   async get(login: string): Promise<User> {
-    const user = await this.storage.get<User>(this.loginKey(login));
+    const user = await this.storage.get<User>(`${this.prefix}${login}`);
 
     if (!user) {
       throw new Error(`User ${login} not found`);
@@ -118,15 +112,15 @@ export class UsersDb {
    * @memberof UsersDb
    */
   async add(login: string, password: string, isAdmin = false): Promise<void> {
-    const knownUser = await this.storage.get<User>(this.loginKey(login));
+    const knownUser = await this.storage.get<User>(`${this.prefix}${login}`);
 
     // Check if the user already exists
     if (knownUser) {
       throw new Error(`User ${login} already exists`);
     }
 
     // Save the user into the storage
-    await this.storage.set<User>(this.loginKey(login), {
+    await this.storage.set<User>(`${this.prefix}${login}`, {
       login,
       hashedPassword: await UsersDb.hashPassword(password),
       isAdmin,
@@ -141,7 +135,7 @@ export class UsersDb {
    * @memberof UsersDb
    */
   async set(user: User): Promise<void> {
-    await this.storage.set<User>(this.loginKey(user.login), user);
+    await this.storage.set<User>(`${this.prefix}${user.login}`, user);
   }
 
   /**
@@ -153,7 +147,7 @@ export class UsersDb {
    * @memberof UsersDb
    */
   async delete(login: string): Promise<void> {
-    const deleted = await this.storage.delete(this.loginKey(login));
+    const deleted = await this.storage.delete(`${this.prefix}${login}`);
 
     if (!deleted) {
       throw new Error(`Unable to delete user ${login}`);