Interface Bank

Public shape added by BankMixin.

interface Bank {
    getBankPath(): string;
    getCorpo(): CorpoDescriptor | null;
    getCorpoKey(): string;
    getTillLiquidity(): Money;
    setCorpoKey(value: string): void;
}

Index

Methods

getBankPath getCorpo getCorpoKey getTillLiquidity setCorpoKey

Methods

getBankPath

getBankPath(): string
The durable account-resolution key for this branch (its templatePath).

Returns string
- Defined in packages/server/src/mud/lib/banking/Bank.ts:43

getCorpo

getCorpo(): CorpoDescriptor | null
The resolved corpo descriptor, or null when independent/unknown.

Returns CorpoDescriptor | null
- Defined in packages/server/src/mud/lib/banking/Bank.ts:41

getCorpoKey

getCorpoKey(): string
The bank's corpo affiliation key (resolved via CorpoApi).

Returns string
- Defined in packages/server/src/mud/lib/banking/Bank.ts:38

getTillLiquidity

getTillLiquidity(): Money
The branch's physical cash on hand (Σ vault coin face-values).

Returns Money
- Defined in packages/server/src/mud/lib/banking/Bank.ts:45

setCorpoKey

setCorpoKey(value: string): void
Parameters
- value: string
Returns void
- Defined in packages/server/src/mud/lib/banking/Bank.ts:39