Signer Cleanup Logic (#1368)

* clean up

* await

* mockCleanup

Author: fan-zhang-sv

packages/wallet-sdk/src/CoinbaseWalletProvider.test.ts

@@ -13,7 +13,7 @@ function createProvider() {
 
 const mockHandshake = jest.fn();
 const mockRequest = jest.fn();
-const mockDisconnect = jest.fn();
+const mockCleanup = jest.fn();
 const mockFetchSignerType = jest.spyOn(util, 'fetchSignerType');
 const mockStoreSignerType = jest.spyOn(util, 'storeSignerType');
 const mockLoadSignerType = jest.spyOn(util, 'loadSignerType');
@@ -30,7 +30,7 @@ beforeEach(() => {
       chainId: 1,
       handshake: mockHandshake,
       request: mockRequest,
-      disconnect: mockDisconnect,
+      cleanup: mockCleanup,
     };
   });
 
@@ -148,6 +148,7 @@ describe('Signer configuration', () => {
     expect(mockRequest).toHaveBeenCalledWith(request);
 
     await providerLoadedFromStorage.disconnect();
+    expect(mockCleanup).toHaveBeenCalled();
     expect(provider['signer']).toBeNull();
   });
 
@@ -162,6 +163,7 @@ describe('Signer configuration', () => {
     await provider.request({ method: 'eth_requestAccounts' });
 
     await provider.disconnect();
+    expect(mockCleanup).toHaveBeenCalled();
     expect(provider['signer']).toBeNull();
   });
 });

packages/wallet-sdk/src/CoinbaseWalletProvider.ts

@@ -87,6 +87,7 @@ export class CoinbaseWalletProvider extends ProviderEventEmitter implements Prov
 
   async disconnect() {
     await this.ensureInitialized();
+    await this.signer?.cleanup();
     this.signer = null;
     await clearAllStorage();
     this.emit('disconnect', standardErrors.provider.disconnected('User initiated disconnection'));

packages/wallet-sdk/src/sign/interface.ts

@@ -3,5 +3,5 @@ import { RequestArguments } from ':core/provider/interface';
 export interface Signer {
   handshake(): Promise<void>;
   request(request: RequestArguments): Promise<unknown>;
-  disconnect: () => Promise<void>;
+  cleanup: () => Promise<void>;
 }

packages/wallet-sdk/src/sign/scw/SCWSigner.test.ts

@@ -209,7 +209,7 @@ describe('SCWSigner', () => {
 
   describe('disconnect', () => {
     it('should disconnect successfully', async () => {
-      await signer.disconnect();
+      await signer.cleanup();
 
       expect(storageClearSpy).toHaveBeenCalled();
       expect(mockKeyManager.clear).toHaveBeenCalled();

packages/wallet-sdk/src/sign/scw/SCWSigner.ts

@@ -159,7 +159,7 @@ export class SCWSigner implements Signer {
     return result.value;
   }
 
-  async disconnect() {
+  async cleanup() {
     await this.storage.clear();
     await this.keyManager.clear();
     this.accounts = [];

packages/wallet-sdk/src/sign/walletlink/WalletLinkSigner.test.ts

@@ -47,7 +47,7 @@ describe('LegacyProvider', () => {
     const spy = jest.spyOn(relay, 'resetAndReload');
 
     const provider = createAdapter({ relay });
-    await provider.disconnect();
+    await provider.cleanup();
     expect(spy).toHaveBeenCalled();
   });
 

packages/wallet-sdk/src/sign/walletlink/WalletLinkSigner.ts

@@ -207,7 +207,7 @@ export class WalletLinkSigner implements Signer {
     }
   }
 
-  public async disconnect() {
+  public async cleanup() {
     this.callback = null;
     if (this._relay) {
       this._relay.resetAndReload();