Class DepositBankMemoService

Hierarchy (View Summary)

DepositBankMemoQueryService
- DepositBankMemoService

Index

Constructors

constructor

new DepositBankMemoService(
    args: {
        bankAdminService: BankAdminService;
        db: B2bDatabase;
        entityService: EntityService;
        eventPublisher: CustomerEventPublisher;
        productQuoteService: ProductQuoteService;
        valkeyClient: ValkeyClient | null;
    },
): DepositBankMemoService
Parameters
- args: {
      bankAdminService: BankAdminService;
      db: B2bDatabase;
      entityService: EntityService;
      eventPublisher: CustomerEventPublisher;
      productQuoteService: ProductQuoteService;
      valkeyClient: ValkeyClient | null;
  }
Returns DepositBankMemoService
Overrides DepositBankMemoQueryService.constructor
- Defined in packages/bank-memo-services/src/DepositBankMemoService.ts:585

Properties

`Protected` `Readonly`bankAdminService

bankAdminService: BankAdminService

`Protected` `Readonly`cache

cache: ServiceCache<{ hasNext: boolean; items: DepositBankMemoSearchItem[] }>

`Protected` `Readonly`db

db: B2bDatabase

`Protected` `Readonly`entityService

entityService: EntityService

`Protected` `Readonly`eventPublisher

eventPublisher: CustomerEventPublisher

`Protected` `Readonly`productQuoteService

productQuoteService: ProductQuoteService

`Static`instance

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

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

Methods

create

create(
    __namedParameters: Pick<
        DepositBankMemo,
        "name"
        | "productId"
        | "chain"
        | "frequency",
    > & {
        address: Address;
        customerId: string;
        entityId: string;
        sourceCurrency: string;
    },
): Promise<
    | { ok: true; value: DepositBankMemo }
    | { error: ServiceError; ok: false },
>
The memo slices the pool its product's route names for the entity. Takes no caller tx: it publishes an event and busts once the insert commits.
Parameters
- __namedParameters: Pick<DepositBankMemo, "name" | "productId" | "chain" | "frequency"> & {
      address: Address;
      customerId: string;
      entityId: string;
      sourceCurrency: string;
  }
Returns Promise<
| { ok: true; value: DepositBankMemo }
| { error: ServiceError; ok: false },
>
- Defined in packages/bank-memo-services/src/DepositBankMemoService.ts:603

delete

delete(
    __namedParameters: { customerId: string; memo: string },
): Promise<
    { ok: true; value: undefined }
    | { error: ServiceError; ok: false },
>
Parameters
- __namedParameters: { customerId: string; memo: string }
Returns Promise<{ ok: true; value: undefined } | { error: ServiceError; ok: false }>
- Defined in packages/bank-memo-services/src/DepositBankMemoService.ts:820

get

get(
    __namedParameters: {
        customerId: string;
        includeDeleted?: boolean;
        memo: string;
        tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
    },
): Promise<
    {
        ok: true;
        value: | (
            DepositBankMemo & { entityId: string; entityName: string; entityReferenceId: string | null; ledgerAccountName: string | null; }
        )
        | null;
    },
>
Parameters
- __namedParameters: {
      customerId: string;
      includeDeleted?: boolean;
      memo: string;
      tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
  }
Returns Promise<
    {
        ok: true;
        value: | (
            DepositBankMemo & { entityId: string; entityName: string; entityReferenceId: string | null; ledgerAccountName: string | null; }
        )
        | null;
    },
>
Inherited from DepositBankMemoQueryService.get
- Defined in packages/bank-memo-services/src/DepositBankMemoService.ts:288

invalidate

invalidate(
__namedParameters: { customerId: string; memo: string },
): Promise<void>
Busts one customer's cached searches by their membership tag, and the memo's folded get keys, the one bust a null client honours. Called by the writers after create and delete: DepositBankMemoService and DepositBankMemoAdminService.delete.
Parameters
- __namedParameters: { customerId: string; memo: string }
Returns Promise<void>
Inherited from DepositBankMemoQueryService.invalidate
- Defined in packages/bank-memo-services/src/DepositBankMemoService.ts:548

`Protected`resolveBanks

resolveBanks(rows: { bankId: string }[]): Promise<Map<string, Bank>>
Batch-resolve the banks referenced by rows into a Map<BankId, Bank>. One cached search({ ids }) covers all rows; the mapper throws if a row references a bank that's gone (should be impossible — bankId is a stored FK-ish slug).
Parameters
- rows: { bankId: string }[]
Returns Promise<Map<string, Bank>>
Inherited from DepositBankMemoQueryService.resolveBanks
- Defined in packages/bank-memo-services/src/DepositBankMemoService.ts:267

search

search(
    __namedParameters: DepositBankMemoSearchArgs & {
        tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
    },
): Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: DepositBankMemoSearchItem[] };
    },
>
Parameters
- __namedParameters: DepositBankMemoSearchArgs & {
  tx?: PgAsyncTransaction<NodePgQueryResultHKT, EmptyRelations>;
  }
Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: DepositBankMemoSearchItem[] };
    },
>
Inherited from DepositBankMemoQueryService.search
- Defined in packages/bank-memo-services/src/DepositBankMemoService.ts:316

Class DepositBankMemoService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DepositBankMemoService

Properties

`Protected` `Readonly`bankAdminService

`Protected` `Readonly`cache

`Protected` `Readonly`db

`Protected` `Readonly`entityService

`Protected` `Readonly`eventPublisher

`Protected` `Readonly`productQuoteService

`Static`instance

Methods

create

Parameters

Returns Promise<
| { ok: true; value: DepositBankMemo }
| { error: ServiceError; ok: false },
>

delete

Parameters

Returns Promise<{ ok: true; value: undefined } | { error: ServiceError; ok: false }>

get

Parameters

Returns Promise<
    {
        ok: true;
        value: | (
            DepositBankMemo & { entityId: string; entityName: string; entityReferenceId: string | null; ledgerAccountName: string | null; }
        )
        | null;
    },
>

invalidate

Parameters

Returns Promise<void>

`Protected`resolveBanks

Parameters

Returns Promise<Map<string, Bank>>

search

Parameters

Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: DepositBankMemoSearchItem[] };
    },
>

Settings

On This Page

Class DepositBankMemoService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DepositBankMemoService

Properties

Protected ReadonlybankAdminService

Protected Readonlycache

Protected Readonlydb

Protected ReadonlyentityService

Protected ReadonlyeventPublisher

Protected ReadonlyproductQuoteService

Staticinstance

Methods

create

Parameters

Returns Promise< | { ok: true; value: DepositBankMemo } | { error: ServiceError; ok: false },>

delete

Parameters

Returns Promise<{ ok: true; value: undefined } | { error: ServiceError; ok: false }>

get

Parameters

Returns Promise< { ok: true; value: | ( DepositBankMemo & { entityId: string; entityName: string; entityReferenceId: string | null; ledgerAccountName: string | null; } ) | null; },>

invalidate

Parameters

Returns Promise<void>

ProtectedresolveBanks

Parameters

Returns Promise<Map<string, Bank>>

search

Parameters

Returns Promise< { ok: true; value: { hasNext: boolean; items: DepositBankMemoSearchItem[] }; },>

Settings

On This Page

`Protected` `Readonly`bankAdminService

`Protected` `Readonly`cache

`Protected` `Readonly`db

`Protected` `Readonly`entityService

`Protected` `Readonly`eventPublisher

`Protected` `Readonly`productQuoteService

`Static`instance

Returns Promise<
| { ok: true; value: DepositBankMemo }
| { error: ServiceError; ok: false },
>

Returns Promise<
{
ok: true;
value: | (
DepositBankMemo & { entityId: string; entityName: string; entityReferenceId: string | null; ledgerAccountName: string | null; }
)
| null;
},
>

`Protected`resolveBanks

Returns Promise<
{
ok: true;
value: { hasNext: boolean; items: DepositBankMemoSearchItem[] };
},
>