Complete remove recovery methods

Author: Agusx1211

packages/wallet/wdk/src/sequence/manager.ts

@@ -500,4 +500,20 @@ export class Manager {
   public async completeRecoveryPayload(requestId: string) {
     return this.shared.modules.recovery.completeRecoveryPayload(requestId)
   }
+
+  public async addRecoveryMnemonic(wallet: Address.Address, mnemonic: string) {
+    return this.shared.modules.recovery.addRecoveryMnemonic(wallet, mnemonic)
+  }
+
+  public async addRecoverySigner(wallet: Address.Address, address: Address.Address) {
+    return this.shared.modules.recovery.addRecoverySigner(wallet, address)
+  }
+
+  public async removeRecoverySigner(wallet: Address.Address, address: Address.Address) {
+    return this.shared.modules.recovery.removeRecoverySigner(wallet, address)
+  }
+
+  public async completeRecoveryUpdate(requestId: string) {
+    return this.shared.modules.recovery.completeRecoveryUpdate(requestId)
+  }
 }

packages/wallet/wdk/src/sequence/recovery.ts

@@ -1,10 +1,11 @@
 import { Config, Extensions, GenericTree, Payload } from '@0xsequence/wallet-primitives'
 import { Shared } from './manager.js'
 import { Address, Hex, Provider, RpcTransport } from 'ox'
-import { RecoverySigner } from './types/signer.js'
+import { Kinds, RecoverySigner } from './types/signer.js'
 import { Envelope } from '@0xsequence/wallet-core'
 import { QueuedRecoveryPayload } from './types/recovery.js'
 import { Actions } from './types/index.js'
+import { MnemonicHandler } from './handlers/mnemonic.js'
 
 export class Recovery {
   constructor(private readonly shared: Shared) {}
@@ -31,7 +32,12 @@ export class Recovery {
       return
     }
 
-    const genericTree = await this.shared.sequence.stateProvider.getTree(ext)
+    const sapientSigner = modules[idx]
+    if (!sapientSigner) {
+      throw new Error('recovery-module-not-found')
+    }
+
+    const genericTree = await this.shared.sequence.stateProvider.getTree(sapientSigner.imageHash)
     if (!genericTree) {
       throw new Error('recovery-module-tree-not-found')
     }
@@ -129,11 +135,25 @@ export class Recovery {
     })
   }
 
-  async addRecoverySigner(address: Address.Address) {
-    const { modules } = await this.shared.modules.wallets.getConfigurationParts(address)
+  async addRecoveryMnemonic(wallet: Address.Address, mnemonic: string) {
+    const signer = MnemonicHandler.toSigner(mnemonic)
+    if (!signer) {
+      throw new Error('invalid-mnemonic')
+    }
+
+    await signer.witness(this.shared.sequence.stateProvider, wallet, {
+      isForRecovery: true,
+      signerKind: Kinds.LoginMnemonic,
+    })
+
+    return this.addRecoverySigner(wallet, signer.address)
+  }
+
+  async addRecoverySigner(wallet: Address.Address, address: Address.Address) {
+    const { modules } = await this.shared.modules.wallets.getConfigurationParts(wallet)
     await this.addRecoverySignerToModules(modules, address)
     return this.shared.modules.wallets.requestConfigurationUpdate(
-      address,
+      wallet,
       {
         modules,
       },
@@ -142,17 +162,26 @@ export class Recovery {
     )
   }
 
-  async removeRecoverySigner(address: Address.Address) {
-    const { modules } = await this.shared.modules.wallets.getConfigurationParts(address)
+  async removeRecoverySigner(wallet: Address.Address, address: Address.Address) {
+    const { modules } = await this.shared.modules.wallets.getConfigurationParts(wallet)
     await this.removeRecoverySignerFromModules(modules, address)
     return this.shared.modules.wallets.requestConfigurationUpdate(
-      address,
+      wallet,
       { modules },
       Actions.RemoveRecoverySigner,
       'wallet-webapp',
     )
   }
 
+  async completeRecoveryUpdate(requestId: string) {
+    const request = await this.shared.modules.signatures.get(requestId)
+    if (request.action !== 'add-recovery-signer' && request.action !== 'remove-recovery-signer') {
+      throw new Error('invalid-recovery-update-action')
+    }
+
+    return this.shared.modules.wallets.completeConfigurationUpdate(requestId)
+  }
+
   async getRecoverySigners(address: Address.Address): Promise<RecoverySigner[] | undefined> {
     const { raw } = await this.shared.modules.wallets.getConfiguration({ wallet: address })
     const recoveryLeaf = raw.modules.find((m) => m.address === this.shared.sequence.extensions.recovery)
@@ -171,11 +200,17 @@ export class Recovery {
       throw new Error('recovery-module-tree-incomplete')
     }
 
+    const kos = await this.shared.modules.signers.resolveKinds(
+      address,
+      leaves.map((l) => l.signer),
+    )
+
     return leaves
       .filter((l) => l.signer !== '0x0000000000000000000000000000000000000000')
       .map((l) => ({
         address: l.signer,
-        kind: 'recovery',
+        kind: kos.find((s) => s.address === l.signer)?.kind || 'unknown',
+        isRecovery: true,
         minTimestamp: l.minTimestamp,
         requiredDeltaTime: l.requiredDeltaTime,
       }))

packages/wallet/wdk/src/sequence/types/signer.ts

@@ -3,7 +3,7 @@ import { Address, Hex } from 'ox'
 export const Kinds = {
   LocalDevice: 'local-device',
   LoginPasskey: 'login-passkey',
-  LoginMnemonic: 'login-mnemonic',
+  LoginMnemonic: 'login-mnemonic', // Todo: do not name it login-mnemonic, just mnemonic
   LoginEmailOtp: 'login-email-otp',
   LoginGooglePkce: 'login-google-pkce',
   LoginApplePkce: 'login-apple-pkce',
@@ -23,7 +23,8 @@ export type SignerWithKind = {
 }
 
 export type RecoverySigner = {
-  kind: 'recovery'
+  kind: Kind
+  isRecovery: true
   address: Address.Address
   minTimestamp: bigint
   requiredDeltaTime: bigint

packages/wallet/wdk/src/sequence/wallets.ts

@@ -543,6 +543,26 @@ export class Wallets {
     return requestId
   }
 
+  public async completeConfigurationUpdate(requestId: string) {
+    const request = await this.shared.modules.signatures.get(requestId)
+    if (!Payload.isConfigUpdate(request.envelope.payload)) {
+      throw new Error('invalid-request-payload')
+    }
+
+    if (!Envelope.reachedThreshold(request.envelope)) {
+      throw new Error('insufficient-weight')
+    }
+
+    const wallet = new CoreWallet(request.wallet, {
+      context: this.shared.sequence.context,
+      stateProvider: this.shared.sequence.stateProvider,
+      guest: this.shared.sequence.guest,
+    })
+
+    await wallet.submitUpdate(request.envelope as Envelope.Signed<Payload.ConfigUpdate>)
+    await this.shared.modules.signatures.complete(requestId)
+  }
+
   async login(args: LoginArgs): Promise<string | undefined> {
     if (isLoginToWalletArgs(args)) {
       const prevWallet = await this.exists(args.wallet)
@@ -642,28 +662,12 @@ export class Wallets {
   async completeLogin(requestId: string) {
     const request = await this.shared.modules.signatures.get(requestId)
 
-    const envelope = request.envelope
-    if (!Payload.isConfigUpdate(envelope.payload)) {
-      throw new Error('invalid-request-payload')
-    }
-
-    if (!Envelope.reachedThreshold(envelope)) {
-      throw new Error('insufficient-weight')
-    }
-
     const walletEntry = await this.shared.databases.manager.get(request.wallet)
     if (!walletEntry) {
       throw new Error('login-for-wallet-not-found')
     }
 
-    const wallet = new CoreWallet(request.wallet, {
-      context: this.shared.sequence.context,
-      stateProvider: this.shared.sequence.stateProvider,
-      guest: this.shared.sequence.guest,
-    })
-
-    await wallet.submitUpdate(envelope as Envelope.Signed<Payload.ConfigUpdate>)
-    await this.shared.modules.signatures.complete(requestId)
+    await this.completeConfigurationUpdate(requestId)
 
     // Save entry in the manager db
     await this.shared.databases.manager.set({
@@ -731,10 +735,6 @@ export class Wallets {
 
   async completeLogout(requestId: string, options?: { skipValidateSave?: boolean }) {
     const request = await this.shared.modules.signatures.get(requestId)
-    if (!Payload.isConfigUpdate(request.envelope.payload)) {
-      throw new Error('invalid-request-payload')
-    }
-
     const walletEntry = await this.shared.databases.manager.get(request.wallet)
     if (!walletEntry) {
       throw new Error('wallet-not-found')
@@ -747,17 +747,7 @@ export class Wallets {
       )
     }
 
-    const wallet = new CoreWallet(request.wallet, {
-      context: this.shared.sequence.context,
-      stateProvider: this.shared.sequence.stateProvider,
-      guest: this.shared.sequence.guest,
-    })
-
-    await wallet.submitUpdate(request.envelope as Envelope.Signed<Payload.ConfigUpdate>, {
-      validateSave: !options?.skipValidateSave,
-    })
-
-    await this.shared.modules.signatures.complete(requestId)
+    await this.completeConfigurationUpdate(requestId)
     await this.shared.databases.manager.del(request.wallet)
     await this.shared.modules.devices.remove(walletEntry.device)
   }