@bsv/wallet-toolbox 1.3.5 → 1.3.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/wallet-toolbox",
-  "version": "1.3.5",
+  "version": "1.3.6",
   "description": "BRC100 conforming wallet, wallet storage and wallet signer components",
   "main": "./out/src/index.js",
   "types": "./out/src/index.d.ts",

package/src/storage/StorageIdb.ts

@@ -22,7 +22,7 @@ import {
   verifyOne,
   verifyOneOrNone
 } from '../index.client'
-import { StorageProvider, StorageProviderOptions } from './StorageProvider'
+import { StorageAdminStats, StorageProvider, StorageProviderOptions } from './StorageProvider'
 import { StorageIdbSchema } from './schema/StorageIdbSchema'
 import { DBType } from './StorageReader'
 import { TransactionStatus } from '../sdk'
@@ -42,6 +42,10 @@ export class StorageIdb extends StorageProvider implements sdk.WalletStorageProv
     this.dbName = `wallet-toolbox-${this.chain}net`
   }
 
+  override adminStats(adminIdentityKey: string): Promise<StorageAdminStats> {
+    throw new Error('Method not implemented.')
+  }
+
   /**
    * This method must be called at least once before any other method accesses the database,
    * and each time the schema may have updated.

package/src/storage/StorageKnex.ts

@@ -1,4 +1,4 @@
-import { ListActionsResult, ListOutputsResult } from '@bsv/sdk'
+import { ListActionsResult, ListOutputsResult, Transaction } from '@bsv/sdk'
 import { sdk, verifyOne, verifyOneOrNone, verifyTruthy } from '../index.all'
 import {
   KnexMigrations,
@@ -25,7 +25,7 @@ import {
 } from './index.all'
 
 import { Knex } from 'knex'
-import { StorageProvider, StorageProviderOptions } from './StorageProvider'
+import { StorageAdminStats, StorageProvider, StorageProviderOptions } from './StorageProvider'
 import { purgeData } from './methods/purgeData'
 import { listActions } from './methods/listActionsKnex'
 import { listOutputs } from './methods/listOutputsKnex'
@@ -1126,4 +1126,218 @@ export class StorageKnex extends StorageProvider implements sdk.WalletStoragePro
     }
     return entities
   }
+
+  async adminStats(adminIdentityKey: string): Promise<StorageAdminStats> {
+    if (this.dbtype !== 'MySQL') throw new sdk.WERR_NOT_IMPLEMENTED('adminStats, only MySQL is supported')
+
+    const one_day_ago = new Date(Date.now() - 24 * 60 * 60 * 1000).toISOString()
+    const one_week_ago = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000).toISOString()
+    const one_month_ago = new Date(Date.now() - 30 * 24 * 60 * 60 * 1000).toISOString()
+
+    const [
+      [
+        {
+          usersDay,
+          usersMonth,
+          usersWeek,
+          usersTotal,
+          transactionsDay,
+          transactionsMonth,
+          transactionsWeek,
+          transactionsTotal,
+          txCompletedDay,
+          txCompletedMonth,
+          txCompletedWeek,
+          txCompletedTotal,
+          txFailedDay,
+          txFailedMonth,
+          txFailedWeek,
+          txFailedTotal,
+          txUnprocessedDay,
+          txUnprocessedMonth,
+          txUnprocessedWeek,
+          txUnprocessedTotal,
+          txSendingDay,
+          txSendingMonth,
+          txSendingWeek,
+          txSendingTotal,
+          txUnprovenDay,
+          txUnprovenMonth,
+          txUnprovenWeek,
+          txUnprovenTotal,
+          txUnsignedDay,
+          txUnsignedMonth,
+          txUnsignedWeek,
+          txUnsignedTotal,
+          txNosendDay,
+          txNosendMonth,
+          txNosendWeek,
+          txNosendTotal,
+          txNonfinalDay,
+          txNonfinalMonth,
+          txNonfinalWeek,
+          txNonfinalTotal,
+          txUnfailDay,
+          txUnfailMonth,
+          txUnfailWeek,
+          txUnfailTotal,
+          satoshisDefaultDay,
+          satoshisDefaultMonth,
+          satoshisDefaultWeek,
+          satoshisDefaultTotal,
+          satoshisOtherDay,
+          satoshisOtherMonth,
+          satoshisOtherWeek,
+          satoshisOtherTotal,
+          basketsDay,
+          basketsMonth,
+          basketsWeek,
+          basketsTotal,
+          labelsDay,
+          labelsMonth,
+          labelsWeek,
+          labelsTotal,
+          tagsDay,
+          tagsMonth,
+          tagsWeek,
+          tagsTotal
+        }
+      ]
+    ] = await this.knex.raw(`
+select
+    (select count(*) from users where created_at > '${one_day_ago}') as usersDay,
+    (select count(*) from users where created_at > '${one_week_ago}') as usersWeek,
+    (select count(*) from users where created_at > '${one_month_ago}') as usersMonth,
+	  (select count(*) from users) as usersTotal,
+    (select count(*) from transactions where created_at > '${one_day_ago}') as transactionsDay,
+    (select count(*) from transactions where created_at > '${one_week_ago}') as transactionsWeek,
+    (select count(*) from transactions where created_at > '${one_month_ago}') as transactionsMonth,
+	  (select count(*) from transactions) as transactionsTotal,
+    (select count(*) from transactions where status = 'completed' and created_at > '${one_day_ago}') as txCompletedDay,
+    (select count(*) from transactions where status = 'completed' and created_at > '${one_week_ago}') as txCompletedWeek,
+    (select count(*) from transactions where status = 'completed' and created_at > '${one_month_ago}') as txCompletedMonth,
+	  (select count(*) from transactions where status = 'completed') as txCompletedTotal,
+    (select count(*) from transactions where status = 'failed' and created_at > '${one_day_ago}') as txFailedDay,
+    (select count(*) from transactions where status = 'failed' and created_at > '${one_week_ago}') as txFailedWeek,
+    (select count(*) from transactions where status = 'failed' and created_at > '${one_month_ago}') as txFailedMonth,
+	  (select count(*) from transactions where status = 'failed') as txFailedTotal,
+    (select count(*) from transactions where status = 'unprocessed' and created_at > '${one_day_ago}') as txUnprocessedDay,
+    (select count(*) from transactions where status = 'unprocessed' and created_at > '${one_week_ago}') as txUnprocessedWeek,
+    (select count(*) from transactions where status = 'unprocessed' and created_at > '${one_month_ago}') as txUnprocessedMonth,
+	  (select count(*) from transactions where status = 'unprocessed') as txUnprocessedTotal,
+    (select count(*) from transactions where status = 'sending' and created_at > '${one_day_ago}') as txSendingDay,
+    (select count(*) from transactions where status = 'sending' and created_at > '${one_week_ago}') as txSendingWeek,
+    (select count(*) from transactions where status = 'sending' and created_at > '${one_month_ago}') as txSendingMonth,
+	  (select count(*) from transactions where status = 'sending') as txSendingTotal,
+    (select count(*) from transactions where status = 'unproven' and created_at > '${one_day_ago}') as txUnprovenDay,
+    (select count(*) from transactions where status = 'unproven' and created_at > '${one_week_ago}') as txUnprovenWeek,
+    (select count(*) from transactions where status = 'unproven' and created_at > '${one_month_ago}') as txUnprovenMonth,
+	  (select count(*) from transactions where status = 'unproven') as txUnprovenTotal,
+    (select count(*) from transactions where status = 'unsigned' and created_at > '${one_day_ago}') as txUnsignedDay,
+    (select count(*) from transactions where status = 'unsigned' and created_at > '${one_week_ago}') as txUnsignedWeek,
+    (select count(*) from transactions where status = 'unsigned' and created_at > '${one_month_ago}') as txUnsignedMonth,
+	  (select count(*) from transactions where status = 'unsigned') as txUnsignedTotal,
+    (select count(*) from transactions where status = 'nosend' and created_at > '${one_day_ago}') as txNosendDay,
+    (select count(*) from transactions where status = 'nosend' and created_at > '${one_week_ago}') as txNosendWeek,
+    (select count(*) from transactions where status = 'nosend' and created_at > '${one_month_ago}') as txNosendMonth,
+	  (select count(*) from transactions where status = 'nosend') as txNosendTotal,
+    (select count(*) from transactions where status = 'nonfinal' and created_at > '${one_day_ago}') as txNonfinalDay,
+    (select count(*) from transactions where status = 'nonfinal' and created_at > '${one_week_ago}') as txNonfinalWeek,
+    (select count(*) from transactions where status = 'nonfinal' and created_at > '${one_month_ago}') as txNonfinalMonth,
+	  (select count(*) from transactions where status = 'nonfinal') as txNonfinalTotal,
+    (select count(*) from transactions where status = 'unfail' and created_at > '${one_day_ago}') as txUnfailDay,
+    (select count(*) from transactions where status = 'unfail' and created_at > '${one_week_ago}') as txUnfailWeek,
+    (select count(*) from transactions where status = 'unfail' and created_at > '${one_month_ago}') as txUnfailMonth,
+	  (select count(*) from transactions where status = 'unfail') as txUnfailTotal,
+    (select sum(satoshis) from outputs where spendable = 1 and \`change\` = 1 and created_at > '${one_day_ago}') as satoshisDefaultDay,
+    (select sum(satoshis) from outputs where spendable = 1 and \`change\` = 1 and created_at > '${one_week_ago}') as satoshisDefaultWeek,
+    (select sum(satoshis) from outputs where spendable = 1 and \`change\` = 1 and created_at > '${one_month_ago}') as satoshisDefaultMonth,
+	  (select sum(satoshis) from outputs where spendable = 1 and \`change\` = 1) as satoshisDefaultTotal,
+    (select sum(satoshis) from outputs where spendable = 1 and \`change\` = 0 and not basketId is null and created_at > '${one_day_ago}') as satoshisOtherDay,
+    (select sum(satoshis) from outputs where spendable = 1 and \`change\` = 0 and not basketId is null and created_at > '${one_week_ago}') as satoshisOtherWeek,
+    (select sum(satoshis) from outputs where spendable = 1 and \`change\` = 0 and not basketId is null and created_at > '${one_month_ago}') as satoshisOtherMonth,
+	  (select sum(satoshis) from outputs where spendable = 1 and \`change\` = 0 and not basketId is null) as satoshisOtherTotal,
+    (select count(*) from output_baskets where created_at > '${one_day_ago}') as basketsDay,
+    (select count(*) from output_baskets where created_at > '${one_week_ago}') as basketsWeek,
+    (select count(*) from output_baskets where created_at > '${one_month_ago}') as basketsMonth,
+	  (select count(*) from output_baskets) as basketsTotal,
+    (select count(*) from tx_labels where created_at > '${one_day_ago}') as labelsDay,
+    (select count(*) from tx_labels where created_at > '${one_week_ago}') as labelsWeek,
+    (select count(*) from tx_labels where created_at > '${one_month_ago}') as labelsMonth,
+	  (select count(*) from tx_labels) as labelsTotal,
+    (select count(*) from output_tags where created_at > '${one_day_ago}') as tagsDay,
+    (select count(*) from output_tags where created_at > '${one_week_ago}') as tagsWeek,
+    (select count(*) from output_tags where created_at > '${one_month_ago}') as tagsMonth,
+	  (select count(*) from output_tags) as tagsTotal
+      `)
+    const r: StorageAdminStats = {
+      requestedBy: adminIdentityKey,
+      when: new Date().toISOString(),
+      usersDay,
+      usersWeek,
+      usersMonth,
+      usersTotal,
+      transactionsDay,
+      transactionsWeek,
+      transactionsMonth,
+      transactionsTotal,
+      txCompletedDay,
+      txCompletedWeek,
+      txCompletedMonth,
+      txCompletedTotal,
+      txFailedDay,
+      txFailedWeek,
+      txFailedMonth,
+      txFailedTotal,
+      txUnprocessedDay,
+      txUnprocessedWeek,
+      txUnprocessedMonth,
+      txUnprocessedTotal,
+      txSendingDay,
+      txSendingWeek,
+      txSendingMonth,
+      txSendingTotal,
+      txUnprovenDay,
+      txUnprovenWeek,
+      txUnprovenMonth,
+      txUnprovenTotal,
+      txUnsignedDay,
+      txUnsignedWeek,
+      txUnsignedMonth,
+      txUnsignedTotal,
+      txNosendDay,
+      txNosendWeek,
+      txNosendMonth,
+      txNosendTotal,
+      txNonfinalDay,
+      txNonfinalWeek,
+      txNonfinalMonth,
+      txNonfinalTotal,
+      txUnfailDay,
+      txUnfailWeek,
+      txUnfailMonth,
+      txUnfailTotal,
+      satoshisDefaultDay,
+      satoshisDefaultWeek,
+      satoshisDefaultMonth,
+      satoshisDefaultTotal,
+      satoshisOtherDay,
+      satoshisOtherWeek,
+      satoshisOtherMonth,
+      satoshisOtherTotal,
+      basketsDay,
+      basketsWeek,
+      basketsMonth,
+      basketsTotal,
+      labelsDay,
+      labelsWeek,
+      labelsMonth,
+      labelsTotal,
+      tagsDay,
+      tagsWeek,
+      tagsMonth,
+      tagsTotal
+    }
+    return r
+  }
 }

package/src/storage/StorageProvider.ts

@@ -106,6 +106,8 @@ export abstract class StorageProvider extends StorageReaderWriter implements sdk
   abstract findOutputsAuth(auth: sdk.AuthId, args: sdk.FindOutputsArgs): Promise<TableOutput[]>
   abstract insertCertificateAuth(auth: sdk.AuthId, certificate: TableCertificateX): Promise<number>
 
+  abstract adminStats(adminIdentityKey: string): Promise<StorageAdminStats>
+
   override isStorageProvider(): boolean {
     return true
   }
@@ -694,3 +696,72 @@ export function validateStorageFeeModel(v?: sdk.StorageFeeModel): sdk.StorageFee
   }
   return r
 }
+
+export interface StorageAdminStats {
+  requestedBy: string
+  when: string
+  usersDay: number
+  usersWeek: number
+  usersMonth: number
+  usersTotal: number
+  transactionsDay: number
+  transactionsWeek: number
+  transactionsMonth: number
+  transactionsTotal: number
+  txCompletedDay: number
+  txCompletedWeek: number
+  txCompletedMonth: number
+  txCompletedTotal: number
+  txFailedDay: number
+  txFailedWeek: number
+  txFailedMonth: number
+  txFailedTotal: number
+  txUnprocessedDay: number
+  txUnprocessedWeek: number
+  txUnprocessedMonth: number
+  txUnprocessedTotal: number
+  txSendingDay: number
+  txSendingWeek: number
+  txSendingMonth: number
+  txSendingTotal: number
+  txUnprovenDay: number
+  txUnprovenWeek: number
+  txUnprovenMonth: number
+  txUnprovenTotal: number
+  txUnsignedDay: number
+  txUnsignedWeek: number
+  txUnsignedMonth: number
+  txUnsignedTotal: number
+  txNosendDay: number
+  txNosendWeek: number
+  txNosendMonth: number
+  txNosendTotal: number
+  txNonfinalDay: number
+  txNonfinalWeek: number
+  txNonfinalMonth: number
+  txNonfinalTotal: number
+  txUnfailDay: number
+  txUnfailWeek: number
+  txUnfailMonth: number
+  txUnfailTotal: number
+  satoshisDefaultDay: number
+  satoshisDefaultWeek: number
+  satoshisDefaultMonth: number
+  satoshisDefaultTotal: number
+  satoshisOtherDay: number
+  satoshisOtherWeek: number
+  satoshisOtherMonth: number
+  satoshisOtherTotal: number
+  basketsDay: number
+  basketsWeek: number
+  basketsMonth: number
+  basketsTotal: number
+  labelsDay: number
+  labelsWeek: number
+  labelsMonth: number
+  labelsTotal: number
+  tagsDay: number
+  tagsWeek: number
+  tagsMonth: number
+  tagsTotal: number
+}

package/src/storage/__test/adminStats.man.test.ts

@@ -0,0 +1,31 @@
+import { before } from 'node:test'
+import { _tu } from '../../../test/utils/TestUtilsWalletStorage'
+import { Setup } from '../../Setup'
+import { StorageKnex } from '../StorageKnex'
+
+describe('storage adminStats tests', () => {
+  jest.setTimeout(99999999)
+
+  const env = _tu.getEnv('main')
+  const knex = Setup.createMySQLKnex(process.env.MAIN_CLOUD_MYSQL_CONNECTION!)
+  const storage = new StorageKnex({
+    chain: env.chain,
+    knex: knex,
+    commissionSatoshis: 0,
+    commissionPubKeyHex: undefined,
+    feeModel: { model: 'sat/kb', value: 1 }
+  })
+
+  beforeAll(async () => {
+    await storage.makeAvailable()
+  })
+  afterAll(async () => {
+    await storage.destroy()
+  })
+
+  test('0 adminStats', async () => {
+    const r = await storage.adminStats(env.identityKey)
+    expect(r.requestedBy).toBe(env.identityKey)
+    expect(r.usersTotal).toBeGreaterThan(0)
+  })
+})

package/src/storage/__test/getBeefForTransaction.test.ts

@@ -46,7 +46,8 @@ import {
   TableUser,
   sdk,
   Services,
-  EntityProvenTx
+  EntityProvenTx,
+  StorageAdminStats
 } from '../../index.client'
 
 describe('getBeefForTransaction tests', () => {
@@ -371,4 +372,7 @@ class ProtoStorage extends StorageProvider {
   override getOutputTagMapsForUser(args: FindForUserSincePagedArgs): Promise<TableOutputTagMap[]> {
     throw this.nip
   }
+  override adminStats(adminIdentityKey: string): Promise<StorageAdminStats> {
+    throw this.nip
+  }
 }

package/src/storage/remoting/StorageServer.ts

@@ -11,13 +11,12 @@ import { AuthMiddlewareOptions, createAuthMiddleware } from '@bsv/auth-express-m
 import { createPaymentMiddleware } from '@bsv/payment-express-middleware'
 import { sdk, Wallet, StorageProvider } from '../../index.all'
 
-import { StorageKnex } from '../StorageKnex'
-
 export interface WalletStorageServerOptions {
   port: number
   wallet: Wallet
   monetize: boolean
   calculateRequestPrice?: (req: Request) => number | Promise<number>
+  adminIdentityKeys?: string[]
 }
 
 export class StorageServer {
@@ -27,6 +26,7 @@ export class StorageServer {
   private wallet: Wallet
   private monetize: boolean
   private calculateRequestPrice?: (req: Request) => number | Promise<number>
+  private adminIdentityKeys?: string[]
 
   constructor(storage: StorageProvider, options: WalletStorageServerOptions) {
     this.storage = storage
@@ -34,6 +34,7 @@ export class StorageServer {
     this.wallet = options.wallet
     this.monetize = options.monetize
     this.calculateRequestPrice = options.calculateRequestPrice
+    this.adminIdentityKeys = options.adminIdentityKeys
 
     this.setupRoutes()
   }
@@ -103,6 +104,15 @@ export class StorageServer {
                   throw new sdk.WERR_UNAUTHORIZED('function may only access authenticated user.')
               }
               break
+            case 'adminStats':
+              {
+                // TODO: add check for admin user
+                if (params[0] !== req.auth.identityKey)
+                  throw new sdk.WERR_UNAUTHORIZED('function may only access authenticated admin user.')
+                if (!this.adminIdentityKeys || !this.adminIdentityKeys.includes(req.auth.identityKey))
+                  throw new sdk.WERR_UNAUTHORIZED('function may only be accessed by admin user.')
+              }
+              break
             case 'processSyncChunk':
               {
                 await this.validateParam0(params, req)