feat: expose wallet API (openwallet-foundation#566)

This commit also contains the following changes: * Create a master secret when creating a wallet. * Do not delete wallet when shutdown is called on agent. * Expose the whole wallet API, which also contains methods that should be used only inside the framework. We need to improve that in the future. Signed-off-by: Jakub Koci <[email protected]> BREAKING CHANGE: The agent’s `shutdown` method does not delete the wallet anymore. If you want to delete the wallet, you can do it via exposed wallet API. Signed-off-by: annelein <[email protected]>
animo · Jan 28, 2022 · 1f71aa9 · 1f71aa9
1 parent 9452a38
commit 1f71aa9
Show file tree

Hide file tree

Showing 18 changed files with 220 additions and 166 deletions.
diff --git a/packages/core/src/agent/Agent.ts b/packages/core/src/agent/Agent.ts
@@ -39,7 +39,6 @@ export class Agent {
   protected logger: Logger
   protected container: DependencyContainer
   protected eventEmitter: EventEmitter
-  protected wallet: Wallet
   protected messageReceiver: MessageReceiver
   protected transportService: TransportService
   protected messageSender: MessageSender
@@ -54,6 +53,7 @@ export class Agent {
   public readonly mediationRecipient!: RecipientModule
   public readonly mediator!: MediatorModule
   public readonly discovery!: DiscoverFeaturesModule
+  public readonly wallet: Wallet
 
   public constructor(initialConfig: InitConfig, dependencies: AgentDependencies) {
     // Create child container so we don't interfere with anything outside of this agent
@@ -181,7 +181,7 @@ export class Agent {
     this._isInitialized = true
   }
 
-  public async shutdown({ deleteWallet = false }: { deleteWallet?: boolean } = {}) {
+  public async shutdown() {
     // All observables use takeUntil with the stop$ observable
     // this means all observables will stop running if a value is emitted on this observable
     this.agentConfig.stop$.next(true)
@@ -194,13 +194,9 @@ export class Agent {
       transport.stop()
     }
 
-    // close/delete wallet if still initialized
+    // close wallet if still initialized
     if (this.wallet.isInitialized) {
-      if (deleteWallet) {
-        await this.wallet.delete()
-      } else {
-        await this.wallet.close()
-      }
+      await this.wallet.close()
     }
   }
 

diff --git a/packages/core/src/modules/credentials/__tests__/CredentialService.test.ts b/packages/core/src/modules/credentials/__tests__/CredentialService.test.ts
@@ -563,7 +563,7 @@ describe('CredentialService', () => {
         '~please_ack': expect.any(Object),
       })
 
-      // We're using instance of `StubWallet`. Value of `cred` should be as same as in the credential response message.
+      // Value of `cred` should be as same as in the credential response message.
       const [cred] = await indyIssuerService.createCredential({
         credentialOffer: credOffer,
         credentialRequest: credReq,

diff --git a/packages/core/src/modules/credentials/__tests__/StubWallet.ts b/packages/core/src/modules/credentials/__tests__/StubWallet.ts
diff --git a/packages/core/src/modules/routing/__tests__/mediation.test.ts b/packages/core/src/modules/routing/__tests__/mediation.test.ts
@@ -25,15 +25,12 @@ describe('mediator establishment', () => {
   let senderAgent: Agent
 
   afterEach(async () => {
-    await recipientAgent.shutdown({
-      deleteWallet: true,
-    })
-    await mediatorAgent.shutdown({
-      deleteWallet: true,
-    })
-    await senderAgent.shutdown({
-      deleteWallet: true,
-    })
+    await recipientAgent.shutdown()
+    await recipientAgent.wallet.delete()
+    await mediatorAgent.shutdown()
+    await mediatorAgent.wallet.delete()
+    await senderAgent.shutdown()
+    await senderAgent.wallet.delete()
   })
 
   test(`Mediation end-to-end flow

diff --git a/packages/core/src/wallet/IndyWallet.ts b/packages/core/src/wallet/IndyWallet.ts
@@ -14,16 +14,10 @@ import { isIndyError } from '../utils/indyError'
 import { WalletDuplicateError, WalletNotFoundError, WalletError } from './error'
 import { WalletInvalidKeyError } from './error/WalletInvalidKeyError'
 
-export interface IndyOpenWallet {
-  walletHandle: number
-  masterSecretId: string
-  walletConfig: Indy.WalletConfig
-  walletCredentials: Indy.WalletCredentials
-}
-
 @scoped(Lifecycle.ContainerScoped)
 export class IndyWallet implements Wallet {
-  private openWalletInfo?: IndyOpenWallet
+  private walletConfig?: WalletConfig
+  private walletHandle?: number
 
   private logger: Logger
   private publicDidInfo: DidInfo | undefined
@@ -34,32 +28,36 @@ export class IndyWallet implements Wallet {
     this.indy = agentConfig.agentDependencies.indy
   }
 
+  public get isProvisioned() {
+    return this.walletConfig !== undefined
+  }
+
   public get isInitialized() {
-    return this.openWalletInfo !== undefined
+    return this.walletHandle !== undefined
   }
 
   public get publicDid() {
     return this.publicDidInfo
   }
 
   public get handle() {
-    if (!this.isInitialized || !this.openWalletInfo) {
+    if (!this.walletHandle) {
       throw new AriesFrameworkError(
         'Wallet has not been initialized yet. Make sure to await agent.initialize() before using the agent.'
       )
     }
 
-    return this.openWalletInfo.walletHandle
+    return this.walletHandle
   }
 
   public get masterSecretId() {
-    if (!this.isInitialized || !this.openWalletInfo) {
+    if (!this.isInitialized || !this.walletConfig?.id) {
       throw new AriesFrameworkError(
         'Wallet has not been initialized yet. Make sure to await agent.initialize() before using the agent.'
       )
     }
 
-    return this.openWalletInfo.masterSecretId
+    return this.walletConfig.id
   }
 
   public async initialize(walletConfig: WalletConfig) {
@@ -96,6 +94,20 @@ export class IndyWallet implements Wallet {
 
     try {
       await this.indy.createWallet({ id: walletConfig.id }, { key: walletConfig.key })
+
+      this.walletConfig = {
+        id: walletConfig.id,
+        key: walletConfig.key,
+      }
+
+      // We usually want to create master secret only once, therefore, we can to do so when creating a wallet.
+      await this.open(walletConfig)
+
+      // We need to open wallet before creating master secret because we need wallet handle here.
+      await this.createMasterSecret(this.handle, walletConfig.id)
+
+      // We opened wallet just to create master secret, we can close it now.
+      await this.close()
     } catch (error) {
       if (isIndyError(error, 'WalletAlreadyExistsError')) {
         const errorMessage = `Wallet '${walletConfig.id}' already exists`
@@ -122,21 +134,17 @@ export class IndyWallet implements Wallet {
    * @throws {WalletError} if another error occurs
    */
   public async open(walletConfig: WalletConfig): Promise<void> {
-    if (this.isInitialized) {
+    if (this.walletHandle) {
       throw new WalletError(
-        'Wallet instance already initialized. Close the currently opened wallet before re-initializing the wallet'
+        'Wallet instance already opened. Close the currently opened wallet before re-opening the wallet'
       )
     }
 
     try {
-      const walletHandle = await this.indy.openWallet({ id: walletConfig.id }, { key: walletConfig.key })
-      const masterSecretId = await this.createMasterSecret(walletHandle, walletConfig.id)
-
-      this.openWalletInfo = {
-        walletConfig: { id: walletConfig.id },
-        walletCredentials: { key: walletConfig.key },
-        walletHandle,
-        masterSecretId,
+      this.walletHandle = await this.indy.openWallet({ id: walletConfig.id }, { key: walletConfig.key })
+      this.walletConfig = {
+        id: walletConfig.id,
+        key: walletConfig.key,
       }
     } catch (error) {
       if (isIndyError(error, 'WalletNotFoundError')) {
@@ -171,31 +179,31 @@ export class IndyWallet implements Wallet {
    * @throws {WalletError} if another error occurs
    */
   public async delete(): Promise<void> {
-    const walletInfo = this.openWalletInfo
-
-    if (!this.isInitialized || !walletInfo) {
+    if (!this.walletConfig) {
       throw new WalletError(
-        'Can not delete wallet that is not initialized. Make sure to call initialize before deleting the wallet'
+        'Can not delete wallet that does not have wallet config set. Make sure to call create wallet before deleting the wallet'
       )
     }
 
-    this.logger.info(`Deleting wallet '${walletInfo.walletConfig.id}'`)
+    this.logger.info(`Deleting wallet '${this.walletConfig.id}'`)
 
-    await this.close()
+    if (this.walletHandle) {
+      await this.close()
+    }
 
     try {
-      await this.indy.deleteWallet(walletInfo.walletConfig, walletInfo.walletCredentials)
+      await this.indy.deleteWallet({ id: this.walletConfig.id }, { key: this.walletConfig.key })
     } catch (error) {
       if (isIndyError(error, 'WalletNotFoundError')) {
-        const errorMessage = `Error deleting wallet: wallet '${walletInfo.walletConfig.id}' not found`
+        const errorMessage = `Error deleting wallet: wallet '${this.walletConfig.id}' not found`
         this.logger.debug(errorMessage)
 
         throw new WalletNotFoundError(errorMessage, {
           walletType: 'IndyWallet',
           cause: error,
         })
       } else {
-        const errorMessage = `Error deleting wallet '${walletInfo.walletConfig.id}': ${error.message}`
+        const errorMessage = `Error deleting wallet '${this.walletConfig.id}': ${error.message}`
         this.logger.error(errorMessage, {
           error,
           errorMessage: error.message,
@@ -210,9 +218,13 @@ export class IndyWallet implements Wallet {
    * @throws {WalletError} if the wallet is already closed or another error occurs
    */
   public async close(): Promise<void> {
+    if (!this.walletHandle) {
+      throw new WalletError('Wallet is in inavlid state, you are trying to close wallet that has no `walletHandle`.')
+    }
+
     try {
-      await this.indy.closeWallet(this.handle)
-      this.openWalletInfo = undefined
+      await this.indy.closeWallet(this.walletHandle)
+      this.walletHandle = undefined
       this.publicDidInfo = undefined
     } catch (error) {
       if (isIndyError(error, 'WalletInvalidHandle')) {

diff --git a/packages/core/src/wallet/Wallet.ts b/packages/core/src/wallet/Wallet.ts
@@ -4,8 +4,11 @@ import type { Buffer } from '../utils/buffer'
 export interface Wallet {
   publicDid: DidInfo | undefined
   isInitialized: boolean
+  isProvisioned: boolean
 
   initialize(walletConfig: WalletConfig): Promise<void>
+  create(walletConfig: WalletConfig): Promise<void>
+  open(walletConfig: WalletConfig): Promise<void>
   close(): Promise<void>
   delete(): Promise<void>
 

diff --git a/packages/core/tests/agents.test.ts b/packages/core/tests/agents.test.ts
@@ -23,13 +23,10 @@ describe('agents', () => {
   let bobConnection: ConnectionRecord
 
   afterAll(async () => {
-    await bobAgent.shutdown({
-      deleteWallet: true,
-    })
-
-    await aliceAgent.shutdown({
-      deleteWallet: true,
-    })
+    await bobAgent.shutdown()
+    await bobAgent.wallet.delete()
+    await aliceAgent.shutdown()
+    await aliceAgent.wallet.delete()
   })
 
   test('make a connection between agents', async () => {

diff --git a/packages/core/tests/connectionless-credentials.test.ts b/packages/core/tests/connectionless-credentials.test.ts
@@ -70,8 +70,10 @@ describe('credentials', () => {
   })
 
   afterEach(async () => {
-    await faberAgent.shutdown({ deleteWallet: true })
-    await aliceAgent.shutdown({ deleteWallet: true })
+    await faberAgent.shutdown()
+    await faberAgent.wallet.delete()
+    await aliceAgent.shutdown()
+    await aliceAgent.wallet.delete()
   })
 
   test('Faber starts with connection-less credential offer to Alice', async () => {

diff --git a/packages/core/tests/connections.test.ts b/packages/core/tests/connections.test.ts
@@ -40,12 +40,10 @@ describe('connections', () => {
   })
 
   afterAll(async () => {
-    await faberAgent.shutdown({
-      deleteWallet: true,
-    })
-    await aliceAgent.shutdown({
-      deleteWallet: true,
-    })
+    await faberAgent.shutdown()
+    await faberAgent.wallet.delete()
+    await aliceAgent.shutdown()
+    await aliceAgent.wallet.delete()
   })
 
   it('should be able to make multiple connections using a multi use invite', async () => {

diff --git a/packages/core/tests/credentials-auto-accept.test.ts b/packages/core/tests/credentials-auto-accept.test.ts
@@ -39,12 +39,10 @@ describe('auto accept credentials', () => {
     })
 
     afterAll(async () => {
-      await aliceAgent.shutdown({
-        deleteWallet: true,
-      })
-      await faberAgent.shutdown({
-        deleteWallet: true,
-      })
+      await faberAgent.shutdown()
+      await faberAgent.wallet.delete()
+      await aliceAgent.shutdown()
+      await aliceAgent.wallet.delete()
     })
 
     test('Alice starts with credential proposal to Faber, both with autoAcceptCredential on `always`', async () => {
@@ -163,12 +161,10 @@ describe('auto accept credentials', () => {
     })
 
     afterAll(async () => {
-      await aliceAgent.shutdown({
-        deleteWallet: true,
-      })
-      await faberAgent.shutdown({
-        deleteWallet: true,
-      })
+      await faberAgent.shutdown()
+      await faberAgent.wallet.delete()
+      await aliceAgent.shutdown()
+      await aliceAgent.wallet.delete()
     })
 
     test('Alice starts with credential proposal to Faber, both with autoAcceptCredential on `contentApproved`', async () => {