feat: add auditsnapshotaccruals

gridcat · Jul 7, 2021 · 8834777 · 8834777
1 parent 046c4c9
commit 8834777
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 2 deletions.
diff --git a/src/RPC/Developer.ts b/src/RPC/Developer.ts
@@ -1,4 +1,4 @@
-import { AuditSnapshot, AuditSnapshotDetailed } from '../contracts/auditSnapshot';
+import { AuditSnapshot, AuditSnapshotAccurals, AuditSnapshotDetailed } from '../contracts/auditSnapshot';
 import { RPCBase } from '../RPCBase';
 import { CPID } from '../types';
 
@@ -18,4 +18,15 @@ export class Developer extends RPCBase {
   public async auditSnapshotAccrual(cpid: CPID, detailed: boolean): Promise<AuditSnapshot | AuditSnapshotDetailed> {
     return this.call('auditsnapshotaccrual', cpid, detailed);
   }
+
+  /**
+   * Report accrual audit for entire population of CPIDs.
+   *
+   * @param {boolean} [mismatchedOnly]
+   * @returns {Promise<AuditSnapshotAccurals>}
+   * @memberof Developer
+   */
+  public async auditSnapshotAccruals(mismatchedOnly?: boolean): Promise<AuditSnapshotAccurals> {
+    return this.call('auditsnapshotaccruals', mismatchedOnly);
+  }
 }
diff --git a/src/contracts/auditSnapshot.ts b/src/contracts/auditSnapshot.ts
@@ -1,3 +1,5 @@
+import { CPID } from '../types';
+
 interface Audit {
   boundary: string;
   lowTime: number;
@@ -17,7 +19,7 @@ interface BeaconTimestamp {
 }
 
 export interface AuditSnapshot {
-  cpid: string;
+  cpid: CPID;
   accrualAccountExists: boolean;
   latestBeaconTimestamp: BeaconTimestamp;
   originalBeaconTimestamp: BeaconTimestamp;
@@ -32,3 +34,28 @@ export interface AuditSnapshotDetailed extends AuditSnapshot {
   beaconChain: BeaconTimestamp[];
   audit: Audit[];
 }
+
+interface AccuralMismatchDetails {
+  cpid: CPID;
+  match: {
+    cpid: CPID;
+    accrualAccountExists: true,
+    latestBeaconTimestamp: BeaconTimestamp;
+    originalBeaconTimestamp: BeaconTimestamp;
+    renewals: number;
+    accrualByAudit: number;
+    accrualByGetAccrual: number;
+    newbieCorrection: number;
+    accrualLastPeriod: number;
+  }
+}
+
+export interface AuditSnapshotAccurals {
+  numberOfCpids: number;
+  numberOfMatches: number;
+  numberOfMismatches: number;
+  numberOfMismatchesLastPeriodOnly: number;
+  numberAccrualAccountsNotPresent: number;
+  numberNotPresent: number;
+  accrualMismatchDetails: AccuralMismatchDetails[];
+}