Class Keyset

Index

Constructors

Accessors

expiry fee hasHexId hasKeys id isActive keys unit version

Methods

toMintKeys toMintKeyset verify fromMintApi verifyKeysetId

Constructors

constructor

new Keyset(
    id: string,
    unit: string,
    active: boolean,
    input_fee_ppk?: number,
    final_expiry?: number,
): Keyset
Parameters
- id: string
- unit: string
- active: boolean
- Optionalinput_fee_ppk: number
- Optionalfinal_expiry: number
Returns Keyset
- Defined in src/wallet/Keyset.ts:16

Accessors

expiry

get expiry(): number | undefined
Returns number | undefined
- Defined in src/wallet/Keyset.ts:46

fee

get fee(): number
Returns number
- Defined in src/wallet/Keyset.ts:42

hasHexId

get hasHexId(): boolean
True if the ID is modern byte-encoded hex.

Returns boolean
- Defined in src/wallet/Keyset.ts:57

hasKeys

get hasKeys(): boolean
Returns boolean
- Defined in src/wallet/Keyset.ts:50

id

get id(): string
Returns string
- Defined in src/wallet/Keyset.ts:30

isActive

get isActive(): boolean
Returns boolean
- Defined in src/wallet/Keyset.ts:38

keys

get keys(): Record<number, string>
Returns Record<number, string>
- Defined in src/wallet/Keyset.ts:68
set keys(keys: Record<number, string>): void
Parameters
- keys: Record<number, string>
Returns void
- Defined in src/wallet/Keyset.ts:72

unit

get unit(): string
Returns string
- Defined in src/wallet/Keyset.ts:34

version

get version(): number
Keyset ID version byte (-1 for base64 or unparseable IDs).

Returns number
- Defined in src/wallet/Keyset.ts:64

Methods

toMintKeys

toMintKeys(): MintKeys | null
To Mint API MintKeys format.

Returns MintKeys | null
MintKeys object.
- Defined in src/wallet/Keyset.ts:96

toMintKeyset

toMintKeyset(): MintKeyset
To Mint API MintKeyset format.

Returns MintKeyset
MintKeyset object.
- Defined in src/wallet/Keyset.ts:81

verify

verify(): boolean
Verifies that the keyset's ID matches the derived ID from its keys, unit, and expiry.

Returns boolean
True if verification succeeds, false otherwise (e.g: no keys or mismatch).
- Defined in src/wallet/Keyset.ts:115

`Static`fromMintApi

fromMintApi(meta: MintKeyset, keys?: MintKeys): Keyset
Create a Keyset from Mint API DTOs.
Parameters
- meta: MintKeyset
  The MintKeyset metadata from GetKeysetsResponse.
- Optionalkeys: MintKeys
  The MintKeys from GetKeysResponse.
Returns Keyset
Keyset instance.
- Defined in src/wallet/Keyset.ts:160

`Static`verifyKeysetId

verifyKeysetId(keys: MintKeys): boolean
Verifies that a MintKeys DTO has a correct id for its keys/unit/expiry.
Parameters
- keys: MintKeys
Returns boolean
True if verification succeeds, false otherwise (e.g: no keys, too many keys, one key serving two denominations, or mismatch).
- Defined in src/wallet/Keyset.ts:128