Class DepositAdminService

Owns deposit-search. DepositAdminService is the only deposit writer; a deposit row embeds its quote, so quote writers bust it through DepositQuoteCache.

Hierarchy (View Summary)

DepositAdminQueryService
- DepositAdminService

Index

Constructors

constructor

new DepositAdminService(
    args: {
        db: B2bDatabase;
        depositQuoteAdminService: DepositQuoteAdminService;
        eventPublisher: CustomerEventPublisher;
        internalEventPublisher: InternalEventPublisher | null;
        valkeyClient: ValkeyClient | null;
    },
): DepositAdminService
Parameters
- args: {
      db: B2bDatabase;
      depositQuoteAdminService: DepositQuoteAdminService;
      eventPublisher: CustomerEventPublisher;
      internalEventPublisher: InternalEventPublisher | null;
      valkeyClient: ValkeyClient | null;
  }
Returns DepositAdminService
Overrides DepositAdminQueryService.constructor
- Defined in packages/deposit-services/src/DepositAdminService.ts:492

Properties

`Protected` `Readonly`cache

cache: ServiceCache<CachedSearchPage<Deposit>>

`Protected` `Readonly`db

db: B2bDatabase

`Static`instance

instance: (...args: []) => DepositAdminService = ...

The process default: built from each dependency's own instance().

Methods

create

create(
    args: {
        data?: Omit<
            { idempotencyKey?: string } & (
                | {
                    merchantId?: string;
                    retailChain?: string;
                    retailerName?: string;
                    storeAddress1?: string;
                    storeAddress2?: string;
                    storeCity?: string;
                    storeCounty?: string;
                    storeLatitude?: string;
                    storeLongitude?: string;
                    storeName?: string;
                    storeNumber?: string;
                    storeState?: string;
                    storeTransactionDate?: string;
                    storeZipcode?: string;
                    type: "CASH";
                }
                | { type: "US_WIRE" }
                | { type: "SWIFT_WIRE" }
                | { type: "US_BANK_ACH" }
                | { type: "RTP" }
                | { type: "FEDNOW" }
                | { type: "ACH_CREDIT" }
            ),
            "idempotencyKey",
        >;
        idempotencyKey: string;
        onCancelled?: "return" | "recreate";
        quoteId: string;
        tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
    },
): Promise<Deposit>
Parameters
- args: {
      data?: Omit<
          { idempotencyKey?: string } & (
              | {
                  merchantId?: string;
                  retailChain?: string;
                  retailerName?: string;
                  storeAddress1?: string;
                  storeAddress2?: string;
                  storeCity?: string;
                  storeCounty?: string;
                  storeLatitude?: string;
                  storeLongitude?: string;
                  storeName?: string;
                  storeNumber?: string;
                  storeState?: string;
                  storeTransactionDate?: string;
                  storeZipcode?: string;
                  type: "CASH";
              }
              | { type: "US_WIRE" }
              | { type: "SWIFT_WIRE" }
              | { type: "US_BANK_ACH" }
              | { type: "RTP" }
              | { type: "FEDNOW" }
              | { type: "ACH_CREDIT" }
          ),
          "idempotencyKey",
      >;
      idempotencyKey: string;
      onCancelled?: "return" | "recreate";
      quoteId: string;
      tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
  }
  - Optionaldata?: Omit<
        { idempotencyKey?: string } & (
            | {
                merchantId?: string;
                retailChain?: string;
                retailerName?: string;
                storeAddress1?: string;
                storeAddress2?: string;
                storeCity?: string;
                storeCounty?: string;
                storeLatitude?: string;
                storeLongitude?: string;
                storeName?: string;
                storeNumber?: string;
                storeState?: string;
                storeTransactionDate?: string;
                storeZipcode?: string;
                type: "CASH";
            }
            | { type: "US_WIRE" }
            | { type: "SWIFT_WIRE" }
            | { type: "US_BANK_ACH" }
            | { type: "RTP" }
            | { type: "FEDNOW" }
            | { type: "ACH_CREDIT" }
        ),
        "idempotencyKey",
    >
  - idempotencyKey: string
  - OptionalonCancelled?: "return" | "recreate"
    
    What to do when the key already resolves to a CANCELLED deposit. A live deposit under the key is returned idempotently on both.
    
    "return" (default) hands back the terminal row. The public accept path takes a customer-supplied key, and idempotency there means the same key always answers the same thing.
    
    "recreate" inserts a fresh deposit and leaves the cancelled row as history. Only the processFromBankTransaction rails ask for this, where the key is a bankTransactionId and a re-drive means "process this credit", not "give me the previous answer". Throws DepositCancelledAfterMintError when the dead deposit already minted.
    
    Reviving a cancelled deposit is not one of the modes: the Green Dot AUTH arm of the consumption drain does that itself, where the authorisation sequence it belongs to is readable.
  - quoteId: string
  - Optionaltx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>
Returns Promise<Deposit>
- Defined in packages/deposit-services/src/DepositAdminService.ts:517

findAchBatchStatuses

findAchBatchStatuses(
__namedParameters: { achBatchId: string },
): Promise<{ ok: true; value: Pick<Deposit, "id" | "status">[] }>
Every deposit on an ACH batch with its status, read from the database. Batch reconciliation rewrites the credit's DEPOSIT_IDS from these, so a cached status would put back a deposit that has cancelled.
Parameters
- __namedParameters: { achBatchId: string }
Returns Promise<{ ok: true; value: Pick<Deposit, "id" | "status">[] }>
Inherited from DepositAdminQueryService.findAchBatchStatuses
- Defined in packages/deposit-services/src/DepositAdminService.ts:234

findFeeSweep

findFeeSweep(
    __namedParameters: { id: string },
): Promise<
    { ok: true; value: Pick<Deposit, "updatedAt" | "feeSweepTxId">
    | null },
>
The fee transfer a deposit already recorded and when the row last changed, read from the database, or null without the deposit. The mint reads it so a retry records its fee once.
Parameters
- __namedParameters: { id: string }
Returns Promise<{ ok: true; value: Pick<Deposit, "updatedAt" | "feeSweepTxId"> | null }>
Inherited from DepositAdminQueryService.findFeeSweep
- Defined in packages/deposit-services/src/DepositAdminService.ts:215

findInStatus

findInStatus(
    __namedParameters: {
        id: string;
        statuses: (
            "PENDING"
            | "CANCELLED"
            | "PROCESSING"
            | "COMPLETED"
            | "RETURNED"
        )[];
    },
): Promise<{ ok: true; value: Deposit | null }>
The deposit while it is still in one of statuses, read from the database. For a guard that acts on that status, where a stale cached status would let it act on a deposit that has since settled or cancelled.
Parameters
- __namedParameters: {
      id: string;
      statuses: (
          "PENDING"
          | "CANCELLED"
          | "PROCESSING"
          | "COMPLETED"
          | "RETURNED"
      )[];
  }
Returns Promise<{ ok: true; value: Deposit | null }>
Inherited from DepositAdminQueryService.findInStatus
- Defined in packages/deposit-services/src/DepositAdminService.ts:199

get

get(
    __namedParameters: {
        id: string;
        includeHistory?: boolean;
        tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
    },
): Promise<{ ok: true; value: Deposit | null }>
Get a deposit by ID without customer restriction
Parameters
- __namedParameters: {
      id: string;
      includeHistory?: boolean;
      tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
  }
Returns Promise<{ ok: true; value: Deposit | null }>
Inherited from DepositAdminQueryService.get
- Defined in packages/deposit-services/src/DepositAdminService.ts:99

invalidateCache

invalidateCache(
    __namedParameters: {
        customerIds: readonly string[];
        keys?: readonly CacheKey[];
        records?: readonly string[];
    },
): Promise<void>
Clear each customer's membership tag and each record tag wherever cached, and always this namespace's collection tag. keys are exact deletes in this instance's key space: the only bust a null client honours.
Parameters
- __namedParameters: {
      customerIds: readonly string[];
      keys?: readonly CacheKey[];
      records?: readonly string[];
  }
Returns Promise<void>
Inherited from DepositAdminQueryService.invalidateCache
- Defined in packages/db/src/valkey/service-cache.ts:543

invalidateCreated

invalidateCreated(createdDeposit: Deposit): Promise<void>
Busts what a new deposit changes and publishes deposit.deposit.created. create calls this itself; a caller that passed tx calls it after commit.
Parameters
- createdDeposit: Deposit
Returns Promise<void>
- Defined in packages/deposit-services/src/DepositAdminService.ts:736

search

search(
__namedParameters: DepositAdminSearchArgs,
): Promise<{ ok: true; value: DepositAdminSearchPage }>
Admin search for deposits without customer restriction
Parameters
- __namedParameters: DepositAdminSearchArgs
Returns Promise<{ ok: true; value: DepositAdminSearchPage }>
Inherited from DepositAdminQueryService.search
- Defined in packages/deposit-services/src/DepositAdminService.ts:120

searchIterator

searchIterator(
params: Omit<Parameters<DepositAdminQueryService["search"]>[0], "page">,
): AsyncGenerator<Deposit>
Parameters
- params: Omit<Parameters<DepositAdminQueryService["search"]>[0], "page">
Returns AsyncGenerator<Deposit>
Inherited from DepositAdminQueryService.searchIterator
- Defined in packages/deposit-services/src/DepositAdminService.ts:423

`Protected`searchTags

searchTags(
    __namedParameters: {
        customerIds: readonly string[] | undefined;
        fields?: readonly string[];
        records?: readonly string[];
    },
): string[]
Tags for a page: the scope its query searched (each customer's membership tag, else the collection tag), so an empty page is bustable too, plus the records it projects and the fields that chose or ordered its rows.
Parameters
- __namedParameters: {
      customerIds: readonly string[] | undefined;
      fields?: readonly string[];
      records?: readonly string[];
  }
Returns string[]
Inherited from DepositAdminQueryService.searchTags
- Defined in packages/db/src/valkey/service-cache.ts:519

update

update(
    args: {
        bankTransactionId?: string;
        data: {
            feeSweepTxId?: string | null;
            feeSweepTxType?: "SOLANA_TRANSACTION_SIGNATURE" | null;
            receiptId?: string | null;
            receiptType?: "SOLANA_TRANSACTION_SIGNATURE" | null;
            status?:
                | "PENDING"
                | "CANCELLED"
                | "PROCESSING"
                | "COMPLETED"
                | "RETURNED";
            storeData?: Partial<
                Omit<
                    { idempotencyKey?: string } & {
                        merchantId?: string;
                        retailChain?: string;
                        retailerName?: string;
                        storeAddress1?: string;
                        storeAddress2?: string;
                        storeCity?: string;
                        storeCounty?: string;
                        storeLatitude?: string;
                        storeLongitude?: string;
                        storeName?: string;
                        storeNumber?: string;
                        storeState?: string;
                        storeTransactionDate?: string;
                        storeZipcode?: string;
                        type: "CASH";
                    },
                    "type"
                    | "idempotencyKey",
                >,
            >;
        };
        expectedStatuses?: (
            "PENDING"
            | "CANCELLED"
            | "PROCESSING"
            | "COMPLETED"
            | "RETURNED"
        )[];
        id: string;
        reason?: string;
        unlessInAchFile?: boolean;
    },
): Promise<{ applied: true } | { applied: false; inAchFile: boolean }>
Parameters
- args: {
      bankTransactionId?: string;
      data: {
          feeSweepTxId?: string | null;
          feeSweepTxType?: "SOLANA_TRANSACTION_SIGNATURE" | null;
          receiptId?: string | null;
          receiptType?: "SOLANA_TRANSACTION_SIGNATURE" | null;
          status?: "PENDING" | "CANCELLED" | "PROCESSING" | "COMPLETED" | "RETURNED";
          storeData?: Partial<
              Omit<
                  { idempotencyKey?: string } & {
                      merchantId?: string;
                      retailChain?: string;
                      retailerName?: string;
                      storeAddress1?: string;
                      storeAddress2?: string;
                      storeCity?: string;
                      storeCounty?: string;
                      storeLatitude?: string;
                      storeLongitude?: string;
                      storeName?: string;
                      storeNumber?: string;
                      storeState?: string;
                      storeTransactionDate?: string;
                      storeZipcode?: string;
                      type: "CASH";
                  },
                  "type"
                  | "idempotencyKey",
              >,
          >;
      };
      expectedStatuses?: (
          "PENDING"
          | "CANCELLED"
          | "PROCESSING"
          | "COMPLETED"
          | "RETURNED"
      )[];
      id: string;
      reason?: string;
      unlessInAchFile?: boolean;
  }
  - OptionalbankTransactionId?: string
    
    The bank transaction (an ACH return) that made this transition, recorded beside reason.
  - data: {
        feeSweepTxId?: string | null;
        feeSweepTxType?: "SOLANA_TRANSACTION_SIGNATURE" | null;
        receiptId?: string | null;
        receiptType?: "SOLANA_TRANSACTION_SIGNATURE" | null;
        status?: "PENDING" | "CANCELLED" | "PROCESSING" | "COMPLETED" | "RETURNED";
        storeData?: Partial<
            Omit<
                { idempotencyKey?: string } & {
                    merchantId?: string;
                    retailChain?: string;
                    retailerName?: string;
                    storeAddress1?: string;
                    storeAddress2?: string;
                    storeCity?: string;
                    storeCounty?: string;
                    storeLatitude?: string;
                    storeLongitude?: string;
                    storeName?: string;
                    storeNumber?: string;
                    storeState?: string;
                    storeTransactionDate?: string;
                    storeZipcode?: string;
                    type: "CASH";
                },
                "type"
                | "idempotencyKey",
            >,
        >;
    }
  - OptionalexpectedStatuses?: ("PENDING" | "CANCELLED" | "PROCESSING" | "COMPLETED" | "RETURNED")[]
    
    Compare-and-set: from any other status nothing is written or published.
  - id: string
  - Optionalreason?: string
    
    Why the status changed, recorded on the transition and surfaced as failure_reason. Set by operators and by the machine paths that cancel a deposit — a CANCELLED write without one is indistinguishable from the others on the history row.
  - OptionalunlessInAchFile?: boolean
    
    Refuse while the deposit's ACH batch is on an unarchived file, whose NACHA contents already carry its entry. Checked under locks file creation waits on.
Returns Promise<{ applied: true } | { applied: false; inAchFile: boolean }>
- Defined in packages/deposit-services/src/DepositAdminService.ts:775

`Static`adminGetCacheKeys

adminGetCacheKeys(__namedParameters: { id: string }): CacheKey[]
The key get reads through on the admin surface: { ids: [id], includeHistory, pageSize: 1 } plus search's page default. Writers pass both includeHistory variants so read-after-write holds under a null client.
Parameters
- __namedParameters: { id: string }
Returns CacheKey[]
Inherited from DepositAdminQueryService.adminGetCacheKeys
- Defined in packages/deposit-services/src/DepositCache.ts:45

Class DepositAdminService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DepositAdminService

Properties

Protected Readonlycache

Protected Readonlydb

Staticinstance

Methods

create

Parameters

idempotencyKey: string

OptionalonCancelled?: "return" | "recreate"

quoteId: string

Optionaltx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>

Returns Promise<Deposit>

findAchBatchStatuses

Parameters

Returns Promise<{ ok: true; value: Pick<Deposit, "id" | "status">[] }>

findFeeSweep

Parameters

Returns Promise<{ ok: true; value: Pick<Deposit, "updatedAt" | "feeSweepTxId"> | null }>

findInStatus

Parameters

Returns Promise<{ ok: true; value: Deposit | null }>

get

Parameters

Returns Promise<{ ok: true; value: Deposit | null }>

invalidateCache

Parameters

Returns Promise<void>

invalidateCreated

Parameters

Returns Promise<void>

search

Parameters

Returns Promise<{ ok: true; value: DepositAdminSearchPage }>

searchIterator

Parameters

Returns AsyncGenerator<Deposit>

ProtectedsearchTags

Parameters

Returns string[]

update

Parameters

OptionalbankTransactionId?: string

OptionalexpectedStatuses?: ("PENDING" | "CANCELLED" | "PROCESSING" | "COMPLETED" | "RETURNED")[]

id: string

Optionalreason?: string

OptionalunlessInAchFile?: boolean

Returns Promise<{ applied: true } | { applied: false; inAchFile: boolean }>

StaticadminGetCacheKeys

Parameters

Returns CacheKey[]

Settings

On This Page

`Protected` `Readonly`cache

`Protected` `Readonly`db

`Static`instance

`Optional`onCancelled?: "return" | "recreate"

`Optional`tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>

`Protected`searchTags

`Optional`bankTransactionId?: string

`Optional`expectedStatuses?: ("PENDING" | "CANCELLED" | "PROCESSING" | "COMPLETED" | "RETURNED")[]

`Optional`reason?: string

`Optional`unlessInAchFile?: boolean

`Static`adminGetCacheKeys