@trustless-work/blocks 0.0.4 → 0.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trustless-work/blocks",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "author": "Trustless Work",
   "keywords": [
     "react",

package/templates/escrows/details/EscrowDetailDialog.tsx

@@ -59,7 +59,7 @@ const EscrowDetailDialog = ({
   return (
     <>
       <Dialog open={isDialogOpen} onOpenChange={handleClose}>
-        <DialogContent className="!w-full sm:!max-w-4xl max-h-[95vh] overflow-y-auto">
+        <DialogContent className="w-11/12 sm:w-3/4 h-[95vh] overflow-y-auto flex flex-col !max-w-none">
           <DialogHeader className="flex-shrink-0">
             <div className="w-full">
               <div className="flex flex-col gap-2">

package/templates/escrows/escrow-context/EscrowAmountProvider.tsx

@@ -37,7 +37,10 @@ export const EscrowAmountProvider = ({ children }: { children: ReactNode }) => {
 
   const setAmounts: AmountEscrowStore["setAmounts"] = useCallback(
     (totalAmount, platformFee) => {
+      // Trustless Work percentage
       const trustlessPercentage = 0.3;
+
+      // Receiver percentage
       const receiverPercentage = 100 - (trustlessPercentage + platformFee);
 
       setReceiverAmount((totalAmount * receiverPercentage) / 100);

package/templates/escrows/escrow-context/EscrowDialogsProvider.tsx

@@ -10,14 +10,7 @@ export type DialogState = {
 
 export type DialogStates = {
   second: DialogState;
-  completeMilestone: DialogState;
-  qr: DialogState;
-  resolveDispute: DialogState;
-  editMilestone: DialogState;
-  editEntities: DialogState;
-  editBasicProperties: DialogState;
   successRelease: DialogState;
-  successResolveDispute: DialogState;
 };
 
 export type StatusStates = {};
@@ -34,60 +27,20 @@ export function EscrowDialogsProvider({
   children: React.ReactNode;
 }) {
   const [secondOpen, setSecondOpen] = useState(false);
-  const [completeMilestoneOpen, setCompleteMilestoneOpen] = useState(false);
-  const [qrOpen, setQrOpen] = useState(false);
-  const [resolveDisputeOpen, setResolveDisputeOpen] = useState(false);
-  const [editMilestoneOpen, setEditMilestoneOpen] = useState(false);
-  const [editEntitiesOpen, setEditEntitiesOpen] = useState(false);
-  const [editBasicPropertiesOpen, setEditBasicPropertiesOpen] = useState(false);
   const [successReleaseOpen, setSuccessReleaseOpen] = useState(false);
-  const [successResolveDisputeOpen, setSuccessResolveDisputeOpen] =
-    useState(false);
 
   const value = useMemo<EscrowDialogsContextType>(
     () => ({
+      // Detail Escrow Dialog
       second: { isOpen: secondOpen, setIsOpen: setSecondOpen },
-      completeMilestone: {
-        isOpen: completeMilestoneOpen,
-        setIsOpen: setCompleteMilestoneOpen,
-      },
-      qr: { isOpen: qrOpen, setIsOpen: setQrOpen },
-      resolveDispute: {
-        isOpen: resolveDisputeOpen,
-        setIsOpen: setResolveDisputeOpen,
-      },
-      editMilestone: {
-        isOpen: editMilestoneOpen,
-        setIsOpen: setEditMilestoneOpen,
-      },
-      editEntities: {
-        isOpen: editEntitiesOpen,
-        setIsOpen: setEditEntitiesOpen,
-      },
-      editBasicProperties: {
-        isOpen: editBasicPropertiesOpen,
-        setIsOpen: setEditBasicPropertiesOpen,
-      },
+
+      // Success Release Dialog
       successRelease: {
         isOpen: successReleaseOpen,
         setIsOpen: setSuccessReleaseOpen,
       },
-      successResolveDispute: {
-        isOpen: successResolveDisputeOpen,
-        setIsOpen: setSuccessResolveDisputeOpen,
-      },
     }),
-    [
-      secondOpen,
-      completeMilestoneOpen,
-      qrOpen,
-      resolveDisputeOpen,
-      editMilestoneOpen,
-      editEntitiesOpen,
-      editBasicPropertiesOpen,
-      successReleaseOpen,
-      successResolveDisputeOpen,
-    ]
+    [secondOpen, successReleaseOpen]
   );
 
   return (

package/templates/escrows/escrow-context/EscrowProvider.tsx

@@ -35,6 +35,9 @@ export const EscrowProvider = ({ children }: { children: ReactNode }) => {
   );
   const [userRolesInEscrow, setUserRolesInEscrowState] = useState<string[]>([]);
 
+  /**
+   * Get the selected escrow from the local storage
+   */
   useEffect(() => {
     try {
       const stored = localStorage.getItem(LOCAL_STORAGE_KEY);
@@ -47,6 +50,11 @@ export const EscrowProvider = ({ children }: { children: ReactNode }) => {
     }
   }, []);
 
+  /**
+   * Persist the selected escrow to the local storage
+   *
+   * @param value - The escrow to persist
+   */
   const persist = (value: Escrow | null) => {
     if (value) {
       localStorage.setItem(LOCAL_STORAGE_KEY, JSON.stringify(value));
@@ -55,6 +63,11 @@ export const EscrowProvider = ({ children }: { children: ReactNode }) => {
     }
   };
 
+  /**
+   * Update the selected escrow
+   *
+   * @param updater - The updater function
+   */
   const updateEscrow: EscrowContextType["updateEscrow"] = (updater) => {
     setSelectedEscrowState((current) => {
       if (!current) return current;
@@ -67,6 +80,12 @@ export const EscrowProvider = ({ children }: { children: ReactNode }) => {
     });
   };
 
+  /**
+   * Set a field of the selected escrow
+   *
+   * @param key - The key of the field to set
+   * @param value - The value to set
+   */
   const setEscrowField: EscrowContextType["setEscrowField"] = (key, value) => {
     setSelectedEscrowState((current) => {
       if (!current) return current;
@@ -76,11 +95,19 @@ export const EscrowProvider = ({ children }: { children: ReactNode }) => {
     });
   };
 
+  /**
+   * Clear the selected escrow
+   */
   const clearEscrow = () => {
     setSelectedEscrowState(null);
     persist(null);
   };
 
+  /**
+   * Set the user roles in the escrow
+   *
+   * @param roles - The roles to set
+   */
   const setUserRolesInEscrow = useCallback((roles: string[]) => {
     setUserRolesInEscrowState((prev) => {
       // Avoid unnecessary updates to prevent re-renders
@@ -94,6 +121,9 @@ export const EscrowProvider = ({ children }: { children: ReactNode }) => {
     });
   }, []);
 
+  /**
+   * Check if the user has an escrow
+   */
   const hasEscrow = useMemo(() => Boolean(selectedEscrow), [selectedEscrow]);
 
   return (

package/templates/escrows/escrows-by-role/cards/EscrowsCards.tsx

@@ -119,6 +119,16 @@ export function EscrowsByRoleCards() {
     dialogStates.second.setIsOpen(true);
   };
 
+  /**
+   * Based on the provided roles -> https://docs.trustlesswork.com/trustless-work/technology-overview/roles-in-trustless-work
+   *
+   * You must pass one or more roles according to requirements. Acctually it's coming from the select filter.
+   *
+   * For example:
+   * - If the user is a freelancer, you must pass the "serviceProvider" and "receiver" role
+   *
+   * Depending of the role, you'll have different actions buttons
+   */
   const activeRole: Role[] = role.split(",") as Role[];
 
   return (

package/templates/escrows/escrows-by-role/table/EscrowsTable.tsx

@@ -202,7 +202,18 @@ export function EscrowsByRoleTable() {
     enableSortingRemoval: true,
   });
 
+  /**
+   * Based on the provided roles -> https://docs.trustlesswork.com/trustless-work/technology-overview/roles-in-trustless-work
+   *
+   * You must pass one or more roles according to requirements. Acctually it's coming from the select filter.
+   *
+   * For example:
+   * - If the user is a freelancer, you must pass the "serviceProvider" and "receiver" role
+   *
+   * Depending of the role, you'll have different actions buttons
+   */
   const activeRole: Role[] = role.split(",") as Role[];
+
   const escrows = data ?? [];
 
   return (

package/templates/escrows/escrows-by-role/useEscrowsByRole.shared.ts

@@ -234,6 +234,12 @@ export function useEscrowsByRole() {
     dateRange,
   ]);
 
+  /**
+   * Call the query to get the escrows from the Trustless Work Indexer
+   *
+   * @param params - The parameters for the query
+   * @returns The query result
+   */
   const query = useEscrowsByRoleQuery(params);
   const nextPageQuery = useEscrowsByRoleQuery({ ...params, page: page + 1 });
 

package/templates/escrows/escrows-by-signer/cards/EscrowsCards.tsx

@@ -116,7 +116,18 @@ export function EscrowsBySignerCards() {
     dialogStates.second.setIsOpen(true);
   };
 
+  /**
+   * Based on the provided roles -> https://docs.trustlesswork.com/trustless-work/technology-overview/roles-in-trustless-work
+   *
+   * You must pass one or more roles according to requirements
+   *
+   * For example:
+   * - If the user is a freelancer, you must pass the "serviceProvider" and "receiver" role
+   *
+   * Depending of the role, you'll have different actions buttons
+   */
   const activeRole: Role[] = ["approver"];
+
   const escrows: Escrow[] = data ?? [];
 
   return (

package/templates/escrows/escrows-by-signer/table/EscrowsTable.tsx

@@ -199,7 +199,18 @@ export function EscrowsBySignerTable() {
     enableSortingRemoval: true,
   });
 
+  /**
+   * Based on the provided roles -> https://docs.trustlesswork.com/trustless-work/technology-overview/roles-in-trustless-work
+   *
+   * You must pass one or more roles according to requirements
+   *
+   * For example:
+   * - If the user is a freelancer, you must pass the "serviceProvider" and "receiver" role
+   *
+   * Depending of the role, you'll have different actions buttons
+   */
   const activeRole: Role[] = ["approver"];
+
   const escrows = data ?? [];
 
   return (

package/templates/escrows/escrows-by-signer/useEscrowsBySigner.shared.ts

@@ -221,6 +221,12 @@ export function useEscrowsBySigner() {
     dateRange,
   ]);
 
+  /**
+   * Call the query to get the escrows from the Trustless Work Indexer
+   *
+   * @param params - The parameters for the query
+   * @returns The query result
+   */
   const query = useEscrowsBySignerQuery(params);
   const nextPageQuery = useEscrowsBySignerQuery({ ...params, page: page + 1 });
 

package/templates/escrows/single-release/approve-milestone/button/ApproveMilestone.tsx

@@ -27,6 +27,12 @@ export default function ApproveMilestoneButton({
     try {
       setIsSubmitting(true);
 
+      /**
+       * Create the payload for the approve milestone mutation
+       *
+       * @param milestoneIndex - The index of the milestone to approve
+       * @returns The payload for the approve milestone mutation
+       */
       const payload: ApproveMilestonePayload = {
         contractId: selectedEscrow?.contractId || "",
         milestoneIndex: String(milestoneIndex),
@@ -34,6 +40,13 @@ export default function ApproveMilestoneButton({
         newFlag: true,
       };
 
+      /**
+       * Call the approve milestone mutation
+       *
+       * @param payload - The payload for the approve milestone mutation
+       * @param type - The type of the escrow
+       * @param address - The address of the escrow
+       */
       await approveMilestone.mutateAsync({
         payload,
         type: "single-release",

package/templates/escrows/single-release/approve-milestone/shared/useApproveMilestone.ts

@@ -31,6 +31,12 @@ export function useApproveMilestone() {
     try {
       setIsSubmitting(true);
 
+      /**
+       * Create the final payload for the approve milestone mutation
+       *
+       * @param payload - The payload from the form
+       * @returns The final payload for the approve milestone mutation
+       */
       const finalPayload: ApproveMilestonePayload = {
         contractId: selectedEscrow?.contractId || "",
         milestoneIndex: payload.milestoneIndex,
@@ -38,6 +44,13 @@ export function useApproveMilestone() {
         newFlag: true,
       };
 
+      /**
+       * Call the approve milestone mutation
+       *
+       * @param payload - The final payload for the approve milestone mutation
+       * @param type - The type of the escrow
+       * @param address - The address of the escrow
+       */
       await approveMilestone.mutateAsync({
         payload: finalPayload,
         type: "single-release",

package/templates/escrows/single-release/change-milestone-status/button/ChangeMilestoneStatus.tsx

@@ -36,6 +36,14 @@ export default function ChangeMilestoneStatusButton({
 
       setIsSubmitting(true);
 
+      /**
+       * Create the payload for the change milestone status mutation
+       *
+       * @param status - The status to change
+       * @param evidence - The evidence to change
+       * @param milestoneIndex - The index of the milestone to change
+       * @returns The payload for the change milestone status mutation
+       */
       const payload: ChangeMilestoneStatusPayload = {
         contractId: selectedEscrow?.contractId || "",
         milestoneIndex: String(milestoneIndex),
@@ -44,6 +52,13 @@ export default function ChangeMilestoneStatusButton({
         serviceProvider: walletAddress || "",
       };
 
+      /**
+       * Call the change milestone status mutation
+       *
+       * @param payload - The payload for the change milestone status mutation
+       * @param type - The type of the escrow
+       * @param address - The address of the escrow
+       */
       await changeMilestoneStatus.mutateAsync({
         payload,
         type: "single-release",

package/templates/escrows/single-release/change-milestone-status/shared/useChangeMilestoneStatus.ts

@@ -36,6 +36,12 @@ export function useChangeMilestoneStatus() {
     try {
       setIsSubmitting(true);
 
+      /**
+       * Create the final payload for the change milestone status mutation
+       *
+       * @param payload - The payload from the form
+       * @returns The final payload for the change milestone status mutation
+       */
       const finalPayload: ChangeMilestoneStatusPayload = {
         contractId: selectedEscrow?.contractId || "",
         milestoneIndex: payload.milestoneIndex,
@@ -44,6 +50,13 @@ export function useChangeMilestoneStatus() {
         serviceProvider: walletAddress || "",
       };
 
+      /**
+       * Call the change milestone status mutation
+       *
+       * @param payload - The final payload for the change milestone status mutation
+       * @param type - The type of the escrow
+       * @param address - The address of the escrow
+       */
       await changeMilestoneStatus.mutateAsync({
         payload: finalPayload,
         type: "single-release",

package/templates/escrows/single-release/dispute-escrow/button/DisputeEscrow.tsx

@@ -21,11 +21,23 @@ export default function DisputeEscrowButton() {
     try {
       setIsSubmitting(true);
 
+      /**
+       * Create the payload for the dispute escrow mutation
+       *
+       * @returns The payload for the dispute escrow mutation
+       */
       const payload: SingleReleaseStartDisputePayload = {
         contractId: selectedEscrow?.contractId || "",
         signer: walletAddress || "",
       };
 
+      /**
+       * Call the dispute escrow mutation
+       *
+       * @param payload - The payload for the dispute escrow mutation
+       * @param type - The type of the escrow
+       * @param address - The address of the escrow
+       */
       await startDispute.mutateAsync({
         payload,
         type: "single-release",

package/templates/escrows/single-release/fund-escrow/button/FundEscrow.tsx

@@ -35,12 +35,24 @@ export default function FundEscrowButton({ amount }: FundEscrowButtonProps) {
 
       setIsSubmitting(true);
 
+      /**
+       * Create the payload for the fund escrow mutation
+       *
+       * @returns The payload for the fund escrow mutation
+       */
       const payload: FundEscrowPayload = {
         amount: Number(amount),
         contractId: selectedEscrow?.contractId || "",
         signer: walletAddress || "",
       };
 
+      /**
+       * Call the fund escrow mutation
+       *
+       * @param payload - The payload for the fund escrow mutation
+       * @param type - The type of the escrow
+       * @param address - The address of the escrow
+       */
       await fundEscrow.mutateAsync({
         payload,
         type: "single-release",

package/templates/escrows/single-release/fund-escrow/shared/useFundEscrow.ts

@@ -31,6 +31,12 @@ export function useFundEscrow() {
     try {
       setIsSubmitting(true);
 
+      /**
+       * Create the final payload for the fund escrow mutation
+       *
+       * @param payload - The payload from the form
+       * @returns The final payload for the fund escrow mutation
+       */
       const finalPayload: FundEscrowPayload = {
         amount:
           typeof payload.amount === "string"
@@ -40,6 +46,13 @@ export function useFundEscrow() {
         signer: walletAddress || "",
       };
 
+      /**
+       * Call the fund escrow mutation
+       *
+       * @param payload - The final payload for the fund escrow mutation
+       * @param type - The type of the escrow
+       * @param address - The address of the escrow
+       */
       await fundEscrow.mutateAsync({
         payload: finalPayload,
         type: "single-release",

package/templates/escrows/single-release/initialize-escrow/shared/useInitializeEscrow.ts

@@ -14,12 +14,14 @@ import {
   ErrorResponse,
   handleError,
 } from "@/components/tw-blocks/handle-errors/handle";
+import { useEscrowContext } from "../../../escrow-context/EscrowProvider";
 
 export function useInitializeEscrow() {
   const [isSubmitting, setIsSubmitting] = React.useState(false);
 
   const { getSingleReleaseFormSchema } = useInitializeEscrowSchema();
   const formSchema = getSingleReleaseFormSchema();
+  const { setSelectedEscrow } = useEscrowContext();
 
   const { walletAddress } = useWalletContext();
   const { deployEscrow } = useEscrowsMutations();
@@ -71,6 +73,12 @@ export function useInitializeEscrow() {
     try {
       setIsSubmitting(true);
 
+      /**
+       * Create the final payload for the initialize escrow mutation
+       *
+       * @param payload - The payload from the form
+       * @returns The final payload for the initialize escrow mutation
+       */
       const finalPayload: InitializeSingleReleaseEscrowPayload = {
         ...payload,
         amount:
@@ -86,6 +94,13 @@ export function useInitializeEscrow() {
         milestones: payload.milestones,
       };
 
+      /**
+       * Call the initialize escrow mutation
+       *
+       * @param payload - The final payload for the initialize escrow mutation
+       * @param type - The type of the escrow
+       * @param address - The address of the escrow
+       */
       const response: InitializeSingleReleaseEscrowResponse =
         (await deployEscrow.mutateAsync({
           payload: finalPayload,
@@ -93,8 +108,9 @@ export function useInitializeEscrow() {
           address: walletAddress || "",
         })) as InitializeSingleReleaseEscrowResponse;
 
-      console.log("response", response);
       toast.success("Escrow initialized successfully");
+
+      setSelectedEscrow(response);
     } catch (error) {
       toast.error(handleError(error as ErrorResponse).message);
     } finally {

package/templates/escrows/single-release/release-escrow/button/ReleaseEscrow.tsx

@@ -25,11 +25,23 @@ export default function ReleaseEscrowButton() {
     try {
       setIsSubmitting(true);
 
+      /**
+       * Create the payload for the release escrow mutation
+       *
+       * @returns The payload for the release escrow mutation
+       */
       const payload: SingleReleaseReleaseFundsPayload = {
         contractId: selectedEscrow?.contractId || "",
         releaseSigner: walletAddress || "",
       };
 
+      /**
+       * Call the release escrow mutation
+       *
+       * @param payload - The payload for the release escrow mutation
+       * @param type - The type of the escrow
+       * @param address - The address of the escrow
+       */
       await releaseFunds.mutateAsync({
         payload,
         type: "single-release",

package/templates/escrows/single-release/resolve-dispute/button/ResolveDispute.tsx

@@ -44,6 +44,11 @@ export default function ResolveDisputeButton({
 
       setIsSubmitting(true);
 
+      /**
+       * Create the payload for the resolve dispute mutation
+       *
+       * @returns The payload for the resolve dispute mutation
+       */
       const payload: SingleReleaseResolveDisputePayload = {
         contractId: selectedEscrow?.contractId || "",
         disputeResolver: walletAddress || "",
@@ -51,6 +56,13 @@ export default function ResolveDisputeButton({
         receiverFunds: Number(receiverFunds),
       };
 
+      /**
+       * Call the resolve dispute mutation
+       *
+       * @param payload - The payload for the resolve dispute mutation
+       * @param type - The type of the escrow
+       * @param address - The address of the escrow
+       */
       await resolveDispute.mutateAsync({
         payload,
         type: "single-release",

package/templates/escrows/single-release/resolve-dispute/shared/useResolveDispute.ts

@@ -32,6 +32,12 @@ export function useResolveDispute() {
     try {
       setIsSubmitting(true);
 
+      /**
+       * Create the final payload for the resolve dispute mutation
+       *
+       * @param payload - The payload from the form
+       * @returns The final payload for the resolve dispute mutation
+       */
       const finalPayload: SingleReleaseResolveDisputePayload = {
         contractId: selectedEscrow?.contractId || "",
         disputeResolver: walletAddress || "",
@@ -39,6 +45,13 @@ export function useResolveDispute() {
         receiverFunds: Number(payload.receiverFunds),
       };
 
+      /**
+       * Call the resolve dispute mutation
+       *
+       * @param payload - The final payload for the resolve dispute mutation
+       * @param type - The type of the escrow
+       * @param address - The address of the escrow
+       */
       await resolveDispute.mutateAsync({
         payload: finalPayload,
         type: "single-release",

package/templates/escrows/single-release/update-escrow/shared/useUpdateEscrow.ts

@@ -140,6 +140,12 @@ export function useUpdateEscrow() {
     try {
       setIsSubmitting(true);
 
+      /**
+       * Create the final payload for the update escrow mutation
+       *
+       * @param payload - The payload from the form
+       * @returns The final payload for the update escrow mutation
+       */
       const finalPayload: UpdateSingleReleaseEscrowPayload = {
         contractId: selectedEscrow?.contractId || "",
         signer: walletAddress || "",
@@ -167,6 +173,13 @@ export function useUpdateEscrow() {
         },
       };
 
+      /**
+       * Call the update escrow mutation
+       *
+       * @param payload - The final payload for the update escrow mutation
+       * @param type - The type of the escrow
+       * @param address - The address of the escrow
+       */
       (await updateEscrow.mutateAsync({
         payload: finalPayload,
         type: "single-release",

package/templates/handle-errors/handle.ts

@@ -10,23 +10,33 @@ export type ErrorResponse = {
 
 export type WalletError = Pick<ErrorResponse, "message" | "code">;
 
+/**
+ * Handle the error
+ *
+ * @param error - The error
+ * @returns The error response
+ */
 export const handleError = (error: AxiosError | WalletError): ErrorResponse => {
   if (axios.isAxiosError(error)) {
     const axiosError = error as AxiosError<ErrorResponse>;
     const code = axiosError.response?.status || 500;
     const message = axiosError.response?.data?.message || error.message;
+
+    // Map the status code to the error type
     return {
       message,
       code,
       type: mapStatusCodeToErrorType(code),
     };
   } else if (error.code === -4) {
+    // Wallet was closed before transaction was sent
     return {
       message: "Wallet was closed before transaction was sent",
       code: -4,
       type: ApiErrorTypes.WALLET_ERROR,
     };
   } else {
+    // Unknown error
     return {
       message: error.message,
       code: 500,
@@ -35,6 +45,12 @@ export const handleError = (error: AxiosError | WalletError): ErrorResponse => {
   }
 };
 
+/**
+ * Map the status code to the error type
+ *
+ * @param code - The status code
+ * @returns The error type
+ */
 const mapStatusCodeToErrorType = (code: number): ApiErrorTypes => {
   switch (code) {
     case 404:

package/templates/helpers/format.helper.ts

@@ -1,7 +1,20 @@
+/**
+ * Format the currency
+ *
+ * @param value - The value
+ * @param currency - The currency
+ * @returns The formatted currency
+ */
 export const formatCurrency = (value: number, currency: string) => {
   return `${currency} ${value.toFixed(2)}`;
 };
 
+/**
+ * Format the timestamp
+ *
+ * @param ts - The timestamp
+ * @returns The formatted timestamp
+ */
 export function formatTimestamp(ts?: {
   _seconds: number;
   _nanoseconds: number;
@@ -11,10 +24,22 @@ export function formatTimestamp(ts?: {
   return d.toLocaleString();
 }
 
+/**
+ * Format the address
+ *
+ * @param address - The address
+ * @returns The formatted address
+ */
 export function formatAddress(address: string) {
   return `${address.slice(0, 10)}...${address.slice(-4)}`;
 }
 
+/**
+ * Format the role
+ *
+ * @param role - The role
+ * @returns The formatted role
+ */
 export function formatRole(role: string) {
   return role
     .replace(/([A-Z])/g, " $1")
@@ -22,6 +47,12 @@ export function formatRole(role: string) {
     .trim();
 }
 
+/**
+ * Format the text
+ *
+ * @param text - The text
+ * @returns The formatted text
+ */
 export function formatText(text: string) {
   return text.charAt(0).toUpperCase() + text.slice(1);
 }

package/templates/helpers/useCopy.ts

@@ -1,5 +1,10 @@
 import { useState } from "react";
 
+/**
+ * Use copy to clipboard
+ *
+ * @returns The copied key id and the function to copy to clipboard
+ */
 export const useCopy = () => {
   const [copiedKeyId, setCopiedKeyId] = useState(false);
 

package/templates/providers/ReactQueryClientProvider.tsx

@@ -3,6 +3,14 @@
 import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
 import { ReactQueryDevtools } from "@tanstack/react-query-devtools";
 
+/**
+ * Query Client, you can configure the default options for the query client
+ *
+ * - Stale Time: 5 minutes
+ * - GC Time: 30 minutes
+ * - Retry: 1
+ * - Refetch on Window Focus: false
+ */
 const queryClient = new QueryClient({
   defaultOptions: {
     queries: {
@@ -14,6 +22,12 @@ const queryClient = new QueryClient({
   },
 });
 
+/**
+ * React Query Client Provider
+ *
+ * @param children - The children
+ * @returns The React Query Client Provider
+ */
 export function ReactQueryClientProvider({
   children,
 }: {

package/templates/tanstack/useEscrowsByRoleQuery.ts

@@ -14,6 +14,12 @@ type UseEscrowsByRoleQueryParams = Omit<
   validateOnChain?: boolean;
 };
 
+/**
+ * Use the query to get the escrows by role
+ *
+ * @param params - The parameters for the query
+ * @returns The query result
+ */
 export const useEscrowsByRoleQuery = ({
   role,
   roleAddress,
@@ -32,6 +38,7 @@ export const useEscrowsByRoleQuery = ({
   enabled = true,
   validateOnChain = true,
 }: UseEscrowsByRoleQueryParams) => {
+  // Get the escrows by role
   const { getEscrowsByRole } = useGetEscrowsFromIndexerByRole();
 
   return useQuery({
@@ -57,6 +64,13 @@ export const useEscrowsByRoleQuery = ({
       if (!role) {
         throw new Error("Role is required to fetch escrows by role");
       }
+
+      /**
+       * Call the query to get the escrows from the Trustless Work Indexer
+       *
+       * @param params - The parameters for the query
+       * @returns The query result
+       */
       const escrows = await getEscrowsByRole({
         role,
         roleAddress,

package/templates/tanstack/useEscrowsBySignerQuery.ts

@@ -11,6 +11,12 @@ interface UseEscrowsBySignerQueryParams
   validateOnChain?: boolean;
 }
 
+/**
+ * Use the query to get the escrows by signer
+ *
+ * @param params - The parameters for the query
+ * @returns The query result
+ */
 export const useEscrowsBySignerQuery = ({
   signer,
   isActive,
@@ -30,6 +36,7 @@ export const useEscrowsBySignerQuery = ({
 }: UseEscrowsBySignerQueryParams) => {
   const { getEscrowsBySigner } = useGetEscrowsFromIndexerBySigner();
 
+  // Get the escrows by signer
   return useQuery({
     queryKey: [
       "escrows",
@@ -49,6 +56,12 @@ export const useEscrowsBySignerQuery = ({
       validateOnChain,
     ],
     queryFn: async (): Promise<Escrow[]> => {
+      /**
+       * Call the query to get the escrows from the Trustless Work Indexer
+       *
+       * @param params - The parameters for the query
+       * @returns The query result
+       */
       const escrows = await getEscrowsBySigner({
         signer,
         isActive,

package/templates/tanstack/useEscrowsMutations.ts

@@ -26,6 +26,18 @@ import {
 } from "@trustless-work/escrow";
 import { signTransaction } from "../wallet-kit/wallet-kit";
 
+/**
+ * Use the mutations to interact with the escrows
+ *
+ * - Deploy Escrow
+ * - Update Escrow
+ * - Fund Escrow
+ * - Change Milestone Status
+ * - Approve Milestone
+ * - Start Dispute
+ * - Release Funds
+ * - Resolve Dispute
+ */
 export const useEscrowsMutations = () => {
   const queryClient = useQueryClient();
   const { deployEscrow } = useInitializeEscrow();
@@ -38,6 +50,9 @@ export const useEscrowsMutations = () => {
   const { releaseFunds } = useReleaseFunds();
   const { resolveDispute } = useResolveDispute();
 
+  /**
+   * Deploy Escrow
+   */
   const deployEscrowMutation = useMutation({
     mutationFn: async ({
       payload,
@@ -83,6 +98,9 @@ export const useEscrowsMutations = () => {
     },
   });
 
+  /**
+   * Update Escrow
+   */
   const updateEscrowMutation = useMutation({
     mutationFn: async ({
       payload,
@@ -128,6 +146,9 @@ export const useEscrowsMutations = () => {
     },
   });
 
+  /**
+   * Fund Escrow
+   */
   const fundEscrowMutation = useMutation({
     mutationFn: async ({
       payload,
@@ -174,6 +195,9 @@ export const useEscrowsMutations = () => {
     },
   });
 
+  /**
+   * Approve Milestone
+   */
   const approveMilestoneMutation = useMutation({
     mutationFn: async ({
       payload,
@@ -217,6 +241,9 @@ export const useEscrowsMutations = () => {
     },
   });
 
+  /**
+   * Change Milestone Status
+   */
   const changeMilestoneStatusMutation = useMutation({
     mutationFn: async ({
       payload,
@@ -263,6 +290,9 @@ export const useEscrowsMutations = () => {
     },
   });
 
+  /**
+   * Start Dispute
+   */
   const startDisputeMutation = useMutation({
     mutationFn: async ({
       payload,
@@ -308,6 +338,9 @@ export const useEscrowsMutations = () => {
     },
   });
 
+  /**
+   * Release Funds
+   */
   const releaseFundsMutation = useMutation({
     mutationFn: async ({
       payload,
@@ -353,6 +386,9 @@ export const useEscrowsMutations = () => {
     },
   });
 
+  /**
+   * Resolve Dispute
+   */
   const resolveDisputeMutation = useMutation({
     mutationFn: async ({
       payload,

package/templates/wallet-kit/trustlines.ts

@@ -1,3 +1,10 @@
+/**
+ * Trustlines | Non-Native Tokens from Stellar
+ *
+ * @description Trustlines are the tokens that are used to pay for the escrow
+ * @description The trustlines are filtered by the network
+ * @description The trustlines are filtered by the network in the trustlineOptions
+ */
 export const trustlines = [
   // TESTNET
   {

package/templates/wallet-kit/validators.ts

@@ -1,3 +1,9 @@
+/**
+ * Validator for the wallet address
+ *
+ * @param wallet - The wallet address
+ * @returns True if the wallet address is valid, false otherwise
+ */
 export const isValidWallet = (wallet: string) => {
   if (wallet.length !== 56 || wallet[0] !== "G") {
     return false;

package/templates/wallet-kit/wallet-kit.ts

@@ -6,6 +6,13 @@ import {
   FreighterModule,
 } from "@creit.tech/stellar-wallets-kit";
 
+/**
+ * Stellar Wallet Kit
+ *
+ * @description The Stellar Wallet Kit is used to connect to the wallet
+ * @description The Stellar Wallet Kit is used to sign transactions
+ * @description The Stellar Wallet Kit is used to get the wallet address
+ */
 export const kit: StellarWalletsKit = new StellarWalletsKit({
   network: WalletNetwork.TESTNET,
   selectedWalletId: FREIGHTER_ID,
@@ -17,6 +24,12 @@ interface SignTransactionParams {
   address: string;
 }
 
+/**
+ * Sign Transaction Params
+ *
+ * @param unsignedTransaction - The unsigned transaction
+ * @param address - The address of the wallet
+ */
 export const signTransaction = async ({
   unsignedTransaction,
   address,