signhub: SapientSigner.requestSignature -> SapientSigner.sign

Author: attente

packages/account/src/orchestrator/wrapper.ts

@@ -46,16 +46,7 @@ export class AccountOrchestratorWrapper implements signers.SapientSigner {
     return this.account.decorateTransactions(bundle, status)
   }
 
-  async requestSignature(
-    _id: string,
-    message: ethers.utils.BytesLike,
-    metadata: object,
-    callbacks: {
-      onSignature: (signature: ethers.utils.BytesLike) => void
-      onRejection: (error: string) => void
-      onStatus: (situation: string) => void
-    }
-  ): Promise<boolean> {
+  sign(message: ethers.utils.BytesLike, metadata: object): Promise<ethers.utils.BytesLike> {
     if (!commons.isWalletSignRequestMetadata(metadata)) {
       throw new Error('AccountOrchestratorWrapper only supports wallet metadata requests')
     }
@@ -67,14 +58,7 @@ export class AccountOrchestratorWrapper implements signers.SapientSigner {
 
     // For Sequence nested signatures we must use `signDigest` and not `signMessage`
     // otherwise the account will hash the digest and the signature will be invalid.
-    try {
-      callbacks.onSignature(await this.account.signDigest(message, chainId, decorate, cantValidateBehavior, metadata))
-    } catch (err) {
-      callbacks.onRejection('Unable to sign account')
-      return false
-    }
-
-    return true
+    return this.account.signDigest(message, chainId, decorate, cantValidateBehavior, metadata)
   }
 
   notifyStatusChange(_i: string, _s: Status, _m: object): void {}

packages/guard/src/signer.ts

@@ -37,21 +37,9 @@ export class GuardSigner implements signers.SapientSigner {
     return bundle
   }
 
-  async requestSignature(
-    _id: string,
-    message: BytesLike,
-    metadata: object,
-    callbacks: {
-      onSignature: (signature: BytesLike) => void
-      onRejection: (error: string) => void
-      onStatus: (situation: string) => void
-    }
-  ): Promise<boolean> {
-    const { onSignature, onRejection } = callbacks
-
+  async sign(message: BytesLike, metadata: object): Promise<BytesLike> {
     if (!commons.isWalletSignRequestMetadata(metadata)) {
-      onRejection('expected sequence signature request metadata')
-      return false
+      throw new Error('expected sequence signature request metadata')
     }
 
     const guardTotpCode = (metadata as { guardTotpCode?: string }).guardTotpCode
@@ -61,8 +49,8 @@ export class GuardSigner implements signers.SapientSigner {
     const coder = universal.genericCoderFor(metadata.config.version)
     const { encoded } = coder.signature.encodeSigners(metadata.config, metadata.parts ?? new Map(), [], metadata.chainId)
 
-    try {
-      const { sig: signature } = await this.guard.signWith({
+    return (
+      await this.guard.signWith({
         signer: this.address,
         request: {
           msg: ethers.utils.hexlify(message),
@@ -71,17 +59,7 @@ export class GuardSigner implements signers.SapientSigner {
         },
         token: guardTotpCode ? { id: AuthMethod.TOTP, token: guardTotpCode } : undefined
       })
-
-      if (ethers.utils.arrayify(signature).length === 0) {
-        throw new Error('guard response contained no signature data')
-      }
-
-      onSignature(signature)
-      return true
-    } catch (error) {
-      onRejection(`unable to request guard signature: ${error.message ?? error.msg ?? error}`)
-      return false
-    }
+    ).sig
   }
 
   notifyStatusChange(_id: string, _status: Status, _metadata: object): void {}
@@ -248,27 +226,13 @@ async function signOwnershipProof(
     const timestamp = new Date()
     const typedData = getOwnershipProofTypedData(proof.walletAddress, timestamp)
     const digest = encodeTypedDataDigest(typedData)
-    const randomId = ethers.utils.hexlify(ethers.utils.randomBytes(32))
-
-    return new Promise((resolve, reject) =>
-      signer.requestSignature(
-        randomId,
-        digest,
-        {},
-        {
-          onSignature(signature) {
-            resolve({
-              walletAddress: proof.walletAddress,
-              timestamp,
-              signerAddress,
-              signature: ethers.utils.hexlify(signature)
-            })
-          },
-          onRejection: reject,
-          onStatus(_situation) {}
-        }
-      )
-    )
+
+    return {
+      walletAddress: proof.walletAddress,
+      timestamp,
+      signerAddress,
+      signature: ethers.utils.hexlify(await signer.sign(digest, {}))
+    }
   }
 }
 

packages/signhub/src/orchestrator.ts

@@ -190,21 +190,17 @@ export class Orchestrator {
         signers.map(async s => {
           const saddr = await s.getAddress()
           status.signers[saddr] = { situation: InitialSituation }
-          return s.requestSignature(id, message, metadata ?? {}, {
-            onSignature: signature => {
-              const suffix = s.suffix()
-              status.signers[saddr] = { signature, suffix }
-              onStatusUpdate()
-            },
-            onRejection: error => {
-              status.signers[saddr] = { rejected: true, error }
-              onStatusUpdate()
-            },
-            onStatus: situation => {
-              status.signers[saddr] = { situation }
-              onStatusUpdate()
-            }
-          })
+          try {
+            const signature = await s.sign(message, metadata ?? {})
+            const suffix = s.suffix()
+            status.signers[saddr] = { signature, suffix }
+            onStatusUpdate()
+            return true
+          } catch (error) {
+            status.signers[saddr] = { rejected: true, error }
+            onStatusUpdate()
+            return false
+          }
         })
       )
 

packages/signhub/src/signers/signer.ts

@@ -23,16 +23,7 @@ export interface SapientSigner {
   /**
    * Request a signature from the signer.
    */
-  requestSignature(
-    id: string,
-    message: ethers.BytesLike,
-    metadata: object,
-    callbacks: {
-      onSignature: (signature: ethers.BytesLike) => void
-      onRejection: (error: string) => void
-      onStatus: (situation: string) => void
-    }
-  ): Promise<boolean>
+  sign(message: ethers.BytesLike, metadata: object): Promise<ethers.BytesLike>
 
   /**
    * Notify the signer of a status change.
@@ -48,7 +39,7 @@ export function isSapientSigner(signer: ethers.Signer | SapientSigner): signer i
     (signer as SapientSigner).buildDeployTransaction !== undefined &&
     (signer as SapientSigner).predecorateSignedTransactions !== undefined &&
     (signer as SapientSigner).decorateTransactions !== undefined &&
-    (signer as SapientSigner).requestSignature !== undefined &&
+    (signer as SapientSigner).sign !== undefined &&
     (signer as SapientSigner).notifyStatusChange !== undefined
   )
 }

packages/signhub/src/signers/wrapper.ts

@@ -29,18 +29,8 @@ export class SignerWrapper implements SapientSigner {
     return bundle
   }
 
-  async requestSignature(
-    _id: string,
-    message: ethers.BytesLike,
-    _metadata: object,
-    callbacks: {
-      onSignature: (signature: ethers.BytesLike) => void
-      onRejection: (error: string) => void
-      onStatus: (situation: string) => void
-    }
-  ): Promise<boolean> {
-    callbacks.onSignature(await this.signer.signMessage(message))
-    return true
+  sign(message: ethers.utils.BytesLike, metadata: object): Promise<ethers.utils.BytesLike> {
+    return this.signer.signMessage(message)
   }
 
   notifyStatusChange(_i: string, _s: Status, _m: object): void {}