@mainnet-cash/postgresql-storage 2.1.0-alpha.5

package/src/SqlProvider.ts

@@ -0,0 +1,233 @@
+import { StorageProvider, WalletI, TxI } from "mainnet-js";
+import { RegisterWebhookParams } from "./webhook/interface.js";
+import { getSslConfig } from "./util.js";
+import parseDbUrl from "parse-database-url";
+import pg from "pg";
+import format from "pg-format";
+import { Webhook, WebhookRecurrence, WebhookType } from "./webhook/index.js";
+
+export default class SqlProvider implements StorageProvider {
+  private db;
+  private config;
+  private info;
+  private formatter;
+  private walletTable: string;
+  private webhookTable: string = "webhook";
+  private isInit = false;
+
+  public constructor(walletTable?: string) {
+    this.walletTable = walletTable ? walletTable : "wallet";
+    if (!process.env.DATABASE_URL) {
+      throw new Error(
+        "Named wallets and webhooks require a postgres DATABASE_URL environment variable to be set"
+      );
+    }
+    let dbConfig = parseDbUrl(process.env.DATABASE_URL);
+    let ssl = getSslConfig();
+    if (ssl) {
+      dbConfig.ssl = ssl;
+    }
+    this.config = dbConfig;
+
+    const Pool = pg.Pool;
+    this.db = new Pool(dbConfig);
+    this.formatter = format;
+  }
+
+  public getConfig() {
+    return this.config;
+  }
+
+  public async init(): Promise<StorageProvider> {
+    if (!this.isInit) {
+      this.isInit = true;
+      await this.db;
+      await this.formatter;
+
+      let createWalletTable = this.formatter(
+        "CREATE TABLE IF NOT EXISTS %I (id SERIAL, name TEXT PRIMARY KEY, wallet TEXT );",
+        this.walletTable
+      );
+      const resWallet = await this.db.query(createWalletTable);
+
+      let createWebhookTable = this.formatter(
+        "CREATE TABLE IF NOT EXISTS %I (" +
+          "id SERIAL PRIMARY KEY," +
+          "cashaddr TEXT," +
+          "type TEXT," +
+          "recurrence TEXT," +
+          "url TEXT," +
+          "status TEXT," +
+          "tx_seen JSON," +
+          "last_height INTEGER," +
+          "expires_at TIMESTAMPTZ" +
+          ");",
+        this.webhookTable
+      );
+      const resWebhook = await this.db.query(createWebhookTable);
+
+      if (!resWallet || !resWebhook)
+        throw new Error("Failed to init SqlProvider");
+    }
+
+    return this;
+  }
+
+  public async close(): Promise<StorageProvider> {
+    await this.db.end();
+    return this;
+  }
+
+  public getInfo(): string {
+    return this.info;
+  }
+
+  public async addWallet(name: string, walletId: string): Promise<boolean> {
+    let text = this.formatter(
+      "INSERT into %I (name,wallet) VALUES ($1, $2);",
+      this.walletTable
+    );
+    return await this.db.query(text, [name, walletId]);
+  }
+
+  public async getWallets(): Promise<Array<WalletI>> {
+    let text = this.formatter("SELECT * FROM %I;", this.walletTable);
+    let result = await this.db.query(text);
+    if (result) {
+      const WalletArray: WalletI[] = await Promise.all(
+        result.rows.map(async (obj: WalletI) => {
+          return obj;
+        })
+      );
+      return WalletArray;
+    } else {
+      return [];
+    }
+  }
+
+  public async getWallet(name: string): Promise<WalletI | undefined> {
+    let text = this.formatter(
+      "SELECT * FROM %I WHERE name = $1;",
+      this.walletTable
+    );
+    let result = await this.db.query(text, [name]);
+    let w = result.rows[0];
+    return w;
+  }
+
+  public async updateWallet(name: string, walletId: string): Promise<void> {
+    let text = this.formatter(
+      "UPDATE %I SET wallet = $1 WHERE name = $2;",
+      this.walletTable
+    );
+    await this.db.query(text, [walletId, name]);
+  }
+
+  public async walletExists(name: string): Promise<boolean> {
+    return (await this.getWallet(name)) !== undefined;
+  }
+
+  public async webhookFromDb(hook: Webhook) {
+    const { WebhookBch } = await import("./webhook/WebhookBch.js");
+    return new WebhookBch(hook);
+  }
+
+  public async addWebhook(params: RegisterWebhookParams): Promise<Webhook> {
+    // init db if it was not, useful for external api calls
+    await this.init();
+
+    params.type = params.type || WebhookType.transactionInOut;
+    params.recurrence = params.recurrence || WebhookRecurrence.once;
+    const expireTimeout =
+      Number(process.env.WEBHOOK_EXPIRE_TIMEOUT_SECONDS) || 86400;
+    params.duration_sec = params.duration_sec || expireTimeout;
+    params.duration_sec =
+      params.duration_sec > expireTimeout ? expireTimeout : params.duration_sec;
+
+    const expires_at = new Date(
+      new Date().getTime() + params.duration_sec * 1000
+    );
+    let text = this.formatter(
+      "INSERT into %I (cashaddr,type,recurrence,url,status,tx_seen,last_height,expires_at) VALUES ($1, $2, $3, $4, $5, $6, $7, $8) RETURNING *;",
+      this.webhookTable
+    );
+
+    const result = await this.db.query(text, [
+      params.cashaddr,
+      params.type,
+      params.recurrence,
+      params.url,
+      "",
+      "[]",
+      0,
+      expires_at.toISOString(),
+    ]);
+    const hook = await this.webhookFromDb(result.rows[0]);
+    hook.db = this;
+    return hook;
+  }
+
+  public async getWebhooks(): Promise<Array<Webhook>> {
+    let text = this.formatter("SELECT * FROM %I;", this.webhookTable);
+    let result = await this.db.query(text);
+    if (result) {
+      const WebhookArray: Webhook[] = await Promise.all(
+        result.rows.map(async (obj: any) => {
+          obj = await this.webhookFromDb(obj);
+          obj.db = this;
+          return obj;
+        })
+      );
+      return WebhookArray;
+    } else {
+      return [];
+    }
+  }
+
+  public async getWebhook(id: number): Promise<Webhook | undefined> {
+    const text = this.formatter(
+      "SELECT * FROM %I WHERE id = $1;",
+      this.webhookTable
+    );
+    const result = await this.db.query(text, [id]);
+    let hook = result.rows[0];
+    if (hook) {
+      hook = this.webhookFromDb(hook);
+      hook.db = this;
+    }
+    return hook;
+  }
+
+  public async setWebhookStatus(id: number, status: string): Promise<void> {
+    let text = this.formatter(
+      "UPDATE %I SET status = $1 WHERE id = $2;",
+      this.webhookTable
+    );
+    await this.db.query(text, [status, id]);
+  }
+
+  public async setWebhookSeenTxLastHeight(
+    id: number,
+    tx_seen: Array<TxI>,
+    last_height: number
+  ): Promise<void> {
+    let text = this.formatter(
+      "UPDATE %I SET tx_seen = $1, last_height = $2 WHERE id = $3;",
+      this.webhookTable
+    );
+    await this.db.query(text, [JSON.stringify(tx_seen), last_height, id]);
+  }
+
+  public async deleteWebhook(id: number): Promise<void> {
+    let text = this.formatter(
+      "DELETE FROM %I WHERE id = $1;",
+      this.webhookTable
+    );
+    await this.db.query(text, [id]);
+  }
+
+  public async clearWebhooks(): Promise<void> {
+    let text = this.formatter("DELETE FROM %I;", this.webhookTable);
+    await this.db.query(text);
+  }
+}