add js docs

Author: sinzii

packages/create-typink/src/templates/default/ui/src/utils/txToaster.tsx

@@ -4,23 +4,35 @@ import { ISubmittableResult, TxStatus } from 'dedot/types';
 import { useTypink } from 'typink';
 
 export type TxToaster = {
-  onTxProgress: (result: ISubmittableResult) => void;
+  onTxProgress: (progress: ISubmittableResult) => void;
   onTxError: (e: Error) => void;
 };
 
+/**
+ * Creates a toast notification for transaction progress and manages its updates.
+ *
+ * This function initializes a toast notification for a transaction and returns
+ * methods to update the toast based on the transaction's progress or errors.
+ *
+ * @param initialMessage - The initial message to display in the toast notification.
+ *                         Defaults to 'Signing Transaction...'.
+ * @returns An object containing two methods:
+ *          - onTxProgress: Updates the toast based on transaction progress.
+ *          - onTxError: Updates the toast when a transaction error occurs.
+ */
 export function txToaster(initialMessage: string = 'Signing Transaction...'): TxToaster {
   const toastId = toast.info(initialMessage, {
     autoClose: false, // prettier-end-here
     isLoading: true,
     closeOnClick: false,
   });
 
-  const onTxProgress = (result: ISubmittableResult) => {
+  const onTxProgress = (progress: ISubmittableResult) => {
     let toastType: TypeOptions = 'default';
     let autoClose: boolean | number = false;
     let toastMessage: string = 'Transaction In Progress...';
 
-    const { status, dispatchError } = result;
+    const { status, dispatchError } = progress;
     const succeeded = !dispatchError;
 
     if (status.type === 'Finalized') {

packages/typink/src/helpers/balance.ts

@@ -2,6 +2,13 @@ import { GenericContractApi } from 'dedot/contracts';
 import { ISubstrateClient } from 'dedot';
 import { BalanceInsufficientError } from '../utils/index.js';
 
+/**
+ * Checks whether the specified account has a sufficient free balance.
+ * Throws a `BalanceInsufficientError` if the free balance is not enough to perform transaction.
+ *
+ * @param client
+ * @param address
+ */
 export const checkBalanceSufficiency = async <T extends GenericContractApi = GenericContractApi>(
   client: ISubstrateClient<T['types']['ChainApi']>,
   address: string,
@@ -11,4 +18,4 @@ export const checkBalanceSufficiency = async <T extends GenericContractApi = Gen
   if (balance.data.free <= 0n) {
     throw new BalanceInsufficientError(address);
   }
-};
+};

packages/typink/src/utils/errors.ts

@@ -13,6 +13,12 @@ import { ISubstrateClient } from 'dedot';
  */
 export class TypinkError extends DedotError {}
 
+/**
+ * Represents an error that occurs during contract message execution.
+ *
+ * @typeparam T - The type of the error object, extends any.
+ * @extends TypinkError
+ */
 export class ContractMessageError<T extends any> extends TypinkError {
   constructor(
     public error: T,
@@ -22,6 +28,11 @@ export class ContractMessageError<T extends any> extends TypinkError {
   }
 }
 
+/**
+ * Represents an error that occurs when the caller has insufficient balance to perform a transaction.
+ *
+ * @extends TypinkError
+ */
 export class BalanceInsufficientError extends TypinkError {
   constructor(
     public caller: string,
@@ -41,6 +52,12 @@ const extractErrorType = (error: any): string => {
   return JSON.stringify(error);
 };
 
+/**
+ * Extract human-readable error message from an Error instance
+ *
+ * @param client
+ * @param error
+ */
 export const extractHumanReadableError = <T extends GenericContractApi = GenericContractApi, E extends Error = any>(
   client: ISubstrateClient<T['types']['ChainApi']>,
   error: E,
@@ -132,6 +149,12 @@ export const extractHumanReadableError = <T extends GenericContractApi = Generic
   return error.message;
 };
 
+/**
+ * Replace the message of an Error instance with a human-readable error message
+ *
+ * @param client
+ * @param error
+ */
 export const withReadableErrorMessage = <T extends GenericContractApi = GenericContractApi, E extends Error = any>(
   client: ISubstrateClient<T['types']['ChainApi']>,
   error: E,