@trustless-work/blocks 0.0.5 → 0.0.7

package/templates/{escrows/escrow-context → providers}/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/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,
 }: {
@@ -22,7 +36,9 @@ export function ReactQueryClientProvider({
   return (
     <QueryClientProvider client={queryClient}>
       {children}
-      <ReactQueryDevtools initialIsOpen={false} />
+      {process.env.NODE_ENV !== "production" ? (
+        <ReactQueryDevtools initialIsOpen={false} />
+      ) : null}
     </QueryClientProvider>
   );
 }

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,

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

@@ -1,108 +0,0 @@
-"use client";
-
-import * as React from "react";
-import { createContext, useContext, useMemo, useState } from "react";
-
-export type DialogState = {
-  isOpen: boolean;
-  setIsOpen: (open: boolean) => void;
-};
-
-export type DialogStates = {
-  second: DialogState;
-  completeMilestone: DialogState;
-  qr: DialogState;
-  resolveDispute: DialogState;
-  editMilestone: DialogState;
-  editEntities: DialogState;
-  editBasicProperties: DialogState;
-  successRelease: DialogState;
-  successResolveDispute: DialogState;
-};
-
-export type StatusStates = {};
-
-type EscrowDialogsContextType = DialogStates & StatusStates;
-
-const EscrowDialogsContext = createContext<
-  EscrowDialogsContextType | undefined
->(undefined);
-
-export function EscrowDialogsProvider({
-  children,
-}: {
-  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>(
-    () => ({
-      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,
-      },
-      successRelease: {
-        isOpen: successReleaseOpen,
-        setIsOpen: setSuccessReleaseOpen,
-      },
-      successResolveDispute: {
-        isOpen: successResolveDisputeOpen,
-        setIsOpen: setSuccessResolveDisputeOpen,
-      },
-    }),
-    [
-      secondOpen,
-      completeMilestoneOpen,
-      qrOpen,
-      resolveDisputeOpen,
-      editMilestoneOpen,
-      editEntitiesOpen,
-      editBasicPropertiesOpen,
-      successReleaseOpen,
-      successResolveDisputeOpen,
-    ]
-  );
-
-  return (
-    <EscrowDialogsContext.Provider value={value}>
-      {children}
-    </EscrowDialogsContext.Provider>
-  );
-}
-
-export function useEscrowDialogs() {
-  const ctx = useContext(EscrowDialogsContext);
-  if (!ctx) {
-    throw new Error(
-      "useEscrowDialogs must be used within EscrowDialogsProvider"
-    );
-  }
-  return ctx;
-}