Class UtilaVaultAdminService

Management of the Utila vaults: which customer each belongs to, the generic vault the rest share, and the service accounts that act in them. The table's only writer: every write busts the cache UtilaVaultService reads.

Hierarchy (View Summary)

UtilaVaultService
- UtilaVaultAdminService

Index

Constructors

constructor

new UtilaVaultAdminService(
    __namedParameters: {
        cosignerHost: CosignerHostClient | null;
        db: B2bDatabase;
        internalEventPublisher: InternalEventPublisher | null;
        valkeyClient: ValkeyClient | null;
    },
): UtilaVaultAdminService
Parameters
- __namedParameters: {
      cosignerHost: CosignerHostClient | null;
      db: B2bDatabase;
      internalEventPublisher: InternalEventPublisher | null;
      valkeyClient: ValkeyClient | null;
  }
Returns UtilaVaultAdminService
Overrides UtilaVaultService.constructor
- Defined in packages/utila-services/src/UtilaVaultAdminService.ts:144

Properties

`Protected` `Readonly`cache

cache: ServiceCache<CachedSearchPage<UtilaVault>>

`Protected` `Readonly`db

db: B2bDatabase

`Static`instance

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

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

Methods

create

create(
    input: {
        adminServiceAccountEmail?: string | null;
        cosignerServiceAccountEmail?: string | null;
        customerId: string | null;
        name: string;
        utilaId: string;
        viewerServiceAccountEmail?: string | null;
    },
): Promise<
    { ok: true; value: UtilaVault }
    | { error: ServiceError; ok: false },
>
Registers a vault bought from Utila. customerId: null is the generic vault; a customer's own vault takes that customer's NEW wallets from here on. A vault given a cosigner account then has a device registered on the host; the vault exists whatever the outcome, which signingStatus records.
Parameters
- input: {
      adminServiceAccountEmail?: string | null;
      cosignerServiceAccountEmail?: string | null;
      customerId: string | null;
      name: string;
      utilaId: string;
      viewerServiceAccountEmail?: string | null;
  }
Returns Promise<{ ok: true; value: UtilaVault } | { error: ServiceError; ok: false }>
- Defined in packages/utila-services/src/UtilaVaultAdminService.ts:166

delete

delete(
    __namedParameters: { id: string },
): Promise<
    { ok: true; value: undefined }
    | { error: ServiceError; ok: false },
>
Soft-deletes a vault, so its customer's NEW wallets fall back to the internal or generic vault. Refused for the generic vault, and while any wallet row names it, deleted or disabled too: a deleted vault is no longer synced.
Parameters
- __namedParameters: { id: string }
Returns Promise<{ ok: true; value: undefined } | { error: ServiceError; ok: false }>
- Defined in packages/utila-services/src/UtilaVaultAdminService.ts:510

get

get(__namedParameters: { id: string }): Promise<UtilaVault | null>
Parameters
- __namedParameters: { id: string }
Returns Promise<UtilaVault | null>
Inherited from UtilaVaultService.get
- 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>
Inherited from UtilaVaultService.getForCustodialWallet
- 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.
Inherited from UtilaVaultService.getForOperations
- 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.
Inherited from UtilaVaultService.getForSweepWallet
- 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 UtilaVaultService.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 UtilaVaultService.invalidateVault
- Defined in packages/utila-services/src/UtilaVaultCache.ts:90

provision

provision(
    __namedParameters: { id: string },
): Promise<
    { ok: true; value: UtilaVault }
    | { error: ServiceError; ok: false },
>
Takes a vault with a cosigner account one step on: registers its device when it has none, else checks the device's approval and health. The retry for every state short of SIGNING; the outcome is recorded either way.
Parameters
- __namedParameters: { id: string }
Returns Promise<{ ok: true; value: UtilaVault } | { error: ServiceError; ok: false }>
- Defined in packages/utila-services/src/UtilaVaultAdminService.ts:257

`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 UtilaVaultService.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 };
    },
>
Inherited from UtilaVaultService.search
- 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 UtilaVaultService.searchTags
- Defined in packages/db/src/valkey/service-cache.ts:519

update

update(
    input: {
        adminServiceAccountEmail?: string | null;
        customerId?: string | null;
        id: string;
        name?: string;
        viewerServiceAccountEmail?: string | null;
    },
): Promise<
    { ok: true; value: UtilaVault }
    | { error: ServiceError; ok: false },
>
Renames a live vault, changes its service accounts, or gives it to another customer (null: nobody). Only NEW wallets follow: existing rows never move, so a customer cannot be given a vault holding another customer's wallets.
Parameters
- input: {
      adminServiceAccountEmail?: string | null;
      customerId?: string | null;
      id: string;
      name?: string;
      viewerServiceAccountEmail?: string | null;
  }
Returns Promise<{ ok: true; value: UtilaVault } | { error: ServiceError; ok: false }>
- Defined in packages/utila-services/src/UtilaVaultAdminService.ts:419

`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 UtilaVaultService.getCacheKey
- Defined in packages/utila-services/src/UtilaVaultCache.ts:47

Class UtilaVaultAdminService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns UtilaVaultAdminService

Properties

Protected Readonlycache

Protected Readonlydb

Staticinstance

Methods

create

Parameters

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

delete

Parameters

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

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>

provision

Parameters

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

ProtectedreadThrough

Parameters

Returns Promise<Page<UtilaVault>>

search

Parameters

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

ProtectedsearchTags

Parameters

Returns string[]

update

Parameters

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

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