Class LedgerAccountAdminService

Hierarchy (View Summary)

LedgerAccountAdminQueryService
- LedgerAccountAdminService

Index

Constructors

constructor

new LedgerAccountAdminService(
    args: {
        db: B2bDatabase;
        entityEventPublisher: EntityEventPublisher;
        solanaAccountBalanceQueryService: SolanaAccountBalanceQueryService;
        valkeyClient: ValkeyClient | null;
    },
): LedgerAccountAdminService
Parameters
- args: {
      db: B2bDatabase;
      entityEventPublisher: EntityEventPublisher;
      solanaAccountBalanceQueryService: SolanaAccountBalanceQueryService;
      valkeyClient: ValkeyClient | null;
  }
Returns LedgerAccountAdminService
Overrides LedgerAccountAdminQueryService.constructor
- Defined in packages/ledger-account-services/src/wallet/LedgerAccountAdminService.ts:675

Properties

`Protected` `Readonly`adminSearchCache

adminSearchCache: ServiceCache<CachedLedgerAccountAdminSearch>

This service's own cross-customer admin search cache (read + write).

`Protected` `Readonly`consumerSearchCache

consumerSearchCache: ServiceCache<CachedLedgerAccountSearch>

Buster over the ledger-account-consumer-search namespace owned by LedgerAccountQueryService. Admin writes and the Helius on-chain balance webhook bypass LedgerAccountQueryService, so they must also bust the consumer cache the customer dashboard reads — same namespace + cluster busts cross-process.

`Protected` `Readonly`db

db: B2bDatabase

Methods

get

get(
    args: { id: string },
): Promise<
    {
        ok: true;
        value: | {
            address: Address;
            balance: BigNumber;
            createdAt: Date;
            id: string;
            name: string;
            notes?: string;
            paymentInstrumentId?: string;
            permissions: "ALL"
            | "ADMIN";
            referenceId?: string;
            tokenAccounts: Record<"MOVEUSD", { address: Address }>;
            updatedAt: Date;
            visibility: "PRIVATE" | "PUBLIC";
        } & {
            customerId: string;
            customerName: string;
            customerOrganizationId: string;
            entityDisplayName: string;
            entityId: string;
            entityReferenceId: string
            | null;
            entityType: "IDENTITY" | "ORGANIZATION";
        }
        | null;
    },
>
Get the given ledger account for the given customer
Parameters
- args: { id: string }
Returns Promise<
    {
        ok: true;
        value: | {
            address: Address;
            balance: BigNumber;
            createdAt: Date;
            id: string;
            name: string;
            notes?: string;
            paymentInstrumentId?: string;
            permissions: "ALL"
            | "ADMIN";
            referenceId?: string;
            tokenAccounts: Record<"MOVEUSD", { address: Address }>;
            updatedAt: Date;
            visibility: "PRIVATE" | "PUBLIC";
        } & {
            customerId: string;
            customerName: string;
            customerOrganizationId: string;
            entityDisplayName: string;
            entityId: string;
            entityReferenceId: string
            | null;
            entityType: "IDENTITY" | "ORGANIZATION";
        }
        | null;
    },
>
Inherited from LedgerAccountAdminQueryService.get
- Defined in packages/ledger-account-services/src/wallet/LedgerAccountAdminService.ts:596

getAggregateBalance

getAggregateBalance(
__namedParameters: { bankIds?: string[]; q?: string },
): Promise<{ ok: true; value: { totalBalance: BigNumber } }>
Total MOVEUSD balance across the banks' ledger accounts. Honors the same bankIds + q filters as search so a filtered view's total matches the rows it shows.
Parameters
- __namedParameters: { bankIds?: string[]; q?: string }
  - OptionalbankIds?: string[]
  - Optionalq?: string
    Case-insensitive substring match on account name or entity name.
Returns Promise<{ ok: true; value: { totalBalance: BigNumber } }>
Inherited from LedgerAccountAdminQueryService.getAggregateBalance
- Defined in packages/ledger-account-services/src/wallet/LedgerAccountAdminService.ts:213

invalidateTag

invalidateTag(__namedParameters: { customerId: string }): Promise<void>
Seam for the Helius on-chain balance webhook (and admin writers) to bust the ledger-account search caches. Busts both the consumer cache (tagged by the owning external customerId) and this service's cross-customer admin cache (single collection tag) in lockstep — so the admin pickers invalidate whenever the consumer dashboard does, including on balance changes.
Parameters
- __namedParameters: { customerId: string }
Returns Promise<void>
Inherited from LedgerAccountAdminQueryService.invalidateTag
- Defined in packages/ledger-account-services/src/wallet/LedgerAccountAdminService.ts:124

search

search(
    args: LedgerAccountAdminSearchArgs,
): Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: LedgerAccountAdminSearchItem[];
            total: number;
        };
    },
>
Search ledger accounts across customers (cross-customer admin search). Read-through cached; see LEDGER_ACCOUNT_ADMIN_SEARCH_CACHE.
Parameters
- args: LedgerAccountAdminSearchArgs
Returns Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: LedgerAccountAdminSearchItem[];
            total: number;
        };
    },
>
Inherited from LedgerAccountAdminQueryService.search
- Defined in packages/ledger-account-services/src/wallet/LedgerAccountAdminService.ts:271

searchKeys

searchKeys(
    __namedParameters: LedgerAccountAdminSearchArgs,
): Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: { owner: string; tokenAccounts: string[] }[];
        };
    },
>
Parameters
- __namedParameters: LedgerAccountAdminSearchArgs
Returns Promise<
    {
        ok: true;
        value: {
            hasNext: boolean;
            items: { owner: string; tokenAccounts: string[] }[];
        };
    },
>
Inherited from LedgerAccountAdminQueryService.searchKeys
- Defined in packages/ledger-account-services/src/wallet/LedgerAccountAdminService.ts:479

update

update(
    __namedParameters: {
        customerId?: string;
        data: Pick<LedgerAccount, "name" | "permissions" | "visibility" | "notes">;
        id: string;
    },
): Promise<void>
Parameters
- __namedParameters: {
      customerId?: string;
      data: Pick<LedgerAccount, "name" | "permissions" | "visibility" | "notes">;
      id: string;
  }
Returns Promise<void>
- Defined in packages/ledger-account-services/src/wallet/LedgerAccountAdminService.ts:685

Class LedgerAccountAdminService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LedgerAccountAdminService

Properties

`Protected` `Readonly`adminSearchCache

`Protected` `Readonly`consumerSearchCache

`Protected` `Readonly`db

Methods

get

Parameters

getAggregateBalance

Parameters

`Optional`bankIds?: string[]

`Optional`q?: string

Returns Promise<{ ok: true; value: { totalBalance: BigNumber } }>

invalidateTag

Parameters

Returns Promise<void>

search

Parameters

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

searchKeys

Parameters

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

update

Parameters

Returns Promise<void>

Settings

On This Page

Class LedgerAccountAdminService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LedgerAccountAdminService

Properties

Protected ReadonlyadminSearchCache

Protected ReadonlyconsumerSearchCache

Protected Readonlydb

Methods

get

Parameters

getAggregateBalance

Parameters

OptionalbankIds?: string[]

Optionalq?: string

Returns Promise<{ ok: true; value: { totalBalance: BigNumber } }>

invalidateTag

Parameters

Returns Promise<void>

search

Parameters

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

searchKeys

Parameters

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

update

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`adminSearchCache

`Protected` `Readonly`consumerSearchCache

`Protected` `Readonly`db

`Optional`bankIds?: string[]

`Optional`q?: string

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

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