[AUTOMATED] Update: proto/clients/guard.gen.ts (#709)

Co-authored-by: VojtechVitek <[email protected]>

Author: 0xsequence-bot

packages/guard/src/guard.gen.ts

@@ -1,13 +1,13 @@
 /* eslint-disable */
-// sequence-guard v0.4.0 d6b4a3c89539b494875af543fff459df65bb7b9e
+// sequence-guard v0.4.0 776b307c2145ac7a994eec63240acae042c96067
 // --
-// Code generated by webrpc-gen@v0.24.0 with typescript generator. DO NOT EDIT.
+// Code generated by webrpc-gen@v0.25.3 with typescript generator. DO NOT EDIT.
 //
 // webrpc-gen -schema=guard.ridl -target=typescript -client -out=./clients/guard.gen.ts
 
 export const WebrpcHeader = 'Webrpc'
 
-export const WebrpcHeaderValue = 'webrpc@v0.24.0;gen-typescript@v0.16.3;[email protected]'
+export const WebrpcHeaderValue = 'webrpc@v0.25.3;gen-typescript@v0.17.0;[email protected]'
 
 // WebRPC description and code-gen version
 export const WebRPCVersion = 'v1'
@@ -16,7 +16,7 @@ export const WebRPCVersion = 'v1'
 export const WebRPCSchemaVersion = 'v0.4.0'
 
 // Schema hash generated from your RIDL schema
-export const WebRPCSchemaHash = 'd6b4a3c89539b494875af543fff459df65bb7b9e'
+export const WebRPCSchemaHash = '776b307c2145ac7a994eec63240acae042c96067'
 
 type WebrpcGenVersions = {
   webrpcGenVersion: string
@@ -124,17 +124,61 @@ export interface Guard {
   version(headers?: object, signal?: AbortSignal): Promise<VersionReturn>
   runtimeStatus(headers?: object, signal?: AbortSignal): Promise<RuntimeStatusReturn>
   getSignerConfig(args: GetSignerConfigArgs, headers?: object, signal?: AbortSignal): Promise<GetSignerConfigReturn>
+  /**
+   * Called by sequence.app when the user signs in, and signs messages/transactions/migrations.
+   * Requires a valid 2FA token if enabled.
+   */
   sign(args: SignArgs, headers?: object, signal?: AbortSignal): Promise<SignReturn>
   signWith(args: SignWithArgs, headers?: object, signal?: AbortSignal): Promise<SignWithReturn>
+  /**
+   * Internal use only.
+   * Only ever needs to be called once per chain.
+   * Signs a preconfigured payload that the caller has no control over.
+   */
   patch(args: PatchArgs, headers?: object, signal?: AbortSignal): Promise<PatchReturn>
+  /**
+   * Called by sequence.app when it needs to check the user's 2FA.
+   * This happens during sign in, before signing messages and transactions, and when configuring 2FA.
+   * Requires either a valid JWT or a signature by one of the wallet's signers.
+   */
   authMethods(args: AuthMethodsArgs, headers?: object, signal?: AbortSignal): Promise<AuthMethodsReturn>
+  /**
+   * Not currently called. Requires both a JWT and a wallet signature.
+   */
   setPIN(args: SetPINArgs, headers?: object, signal?: AbortSignal): Promise<SetPINReturn>
+  /**
+   * Not currently called. Requires both a JWT and a wallet signature.
+   */
   resetPIN(args: ResetPINArgs, headers?: object, signal?: AbortSignal): Promise<ResetPINReturn>
+  /**
+   * Called by sequence.app when the user configures their 2FA.
+   * Requires both a JWT and a wallet signature.
+   */
   createTOTP(args: CreateTOTPArgs, headers?: object, signal?: AbortSignal): Promise<CreateTOTPReturn>
+  /**
+   * Called by sequence.app when the user configures their 2FA.
+   * Requires both a JWT and a wallet signature.
+   */
   commitTOTP(args: CommitTOTPArgs, headers?: object, signal?: AbortSignal): Promise<CommitTOTPReturn>
+  /**
+   * Called by sequence.app when the user configures their 2FA.
+   * Requires both a JWT and a wallet signature.
+   */
   resetTOTP(args: ResetTOTPArgs, headers?: object, signal?: AbortSignal): Promise<ResetTOTPReturn>
+  /**
+   * Called by sequence.app when the user uses a recovery code.
+   * Requires either a valid JWT or a signature by one of the wallet's signers.
+   */
   reset2FA(args: Reset2FAArgs, headers?: object, signal?: AbortSignal): Promise<Reset2FAReturn>
+  /**
+   * Called by sequence.app when the user is viewing their recovery codes.
+   * Requires both a JWT and a wallet signature.
+   */
   recoveryCodes(args: RecoveryCodesArgs, headers?: object, signal?: AbortSignal): Promise<RecoveryCodesReturn>
+  /**
+   * Called by sequence.app when the user is viewing their recovery codes.
+   * Requires both a JWT and a wallet signature.
+   */
   resetRecoveryCodes(args: ResetRecoveryCodesArgs, headers?: object, signal?: AbortSignal): Promise<ResetRecoveryCodesReturn>
 }