@argent/x-shared 1.31.0 → 1.31.1

package/dist/onchainRecovery/IOnchainRecoveryService.d.ts

@@ -1,11 +1,11 @@
 import { Address } from '../chains/starknet/address';
-import { OnchainRecovery } from './schema';
+import { OnchainRecovery, StartOnchainRecovery } from './schema';
 
 /**
  * IOnchainRecoveryService interface
  */
 export interface IOnchainRecoveryService {
-    startRecovery(address: Address, feeToken: Address, publicKey: string, privateKey: string): Promise<OnchainRecovery>;
+    startRecovery(address: Address, feeToken: Address, publicKey: string, privateKey: string): Promise<StartOnchainRecovery>;
     getRecovery(address: Address, recoveryId?: number): Promise<OnchainRecovery>;
     cancelRecovery(address: Address, feeToken: Address, publicKey: string, privateKey: string): Promise<void>;
 }

package/dist/onchainRecovery/OnchainRecoveryService.d.ts

@@ -1,7 +1,7 @@
 import { Address } from '../chains/starknet/address';
 import { IHttpService } from '../http';
 import { IOnchainRecoveryService } from './IOnchainRecoveryService';
-import { OnchainRecovery } from './schema';
+import { OnchainRecovery, StartOnchainRecovery } from './schema';
 
 /**
  * RecoveryService class implements IRecoveryService interface.
@@ -10,7 +10,29 @@ export declare class OnchainRecoveryService implements IOnchainRecoveryService {
     protected readonly apiBase: string;
     private readonly httpService;
     constructor(apiBase: string, httpService: IHttpService);
-    startRecovery(address: Address, feeToken: Address, publicKey: string, privateKey: string): Promise<OnchainRecovery>;
+    /**
+     * Starts the recovery process for a given address.
+     * @param address - The address to recover.
+     * @param feeToken - The token to be used for the recovery fee.
+     * @param publicKey - The public key of the signer.
+     * @param privateKey - The private key of the signer.
+     * @returns A promise that resolves to the recovery details.
+     */
+    startRecovery(address: Address, feeToken: Address, publicKey: string, privateKey: string): Promise<StartOnchainRecovery>;
+    /**
+     * Retrieves the on-chain recovery details for a given address and recovery ID.
+     * If no recovery ID is provided, it retrieves the latest recovery details.
+     * @param address - The address to retrieve the recovery details for.
+     * @param recoveryId - (Optional) The recovery ID to retrieve the details for. If not provided, retrieves the latest recovery details.
+     * @returns A promise that resolves to the on-chain recovery details.
+     */
     getRecovery(address: Address, recoveryId?: number): Promise<OnchainRecovery>;
-    cancelRecovery(address: Address, feeToken: Address, publicKey: string, privateKey: string): Promise<void>;
+    /**
+     * Cancels the on-chain recovery process for a given address.
+     * @param address - The address for which to cancel the recovery process.
+     * @param publicKey - The public key of the signer.
+     * @param privateKey - The private key of the signer.
+     * @returns A promise that resolves when the recovery process is successfully canceled.
+     */
+    cancelRecovery(address: Address, publicKey: string, privateKey: string): Promise<void>;
 }

package/dist/onchainRecovery/schema.d.ts

@@ -1,5 +1,12 @@
 import { z } from 'zod';
 
+export declare const startOnchainRecoverySchema: z.ZodObject<{
+    recoveryId: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    recoveryId: number;
+}, {
+    recoveryId: number;
+}>;
 export declare const recoveryBodySchema: z.ZodObject<{
     feeToken: z.ZodEffects<z.ZodPipeline<z.ZodString, z.ZodEffects<z.ZodString, string, string>>, `0x${string}`, string>;
     signerSignature: z.ZodObject<{
@@ -55,17 +62,28 @@ export declare const recoveryBodySchema: z.ZodObject<{
 }>;
 export declare const recoveryStatusSchema: z.ZodEnum<["ONGOING", "COMPLETED", "ERROR", "CANCELLED", "AWAITING_FUNDS"]>;
 export declare const onchainRecoverySchema: z.ZodObject<{
-    status: z.ZodEnum<["ONGOING", "COMPLETED", "ERROR", "CANCELLED", "AWAITING_FUNDS"]>;
+    status: z.ZodOptional<z.ZodEnum<["ONGOING", "COMPLETED", "ERROR", "CANCELLED", "AWAITING_FUNDS"]>>;
     recoveryId: z.ZodOptional<z.ZodNumber>;
-    completionTime: z.ZodArray<z.ZodNumber, "many">;
+    completionTime: z.ZodOptional<z.ZodArray<z.ZodNumber, "many">>;
 }, "strip", z.ZodTypeAny, {
-    status: "ONGOING" | "COMPLETED" | "ERROR" | "CANCELLED" | "AWAITING_FUNDS";
-    completionTime: number[];
+    status?: "ONGOING" | "COMPLETED" | "ERROR" | "CANCELLED" | "AWAITING_FUNDS" | undefined;
     recoveryId?: number | undefined;
+    completionTime?: number[] | undefined;
 }, {
-    status: "ONGOING" | "COMPLETED" | "ERROR" | "CANCELLED" | "AWAITING_FUNDS";
-    completionTime: number[];
+    status?: "ONGOING" | "COMPLETED" | "ERROR" | "CANCELLED" | "AWAITING_FUNDS" | undefined;
     recoveryId?: number | undefined;
+    completionTime?: number[] | undefined;
 }>;
-export type RecoveryStatus = z.infer<typeof recoveryStatusSchema>;
+export declare const startOnchainRecoveryErrorStatusSchema: z.ZodEnum<["undeployedAccount", "notEnoughToPayFees"]>;
+export declare const startOnchainRecoveryErrorSchema: z.ZodObject<{
+    status: z.ZodEnum<["undeployedAccount", "notEnoughToPayFees"]>;
+}, "strip", z.ZodTypeAny, {
+    status: "undeployedAccount" | "notEnoughToPayFees";
+}, {
+    status: "undeployedAccount" | "notEnoughToPayFees";
+}>;
+export type StartOnchainRecovery = z.infer<typeof startOnchainRecoverySchema>;
 export type OnchainRecovery = z.infer<typeof onchainRecoverySchema>;
+export type RecoveryStatus = z.infer<typeof recoveryStatusSchema>;
+export type StartOnchainRecoveryError = z.infer<typeof startOnchainRecoveryErrorSchema>;
+export type StartOnchainRecoveryErrorStatus = z.infer<typeof startOnchainRecoveryErrorStatusSchema>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@argent/x-shared",
-  "version": "1.31.0",
+  "version": "1.31.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/argentlabs/x-shared.git"