feat(core): Improve delegation flow

docker-assets/mediator/Caddyfile

@@ -37,4 +37,4 @@
  # format single_field common_log
  level DEBUG
  }
-}
+}

src/core/agent/agent.ts

@@ -1,84 +1,115 @@
 import { Capacitor } from "@capacitor/core";
+import {
+ randomPasscode,
+ SignifyClient,
+ ready as signifyReady,
+ Tier,
+} from "signify-ts";
+import { Storage } from "@ionic/storage";
 import {
  ConnectionService,
  CredentialService,
  IdentifierService,
 } from "./services";
 import { SignifyNotificationService } from "./services/signifyNotificationService";
-import { StorageApi } from "../storage/storage.types";
-import { SqliteStorage } from "../storage/sqliteStorage";
+import { AgentServicesProps } from "./agent.types";
+import { EventService } from "./services/eventService";
+import {
+ BasicRecord,
+ BasicStorage,
+ CredentialMetadataRecord,
+ CredentialStorage,
+ IdentifierMetadataRecord,
+ IdentifierStorage,
+} from "./records";
+import { KeyStoreKeys, SecureStorage } from "../storage";
+import { MultiSigService } from "./services/multiSigService";
+import { IpexCommunicationService } from "./services/ipexCommunicationService";
+import { SqliteSession } from "../storage/sqliteStorage/sqliteSession";
+import { IonicSession } from "../storage/ionicStorage/ionicSession";
 import { IonicStorage } from "../storage/ionicStorage";
-import { SignifyApi } from "./modules/signify/signifyApi";
-
-const config = {
- label: "idw-agent",
- walletConfig: {
- id: "idw",
- key: "idw", // Right now, this key isn't used as we don't have encryption.
- },
- autoUpdateStorageOnStartup: true,
-};
+import { SqliteStorage } from "../storage/sqliteStorage";
+import { BaseRecord } from "../storage/storage.types";
+
+const walletId = "idw";
 class Agent {
+ static readonly LOCAL_KERIA_ENDPOINT =
+ "https://dev.keria.cf-keripy.metadata.dev.cf-deployments.org";
+ static readonly LOCAL_KERIA_BOOT_ENDPOINT =
+ "https://dev.keria-boot.cf-keripy.metadata.dev.cf-deployments.org";
+
  private static instance: Agent;
- private basicRecordStorage!: StorageApi;
- private signifyApi!: SignifyApi;
+ private agentServicesProps!: AgentServicesProps;
+
+ private storageSession!: SqliteSession | IonicSession;
+
+ private basicStorage!: BasicStorage;
+ private signifyClient!: SignifyClient;
  static ready = false;
 
  // @TODO - foconnor: Registering these should be more generic, but OK for now
  private identifierService!: IdentifierService;
+ private multiSigService!: MultiSigService;
+ private ipexCommunicationService!: IpexCommunicationService;
+
  private connectionService!: ConnectionService;
  private credentialService!: CredentialService;
  private signifyNotificationService!: SignifyNotificationService;
 
  get identifiers() {
  if (!this.identifierService) {
- this.identifierService = new IdentifierService(
- this.basicRecordStorage,
- this.signifyApi
- );
+ this.identifierService = new IdentifierService(this.agentServicesProps);
  }
  return this.identifierService;
  }
 
+ get multiSigs() {
+ if (!this.multiSigService) {
+ this.multiSigService = new MultiSigService(this.agentServicesProps);
+ }
+ return this.multiSigService;
+ }
+
+ get ipexCommunications() {
+ if (!this.ipexCommunicationService) {
+ this.ipexCommunicationService = new IpexCommunicationService(
+ this.agentServicesProps
+ );
+ }
+ return this.ipexCommunicationService;
+ }
+
  get connections() {
  if (!this.connectionService) {
- this.connectionService = new ConnectionService(
- this.basicRecordStorage,
- this.signifyApi
- );
+ this.connectionService = new ConnectionService(this.agentServicesProps);
  }
  return this.connectionService;
  }
 
  get credentials() {
  if (!this.credentialService) {
- this.credentialService = new CredentialService(
- this.basicRecordStorage,
- this.signifyApi
- );
+ this.credentialService = new CredentialService(this.agentServicesProps);
  }
  return this.credentialService;
  }
 
  get basicStorages() {
- return this.basicRecordStorage;
+ return this.basicStorage;
  }
 
  get signifyNotifications() {
  if (!this.signifyNotificationService) {
  this.signifyNotificationService = new SignifyNotificationService(
- this.basicRecordStorage,
- this.signifyApi
+ this.agentServicesProps
  );
  }
  return this.signifyNotificationService;
  }
 
  private constructor() {
- this.basicRecordStorage = Capacitor.isNativePlatform()
- ? new SqliteStorage()
- : new IonicStorage();
- this.signifyApi = new SignifyApi();
+ this.storageSession = Capacitor.isNativePlatform()
+ ? new SqliteSession()
+ : new IonicSession();
  }
 
  static get agent() {
@@ -90,11 +121,59 @@ class Agent {
 
  async start(): Promise<void> {
  if (!Agent.ready) {
- await this.basicRecordStorage.open(config.walletConfig?.id || "idw");
- await this.signifyApi.start();
+ await this.storageSession.open(walletId);
+ await signifyReady();
+ const bran = await this.getBran();
+ // @TODO - foconnor: Review of Tier level.
+ this.signifyClient = new SignifyClient(
+ Agent.LOCAL_KERIA_ENDPOINT,
+ bran,
+ Tier.low,
+ Agent.LOCAL_KERIA_BOOT_ENDPOINT
+ );
+ try {
+ await this.signifyClient.connect();
+ } catch (err) {
+ await this.signifyClient.boot();
+ await this.signifyClient.connect();
+ }
+ this.basicStorage = new BasicStorage(
+ this.getStorageService<BasicRecord>(this.storageSession)
+ );
+ this.agentServicesProps = {
+ basicStorage: this.basicStorage,
+ signifyClient: this.signifyClient,
+ eventService: new EventService(),
+ identifierStorage: new IdentifierStorage(
+ this.getStorageService<IdentifierMetadataRecord>(this.storageSession)
+ ),
+ credentialStorage: new CredentialStorage(
+ this.getStorageService<CredentialMetadataRecord>(this.storageSession)
+ ),
+ };
  Agent.ready = true;
  }
  }
+
+ private async getBran(): Promise<string> {
+ let bran;
+ try {
+ bran = await SecureStorage.get(KeyStoreKeys.SIGNIFY_BRAN);
+ } catch (error) {
+ bran = randomPasscode();
+ await SecureStorage.set(KeyStoreKeys.SIGNIFY_BRAN, bran);
+ }
+ return bran as string;
+ }
+
+ private getStorageService<T extends BaseRecord>(
+ instance: IonicSession | SqliteSession
+ ) {
+ if (instance instanceof IonicSession) {
+ return new IonicStorage<T>(instance.session!);
+ }
+ return new SqliteStorage<T>(instance.session!);
+ }
 }
 
 export { Agent };

src/core/agent/agent.types.ts

@@ -1,7 +1,12 @@
+import { SignifyClient } from "signify-ts";
 import {
  CredentialShortDetails,
  CredentialStatus,
 } from "./services/credentialService.types";
+import { EventService } from "./services/eventService";
+import { IdentifierStorage } from "./records/identifierStorage";
+import { CredentialStorage } from "./records/credentialStorage";
+import { BasicStorage } from "./records/basicStorage";
 
 enum Blockchain {
  CARDANO = "Cardano",
@@ -103,13 +108,153 @@ interface KeriaNotificationMarker {
  lastNotificationId: string;
 }
 
+interface AgentServicesProps {
+ basicStorage: BasicStorage;
+ signifyClient: SignifyClient;
+ eventService: EventService;
+ identifierStorage: IdentifierStorage;
+ credentialStorage: CredentialStorage;
+}
+enum MultiSigRoute {
+ ROT = "/multisig/rot",
+ ICP = "/multisig/icp",
+ IXN = "/multisig/ixn",
+}
+
+interface CreateIdentifierResult {
+ signifyName: string;
+ identifier: string;
+}
+
+interface KeriContact {
+ alias: string;
+ id: string;
+ oobi: string;
+ challenges: string[];
+ wellKnowns: string[];
+}
+
+interface IdentifierResult {
+ name: string;
+ prefix: string;
+ salty: any;
+}
+
+interface IdentifiersListResult {
+ aids: IdentifierResult[];
+ start: 0;
+ end: 0;
+ total: 0;
+}
+
+interface CreateMultisigExnPayload {
+ gid: string;
+ smids: any[];
+ rmids: any;
+ rstates: any;
+ name: string;
+}
+
+interface Aid {
+ name: string;
+ prefix: string;
+ salty: any;
+ transferable: boolean;
+ state: {
+ vn: number[];
+ i: string;
+ s: string;
+ p: string;
+ d: string;
+ f: string;
+ dt: string;
+ et: string;
+ kt: string;
+ k: string[];
+ nt: string;
+ n: string[];
+ bt: string;
+ b: string[];
+ c: string[];
+ ee: {
+ s: string;
+ d: string;
+ br: any[];
+ ba: any[];
+ };
+ di: string;
+ };
+ windexes: number[];
+}
+
+interface MultiSigExnMessage {
+ exn: {
+ v: string;
+ t: string;
+ d: string;
+ i: string;
+ p: string;
+ dt: string;
+ r: string;
+ q: any;
+ a: {
+ gid: string;
+ smids: string[];
+ rmids: string[];
+ rstates: Aid["state"][];
+ name: string;
+ };
+ e: {
+ icp: {
+ v: string;
+ t: string;
+ d: string;
+ i: string;
+ s: string;
+ kt: string;
+ k: string[];
+ nt: string;
+ n: string[];
+ bt: string;
+ b: string[];
+ c: any[];
+ a: any[];
+ };
+ d: string;
+ };
+ };
+}
+
+enum NotificationRoute {
+ Credential = "/exn/ipex/grant",
+ MultiSigIcp = "/multisig/icp",
+ MultiSigRot = "/multisig/rot",
+}
+
+enum OOBIScan {
+ Delegated,
+ Aid,
+}
+
+type ScanOOBIRes =
+ | {
+ oobiType: OOBIScan.Aid;
+ }
+ | {
+ oobiType: OOBIScan.Delegated;
+ delegatePrefix: string;
+ };
+
 export {
  Blockchain,
  ConnectionStatus,
  ConnectionHistoryType,
  MiscRecordId,
  ConnectionKeriEventTypes,
  AcdcKeriEventTypes,
+ NotificationRoute,
+ MultiSigRoute,
+ OOBIScan,
 };
 
 export type {
@@ -124,4 +269,13 @@ export type {
  AcdcKeriStateChangedEvent,
  BaseEventEmitter,
  KeriaNotificationMarker,
+ AgentServicesProps,
+ CreateIdentifierResult,
+ KeriContact,
+ IdentifiersListResult,
+ CreateMultisigExnPayload,
+ MultiSigExnMessage,
+ Aid,
+ IdentifierResult,
+ ScanOOBIRes,
 };