@0xsequence/guard 0.0.0-20231027021244 → 0.0.0-20231102200515

package/dist/0xsequence-guard.cjs.dev.js

@@ -21,7 +21,7 @@ function _extends() {
 }
 
 /* eslint-disable */
-// sequence-guard v0.4.0 b3da61e22d917265bc35085a92b4173ea096a0c8
+// sequence-guard v0.4.0 af5ad0623aec0b231a462052edaea1823f620a1e
 // --
 // Code generated by webrpc-gen@v0.12.x-dev with typescript@v0.10.0 generator. DO NOT EDIT.
 //
@@ -34,7 +34,7 @@ const WebRPCVersion = 'v1';
 const WebRPCSchemaVersion = 'v0.4.0';
 
 // Schema hash generated from your RIDL schema
-const WebRPCSchemaHash = 'b3da61e22d917265bc35085a92b4173ea096a0c8';
+const WebRPCSchemaHash = 'af5ad0623aec0b231a462052edaea1823f620a1e';
 
 //
 // Types
@@ -134,7 +134,9 @@ class Guard {
     this.commitTOTP = (args, headers) => {
       return this.fetch(this.url('CommitTOTP'), createHTTPRequest(args, headers)).then(res => {
         return buildResponse(res).then(_data => {
-          return {};
+          return {
+            codes: _data.codes
+          };
         });
       });
     };
@@ -183,35 +185,59 @@ const buildResponse = res => {
 
 const fetch = typeof global === 'object' ? global.fetch : window.fetch;
 class GuardSigner {
-  constructor(address, url, appendSuffix = false, onError) {
-    this.requests = new Map();
+  constructor(address, url, appendSuffix = false) {
     this.address = address;
     this.url = url;
     this.appendSuffix = appendSuffix;
-    this.onError = onError;
     this.guard = new Guard(url, fetch);
   }
   async getAddress() {
     return this.address;
   }
-  async requestSignature(id, _message, metadata, callbacks) {
+  async requestSignature(_id, message, metadata, callbacks) {
+    const {
+      onSignature,
+      onRejection
+    } = callbacks;
     if (!core.commons.isWalletSignRequestMetadata(metadata)) {
-      callbacks.onRejection('Expected Sequence-like metadata');
-    } else {
-      // Queue the request first, this method only does that
-      // the requesting to the API is later handled on every status change
-      this.requests.set(id, callbacks);
+      onRejection('expected sequence signature request metadata');
+      return false;
     }
-    return true;
-  }
-  notifyStatusChange(id, status, metadata) {
-    if (!this.requests.has(id)) return;
-    if (!core.commons.isWalletSignRequestMetadata(metadata)) {
-      this.requests.get(id).onRejection('Expected Sequence-like metadata (status update)');
-      return;
+    try {
+      var _metadata$parts;
+      const guardTotpCode = metadata.guardTotpCode;
+
+      // Building auxData, notice: this uses the old v1 format
+      // TODO: We should update the guard API so we can pass the metadata directly
+      const coder = core.universal.genericCoderFor(metadata.config.version);
+      const {
+        encoded
+      } = coder.signature.encodeSigners(metadata.config, (_metadata$parts = metadata.parts) != null ? _metadata$parts : new Map(), [], metadata.chainId);
+      const {
+        sig: signature
+      } = await this.guard.signWith({
+        signer: this.address,
+        request: {
+          msg: ethers.ethers.utils.hexlify(message),
+          auxData: this.packMsgAndSig(metadata.address, metadata.digest, encoded, metadata.chainId),
+          chainId: ethers.ethers.BigNumber.from(metadata.chainId).toNumber()
+        },
+        token: guardTotpCode ? {
+          id: AuthMethod.TOTP,
+          token: guardTotpCode
+        } : undefined
+      });
+      if (ethers.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}`);
+      return false;
     }
-    this.evaluateRequest(id, status.message, status, metadata);
   }
+  notifyStatusChange(_id, _status, _metadata) {}
   async getAuthMethods(token) {
     let response;
     if ('jwt' in token) {
@@ -263,11 +289,14 @@ class GuardSigner {
     return new URL(uri);
   }
   async commitTotp(token, jwt) {
-    await this.guard.commitTOTP({
+    const {
+      codes
+    } = await this.guard.commitTOTP({
       token
     }, {
       Authorization: `BEARER ${jwt}`
     });
+    return codes;
   }
   async resetTotp(token) {
     const signedToken = await signUpdateAuthMethodToken(token);
@@ -281,50 +310,6 @@ class GuardSigner {
   packMsgAndSig(address, msg, sig, chainId) {
     return ethers.ethers.utils.defaultAbiCoder.encode(['address', 'uint256', 'bytes', 'bytes'], [address, chainId, msg, sig]);
   }
-  keyOfRequest(signer, msg, auxData, chainId) {
-    return ethers.ethers.utils.solidityKeccak256(['address', 'uint256', 'bytes', 'bytes'], [signer, chainId, msg, auxData]);
-  }
-  async evaluateRequest(id, message, _, metadata) {
-    var _metadata$parts;
-    // Building auxData, notice: this uses the old v1 format
-    // TODO: We should update the guard API so we can pass the metadata directly
-    const coder = core.universal.genericCoderFor(metadata.config.version);
-    const {
-      encoded
-    } = coder.signature.encodeSigners(metadata.config, (_metadata$parts = metadata.parts) != null ? _metadata$parts : new Map(), [], metadata.chainId);
-    try {
-      var _this$requests$get;
-      const key = this.keyOfRequest(this.address, message, encoded, metadata.chainId);
-      const lastAttempt = (_this$requests$get = this.requests.get(id)) == null ? void 0 : _this$requests$get.lastAttempt;
-      if (lastAttempt === key) {
-        return;
-      }
-      this.requests.get(id).lastAttempt = key;
-      const result = await this.guard.signWith({
-        signer: this.address,
-        request: {
-          msg: ethers.ethers.utils.hexlify(message),
-          auxData: this.packMsgAndSig(metadata.address, metadata.digest, encoded, metadata.chainId),
-          chainId: ethers.ethers.BigNumber.from(metadata.chainId).toNumber() // TODO: This should be a string (in the API)
-        },
-
-        token: metadata.guardTotpCode ? {
-          id: AuthMethod.TOTP,
-          token: metadata.guardTotpCode
-        } : undefined
-      });
-      if (ethers.ethers.utils.arrayify(result.sig).length !== 0) {
-        this.requests.get(id).onSignature(result.sig);
-        this.requests.delete(id);
-      }
-    } catch (e) {
-      var _this$onError;
-      // The guard signer may reject the request for a number of reasons
-      // like for example, if it's being the first signer (it waits for other signers to sign first)
-      // We always forward the error here and filter on client side.
-      (_this$onError = this.onError) == null ? void 0 : _this$onError.call(this, e);
-    }
-  }
   suffix() {
     return this.appendSuffix ? [3] : [];
   }

package/dist/0xsequence-guard.cjs.prod.js

@@ -21,7 +21,7 @@ function _extends() {
 }
 
 /* eslint-disable */
-// sequence-guard v0.4.0 b3da61e22d917265bc35085a92b4173ea096a0c8
+// sequence-guard v0.4.0 af5ad0623aec0b231a462052edaea1823f620a1e
 // --
 // Code generated by webrpc-gen@v0.12.x-dev with typescript@v0.10.0 generator. DO NOT EDIT.
 //
@@ -34,7 +34,7 @@ const WebRPCVersion = 'v1';
 const WebRPCSchemaVersion = 'v0.4.0';
 
 // Schema hash generated from your RIDL schema
-const WebRPCSchemaHash = 'b3da61e22d917265bc35085a92b4173ea096a0c8';
+const WebRPCSchemaHash = 'af5ad0623aec0b231a462052edaea1823f620a1e';
 
 //
 // Types
@@ -134,7 +134,9 @@ class Guard {
     this.commitTOTP = (args, headers) => {
       return this.fetch(this.url('CommitTOTP'), createHTTPRequest(args, headers)).then(res => {
         return buildResponse(res).then(_data => {
-          return {};
+          return {
+            codes: _data.codes
+          };
         });
       });
     };
@@ -183,35 +185,59 @@ const buildResponse = res => {
 
 const fetch = typeof global === 'object' ? global.fetch : window.fetch;
 class GuardSigner {
-  constructor(address, url, appendSuffix = false, onError) {
-    this.requests = new Map();
+  constructor(address, url, appendSuffix = false) {
     this.address = address;
     this.url = url;
     this.appendSuffix = appendSuffix;
-    this.onError = onError;
     this.guard = new Guard(url, fetch);
   }
   async getAddress() {
     return this.address;
   }
-  async requestSignature(id, _message, metadata, callbacks) {
+  async requestSignature(_id, message, metadata, callbacks) {
+    const {
+      onSignature,
+      onRejection
+    } = callbacks;
     if (!core.commons.isWalletSignRequestMetadata(metadata)) {
-      callbacks.onRejection('Expected Sequence-like metadata');
-    } else {
-      // Queue the request first, this method only does that
-      // the requesting to the API is later handled on every status change
-      this.requests.set(id, callbacks);
+      onRejection('expected sequence signature request metadata');
+      return false;
     }
-    return true;
-  }
-  notifyStatusChange(id, status, metadata) {
-    if (!this.requests.has(id)) return;
-    if (!core.commons.isWalletSignRequestMetadata(metadata)) {
-      this.requests.get(id).onRejection('Expected Sequence-like metadata (status update)');
-      return;
+    try {
+      var _metadata$parts;
+      const guardTotpCode = metadata.guardTotpCode;
+
+      // Building auxData, notice: this uses the old v1 format
+      // TODO: We should update the guard API so we can pass the metadata directly
+      const coder = core.universal.genericCoderFor(metadata.config.version);
+      const {
+        encoded
+      } = coder.signature.encodeSigners(metadata.config, (_metadata$parts = metadata.parts) != null ? _metadata$parts : new Map(), [], metadata.chainId);
+      const {
+        sig: signature
+      } = await this.guard.signWith({
+        signer: this.address,
+        request: {
+          msg: ethers.ethers.utils.hexlify(message),
+          auxData: this.packMsgAndSig(metadata.address, metadata.digest, encoded, metadata.chainId),
+          chainId: ethers.ethers.BigNumber.from(metadata.chainId).toNumber()
+        },
+        token: guardTotpCode ? {
+          id: AuthMethod.TOTP,
+          token: guardTotpCode
+        } : undefined
+      });
+      if (ethers.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}`);
+      return false;
     }
-    this.evaluateRequest(id, status.message, status, metadata);
   }
+  notifyStatusChange(_id, _status, _metadata) {}
   async getAuthMethods(token) {
     let response;
     if ('jwt' in token) {
@@ -263,11 +289,14 @@ class GuardSigner {
     return new URL(uri);
   }
   async commitTotp(token, jwt) {
-    await this.guard.commitTOTP({
+    const {
+      codes
+    } = await this.guard.commitTOTP({
       token
     }, {
       Authorization: `BEARER ${jwt}`
     });
+    return codes;
   }
   async resetTotp(token) {
     const signedToken = await signUpdateAuthMethodToken(token);
@@ -281,50 +310,6 @@ class GuardSigner {
   packMsgAndSig(address, msg, sig, chainId) {
     return ethers.ethers.utils.defaultAbiCoder.encode(['address', 'uint256', 'bytes', 'bytes'], [address, chainId, msg, sig]);
   }
-  keyOfRequest(signer, msg, auxData, chainId) {
-    return ethers.ethers.utils.solidityKeccak256(['address', 'uint256', 'bytes', 'bytes'], [signer, chainId, msg, auxData]);
-  }
-  async evaluateRequest(id, message, _, metadata) {
-    var _metadata$parts;
-    // Building auxData, notice: this uses the old v1 format
-    // TODO: We should update the guard API so we can pass the metadata directly
-    const coder = core.universal.genericCoderFor(metadata.config.version);
-    const {
-      encoded
-    } = coder.signature.encodeSigners(metadata.config, (_metadata$parts = metadata.parts) != null ? _metadata$parts : new Map(), [], metadata.chainId);
-    try {
-      var _this$requests$get;
-      const key = this.keyOfRequest(this.address, message, encoded, metadata.chainId);
-      const lastAttempt = (_this$requests$get = this.requests.get(id)) == null ? void 0 : _this$requests$get.lastAttempt;
-      if (lastAttempt === key) {
-        return;
-      }
-      this.requests.get(id).lastAttempt = key;
-      const result = await this.guard.signWith({
-        signer: this.address,
-        request: {
-          msg: ethers.ethers.utils.hexlify(message),
-          auxData: this.packMsgAndSig(metadata.address, metadata.digest, encoded, metadata.chainId),
-          chainId: ethers.ethers.BigNumber.from(metadata.chainId).toNumber() // TODO: This should be a string (in the API)
-        },
-
-        token: metadata.guardTotpCode ? {
-          id: AuthMethod.TOTP,
-          token: metadata.guardTotpCode
-        } : undefined
-      });
-      if (ethers.ethers.utils.arrayify(result.sig).length !== 0) {
-        this.requests.get(id).onSignature(result.sig);
-        this.requests.delete(id);
-      }
-    } catch (e) {
-      var _this$onError;
-      // The guard signer may reject the request for a number of reasons
-      // like for example, if it's being the first signer (it waits for other signers to sign first)
-      // We always forward the error here and filter on client side.
-      (_this$onError = this.onError) == null ? void 0 : _this$onError.call(this, e);
-    }
-  }
   suffix() {
     return this.appendSuffix ? [3] : [];
   }

package/dist/0xsequence-guard.esm.js

@@ -17,7 +17,7 @@ function _extends() {
 }
 
 /* eslint-disable */
-// sequence-guard v0.4.0 b3da61e22d917265bc35085a92b4173ea096a0c8
+// sequence-guard v0.4.0 af5ad0623aec0b231a462052edaea1823f620a1e
 // --
 // Code generated by webrpc-gen@v0.12.x-dev with typescript@v0.10.0 generator. DO NOT EDIT.
 //
@@ -30,7 +30,7 @@ const WebRPCVersion = 'v1';
 const WebRPCSchemaVersion = 'v0.4.0';
 
 // Schema hash generated from your RIDL schema
-const WebRPCSchemaHash = 'b3da61e22d917265bc35085a92b4173ea096a0c8';
+const WebRPCSchemaHash = 'af5ad0623aec0b231a462052edaea1823f620a1e';
 
 //
 // Types
@@ -130,7 +130,9 @@ class Guard {
     this.commitTOTP = (args, headers) => {
       return this.fetch(this.url('CommitTOTP'), createHTTPRequest(args, headers)).then(res => {
         return buildResponse(res).then(_data => {
-          return {};
+          return {
+            codes: _data.codes
+          };
         });
       });
     };
@@ -179,35 +181,59 @@ const buildResponse = res => {
 
 const fetch = typeof global === 'object' ? global.fetch : window.fetch;
 class GuardSigner {
-  constructor(address, url, appendSuffix = false, onError) {
-    this.requests = new Map();
+  constructor(address, url, appendSuffix = false) {
     this.address = address;
     this.url = url;
     this.appendSuffix = appendSuffix;
-    this.onError = onError;
     this.guard = new Guard(url, fetch);
   }
   async getAddress() {
     return this.address;
   }
-  async requestSignature(id, _message, metadata, callbacks) {
+  async requestSignature(_id, message, metadata, callbacks) {
+    const {
+      onSignature,
+      onRejection
+    } = callbacks;
     if (!commons.isWalletSignRequestMetadata(metadata)) {
-      callbacks.onRejection('Expected Sequence-like metadata');
-    } else {
-      // Queue the request first, this method only does that
-      // the requesting to the API is later handled on every status change
-      this.requests.set(id, callbacks);
+      onRejection('expected sequence signature request metadata');
+      return false;
     }
-    return true;
-  }
-  notifyStatusChange(id, status, metadata) {
-    if (!this.requests.has(id)) return;
-    if (!commons.isWalletSignRequestMetadata(metadata)) {
-      this.requests.get(id).onRejection('Expected Sequence-like metadata (status update)');
-      return;
+    try {
+      var _metadata$parts;
+      const guardTotpCode = metadata.guardTotpCode;
+
+      // Building auxData, notice: this uses the old v1 format
+      // TODO: We should update the guard API so we can pass the metadata directly
+      const coder = universal.genericCoderFor(metadata.config.version);
+      const {
+        encoded
+      } = coder.signature.encodeSigners(metadata.config, (_metadata$parts = metadata.parts) != null ? _metadata$parts : new Map(), [], metadata.chainId);
+      const {
+        sig: signature
+      } = await this.guard.signWith({
+        signer: this.address,
+        request: {
+          msg: ethers.utils.hexlify(message),
+          auxData: this.packMsgAndSig(metadata.address, metadata.digest, encoded, metadata.chainId),
+          chainId: ethers.BigNumber.from(metadata.chainId).toNumber()
+        },
+        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}`);
+      return false;
     }
-    this.evaluateRequest(id, status.message, status, metadata);
   }
+  notifyStatusChange(_id, _status, _metadata) {}
   async getAuthMethods(token) {
     let response;
     if ('jwt' in token) {
@@ -259,11 +285,14 @@ class GuardSigner {
     return new URL(uri);
   }
   async commitTotp(token, jwt) {
-    await this.guard.commitTOTP({
+    const {
+      codes
+    } = await this.guard.commitTOTP({
       token
     }, {
       Authorization: `BEARER ${jwt}`
     });
+    return codes;
   }
   async resetTotp(token) {
     const signedToken = await signUpdateAuthMethodToken(token);
@@ -277,50 +306,6 @@ class GuardSigner {
   packMsgAndSig(address, msg, sig, chainId) {
     return ethers.utils.defaultAbiCoder.encode(['address', 'uint256', 'bytes', 'bytes'], [address, chainId, msg, sig]);
   }
-  keyOfRequest(signer, msg, auxData, chainId) {
-    return ethers.utils.solidityKeccak256(['address', 'uint256', 'bytes', 'bytes'], [signer, chainId, msg, auxData]);
-  }
-  async evaluateRequest(id, message, _, metadata) {
-    var _metadata$parts;
-    // Building auxData, notice: this uses the old v1 format
-    // TODO: We should update the guard API so we can pass the metadata directly
-    const coder = universal.genericCoderFor(metadata.config.version);
-    const {
-      encoded
-    } = coder.signature.encodeSigners(metadata.config, (_metadata$parts = metadata.parts) != null ? _metadata$parts : new Map(), [], metadata.chainId);
-    try {
-      var _this$requests$get;
-      const key = this.keyOfRequest(this.address, message, encoded, metadata.chainId);
-      const lastAttempt = (_this$requests$get = this.requests.get(id)) == null ? void 0 : _this$requests$get.lastAttempt;
-      if (lastAttempt === key) {
-        return;
-      }
-      this.requests.get(id).lastAttempt = key;
-      const result = await this.guard.signWith({
-        signer: this.address,
-        request: {
-          msg: ethers.utils.hexlify(message),
-          auxData: this.packMsgAndSig(metadata.address, metadata.digest, encoded, metadata.chainId),
-          chainId: ethers.BigNumber.from(metadata.chainId).toNumber() // TODO: This should be a string (in the API)
-        },
-
-        token: metadata.guardTotpCode ? {
-          id: AuthMethod.TOTP,
-          token: metadata.guardTotpCode
-        } : undefined
-      });
-      if (ethers.utils.arrayify(result.sig).length !== 0) {
-        this.requests.get(id).onSignature(result.sig);
-        this.requests.delete(id);
-      }
-    } catch (e) {
-      var _this$onError;
-      // The guard signer may reject the request for a number of reasons
-      // like for example, if it's being the first signer (it waits for other signers to sign first)
-      // We always forward the error here and filter on client side.
-      (_this$onError = this.onError) == null ? void 0 : _this$onError.call(this, e);
-    }
-  }
   suffix() {
     return this.appendSuffix ? [3] : [];
   }

package/dist/declarations/src/guard.gen.d.ts

@@ -1,6 +1,6 @@
 export declare const WebRPCVersion = "v1";
 export declare const WebRPCSchemaVersion = "v0.4.0";
-export declare const WebRPCSchemaHash = "b3da61e22d917265bc35085a92b4173ea096a0c8";
+export declare const WebRPCSchemaHash = "af5ad0623aec0b231a462052edaea1823f620a1e";
 export interface Version {
     webrpcVersion: string;
     schemaVersion: string;
@@ -38,6 +38,10 @@ export interface AuthToken {
     id: string;
     token: string;
 }
+export interface RecoveryCode {
+    code: string;
+    used: boolean;
+}
 export interface Guard {
     ping(headers?: object): Promise<PingReturn>;
     version(headers?: object): Promise<VersionReturn>;
@@ -118,6 +122,7 @@ export interface CommitTOTPArgs {
     token: string;
 }
 export interface CommitTOTPReturn {
+    codes: Array<RecoveryCode>;
 }
 export interface ResetTOTPArgs {
     timestamp: number;

package/dist/declarations/src/signer.d.ts

@@ -2,30 +2,27 @@ import { Account } from '@0xsequence/account';
 import { signers, Status } from '@0xsequence/signhub';
 import { TypedData } from '@0xsequence/utils';
 import { BytesLike, ethers } from 'ethers';
+import { RecoveryCode } from "./guard.gen.js";
 export declare class GuardSigner implements signers.SapientSigner {
     readonly address: string;
     readonly url: string;
     readonly appendSuffix: boolean;
-    private readonly onError?;
     private guard;
-    private requests;
-    constructor(address: string, url: string, appendSuffix?: boolean, onError?: ((err: Error) => void) | undefined);
+    constructor(address: string, url: string, appendSuffix?: boolean);
     getAddress(): Promise<string>;
-    requestSignature(id: string, _message: BytesLike, metadata: Object, callbacks: {
+    requestSignature(_id: string, message: BytesLike, metadata: Object, callbacks: {
         onSignature: (signature: BytesLike) => void;
         onRejection: (error: string) => void;
         onStatus: (situation: string) => void;
     }): Promise<boolean>;
-    notifyStatusChange(id: string, status: Status, metadata: Object): void;
+    notifyStatusChange(_id: string, _status: Status, _metadata: Object): void;
     getAuthMethods(token: GetAuthMethodsToken): Promise<AuthMethod[]>;
     setPin(pin: string | undefined, token: UpdateAuthMethodToken): Promise<void>;
     resetPin(token: UpdateAuthMethodToken): Promise<void>;
     createTotp(token: UpdateAuthMethodToken): Promise<URL>;
-    commitTotp(token: string, jwt: string): Promise<void>;
+    commitTotp(token: string, jwt: string): Promise<RecoveryCode[]>;
     resetTotp(token: UpdateAuthMethodToken): Promise<void>;
     private packMsgAndSig;
-    private keyOfRequest;
-    private evaluateRequest;
     suffix(): BytesLike;
 }
 export declare enum AuthMethod {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsequence/guard",
-  "version": "0.0.0-20231027021244",
+  "version": "0.0.0-20231102200515",
   "description": "guard sub-package for Sequence",
   "repository": "https://github.com/0xsequence/sequence.js/tree/master/packages/guard",
   "source": "src/index.ts",
@@ -10,10 +10,10 @@
   "license": "Apache-2.0",
   "dependencies": {
     "ethers": "^5.7.2",
-    "@0xsequence/account": "0.0.0-20231027021244",
-    "@0xsequence/signhub": "0.0.0-20231027021244",
-    "@0xsequence/core": "0.0.0-20231027021244",
-    "@0xsequence/utils": "0.0.0-20231027021244"
+    "@0xsequence/account": "0.0.0-20231102200515",
+    "@0xsequence/core": "0.0.0-20231102200515",
+    "@0xsequence/utils": "0.0.0-20231102200515",
+    "@0xsequence/signhub": "0.0.0-20231102200515"
   },
   "files": [
     "src",

package/src/guard.gen.ts

@@ -1,5 +1,5 @@
 /* eslint-disable */
-// sequence-guard v0.4.0 b3da61e22d917265bc35085a92b4173ea096a0c8
+// sequence-guard v0.4.0 af5ad0623aec0b231a462052edaea1823f620a1e
 // --
 // Code generated by webrpc-gen@v0.12.x-dev with typescript@v0.10.0 generator. DO NOT EDIT.
 //
@@ -12,7 +12,7 @@ export const WebRPCVersion = 'v1'
 export const WebRPCSchemaVersion = 'v0.4.0'
 
 // Schema hash generated from your RIDL schema
-export const WebRPCSchemaHash = 'b3da61e22d917265bc35085a92b4173ea096a0c8'
+export const WebRPCSchemaHash = 'af5ad0623aec0b231a462052edaea1823f620a1e'
 
 //
 // Types
@@ -62,6 +62,11 @@ export interface AuthToken {
   token: string
 }
 
+export interface RecoveryCode {
+  code: string
+  used: boolean
+}
+
 export interface Guard {
   ping(headers?: object): Promise<PingReturn>
   version(headers?: object): Promise<VersionReturn>
@@ -148,7 +153,9 @@ export interface CommitTOTPArgs {
   token: string
 }
 
-export interface CommitTOTPReturn {}
+export interface CommitTOTPReturn {
+  codes: Array<RecoveryCode>
+}
 export interface ResetTOTPArgs {
   timestamp: number
   signature: string
@@ -272,7 +279,9 @@ export class Guard implements Guard {
   commitTOTP = (args: CommitTOTPArgs, headers?: object): Promise<CommitTOTPReturn> => {
     return this.fetch(this.url('CommitTOTP'), createHTTPRequest(args, headers)).then(res => {
       return buildResponse(res).then(_data => {
-        return {}
+        return {
+          codes: <Array<RecoveryCode>>_data.codes
+        }
       })
     })
   }

package/src/signer.ts

@@ -3,27 +3,17 @@ import { commons, universal } from '@0xsequence/core'
 import { signers, Status } from '@0xsequence/signhub'
 import { TypedData } from '@0xsequence/utils'
 import { BytesLike, ethers, TypedDataDomain } from 'ethers'
-import { AuthMethodsReturn, Guard } from './guard.gen'
+import { AuthMethodsReturn, Guard, RecoveryCode } from './guard.gen'
 
 const fetch = typeof global === 'object' ? global.fetch : window.fetch
 
 export class GuardSigner implements signers.SapientSigner {
   private guard: Guard
-  private requests: Map<
-    string,
-    {
-      lastAttempt?: string
-      onSignature: (signature: BytesLike) => void
-      onRejection: (error: string) => void
-      onStatus: (situation: string) => void
-    }
-  > = new Map()
 
   constructor(
     public readonly address: string,
     public readonly url: string,
     public readonly appendSuffix: boolean = false,
-    private readonly onError?: (err: Error) => void
   ) {
     this.guard = new Guard(url, fetch)
   }
@@ -33,8 +23,8 @@ export class GuardSigner implements signers.SapientSigner {
   }
 
   async requestSignature(
-    id: string,
-    _message: BytesLike,
+    _id: string,
+    message: BytesLike,
     metadata: Object,
     callbacks: {
       onSignature: (signature: BytesLike) => void
@@ -42,26 +32,44 @@ export class GuardSigner implements signers.SapientSigner {
       onStatus: (situation: string) => void
     }
   ): Promise<boolean> {
+    const { onSignature, onRejection } = callbacks
+
     if (!commons.isWalletSignRequestMetadata(metadata)) {
-      callbacks.onRejection('Expected Sequence-like metadata')
-    } else {
-      // Queue the request first, this method only does that
-      // the requesting to the API is later handled on every status change
-      this.requests.set(id, callbacks)
+      onRejection('expected sequence signature request metadata')
+      return false
     }
 
-    return true
-  }
+    try {
+      const guardTotpCode = (metadata as { guardTotpCode?: string }).guardTotpCode
 
-  notifyStatusChange(id: string, status: Status, metadata: Object): void {
-    if (!this.requests.has(id)) return
+      // Building auxData, notice: this uses the old v1 format
+      // TODO: We should update the guard API so we can pass the metadata directly
+      const coder = universal.genericCoderFor(metadata.config.version)
+      const { encoded } = coder.signature.encodeSigners(metadata.config, metadata.parts ?? new Map(), [], metadata.chainId)
 
-    if (!commons.isWalletSignRequestMetadata(metadata)) {
-      this.requests.get(id)!.onRejection('Expected Sequence-like metadata (status update)')
-      return
+      const { sig: signature } = await this.guard.signWith({
+        signer: this.address,
+        request: {
+          msg: ethers.utils.hexlify(message),
+          auxData: this.packMsgAndSig(metadata.address, metadata.digest, encoded, metadata.chainId),
+          chainId: ethers.BigNumber.from(metadata.chainId).toNumber()
+        },
+        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}`)
+      return false
     }
+  }
 
-    this.evaluateRequest(id, status.message, status, metadata)
+  notifyStatusChange(_id: string, _status: Status, _metadata: Object): void {
   }
 
   async getAuthMethods(token: GetAuthMethodsToken): Promise<AuthMethod[]> {
@@ -108,8 +116,9 @@ export class GuardSigner implements signers.SapientSigner {
     return new URL(uri)
   }
 
-  async commitTotp(token: string, jwt: string): Promise<void> {
-    await this.guard.commitTOTP({ token }, { Authorization: `BEARER ${jwt}` })
+  async commitTotp(token: string, jwt: string): Promise<RecoveryCode[]> {
+    const { codes } = await this.guard.commitTOTP({ token }, { Authorization: `BEARER ${jwt}` })
+    return codes
   }
 
   async resetTotp(token: UpdateAuthMethodToken): Promise<void> {
@@ -125,57 +134,6 @@ export class GuardSigner implements signers.SapientSigner {
     return ethers.utils.defaultAbiCoder.encode(['address', 'uint256', 'bytes', 'bytes'], [address, chainId, msg, sig])
   }
 
-  private keyOfRequest(signer: string, msg: BytesLike, auxData: BytesLike, chainId: ethers.BigNumberish): string {
-    return ethers.utils.solidityKeccak256(['address', 'uint256', 'bytes', 'bytes'], [signer, chainId, msg, auxData])
-  }
-
-  private async evaluateRequest(
-    id: string,
-    message: BytesLike,
-    _: Status,
-    metadata: commons.WalletSignRequestMetadata & { guardTotpCode?: string }
-  ): Promise<void> {
-    // Building auxData, notice: this uses the old v1 format
-    // TODO: We should update the guard API so we can pass the metadata directly
-    const coder = universal.genericCoderFor(metadata.config.version)
-    const { encoded } = coder.signature.encodeSigners(metadata.config, metadata.parts ?? new Map(), [], metadata.chainId)
-
-    try {
-      const key = this.keyOfRequest(this.address, message, encoded, metadata.chainId)
-      const lastAttempt = this.requests.get(id)?.lastAttempt
-      if (lastAttempt === key) {
-        return
-      }
-
-      this.requests.get(id)!.lastAttempt = key
-
-      const result = await this.guard.signWith({
-        signer: this.address,
-        request: {
-          msg: ethers.utils.hexlify(message),
-          auxData: this.packMsgAndSig(metadata.address, metadata.digest, encoded, metadata.chainId),
-          chainId: ethers.BigNumber.from(metadata.chainId).toNumber() // TODO: This should be a string (in the API)
-        },
-        token: metadata.guardTotpCode
-          ? {
-              id: AuthMethod.TOTP,
-              token: metadata.guardTotpCode
-            }
-          : undefined
-      })
-
-      if (ethers.utils.arrayify(result.sig).length !== 0) {
-        this.requests.get(id)!.onSignature(result.sig)
-        this.requests.delete(id)
-      }
-    } catch (e) {
-      // The guard signer may reject the request for a number of reasons
-      // like for example, if it's being the first signer (it waits for other signers to sign first)
-      // We always forward the error here and filter on client side.
-      this.onError?.(e)
-    }
-  }
-
   suffix(): BytesLike {
     return this.appendSuffix ? [3] : []
   }