Class UtilaVaultService

The Utila vaults, and which one each kind of wallet or operation uses. UtilaVaultAdminService adds the writes, each of which busts this cache.

Hierarchy (View Summary)

UtilaVaultCache
- UtilaVaultService
  - UtilaVaultAdminService

Index

Constructors

constructor

new UtilaVaultService(
    __namedParameters: {
        db: B2bDatabase;
        valkeyClient: ValkeyClient | null;
    },
): UtilaVaultService
Parameters
- __namedParameters: { db: B2bDatabase; valkeyClient: ValkeyClient | null }
Returns UtilaVaultService
Overrides UtilaVaultCache.constructor
- Defined in packages/utila-services/src/UtilaVaultService.ts:51

Properties

`Protected` `Readonly`cache

cache: ServiceCache<CachedSearchPage<UtilaVault>>

`Protected` `Readonly`db

db: B2bDatabase

`Static`instance

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

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

Methods

get

get(__namedParameters: { id: string }): Promise<UtilaVault | null>
Parameters
- __namedParameters: { id: string }
Returns Promise<UtilaVault | null>
- Defined in packages/utila-services/src/UtilaVaultService.ts:82

getForCustodialWallet

getForCustodialWallet(
__namedParameters: { customerId: string },
): Promise<UtilaVault | null>
The vault customerId's custodial wallets are created in: its own live vault, else the generic vault. Null when neither exists.
Parameters
- __namedParameters: { customerId: string }
Returns Promise<UtilaVault | null>
- Defined in packages/utila-services/src/UtilaVaultService.ts:91

getForOperations

getForOperations(): Promise<UtilaVault | null>
The vault CFX's own signing, minting and program operations run in: the internal vault, else the generic vault. Null when neither exists.

Returns Promise<UtilaVault | null>

Throws
when two live vaults are owned by internal customers.
- Defined in packages/utila-services/src/UtilaVaultService.ts:121

getForSweepWallet

getForSweepWallet(
__namedParameters: { customerId: string },
): Promise<UtilaVault | null>
The vault customerId's sweep wallets are created in: its own live vault, else CFX's internal vault, else the generic vault. Null when none exists.
Parameters
- __namedParameters: { customerId: string }
Returns Promise<UtilaVault | null>

Throws
when two live vaults are owned by internal customers.
- Defined in packages/utila-services/src/UtilaVaultService.ts:106

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 UtilaVaultCache.invalidateCache
- Defined in packages/db/src/valkey/service-cache.ts:543

`Protected`invalidateVault

invalidateVault(__namedParameters: Pick<UtilaVault, "id">): Promise<void>
Bust every page a write to vault could have changed: the collection tag reaches every cached page, and the folded get key covers memory mode.
Parameters
- __namedParameters: Pick<UtilaVault, "id">
Returns Promise<void>
Inherited from UtilaVaultCache.invalidateVault
- Defined in packages/utila-services/src/UtilaVaultCache.ts:90

`Protected`readThrough

readThrough(
key: CacheKey,
read: () => Promise<Page<UtilaVault>>,
): Promise<Page<UtilaVault>>
Read-through: the cached page for key, else read() stored under the collection tag.
Parameters
- key: CacheKey
- read: () => Promise<Page<UtilaVault>>
Returns Promise<Page<UtilaVault>>
Inherited from UtilaVaultCache.readThrough
- Defined in packages/utila-services/src/UtilaVaultCache.ts:56

search

search(
    __namedParameters?: UtilaVaultFilters & { includeDeleted?: boolean },
): Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: UtilaVault[]; total: number };
    },
>
Stored rows only; the getFor* reads apply the fallbacks.
Parameters
- __namedParameters: UtilaVaultFilters & { includeDeleted?: boolean } = {}
Returns Promise<
    {
        ok: true;
        value: { hasNext: boolean; items: UtilaVault[]; total: number };
    },
>
- Defined in packages/utila-services/src/UtilaVaultService.ts:63

`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 UtilaVaultCache.searchTags
- Defined in packages/db/src/valkey/service-cache.ts:519

`Static`getCacheKey

getCacheKey(__namedParameters: { id: string }): Record<string, unknown>
The exact key UtilaVaultService.get reads through: the args it passes plus search's defaults. JCS drops the undefined filters. Writers delete it so read-after-write holds in memory mode.
Parameters
- __namedParameters: { id: string }
Returns Record<string, unknown>
Inherited from UtilaVaultCache.getCacheKey
- Defined in packages/utila-services/src/UtilaVaultCache.ts:47

Class UtilaVaultService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UtilaVaultService

Properties

Protected Readonlycache

Protected Readonlydb

Staticinstance

Methods

get

Parameters

Returns Promise<UtilaVault | null>

getForCustodialWallet

Parameters

Returns Promise<UtilaVault | null>

getForOperations

Returns Promise<UtilaVault | null>

Throws

getForSweepWallet

Parameters

Returns Promise<UtilaVault | null>

Throws

invalidateCache

Parameters

Returns Promise<void>

ProtectedinvalidateVault

Parameters

Returns Promise<void>

ProtectedreadThrough

Parameters

Returns Promise<Page<UtilaVault>>

search

Parameters

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

ProtectedsearchTags

Parameters

Returns string[]

StaticgetCacheKey

Parameters

Returns Record<string, unknown>

Settings

On This Page

`Protected` `Readonly`cache

`Protected` `Readonly`db

`Static`instance

`Protected`invalidateVault

`Protected`readThrough

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

`Protected`searchTags

`Static`getCacheKey