Class MintInfo

Wraps a mint's /v1/info response with capability helpers.

Constructable from any GetInfoResponse, including one persisted from an earlier session; no live connection is needed. Persist cache and rehydrate with new MintInfo(stored). Accessors return snapshots, never internal references.

Constructors

constructor

new MintInfo(info: GetInfoResponse, logger?: Logger): MintInfo
Parameters
- info: GetInfoResponse
- Optionallogger: Logger
Returns MintInfo
- Defined in src/model/MintInfo.ts:49

Accessors

cache

get cache(): GetInfoResponse
Snapshot of the full mint info response, safe to mutate or persist.

Returns GetInfoResponse
- Defined in src/model/MintInfo.ts:523

contact

get contact(): MintContactInfo[]
Returns MintContactInfo[]
- Defined in src/model/MintInfo.ts:526

description

get description(): string | undefined
Returns string | undefined
- Defined in src/model/MintInfo.ts:529

description_long

get description_long(): string | undefined
Returns string | undefined
- Defined in src/model/MintInfo.ts:532

icon_url

get icon_url(): string | undefined
Returns string | undefined
- Defined in src/model/MintInfo.ts:550

maxArrayLength

get maxArrayLength(): number
NUT-06: max length the mint accepts for any array in a request (inputs, outputs, Ys). Always a usable number: the library default when the mint advertises none.

Returns number
- Defined in src/model/MintInfo.ts:573

motd

get motd(): string | undefined
Returns string | undefined
- Defined in src/model/MintInfo.ts:547

name

get name(): string
Returns string
- Defined in src/model/MintInfo.ts:535

nuts

get nuts(): {
    "10"?: { supported: boolean };
    "11"?: { supported: boolean };
    "12"?: { supported: boolean };
    "14"?: { supported: boolean };
    "15"?: { methods: MPPMethod[] };
    "17"?: { supported: WebSocketSupport[] };
    "19"?: {
        cached_endpoints: { method: "GET" | "POST"; path: string }[];
        ttl: number | null;
    };
    "20"?: { supported: boolean };
    "21"?: {
        client_id: string;
        openid_discovery: string;
        protected_endpoints?: { method: "GET" | "POST"; path: string }[];
    };
    "22"?: {
        bat_max_mint: number;
        protected_endpoints: { method: "GET"
        | "POST"; path: string }[];
    };
    "29"?: Nut29Info;
    "4": { disabled: boolean; methods: SwapMethod[] };
    "5": { disabled: boolean; methods: SwapMethod[] };
    "7"?: { supported: boolean };
    "8"?: { supported: boolean };
    "9"?: { supported: boolean };
}
Returns {
    "10"?: { supported: boolean };
    "11"?: { supported: boolean };
    "12"?: { supported: boolean };
    "14"?: { supported: boolean };
    "15"?: { methods: MPPMethod[] };
    "17"?: { supported: WebSocketSupport[] };
    "19"?: {
        cached_endpoints: { method: "GET" | "POST"; path: string }[];
        ttl: number | null;
    };
    "20"?: { supported: boolean };
    "21"?: {
        client_id: string;
        openid_discovery: string;
        protected_endpoints?: { method: "GET" | "POST"; path: string }[];
    };
    "22"?: {
        bat_max_mint: number;
        protected_endpoints: { method: "GET"
        | "POST"; path: string }[];
    };
    "29"?: Nut29Info;
    "4": { disabled: boolean; methods: SwapMethod[] };
    "5": { disabled: boolean; methods: SwapMethod[] };
    "7"?: { supported: boolean };
    "8"?: { supported: boolean };
    "9"?: { supported: boolean };
}
- Defined in src/model/MintInfo.ts:541

pubkey

get pubkey(): string
Returns string
- Defined in src/model/MintInfo.ts:538

time

get time(): number | undefined
Current server time as a Unix timestamp in seconds.

Returns number | undefined
- Defined in src/model/MintInfo.ts:563

tos_url

get tos_url(): string | undefined
Returns string | undefined
- Defined in src/model/MintInfo.ts:566

urls

get urls(): string[] | undefined
Endpoint URLs the mint advertises for itself. Informational only: whether to trust or switch to any of them is the consumer's decision.

Returns string[] | undefined
- Defined in src/model/MintInfo.ts:557

version

get version(): string
Returns string
- Defined in src/model/MintInfo.ts:544

Methods

isSupported

isSupported(num: 4 | 5): { disabled: boolean; params: SwapMethod[] }
Parameters
- num: 4 | 5
Returns { disabled: boolean; params: SwapMethod[] }
- Defined in src/model/MintInfo.ts:304
isSupported(num: 7 | 8 | 9 | 10 | 11 | 12 | 14 | 20): { supported: boolean }
Parameters
- num: 7 | 8 | 9 | 10 | 11 | 12 | 14 | 20
Returns { supported: boolean }
- Defined in src/model/MintInfo.ts:305
isSupported(num: 17): { params?: WebSocketSupport[]; supported: boolean }
Parameters
- num: 17
Returns { params?: WebSocketSupport[]; supported: boolean }
- Defined in src/model/MintInfo.ts:306
isSupported(num: 15): { params?: MPPMethod[]; supported: boolean }
Parameters
- num: 15
Returns { params?: MPPMethod[]; supported: boolean }
- Defined in src/model/MintInfo.ts:307
isSupported(num: 19): { params?: Nut19Policy; supported: boolean }
Parameters
- num: 19
Returns { params?: Nut19Policy; supported: boolean }
- Defined in src/model/MintInfo.ts:308
isSupported(num: 29): { params?: Nut29Info; supported: boolean }
Parameters
- num: 29
Returns { params?: Nut29Info; supported: boolean }
- Defined in src/model/MintInfo.ts:309

requiresBlindAuthToken

requiresBlindAuthToken(method: "GET" | "POST", path: string): boolean
Parameters
- method: "GET" | "POST"
- path: string
Returns boolean
- Defined in src/model/MintInfo.ts:344

requiresClearAuthToken

requiresClearAuthToken(method: "GET" | "POST", path: string): boolean
Parameters
- method: "GET" | "POST"
- path: string
Returns boolean
- Defined in src/model/MintInfo.ts:348

supportsAmountless

supportsAmountless(method?: string, unit?: string): boolean
Parameters
- method: string = 'bolt11'
- unit: string = 'sat'
Returns boolean
- Defined in src/model/MintInfo.ts:603

supportsMintMeltMethod

supportsMintMeltMethod(
    op: "mint" | "melt",
    method: string,
    unit: string,
): boolean
Checks if the mint advertises the given (method, unit) pair for the given operation ('mint' → NUT-4, 'melt' → NUT-5).
Parameters
- op: "mint" | "melt"
- method: string
- unit: string
Returns boolean
- Defined in src/model/MintInfo.ts:597

supportsNut04Description

supportsNut04Description(method: "bolt11" | "bolt12", unit?: string): boolean
Checks if the mint supports creating invoices/offers with a description for the specified payment method.
Parameters
- method: "bolt11" | "bolt12"
  The payment method to check ('bolt11' or 'bolt12')
- Optionalunit: string
Returns boolean
True if the mint supports description for the method, false otherwise.
- Defined in src/model/MintInfo.ts:584

`Static`normalizeInfo

normalizeInfo(info: GetInfoResponse, logger?: Logger): GetInfoResponse
Parameters
- info: GetInfoResponse
- logger: Logger = NULL_LOGGER
Returns GetInfoResponse
- Defined in src/model/MintInfo.ts:61

Class MintInfo

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns MintInfo

Accessors

cache

Returns GetInfoResponse

contact

Returns MintContactInfo[]

description

Returns string | undefined

description_long

Returns string | undefined

icon_url

Returns string | undefined

maxArrayLength

Returns number

motd

Returns string | undefined

name

Returns string

nuts

pubkey

Returns string

time

Returns number | undefined

tos_url

Returns string | undefined

urls

Returns string[] | undefined

version

Returns string

Methods

isSupported

Parameters

Returns { disabled: boolean; params: SwapMethod[] }

Parameters

Returns { supported: boolean }

Parameters

Returns { params?: WebSocketSupport[]; supported: boolean }

Parameters

Returns { params?: MPPMethod[]; supported: boolean }

Parameters

Returns { params?: Nut19Policy; supported: boolean }

Parameters

Returns { params?: Nut29Info; supported: boolean }

requiresBlindAuthToken

Parameters

Returns boolean

requiresClearAuthToken

Parameters

Returns boolean

supportsAmountless

Parameters

Returns boolean

supportsMintMeltMethod

Parameters

Returns boolean

supportsNut04Description

Parameters

Returns boolean

StaticnormalizeInfo

Parameters

Returns GetInfoResponse

Settings

On This Page

`Static`normalizeInfo