@cfxlabsinc/b2b-services
    Preparing search index...

    Class UtilaCustodialWalletAdminQueryService

    Hierarchy (View Summary)

    Index
    constructor
    db
    countsByCustomer entityNameExpression get search
    db: B2bDatabase

    • How many of a customer's custodial wallets are live, and how many are hidden.

      One scan with FILTER aggregates rather than two search calls: the deleted count is only meaningful next to the live one — "2, 1 deleted" is a single fact about the customer, so it should cost a single round trip. Exact, unlike counting a capped page.

      Parameters

      • args: { customerId: string }

      Returns Promise<{ ok: true; value: { deleted: number; live: number } }>

    • The wallet owner's display name — the identity's full name for a person, the organization's name for a business. Built here rather than inlined because it is needed twice: once in the projection and once in the q predicate (Postgres can't reference a select alias from WHERE).

      Returns SQL<unknown>

    • Parameters

      • args: { id: string }

      Returns Promise<
          | {
              ok: true;
              value: | {
                  addresses: Record<UtilaBlockchain, UtilaWalletAddress[]>;
                  createdAt: Date;
                  deletedAt: Date | null;
                  id: string;
                  updatedAt: Date;
                  vaultId: string;
              } & UtilaCustodialWalletReferences
              | null;
          }
          | { error: ServiceError; ok: false },
      >

    • Parameters

      • __namedParameters: {
            createdAt?: DbTimestampCriteria;
            customerIds?: string[];
            entityIds?: string[];
            entityTypes?: ("PERSON" | "BUSINESS")[];
            ids?: string[];
            includeDeleted?: boolean;
            orderBy?: DbOrderByCriterion<
                Omit<
                    PgTableWithColumns<
                        {
                            columns: {
                                createdAt: PgBuildColumn<
                                    "utila_custodial_wallet",
                                    SetHasDefault<SetNotNull<(...)>>,
                                    {
                                        data: Date;
                                        dataType: "object date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "utila_custodial_wallet";
                                    },
                                >;
                                customerId: PgBuildColumn<
                                    "utila_custodial_wallet",
                                    SetNotNull<PgIntegerBuilder>,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...) | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "utila_custodial_wallet";
                                    },
                                >;
                                data: PgBuildColumn<
                                    "utila_custodial_wallet",
                                    SetNotNull<Set$Type<(...), (...)>>,
                                    {
                                        data: { addresses: ... };
                                        dataType: "object json";
                                        driverParam: unknown;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "utila_custodial_wallet";
                                    },
                                >;
                                deletedAt: PgBuildColumn<
                                    "utila_custodial_wallet",
                                    PgTimestampBuilder,
                                    {
                                        data: Date;
                                        dataType: "object date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "utila_custodial_wallet";
                                    },
                                >;
                                id: PgBuildColumn<
                                    "utila_custodial_wallet",
                                    HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...) | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: "byDefault";
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "utila_custodial_wallet";
                                    },
                                >;
                                identityId: PgBuildColumn<
                                    "utila_custodial_wallet",
                                    PgIntegerBuilder,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...)
                                        | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "utila_custodial_wallet";
                                    },
                                >;
                                organizationId: PgBuildColumn<
                                    "utila_custodial_wallet",
                                    PgIntegerBuilder,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...)
                                        | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "utila_custodial_wallet";
                                    },
                                >;
                                updatedAt: PgBuildColumn<
                                    "utila_custodial_wallet",
                                    SetHasDefault<SetHasDefault<(...)>>,
                                    {
                                        data: Date;
                                        dataType: "object date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "utila_custodial_wallet";
                                    },
                                >;
                                vaultId: PgBuildColumn<
                                    "utila_custodial_wallet",
                                    SetNotNull<PgTextBuilder<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "utila_custodial_wallet";
                                    },
                                >;
                                walletId: PgBuildColumn<
                                    "utila_custodial_wallet",
                                    SetNotNull<PgTextBuilder<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "utila_custodial_wallet";
                                    },
                                >;
                            };
                            dialect: "pg";
                            name: "utila_custodial_wallet";
                            schema: "b2b";
                        },
                    >,
                    "enableRLS",
                >,
                "createdAt"
                | "updatedAt",
            >[];
            page?: number;
            pageSize?: number;
            q?: string;
            updatedAt?: DbTimestampCriteria;
        }
        • OptionalcreatedAt?: DbTimestampCriteria
        • OptionalcustomerIds?: string[]
        • OptionalentityIds?: string[]
        • OptionalentityTypes?: ("PERSON" | "BUSINESS")[]

          Narrow to wallets owned by people (identity_id) or by businesses (organization_id). Distinct from entityIds, which names specific entities — this is the "all people" / "all businesses" cut.

        • Optionalids?: string[]
        • OptionalincludeDeleted?: boolean

          Include soft-deleted wallets. Off by default so every caller that forgets it gets the live set. Admin-only: the consumer service has no such flag, because a deleted wallet is precisely one a customer must not see.

        • OptionalorderBy?: DbOrderByCriterion<
              Omit<
                  PgTableWithColumns<
                      {
                          columns: {
                              createdAt: PgBuildColumn<
                                  "utila_custodial_wallet",
                                  SetHasDefault<SetNotNull<(...)>>,
                                  {
                                      data: Date;
                                      dataType: "object date";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "utila_custodial_wallet";
                                  },
                              >;
                              customerId: PgBuildColumn<
                                  "utila_custodial_wallet",
                                  SetNotNull<PgIntegerBuilder>,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...) | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "utila_custodial_wallet";
                                  },
                              >;
                              data: PgBuildColumn<
                                  "utila_custodial_wallet",
                                  SetNotNull<Set$Type<(...), (...)>>,
                                  {
                                      data: { addresses: ... };
                                      dataType: "object json";
                                      driverParam: unknown;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "utila_custodial_wallet";
                                  },
                              >;
                              deletedAt: PgBuildColumn<
                                  "utila_custodial_wallet",
                                  PgTimestampBuilder,
                                  {
                                      data: Date;
                                      dataType: "object date";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "utila_custodial_wallet";
                                  },
                              >;
                              id: PgBuildColumn<
                                  "utila_custodial_wallet",
                                  HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...) | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: "byDefault";
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "utila_custodial_wallet";
                                  },
                              >;
                              identityId: PgBuildColumn<
                                  "utila_custodial_wallet",
                                  PgIntegerBuilder,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...)
                                      | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "utila_custodial_wallet";
                                  },
                              >;
                              organizationId: PgBuildColumn<
                                  "utila_custodial_wallet",
                                  PgIntegerBuilder,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...)
                                      | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "utila_custodial_wallet";
                                  },
                              >;
                              updatedAt: PgBuildColumn<
                                  "utila_custodial_wallet",
                                  SetHasDefault<SetHasDefault<(...)>>,
                                  {
                                      data: Date;
                                      dataType: "object date";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "utila_custodial_wallet";
                                  },
                              >;
                              vaultId: PgBuildColumn<
                                  "utila_custodial_wallet",
                                  SetNotNull<PgTextBuilder<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "utila_custodial_wallet";
                                  },
                              >;
                              walletId: PgBuildColumn<
                                  "utila_custodial_wallet",
                                  SetNotNull<PgTextBuilder<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "utila_custodial_wallet";
                                  },
                              >;
                          };
                          dialect: "pg";
                          name: "utila_custodial_wallet";
                          schema: "b2b";
                      },
                  >,
                  "enableRLS",
              >,
              "createdAt"
              | "updatedAt",
          >[]
        • Optionalpage?: number

          Defaults to 1

        • OptionalpageSize?: number

          Defaults to 10

        • Optionalq?: string

          Case-insensitive substring over the Utila wallet id, the owning customer's name, the entity's name, and the derived addresses — an operator most often arrives holding an address off a block explorer and needs the wallet it belongs to.

        • OptionalupdatedAt?: DbTimestampCriteria

      Returns Promise<
          {
              ok: true;
              value: {
                  hasNext: boolean;
                  items: (
                      {
                          addresses: Record<UtilaBlockchain, UtilaWalletAddress[]>;
                          createdAt: Date;
                          deletedAt: Date | null;
                          id: string;
                          updatedAt: Date;
                          vaultId: string;
                      } & UtilaCustodialWalletReferences
                  )[];
                  total: number;
              };
          },
      >

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods