useListEscrows

useListEscrows

List escrows (GET /escrows) with keyset pagination and filters.

Import

import { useListEscrows } from "@trustless-work/escrow/hooks/rest";

Signature

function useListEscrows(): {
  listEscrows: (params?: ListEscrowsParams) => Promise<ListEscrowsResponse>;
};

ListEscrowsResponse = KeysetPage<EscrowSummary> → { data, hasMore, nextCursor }.

Params

Param	Type	Notes
scope	"mine" | "all"	Segmentation (not access grants)
status	EscrowStatus	active | released | disputed
contractType	EscrowType	Filter name; response field is type
engagementId	string
contractIds	string[]
participant	string	Address
role	Role
platformId / subjectId	string
createdAfter / createdBefore	string	ISO timestamps
limit	number
cursor	string	Keyset cursor
sort	"createdAt" | "updatedAt"
order	"asc" | "desc"

Example

import { useListEscrows } from "@trustless-work/escrow/hooks/rest";
import { useQuery } from "@tanstack/react-query";

const { listEscrows } = useListEscrows();

const { data, isLoading } = useQuery({
  queryKey: ["escrows", "mine", { status: "active" }],
  queryFn: () =>
    listEscrows({
      scope: "mine",
      status: "active",
      limit: 20,
      sort: "createdAt",
      order: "desc",
    }),
});

// data?.data → EscrowSummary[]
// data?.hasMore / data?.nextCursor → load more