@propxchain/core-client 0.2.1 → 0.3.0-canary.24

package/src/canisters/ledger_manager/ledger_manager.did

@@ -58,11 +58,44 @@ type TeamMemberRole =
    manager;
    viewer;
  };
+type Result_2 = 
+ variant {
+   err: text;
+   ok: nat;
+ };
+type Result_1 = 
+ variant {
+   err: text;
+   ok;
+ };
 type Result = 
  variant {
    err: text;
    ok: text;
  };
+type LandRegistryCostEntry = 
+ record {
+   apiEndpoint: text;
+   calledAt: int;
+   calledBy: principal;
+   costPence: nat;
+   description: text;
+   id: nat;
+   invoiceReference: opt text;
+   titleNumber: text;
+   transactionId: text;
+ };
+type LRCostReport = 
+ record {
+   avgCostPerTransaction: nat;
+   byEndpoint: vec record {
+                     text;
+                     nat;
+                   };
+   entryCount: nat;
+   totalGBP: text;
+   totalPence: nat;
+ };
 type DocumentVerification = 
  record {
    landRegistryConfirm: VerificationStatus;
@@ -95,6 +128,17 @@ type CompanyLedger =
    teamMemberCount: nat;
    totalTransactions: nat;
  };
+type BudgetStatus = 
+ record {
+   dailyLimit: nat;
+   dailyRemaining: nat;
+   dailySpent: nat;
+   isOverDailyBudget: bool;
+   isOverMonthlyBudget: bool;
+   monthlyLimit: nat;
+   monthlyRemaining: nat;
+   monthlySpent: nat;
+ };
 type BlockchainEfficiencyMetrics = 
  record {
    avgBlockchainCompletionDays: nat;
@@ -107,6 +151,16 @@ type BlockchainEfficiencyMetrics =
    totalTimeSavedDays: nat;
    transactionsCompleted: nat;
  };
+type AuditEvent = 
+ record {
+   caller: principal;
+   details: text;
+   eventId: nat;
+   eventType: text;
+   metadata: opt text;
+   timestamp: int;
+   transactionId: text;
+ };
 type Analytics = 
  record {
    avgCompletionTime: nat;
@@ -125,23 +179,47 @@ service : {
   addTransactionToLedger: (accountID: text, transactionID: text,
    roleInTransaction: TransactionRole, propertyAddress: text, propertyValue:
    nat, counterparties: vec Counterparty) -> (bool);
+  canAffordAPICall: (costPence: nat) -> (bool) query;
+  clearFailedAuditEvents: () -> ();
   createCompanyTeamMember: (companyID: text, name: text, email: text, role:
    TeamMemberRole, permissions: TeamPermissions) -> (text);
   createUserAccount: (name: text, email: text, accountType: AccountType,
    companyName: opt text, taxID: opt text) -> (text);
+  getAllAuditEvents: () -> (vec AuditEvent) query;
   getBlockchainEfficiencyMetrics: (accountID: text) ->
    (BlockchainEfficiencyMetrics) query;
+  getBudgetStatus: () -> (BudgetStatus) query;
   getCompanyLedger: (companyAccountID: text) -> (CompanyLedger) query;
   getCompanyTeamMembers: (companyAccountID: text) ->
    (vec CompanyTeamMember) query;
   getCycles: () -> (nat) query;
+  getDailyLRSpend: () -> (nat) query;
+  getEventsByTransaction: (transactionId: text) -> (vec AuditEvent) query;
+  getFailedAuditEvents: () -> (vec AuditEvent) query;
   getGlobalBlockchainStats: () -> (BlockchainEfficiencyMetrics) query;
+  getLRCostReport: (fromDate: int, toDate: int) -> (LRCostReport) query;
+  getLRCostsForTransaction: (transactionId: text) ->
+   (vec LandRegistryCostEntry) query;
+  getLRSpendByEndpoint: (fromDate: int, toDate: int) ->
+   (vec record {
+          text;
+          nat;
+        }) query;
   getLedgerAnalytics: (accountID: text, period: text) -> (Analytics) query;
+  getMonthlyLRSpend: () -> (nat) query;
   getMyAccount: () -> (opt UserAccount) query;
   getMyLedger: () -> (vec UserLedgerEntry) query;
   getUserAccount: (accountID: text) -> (opt UserAccount) query;
   getUserLedger: (accountID: text) -> (vec UserLedgerEntry) query;
+  logEvent: (transactionId: text, eventType: text, details: text, metadata:
+   opt text) -> (Result_2);
+  recordLandRegistryCost: (transactionId: text, apiEndpoint: text, costPence:
+   nat, titleNumber: text, description: text, invoiceReference: opt text) ->
+   (Result_2);
+  setDailyBudget: (limitPence: nat) -> (Result_1);
+  setDocumentStorageCanister: (canisterId: principal) -> ();
   setDocumentVerificationCanister: (canisterId: principal) -> ();
+  setMonthlyBudget: (limitPence: nat) -> (Result_1);
   setPropertyRegistryCanister: (canisterId: principal) -> ();
   setTransactionManagerCanister: (canisterId: principal) -> ();
   setUserManagementCanister: (canisterId: principal) -> ();

package/src/canisters/ledger_manager/ledger_manager.did.d.ts

@@ -12,6 +12,15 @@ export interface Analytics {
   'completedTransactions' : bigint,
   'totalTransactions' : bigint,
 }
+export interface AuditEvent {
+  'eventId' : bigint,
+  'metadata' : [] | [string],
+  'timestamp' : bigint,
+  'details' : string,
+  'caller' : Principal,
+  'transactionId' : string,
+  'eventType' : string,
+}
 export interface BlockchainEfficiencyMetrics {
   'avgBlockchainCompletionDays' : bigint,
   'totalCostSaved' : bigint,
@@ -23,6 +32,16 @@ export interface BlockchainEfficiencyMetrics {
   'costReductionPercent' : bigint,
   'totalTimeSavedDays' : bigint,
 }
+export interface BudgetStatus {
+  'dailyRemaining' : bigint,
+  'isOverDailyBudget' : boolean,
+  'monthlyLimit' : bigint,
+  'monthlySpent' : bigint,
+  'dailyLimit' : bigint,
+  'dailySpent' : bigint,
+  'isOverMonthlyBudget' : boolean,
+  'monthlyRemaining' : bigint,
+}
 export interface CompanyLedger {
   'companyAccountID' : string,
   'avgCompletionTime' : bigint,
@@ -48,8 +67,30 @@ export interface DocumentVerification {
   'landRegistryConfirm' : VerificationStatus,
   'surveyReport' : VerificationStatus,
 }
+export interface LRCostReport {
+  'entryCount' : bigint,
+  'byEndpoint' : Array<[string, bigint]>,
+  'avgCostPerTransaction' : bigint,
+  'totalGBP' : string,
+  'totalPence' : bigint,
+}
+export interface LandRegistryCostEntry {
+  'id' : bigint,
+  'titleNumber' : string,
+  'invoiceReference' : [] | [string],
+  'description' : string,
+  'calledAt' : bigint,
+  'calledBy' : Principal,
+  'apiEndpoint' : string,
+  'costPence' : bigint,
+  'transactionId' : string,
+}
 export type Result = { 'ok' : string } |
   { 'err' : string };
+export type Result_1 = { 'ok' : null } |
+  { 'err' : string };
+export type Result_2 = { 'ok' : bigint } |
+  { 'err' : string };
 export type TeamMemberRole = { 'manager' : null } |
   { 'admin' : null } |
   { 'viewer' : null };
@@ -100,6 +141,8 @@ export interface _SERVICE {
     [string, string, TransactionRole, string, bigint, Array<Counterparty>],
     boolean
   >,
+  'canAffordAPICall' : ActorMethod<[bigint], boolean>,
+  'clearFailedAuditEvents' : ActorMethod<[], undefined>,
   'createCompanyTeamMember' : ActorMethod<
     [string, string, string, TeamMemberRole, TeamPermissions],
     string
@@ -108,20 +151,43 @@ export interface _SERVICE {
     [string, string, AccountType, [] | [string], [] | [string]],
     string
   >,
+  'getAllAuditEvents' : ActorMethod<[], Array<AuditEvent>>,
   'getBlockchainEfficiencyMetrics' : ActorMethod<
     [string],
     BlockchainEfficiencyMetrics
   >,
+  'getBudgetStatus' : ActorMethod<[], BudgetStatus>,
   'getCompanyLedger' : ActorMethod<[string], CompanyLedger>,
   'getCompanyTeamMembers' : ActorMethod<[string], Array<CompanyTeamMember>>,
   'getCycles' : ActorMethod<[], bigint>,
+  'getDailyLRSpend' : ActorMethod<[], bigint>,
+  'getEventsByTransaction' : ActorMethod<[string], Array<AuditEvent>>,
+  'getFailedAuditEvents' : ActorMethod<[], Array<AuditEvent>>,
   'getGlobalBlockchainStats' : ActorMethod<[], BlockchainEfficiencyMetrics>,
+  'getLRCostReport' : ActorMethod<[bigint, bigint], LRCostReport>,
+  'getLRCostsForTransaction' : ActorMethod<
+    [string],
+    Array<LandRegistryCostEntry>
+  >,
+  'getLRSpendByEndpoint' : ActorMethod<
+    [bigint, bigint],
+    Array<[string, bigint]>
+  >,
   'getLedgerAnalytics' : ActorMethod<[string, string], Analytics>,
+  'getMonthlyLRSpend' : ActorMethod<[], bigint>,
   'getMyAccount' : ActorMethod<[], [] | [UserAccount]>,
   'getMyLedger' : ActorMethod<[], Array<UserLedgerEntry>>,
   'getUserAccount' : ActorMethod<[string], [] | [UserAccount]>,
   'getUserLedger' : ActorMethod<[string], Array<UserLedgerEntry>>,
+  'logEvent' : ActorMethod<[string, string, string, [] | [string]], Result_2>,
+  'recordLandRegistryCost' : ActorMethod<
+    [string, string, bigint, string, string, [] | [string]],
+    Result_2
+  >,
+  'setDailyBudget' : ActorMethod<[bigint], Result_1>,
+  'setDocumentStorageCanister' : ActorMethod<[Principal], undefined>,
   'setDocumentVerificationCanister' : ActorMethod<[Principal], undefined>,
+  'setMonthlyBudget' : ActorMethod<[bigint], Result_1>,
   'setPropertyRegistryCanister' : ActorMethod<[Principal], undefined>,
   'setTransactionManagerCanister' : ActorMethod<[Principal], undefined>,
   'setUserManagementCanister' : ActorMethod<[Principal], undefined>,

package/src/canisters/ledger_manager/ledger_manager.did.js

@@ -24,6 +24,15 @@ export const idlFactory = ({ IDL }) => {
     'company' : IDL.Null,
     'individual' : IDL.Null,
   });
+  const AuditEvent = IDL.Record({
+    'eventId' : IDL.Nat,
+    'metadata' : IDL.Opt(IDL.Text),
+    'timestamp' : IDL.Int,
+    'details' : IDL.Text,
+    'caller' : IDL.Principal,
+    'transactionId' : IDL.Text,
+    'eventType' : IDL.Text,
+  });
   const BlockchainEfficiencyMetrics = IDL.Record({
     'avgBlockchainCompletionDays' : IDL.Nat,
     'totalCostSaved' : IDL.Nat,
@@ -35,6 +44,16 @@ export const idlFactory = ({ IDL }) => {
     'costReductionPercent' : IDL.Nat,
     'totalTimeSavedDays' : IDL.Nat,
   });
+  const BudgetStatus = IDL.Record({
+    'dailyRemaining' : IDL.Nat,
+    'isOverDailyBudget' : IDL.Bool,
+    'monthlyLimit' : IDL.Nat,
+    'monthlySpent' : IDL.Nat,
+    'dailyLimit' : IDL.Nat,
+    'dailySpent' : IDL.Nat,
+    'isOverMonthlyBudget' : IDL.Bool,
+    'monthlyRemaining' : IDL.Nat,
+  });
   const CompanyLedger = IDL.Record({
     'companyAccountID' : IDL.Text,
     'avgCompletionTime' : IDL.Nat,
@@ -54,6 +73,24 @@ export const idlFactory = ({ IDL }) => {
     'role' : TeamMemberRole,
     'email' : IDL.Text,
   });
+  const LRCostReport = IDL.Record({
+    'entryCount' : IDL.Nat,
+    'byEndpoint' : IDL.Vec(IDL.Tuple(IDL.Text, IDL.Nat)),
+    'avgCostPerTransaction' : IDL.Nat,
+    'totalGBP' : IDL.Text,
+    'totalPence' : IDL.Nat,
+  });
+  const LandRegistryCostEntry = IDL.Record({
+    'id' : IDL.Nat,
+    'titleNumber' : IDL.Text,
+    'invoiceReference' : IDL.Opt(IDL.Text),
+    'description' : IDL.Text,
+    'calledAt' : IDL.Int,
+    'calledBy' : IDL.Principal,
+    'apiEndpoint' : IDL.Text,
+    'costPence' : IDL.Nat,
+    'transactionId' : IDL.Text,
+  });
   const Analytics = IDL.Record({
     'transactionVolume' : IDL.Nat,
     'avgCompletionTime' : IDL.Nat,
@@ -103,6 +140,8 @@ export const idlFactory = ({ IDL }) => {
     'counterparties' : IDL.Vec(Counterparty),
     'transactionID' : IDL.Text,
   });
+  const Result_2 = IDL.Variant({ 'ok' : IDL.Nat, 'err' : IDL.Text });
+  const Result_1 = IDL.Variant({ 'ok' : IDL.Null, 'err' : IDL.Text });
   const Result = IDL.Variant({ 'ok' : IDL.Text, 'err' : IDL.Text });
   return IDL.Service({
     'addTransactionToLedger' : IDL.Func(
@@ -117,6 +156,8 @@ export const idlFactory = ({ IDL }) => {
         [IDL.Bool],
         [],
       ),
+    'canAffordAPICall' : IDL.Func([IDL.Nat], [IDL.Bool], ['query']),
+    'clearFailedAuditEvents' : IDL.Func([], [], []),
     'createCompanyTeamMember' : IDL.Func(
         [IDL.Text, IDL.Text, IDL.Text, TeamMemberRole, TeamPermissions],
         [IDL.Text],
@@ -127,11 +168,13 @@ export const idlFactory = ({ IDL }) => {
         [IDL.Text],
         [],
       ),
+    'getAllAuditEvents' : IDL.Func([], [IDL.Vec(AuditEvent)], ['query']),
     'getBlockchainEfficiencyMetrics' : IDL.Func(
         [IDL.Text],
         [BlockchainEfficiencyMetrics],
         ['query'],
       ),
+    'getBudgetStatus' : IDL.Func([], [BudgetStatus], ['query']),
     'getCompanyLedger' : IDL.Func([IDL.Text], [CompanyLedger], ['query']),
     'getCompanyTeamMembers' : IDL.Func(
         [IDL.Text],
@@ -139,16 +182,35 @@ export const idlFactory = ({ IDL }) => {
         ['query'],
       ),
     'getCycles' : IDL.Func([], [IDL.Nat], ['query']),
+    'getDailyLRSpend' : IDL.Func([], [IDL.Nat], ['query']),
+    'getEventsByTransaction' : IDL.Func(
+        [IDL.Text],
+        [IDL.Vec(AuditEvent)],
+        ['query'],
+      ),
+    'getFailedAuditEvents' : IDL.Func([], [IDL.Vec(AuditEvent)], ['query']),
     'getGlobalBlockchainStats' : IDL.Func(
         [],
         [BlockchainEfficiencyMetrics],
         ['query'],
       ),
+    'getLRCostReport' : IDL.Func([IDL.Int, IDL.Int], [LRCostReport], ['query']),
+    'getLRCostsForTransaction' : IDL.Func(
+        [IDL.Text],
+        [IDL.Vec(LandRegistryCostEntry)],
+        ['query'],
+      ),
+    'getLRSpendByEndpoint' : IDL.Func(
+        [IDL.Int, IDL.Int],
+        [IDL.Vec(IDL.Tuple(IDL.Text, IDL.Nat))],
+        ['query'],
+      ),
     'getLedgerAnalytics' : IDL.Func(
         [IDL.Text, IDL.Text],
         [Analytics],
         ['query'],
       ),
+    'getMonthlyLRSpend' : IDL.Func([], [IDL.Nat], ['query']),
     'getMyAccount' : IDL.Func([], [IDL.Opt(UserAccount)], ['query']),
     'getMyLedger' : IDL.Func([], [IDL.Vec(UserLedgerEntry)], ['query']),
     'getUserAccount' : IDL.Func([IDL.Text], [IDL.Opt(UserAccount)], ['query']),
@@ -157,7 +219,20 @@ export const idlFactory = ({ IDL }) => {
         [IDL.Vec(UserLedgerEntry)],
         ['query'],
       ),
+    'logEvent' : IDL.Func(
+        [IDL.Text, IDL.Text, IDL.Text, IDL.Opt(IDL.Text)],
+        [Result_2],
+        [],
+      ),
+    'recordLandRegistryCost' : IDL.Func(
+        [IDL.Text, IDL.Text, IDL.Nat, IDL.Text, IDL.Text, IDL.Opt(IDL.Text)],
+        [Result_2],
+        [],
+      ),
+    'setDailyBudget' : IDL.Func([IDL.Nat], [Result_1], []),
+    'setDocumentStorageCanister' : IDL.Func([IDL.Principal], [], []),
     'setDocumentVerificationCanister' : IDL.Func([IDL.Principal], [], []),
+    'setMonthlyBudget' : IDL.Func([IDL.Nat], [Result_1], []),
     'setPropertyRegistryCanister' : IDL.Func([IDL.Principal], [], []),
     'setTransactionManagerCanister' : IDL.Func([IDL.Principal], [], []),
     'setUserManagementCanister' : IDL.Func([IDL.Principal], [], []),