Class Keyset

Index

Constructors

Accessors

active expiry fee final_expiry hasHexId hasKeys id input_fee_ppk isActive keys unit

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:13

Accessors

active

get active(): boolean
Returns boolean
Deprecated
Use isActive instead.
- Defined in src/wallet/Keyset.ts:66

expiry

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

fee

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

final_expiry

get final_expiry(): undefined | number
Returns undefined | number
Deprecated
Use expiry instead.
- Defined in src/wallet/Keyset.ts:80

hasHexId

get hasHexId(): boolean
Returns boolean
- Defined in src/wallet/Keyset.ts:51

hasKeys

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

id

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

input_fee_ppk

get input_fee_ppk(): number
Returns number
Deprecated
Use fee instead.
- Defined in src/wallet/Keyset.ts:73

isActive

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

keys

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

unit

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

Methods

toMintKeys

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

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

toMintKeyset

toMintKeyset(): MintKeyset
To Mint API MintKeyset format.

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

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:123

`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:158

`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 or mismatch).
- Defined in src/wallet/Keyset.ts:135