lnurlcash-kit 0.1.2 → 0.2.0

package/dist/index.d.ts

@@ -1,34 +1,19 @@
-declare const isBech32Lnurl: (data: string) => boolean;
-declare const toBech32Lnurl: (url: string) => string;
-declare const fromBech32Lnurl: (data: string) => string | null;
-declare const isAllowedServiceUrl: (value: string) => boolean;
-declare const fromLud17: (url: string) => string;
-declare const toLud17w: (url: string) => string;
-declare const isLightningAddress: (value: string) => boolean;
-declare const resolveMintInput: (value: string) => string | null;
-declare const mintAddressUrl: (payUrl: string) => string | null;
-declare const lightningAddressUsername: (payUrl: string) => string | null;
-declare const resolveLnurlInput: (value: string) => string | null;
-declare const serverOf: (url: string) => string;
-
-declare const noteK1: (url: string) => string | null;
-declare const requireNoteK1: (url: string) => string;
-declare const noteDeclaredAmount: (url: string) => number | null;
-declare const noteSignature: (url: string) => string | null;
-declare const resolveNoteInput: (value: string) => string | null;
-declare const isValidNoteInput: (value: string) => boolean;
-declare const buildNoteUrl: (withdrawLink: string, k1: string, amountMsat?: number) => string;
-declare const withNewK1: (url: string, k1: string, amountMsat: number, signature?: string) => string;
-declare const withoutK1: (url: string, amountMsat: number, signature?: string) => string;
-
 declare const hashK1: (k1: string) => string;
 type RandomSecret = () => string;
 declare const defaultRandomSecret: RandomSecret;
 declare const isPreimage: (value: string) => boolean;
+declare const deriveNoteRoot: (seed: Uint8Array) => Uint8Array;
+declare const deriveNoteSecret: (root: Uint8Array, host: string, index: number) => string;
+declare const derivedSecretSource: (root: Uint8Array, host: string, start?: number) => RandomSecret & {
+    index: () => number;
+};
 
-declare const noteSignatureMessage: (k1: string, amountMsat: number) => string;
-declare const noteSignatureDigest: (k1: string, amountMsat: number) => Uint8Array;
-declare const verifyNoteSignature: (k1: string, amountMsat: number, signatureHex: string, mintPubkeyHex: string) => boolean;
+type LnurlcashOptions = {
+    fetch?: typeof globalThis.fetch;
+    timeoutMs?: number;
+    offline?: boolean;
+    randomSecret?: RandomSecret;
+};
 
 type MintFee = {
     baseFeeMsat: number;
@@ -46,45 +31,6 @@ declare const grossUpForMintFee: (netMsat: number, fee: MintFee) => number;
 declare const formatFeePercent: (ppm: number) => string;
 declare const describeMintFee: (fee: MintFee) => string;
 
-declare const isBolt11Invoice: (value: string) => boolean;
-declare const sameInvoice: (a: string, b: string) => boolean;
-declare const decodeBolt11AmountMsat: (pr: string) => number | null;
-
-declare class LnurlcashError extends Error {
-    constructor(message: string);
-}
-declare class RequestRefusedError extends LnurlcashError {
-}
-declare class ProtocolError extends LnurlcashError {
-}
-declare class ServiceRejectedError extends LnurlcashError {
-    readonly reason: string;
-    constructor(reason: string);
-}
-declare class PendingNoteError extends ServiceRejectedError {
-    constructor(reason?: string);
-}
-declare class NoteSpentError extends ServiceRejectedError {
-    constructor(reason: string);
-}
-declare class NoteUnknownError extends ServiceRejectedError {
-    constructor(reason: string);
-}
-declare class AmbiguousMintError extends LnurlcashError {
-}
-declare class AmbiguousMutationError extends AmbiguousMintError {
-    readonly newSecrets: string[];
-    constructor(message: string, newSecrets: string[]);
-}
-declare const classifyNoteError: (reason: string) => ServiceRejectedError;
-
-type LnurlcashOptions = {
-    fetch?: typeof globalThis.fetch;
-    timeoutMs?: number;
-    offline?: boolean;
-    randomSecret?: RandomSecret;
-};
-
 type WithdrawRequestInfo = {
     tag: 'withdrawRequest';
     callback: string;
@@ -96,12 +42,18 @@ type WithdrawRequestInfo = {
 };
 declare const fetchNoteInfo: (url: string, options?: LnurlcashOptions) => Promise<WithdrawRequestInfo>;
 declare const probeBurnedNote: (url: string, options?: LnurlcashOptions) => Promise<"live" | "gone" | "unknown">;
+type MintContact = {
+    nostr?: string;
+    email?: string;
+    url?: string;
+};
 type MintAddressInfo = {
     tag: 'withdrawRequest';
     callback: string;
     minWithdrawable: number;
     maxWithdrawable: number;
     defaultDescription?: string;
+    mintPubkey?: string;
     nodePubkey?: string;
     payLink: string;
     nodeAlias?: string;
@@ -110,6 +62,15 @@ type MintAddressInfo = {
     nodeCapacityMsat?: number;
     nodeNumChannels?: number;
     nodeNumPeers?: number;
+    name?: string;
+    description?: string;
+    contact?: MintContact;
+    tosUrl?: string;
+    motd?: string;
+    fees?: MintFee;
+    version?: string;
+    previousPubkeys?: string[];
+    mintToHash?: boolean;
 };
 declare const fetchMintAddress: (url: string, options?: LnurlcashOptions) => Promise<MintAddressInfo>;
 type WithdrawSuccessResponse = {
@@ -163,20 +124,156 @@ type PayRequestInfo = {
     withdrawLink?: string;
     mintPubkey?: string;
     mintFee?: MintFee;
+    mintToHash?: boolean;
 };
 declare const fetchPayRequest: (url: string, options?: LnurlcashOptions) => Promise<PayRequestInfo>;
 type InvoiceResult = {
     pr: string;
     verify?: string;
     disposable: boolean;
+    mintToHash: boolean;
+};
+type InvoiceRequestOptions = LnurlcashOptions & {
+    h?: string;
 };
-declare const requestInvoice: (payCallback: string, amountMsat: number, options?: LnurlcashOptions) => Promise<InvoiceResult>;
+declare const requestInvoice: (payCallback: string, amountMsat: number, options?: InvoiceRequestOptions) => Promise<InvoiceResult>;
 type VerifyResult = {
     settled: boolean;
     preimage: string | null;
     pr: string;
 };
 declare const fetchInvoiceVerification: (verifyUrl: string, options?: LnurlcashOptions) => Promise<VerifyResult>;
+type MintClaim = {
+    state: 'minted' | 'unminted' | 'pending' | 'spent';
+    k1: string;
+    amountMsat: number | null;
+    callback: string | null;
+};
+declare const claimMintedNote: (withdrawLink: string, k1: string, options?: LnurlcashOptions) => Promise<MintClaim>;
+
+type SettleForValueOptions = {
+    mints: string[];
+    minMsat: number;
+    requireSignature?: boolean;
+};
+type SettledForValue = {
+    note: SettledNote;
+    newUrl: string;
+};
+declare const settleNoteForValue: (noteUrl: string, { mints, minMsat, requireSignature }: SettleForValueOptions, options?: LnurlcashOptions) => Promise<SettledForValue>;
+
+type RestoredNote = {
+    index: number;
+    k1: string;
+    amountMsat: number | null;
+    state: 'live' | 'pending';
+};
+type RestoreResult = {
+    found: RestoredNote[];
+    next: number;
+};
+type RestoreOptions = {
+    gap?: number;
+    start?: number;
+};
+declare const restoreNotes: (baseUrl: string, root: Uint8Array, host: string, { gap, start }?: RestoreOptions, options?: LnurlcashOptions) => Promise<RestoreResult>;
+
+declare const isBech32Lnurl: (data: string) => boolean;
+declare const toBech32Lnurl: (url: string) => string;
+declare const fromBech32Lnurl: (data: string) => string | null;
+declare const isAllowedServiceUrl: (value: string) => boolean;
+declare const fromLud17: (url: string) => string;
+declare const toLud17w: (url: string) => string;
+declare const isLightningAddress: (value: string) => boolean;
+declare const resolveMintInput: (value: string) => string | null;
+declare const mintAddressUrl: (payUrl: string) => string | null;
+declare const lightningAddressUsername: (payUrl: string) => string | null;
+declare const resolveLnurlInput: (value: string) => string | null;
+declare const serverOf: (url: string) => string;
+
+declare const noteK1: (url: string) => string | null;
+declare const requireNoteK1: (url: string) => string;
+declare const noteDeclaredAmount: (url: string) => number | null;
+declare const noteSignature: (url: string) => string | null;
+declare const resolveNoteInput: (value: string) => string | null;
+declare const isValidNoteInput: (value: string) => boolean;
+declare const buildNoteUrl: (withdrawLink: string, k1: string, amountMsat?: number) => string;
+declare const withNewK1: (url: string, k1: string, amountMsat: number, signature?: string) => string;
+declare const withoutK1: (url: string, amountMsat: number, signature?: string) => string;
+
+declare const PAYMENT_REQUEST_PREFIX = "lnurlcashreq1";
+type PaymentRequestMethodDetails = {
+    mints: string[];
+    mintPubkeys?: string[];
+};
+type PaymentRequest = {
+    v: 1;
+    id: string;
+    amount: string;
+    currency: 'sat';
+    methodDetails: PaymentRequestMethodDetails;
+    to?: string;
+    memo?: string;
+    expires?: number;
+};
+declare const paymentRequestAmountMsat: (request: PaymentRequest) => number;
+declare const encodePaymentRequest: (request: PaymentRequest) => string;
+type DecodeOptions = {
+    now?: number;
+};
+declare const decodePaymentRequest: (value: string, { now }?: DecodeOptions) => PaymentRequest;
+declare const isPaymentRequest: (value: string) => boolean;
+
+declare const noteSignatureMessage: (k1: string, amountMsat: number) => string;
+declare const noteSignatureDigest: (k1: string, amountMsat: number) => Uint8Array;
+type SignatureCheck = {
+    valid: true;
+    pubkey: string;
+} | {
+    valid: false;
+    pubkey: null;
+};
+declare const verifyNoteSignatureAgainst: (k1: string, amountMsat: number, signatureHex: string, mintPubkeys: string | string[]) => SignatureCheck;
+declare const verifyNoteSignature: (k1: string, amountMsat: number, signatureHex: string, mintPubkeys: string | string[]) => boolean;
+
+declare const isBolt11Invoice: (value: string) => boolean;
+declare const sameInvoice: (a: string, b: string) => boolean;
+declare const decodeBolt11AmountMsat: (pr: string) => number | null;
+
+declare class LnurlcashError extends Error {
+    constructor(message: string);
+}
+declare class RequestRefusedError extends LnurlcashError {
+}
+declare class ProtocolError extends LnurlcashError {
+}
+declare class ServiceRejectedError extends LnurlcashError {
+    readonly reason: string;
+    newSecrets?: string[];
+    constructor(reason: string);
+}
+declare class PendingNoteError extends ServiceRejectedError {
+    constructor(reason?: string);
+}
+declare class NoteSpentError extends ServiceRejectedError {
+    constructor(reason: string);
+}
+declare class NoteUnknownError extends ServiceRejectedError {
+    constructor(reason: string);
+}
+declare class AmbiguousMintError extends LnurlcashError {
+}
+declare class AmbiguousMutationError extends AmbiguousMintError {
+    readonly newSecrets: string[];
+    constructor(message: string, newSecrets: string[]);
+}
+declare class InsufficientValueError extends ServiceRejectedError {
+    readonly amountMsat: number;
+    readonly minMsat: number;
+    constructor(amountMsat: number, minMsat: number);
+}
+declare const newSecretsOf: (err: unknown) => string[];
+declare const classifyNoteError: (reason: string) => ServiceRejectedError;
 
 declare const createClient: (options?: LnurlcashOptions) => {
     fetchNoteInfo: (url: string) => Promise<WithdrawRequestInfo>;
@@ -191,9 +288,12 @@ declare const createClient: (options?: LnurlcashOptions) => {
     mergeNotesWithHash: (callback: string, k1s: string[], h: string) => Promise<HashedMutationResult>;
     settleNote: (baseUrl: string, k1: string, expectedAmountMsat: number, signature?: string) => Promise<SettledNote>;
     fetchPayRequest: (url: string) => Promise<PayRequestInfo>;
-    requestInvoice: (payCallback: string, amountMsat: number) => Promise<InvoiceResult>;
+    requestInvoice: (payCallback: string, amountMsat: number, h?: string) => Promise<InvoiceResult>;
     fetchInvoiceVerification: (verifyUrl: string) => Promise<VerifyResult>;
+    claimMintedNote: (withdrawLink: string, k1: string) => Promise<MintClaim>;
+    restoreNotes: (baseUrl: string, root: Uint8Array, host: string, restoreOptions?: RestoreOptions) => Promise<RestoreResult>;
+    settleNoteForValue: (noteUrl: string, terms: SettleForValueOptions) => Promise<SettledForValue>;
 };
 type LnurlcashClient = ReturnType<typeof createClient>;
 
-export { AmbiguousMintError, AmbiguousMutationError, type HashedMutationResult, type HashedSplitResult, type InvoiceResult, type LnurlcashClient, LnurlcashError, type LnurlcashOptions, type MeltResult, type MintAddressInfo, type MintFee, type MintFeeBand, NoteSpentError, NoteUnknownError, type PayRequestInfo, PendingNoteError, ProtocolError, type RandomSecret, RequestRefusedError, type RotateResult, ServiceRejectedError, type SettledNote, type SplitResult, type VerifyResult, type WithdrawRequestInfo, type WithdrawSuccessResponse, applyMintFee, buildNoteUrl, classifyNoteError, createClient, decodeBolt11AmountMsat, defaultRandomSecret, describeMintFee, fetchInvoiceVerification, fetchMintAddress, fetchNoteInfo, fetchPayRequest, formatFeePercent, fromBech32Lnurl, fromLud17, grossUpForMintFee, hashK1, isAllowedServiceUrl, isBech32Lnurl, isBolt11Invoice, isLightningAddress, isPreimage, isValidNoteInput, lightningAddressUsername, meltNote, mergeNotes, mergeNotesWithHash, mintAddressUrl, mintFeeBand, noteDeclaredAmount, noteK1, noteSignature, noteSignatureDigest, noteSignatureMessage, parseMintFee, probeBurnedNote, requestInvoice, requireNoteK1, resolveLnurlInput, resolveMintInput, resolveNoteInput, rotateNote, rotateNoteWithHash, sameInvoice, serverOf, settleNote, splitNote, splitNoteWithHash, toBech32Lnurl, toLud17w, verifyNoteSignature, withNewK1, withinMintFeeBand, withoutK1 };
+export { AmbiguousMintError, AmbiguousMutationError, type DecodeOptions, type HashedMutationResult, type HashedSplitResult, InsufficientValueError, type InvoiceRequestOptions, type InvoiceResult, type LnurlcashClient, LnurlcashError, type LnurlcashOptions, type MeltResult, type MintAddressInfo, type MintClaim, type MintContact, type MintFee, type MintFeeBand, NoteSpentError, NoteUnknownError, PAYMENT_REQUEST_PREFIX, type PayRequestInfo, type PaymentRequest, type PaymentRequestMethodDetails, PendingNoteError, ProtocolError, type RandomSecret, RequestRefusedError, type RestoreOptions, type RestoreResult, type RestoredNote, type RotateResult, ServiceRejectedError, type SettleForValueOptions, type SettledForValue, type SettledNote, type SignatureCheck, type SplitResult, type VerifyResult, type WithdrawRequestInfo, type WithdrawSuccessResponse, applyMintFee, buildNoteUrl, claimMintedNote, classifyNoteError, createClient, decodeBolt11AmountMsat, decodePaymentRequest, defaultRandomSecret, deriveNoteRoot, deriveNoteSecret, derivedSecretSource, describeMintFee, encodePaymentRequest, fetchInvoiceVerification, fetchMintAddress, fetchNoteInfo, fetchPayRequest, formatFeePercent, fromBech32Lnurl, fromLud17, grossUpForMintFee, hashK1, isAllowedServiceUrl, isBech32Lnurl, isBolt11Invoice, isLightningAddress, isPaymentRequest, isPreimage, isValidNoteInput, lightningAddressUsername, meltNote, mergeNotes, mergeNotesWithHash, mintAddressUrl, mintFeeBand, newSecretsOf, noteDeclaredAmount, noteK1, noteSignature, noteSignatureDigest, noteSignatureMessage, parseMintFee, paymentRequestAmountMsat, probeBurnedNote, requestInvoice, requireNoteK1, resolveLnurlInput, resolveMintInput, resolveNoteInput, restoreNotes, rotateNote, rotateNoteWithHash, sameInvoice, serverOf, settleNote, settleNoteForValue, splitNote, splitNoteWithHash, toBech32Lnurl, toLud17w, verifyNoteSignature, verifyNoteSignatureAgainst, withNewK1, withinMintFeeBand, withoutK1 };