@breeztech/breez-sdk-spark 0.5.1 → 0.6.0-rc1

package/bundler/breez_sdk_spark_wasm.d.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 export function initLogging(logger: Logger, filter?: string | null): Promise<void>;
-export function connect(request: ConnectRequest): Promise<BreezSdk>;
 export function defaultConfig(network: Network): Config;
+export function connect(request: ConnectRequest): Promise<BreezSdk>;
 /**
  * Entry point invoked by JavaScript in a worker.
  */
@@ -45,8 +45,6 @@ export interface BitcoinChainService {
     recommendedFees(): Promise<RecommendedFees>;
 }
 
-export type ChainApiType = "esplora" | "mempoolSpace";
-
 export interface RecommendedFees {
     fastestFee: number;
     halfHourFee: number;
@@ -55,6 +53,12 @@ export interface RecommendedFees {
     minimumFee: number;
 }
 
+export interface TxStatus {
+    confirmed: boolean;
+    blockHeight?: number;
+    blockTime?: number;
+}
+
 export interface Utxo {
     txid: string;
     vout: number;
@@ -62,154 +66,105 @@ export interface Utxo {
     status: TxStatus;
 }
 
-export interface TxStatus {
-    confirmed: boolean;
-    blockHeight?: number;
-    blockTime?: number;
-}
+export type ChainApiType = "esplora" | "mempoolSpace";
 
 export interface PaymentObserver {
     beforeSend: (payments: ProvisionalPayment[]) => Promise<void>;
 }
 
-export interface OutgoingChange {
-    change: RecordChange;
-    parent?: Record;
-}
-
-export interface SyncWalletResponse {}
-
-export interface PrepareLnurlPayResponse {
-    amountSats: number;
-    comment?: string;
-    payRequest: LnurlPayRequestDetails;
-    feeSats: number;
-    invoiceDetails: Bolt11InvoiceDetails;
-    successAction?: SuccessAction;
-}
+export type PaymentType = "send" | "receive";
 
-export interface LightningAddressDetails {
+export interface BitcoinAddressDetails {
     address: string;
-    payRequest: LnurlPayRequestDetails;
+    network: BitcoinNetwork;
+    source: PaymentRequestSource;
 }
 
-export interface LnurlPayInfo {
-    lnAddress?: string;
-    comment?: string;
-    domain?: string;
-    metadata?: string;
-    processedSuccessAction?: SuccessActionProcessed;
-    rawSuccessAction?: SuccessAction;
+export interface ReceivePaymentRequest {
+    paymentMethod: ReceivePaymentMethod;
 }
 
-export interface UnversionedRecordChange {
-    id: RecordId;
-    schemaVersion: string;
-    updatedFields: Map<string, string>;
+export interface LnurlWithdrawResponse {
+    paymentRequest: string;
+    payment?: Payment;
 }
 
-export type ProvisionalPaymentDetails = { type: "bitcoin"; withdrawalAddress: string } | { type: "lightning"; invoice: string } | { type: "spark"; payRequest: string } | { type: "token"; tokenId: string; payRequest: string };
+export type ReceivePaymentMethod = { type: "sparkAddress" } | { type: "sparkInvoice"; amount?: bigint; tokenIdentifier?: string; expiryTime?: number; description?: string; senderPublicKey?: string } | { type: "bitcoinAddress" } | { type: "bolt11Invoice"; description: string; amountSats?: number };
 
-export interface RefundDepositRequest {
+export interface DepositInfo {
     txid: string;
     vout: number;
-    destinationAddress: string;
-    fee: Fee;
-}
-
-export interface RecordId {
-    type: string;
-    dataId: string;
-}
-
-export interface LnurlWithdrawResponse {
-    paymentRequest: string;
-    payment?: Payment;
+    amountSats: number;
+    refundTx?: string;
+    refundTxId?: string;
+    claimError?: DepositClaimError;
 }
 
-export interface LnurlWithdrawRequestDetails {
-    callback: string;
-    k1: string;
-    defaultDescription: string;
-    minWithdrawable: number;
-    maxWithdrawable: number;
+export interface PaymentMetadata {
+    lnurlPayInfo?: LnurlPayInfo;
+    lnurlWithdrawInfo?: LnurlWithdrawInfo;
+    lnurlDescription?: string;
 }
 
-export interface SignMessageResponse {
-    pubkey: string;
-    signature: string;
+export interface ExternalInputParser {
+    providerId: string;
+    inputRegex: string;
+    parserUrl: string;
 }
 
-export type Fee = { type: "fixed"; amount: number } | { type: "rate"; satPerVbyte: number };
-
-export interface ClaimHtlcPaymentResponse {
-    payment: Payment;
-}
+export type Network = "mainnet" | "regtest";
 
-export interface ListFiatCurrenciesResponse {
-    currencies: FiatCurrency[];
+export interface SilentPaymentAddressDetails {
+    address: string;
+    network: BitcoinNetwork;
+    source: PaymentRequestSource;
 }
 
-export interface RecordChange {
-    id: RecordId;
-    schemaVersion: string;
-    updatedFields: Map<string, string>;
-    revision: number;
+export interface GetTokensMetadataRequest {
+    tokenIdentifiers: string[];
 }
 
-export interface LnurlPayRequestDetails {
-    callback: string;
-    minSendable: number;
-    maxSendable: number;
-    metadataStr: string;
-    commentAllowed: number;
-    domain: string;
-    url: string;
-    address?: string;
-    allowsNostr?: boolean;
-    nostrPubkey?: string;
+export interface Bolt11RouteHint {
+    hops: Bolt11RouteHintHop[];
 }
 
-export interface Bolt12Invoice {
-    invoice: string;
-    source: PaymentRequestSource;
+export interface RefundDepositResponse {
+    txId: string;
+    txHex: string;
 }
 
-export interface Bip21Extra {
-    key: string;
-    value: string;
+export interface SendPaymentRequest {
+    prepareResponse: PrepareSendPaymentResponse;
+    options?: SendPaymentOptions;
+    idempotencyKey?: string;
 }
 
-export type SparkHtlcStatus = "waitingForPreimage" | "preimageShared" | "returned";
+export type InputType = ({ type: "bitcoinAddress" } & BitcoinAddressDetails) | ({ type: "bolt11Invoice" } & Bolt11InvoiceDetails) | ({ type: "bolt12Invoice" } & Bolt12InvoiceDetails) | ({ type: "bolt12Offer" } & Bolt12OfferDetails) | ({ type: "lightningAddress" } & LightningAddressDetails) | ({ type: "lnurlPay" } & LnurlPayRequestDetails) | ({ type: "silentPaymentAddress" } & SilentPaymentAddressDetails) | ({ type: "lnurlAuth" } & LnurlAuthRequestDetails) | ({ type: "url" } & string) | ({ type: "bip21" } & Bip21Details) | ({ type: "bolt12InvoiceRequest" } & Bolt12InvoiceRequestDetails) | ({ type: "lnurlWithdraw" } & LnurlWithdrawRequestDetails) | ({ type: "sparkAddress" } & SparkAddressDetails) | ({ type: "sparkInvoice" } & SparkInvoiceDetails);
 
-export interface LightningAddressInfo {
-    description: string;
-    lightningAddress: string;
-    lnurl: string;
-    username: string;
+export interface LnurlWithdrawRequest {
+    amountSats: number;
+    withdrawRequest: LnurlWithdrawRequestDetails;
+    completionTimeoutSecs?: number;
 }
 
-export interface CheckMessageRequest {
-    message: string;
-    pubkey: string;
-    signature: string;
+export interface RecordId {
+    type: string;
+    dataId: string;
 }
 
-export interface Bolt12InvoiceRequestDetails {}
-
-export interface TokenBalance {
-    balance: bigint;
-    tokenMetadata: TokenMetadata;
+export interface IncomingChange {
+    newState: Record;
+    oldState?: Record;
 }
 
-export interface Bolt12OfferBlindedPath {
-    blindedHops: string[];
+export interface SparkInvoicePaymentDetails {
+    description?: string;
+    invoice: string;
 }
 
-export type DepositClaimError = { type: "depositClaimFeeExceeded"; tx: string; vout: number; maxFee?: Fee; actualFee: number } | { type: "missingUtxo"; tx: string; vout: number } | { type: "generic"; message: string };
-
-export interface GetPaymentRequest {
-    paymentId: string;
+export interface Bolt12Offer {
+    offer: string;
+    source: PaymentRequestSource;
 }
 
 export interface PaymentRequestSource {
@@ -217,208 +172,195 @@ export interface PaymentRequestSource {
     bip353Address?: string;
 }
 
-export interface ListUnclaimedDepositsResponse {
-    deposits: DepositInfo[];
+export interface TokenBalance {
+    balance: bigint;
+    tokenMetadata: TokenMetadata;
 }
 
-export type PaymentStatus = "completed" | "pending" | "failed";
-
-export interface LnurlPayRequest {
-    prepareResponse: PrepareLnurlPayResponse;
-    idempotencyKey?: string;
+export interface SignMessageResponse {
+    pubkey: string;
+    signature: string;
 }
 
-export type SuccessActionProcessed = { type: "aes"; result: AesSuccessActionDataResult } | { type: "message"; data: MessageSuccessActionData } | { type: "url"; data: UrlSuccessActionData };
+export interface GetPaymentResponse {
+    payment: Payment;
+}
 
-export type OnchainConfirmationSpeed = "fast" | "medium" | "slow";
+export type PaymentDetails = { type: "spark"; invoiceDetails?: SparkInvoicePaymentDetails; htlcDetails?: SparkHtlcDetails } | { type: "token"; metadata: TokenMetadata; txHash: string; invoiceDetails?: SparkInvoicePaymentDetails } | { type: "lightning"; description?: string; preimage?: string; invoice: string; paymentHash: string; destinationPubkey: string; lnurlPayInfo?: LnurlPayInfo; lnurlWithdrawInfo?: LnurlWithdrawInfo; lnurlReceiveMetadata?: LnurlReceiveMetadata } | { type: "withdraw"; txId: string } | { type: "deposit"; txId: string };
 
 export interface LocalizedName {
     locale: string;
     name: string;
 }
 
-export interface SparkHtlcOptions {
-    paymentHash: string;
-    expiryDurationSecs: number;
+export interface PrepareLnurlPayResponse {
+    amountSats: number;
+    comment?: string;
+    payRequest: LnurlPayRequestDetails;
+    feeSats: number;
+    invoiceDetails: Bolt11InvoiceDetails;
+    successAction?: SuccessAction;
 }
 
 export interface CheckMessageResponse {
     isValid: boolean;
 }
 
-export interface CheckLightningAddressRequest {
-    username: string;
+export type ProvisionalPaymentDetails = { type: "bitcoin"; withdrawalAddress: string } | { type: "lightning"; invoice: string } | { type: "spark"; payRequest: string } | { type: "token"; tokenId: string; payRequest: string };
+
+export type Seed = { type: "mnemonic"; mnemonic: string; passphrase?: string } | ({ type: "entropy" } & number[]);
+
+export type SparkHtlcStatus = "waitingForPreimage" | "preimageShared" | "returned";
+
+export interface Symbol {
+    grapheme?: string;
+    template?: string;
+    rtl?: boolean;
+    position?: number;
 }
 
-export interface PrepareLnurlPayRequest {
-    amountSats: number;
-    comment?: string;
-    payRequest: LnurlPayRequestDetails;
-    validateSuccessActionUrl?: boolean;
+export type MaxFee = { type: "fixed"; amount: number } | { type: "rate"; satPerVbyte: number } | { type: "networkRecommended"; leewaySatPerVbyte: number };
+
+export interface UpdateUserSettingsRequest {
+    sparkPrivateModeEnabled?: boolean;
 }
 
-export interface UserSettings {
-    sparkPrivateModeEnabled: boolean;
+export interface RegisterLightningAddressRequest {
+    username: string;
+    description?: string;
 }
 
 export type KeySetType = "default" | "taproot" | "nativeSegwit" | "wrappedSegwit" | "legacy";
 
-export interface LogEntry {
-    line: string;
-    level: string;
+export interface LocaleOverrides {
+    locale: string;
+    spacing?: number;
+    symbol: Symbol;
 }
 
-export interface PrepareSendPaymentResponse {
-    paymentMethod: SendPaymentMethod;
-    amount: bigint;
-    tokenIdentifier?: string;
-}
+export type AssetFilter = { type: "bitcoin" } | { type: "token"; tokenIdentifier?: string };
 
-export interface RefundDepositResponse {
-    txId: string;
-    txHex: string;
+export interface ListUnclaimedDepositsResponse {
+    deposits: DepositInfo[];
 }
 
-export interface Credentials {
+export interface LightningAddressInfo {
+    description: string;
+    lightningAddress: string;
+    lnurl: string;
     username: string;
-    password: string;
 }
 
-export interface Payment {
-    id: string;
-    paymentType: PaymentType;
-    status: PaymentStatus;
-    amount: bigint;
-    fees: bigint;
-    timestamp: number;
-    method: PaymentMethod;
-    details?: PaymentDetails;
+export interface TokenMetadata {
+    identifier: string;
+    issuerPublicKey: string;
+    name: string;
+    ticker: string;
+    decimals: number;
+    maxSupply: bigint;
+    isFreezable: boolean;
 }
 
-export interface Bolt11RouteHintHop {
-    srcNodeId: string;
-    shortChannelId: string;
-    feesBaseMsat: number;
-    feesProportionalMillionths: number;
-    cltvExpiryDelta: number;
-    htlcMinimumMsat?: number;
-    htlcMaximumMsat?: number;
+export interface Config {
+    apiKey?: string;
+    network: Network;
+    syncIntervalSecs: number;
+    maxDepositClaimFee?: MaxFee;
+    lnurlDomain?: string;
+    preferSparkOverLightning: boolean;
+    externalInputParsers?: ExternalInputParser[];
+    useDefaultExternalInputParsers: boolean;
+    realTimeSyncServerUrl?: string;
+    privateEnabledDefault: boolean;
 }
 
-export interface MessageSuccessActionData {
-    message: string;
+export interface ProvisionalPayment {
+    paymentId: string;
+    amount: bigint;
+    details: ProvisionalPaymentDetails;
 }
 
-export interface SendPaymentResponse {
-    payment: Payment;
+export interface SparkHtlcOptions {
+    paymentHash: string;
+    expiryDurationSecs: number;
 }
 
-export type SendPaymentOptions = { type: "bitcoinAddress"; confirmationSpeed: OnchainConfirmationSpeed } | { type: "bolt11Invoice"; preferSpark: boolean; completionTimeoutSecs?: number } | { type: "sparkAddress"; htlcOptions?: SparkHtlcOptions };
+export interface SyncWalletRequest {}
 
-export interface GetInfoRequest {
-    ensureSynced?: boolean;
+export interface MessageSuccessActionData {
+    message: string;
 }
 
-export interface SendOnchainSpeedFeeQuote {
-    userFeeSat: number;
-    l1BroadcastFeeSat: number;
+export interface PrepareSendPaymentRequest {
+    paymentRequest: string;
+    amount?: bigint;
+    tokenIdentifier?: string;
 }
 
-export interface Rate {
-    coin: string;
-    value: number;
+export interface RecordChange {
+    id: RecordId;
+    schemaVersion: string;
+    updatedFields: Map<string, string>;
+    revision: number;
 }
 
-export type ReceivePaymentMethod = { type: "sparkAddress" } | { type: "sparkInvoice"; amount?: bigint; tokenIdentifier?: string; expiryTime?: number; description?: string; senderPublicKey?: string } | { type: "bitcoinAddress" } | { type: "bolt11Invoice"; description: string; amountSats?: number };
+export type DepositClaimError = { type: "maxDepositClaimFeeExceeded"; tx: string; vout: number; maxFee?: Fee; requiredFeeSats: number; requiredFeeRateSatPerVbyte: number } | { type: "missingUtxo"; tx: string; vout: number } | { type: "generic"; message: string };
 
-export type Seed = { type: "mnemonic"; mnemonic: string; passphrase?: string } | ({ type: "entropy" } & number[]);
-
-export interface GetTokensMetadataRequest {
-    tokenIdentifiers: string[];
+export interface LogEntry {
+    line: string;
+    level: string;
 }
 
-export type InputType = ({ type: "bitcoinAddress" } & BitcoinAddressDetails) | ({ type: "bolt11Invoice" } & Bolt11InvoiceDetails) | ({ type: "bolt12Invoice" } & Bolt12InvoiceDetails) | ({ type: "bolt12Offer" } & Bolt12OfferDetails) | ({ type: "lightningAddress" } & LightningAddressDetails) | ({ type: "lnurlPay" } & LnurlPayRequestDetails) | ({ type: "silentPaymentAddress" } & SilentPaymentAddressDetails) | ({ type: "lnurlAuth" } & LnurlAuthRequestDetails) | ({ type: "url" } & string) | ({ type: "bip21" } & Bip21Details) | ({ type: "bolt12InvoiceRequest" } & Bolt12InvoiceRequestDetails) | ({ type: "lnurlWithdraw" } & LnurlWithdrawRequestDetails) | ({ type: "sparkAddress" } & SparkAddressDetails) | ({ type: "sparkInvoice" } & SparkInvoiceDetails);
-
-export type SuccessAction = { type: "aes"; data: AesSuccessActionData } | { type: "message"; data: MessageSuccessActionData } | { type: "url"; data: UrlSuccessActionData };
+export interface ListUnclaimedDepositsRequest {}
 
-export interface ListPaymentsRequest {
-    typeFilter?: PaymentType[];
-    statusFilter?: PaymentStatus[];
-    assetFilter?: AssetFilter;
-    sparkHtlcStatusFilter?: SparkHtlcStatus[];
-    fromTimestamp?: number;
-    toTimestamp?: number;
-    offset?: number;
-    limit?: number;
-    sortAscending?: boolean;
-}
+export type UpdateDepositPayload = { type: "claimError"; error: DepositClaimError } | { type: "refund"; refundTxid: string; refundTx: string };
 
-export interface Bolt12InvoiceDetails {
-    amountMsat: number;
-    invoice: Bolt12Invoice;
+export interface GetInfoResponse {
+    balanceSats: number;
+    tokenBalances: Map<string, TokenBalance>;
 }
 
-export interface Symbol {
-    grapheme?: string;
-    template?: string;
-    rtl?: boolean;
-    position?: number;
+export interface SendOnchainSpeedFeeQuote {
+    userFeeSat: number;
+    l1BroadcastFeeSat: number;
 }
 
-export type SdkEvent = { type: "synced" } | { type: "dataSynced"; didPullNewRecords: boolean } | { type: "unclaimedDeposits"; unclaimedDeposits: DepositInfo[] } | { type: "claimedDeposits"; claimedDeposits: DepositInfo[] } | { type: "paymentSucceeded"; payment: Payment } | { type: "paymentPending"; payment: Payment } | { type: "paymentFailed"; payment: Payment };
+export type SendPaymentMethod = { type: "bitcoinAddress"; address: BitcoinAddressDetails; feeQuote: SendOnchainFeeQuote } | { type: "bolt11Invoice"; invoiceDetails: Bolt11InvoiceDetails; sparkTransferFeeSats?: number; lightningFeeSats: number } | { type: "sparkAddress"; address: string; fee: bigint; tokenIdentifier?: string } | { type: "sparkInvoice"; sparkInvoiceDetails: SparkInvoiceDetails; fee: bigint; tokenIdentifier?: string };
 
-export interface Bolt12OfferDetails {
-    absoluteExpiry?: number;
-    chains: string[];
-    description?: string;
-    issuer?: string;
-    minAmount?: Amount;
-    offer: Bolt12Offer;
-    paths: Bolt12OfferBlindedPath[];
-    signingPubkey?: string;
+export interface SendOnchainFeeQuote {
+    id: string;
+    expiresAt: number;
+    speedFast: SendOnchainSpeedFeeQuote;
+    speedMedium: SendOnchainSpeedFeeQuote;
+    speedSlow: SendOnchainSpeedFeeQuote;
 }
 
-export interface DepositInfo {
-    txid: string;
-    vout: number;
-    amountSats: number;
-    refundTx?: string;
-    refundTxId?: string;
-    claimError?: DepositClaimError;
+export interface Bolt12Invoice {
+    invoice: string;
+    source: PaymentRequestSource;
 }
 
-export interface GetTokensMetadataResponse {
-    tokensMetadata: TokenMetadata[];
-}
+export type BitcoinNetwork = "bitcoin" | "testnet3" | "testnet4" | "signet" | "regtest";
 
-export interface ProvisionalPayment {
-    paymentId: string;
-    amount: bigint;
-    details: ProvisionalPaymentDetails;
+export interface LnurlWithdrawRequestDetails {
+    callback: string;
+    k1: string;
+    defaultDescription: string;
+    minWithdrawable: number;
+    maxWithdrawable: number;
 }
 
-export interface Record {
-    id: RecordId;
-    revision: number;
-    schemaVersion: string;
-    data: Map<string, string>;
+export interface OutgoingChange {
+    change: RecordChange;
+    parent?: Record;
 }
 
-export interface Bolt11InvoiceDetails {
-    amountMsat?: number;
-    description?: string;
-    descriptionHash?: string;
-    expiry: number;
-    invoice: Bolt11Invoice;
-    minFinalCltvExpiryDelta: number;
-    network: BitcoinNetwork;
-    payeePubkey: string;
-    paymentHash: string;
-    paymentSecret: string;
-    routingHints: Bolt11RouteHint[];
-    timestamp: number;
+export interface Bolt12OfferBlindedPath {
+    blindedHops: string[];
 }
 
+export type Amount = { type: "bitcoin"; amountMsat: number } | { type: "currency"; iso4217Code: string; fractionalAmount: number };
+
 export interface LnurlAuthRequestDetails {
     k1: string;
     action?: string;
@@ -426,51 +368,29 @@ export interface LnurlAuthRequestDetails {
     url: string;
 }
 
-export interface TokenMetadata {
-    identifier: string;
-    issuerPublicKey: string;
-    name: string;
-    ticker: string;
-    decimals: number;
-    maxSupply: bigint;
-    isFreezable: boolean;
-}
-
-export interface ClaimDepositRequest {
-    txid: string;
-    vout: number;
-    maxFee?: Fee;
-}
-
-export interface ConnectRequest {
-    config: Config;
-    seed: Seed;
-    storageDir: string;
+export interface SetLnurlMetadataItem {
+    paymentHash: string;
+    senderComment?: string;
+    nostrZapRequest?: string;
+    nostrZapReceipt?: string;
 }
 
-export interface ReceivePaymentRequest {
-    paymentMethod: ReceivePaymentMethod;
+export interface Record {
+    id: RecordId;
+    revision: number;
+    schemaVersion: string;
+    data: Map<string, string>;
 }
 
-export type AesSuccessActionDataResult = { type: "decrypted"; data: AesSuccessActionDataDecrypted } | { type: "errorStatus"; reason: string };
-
-export type UpdateDepositPayload = { type: "claimError"; error: DepositClaimError } | { type: "refund"; refundTxid: string; refundTx: string };
-
-export interface SendPaymentRequest {
-    prepareResponse: PrepareSendPaymentResponse;
-    options?: SendPaymentOptions;
+export interface LnurlPayRequest {
+    prepareResponse: PrepareLnurlPayResponse;
     idempotencyKey?: string;
 }
 
-export interface LocaleOverrides {
-    locale: string;
-    spacing?: number;
-    symbol: Symbol;
-}
-
-export interface FiatCurrency {
-    id: string;
-    info: CurrencyInfo;
+export interface CheckMessageRequest {
+    message: string;
+    pubkey: string;
+    signature: string;
 }
 
 export interface LnurlPayResponse {
@@ -478,34 +398,29 @@ export interface LnurlPayResponse {
     successAction?: SuccessActionProcessed;
 }
 
-export interface ListUnclaimedDepositsRequest {}
-
-export interface ClaimHtlcPaymentRequest {
-    preimage: string;
+export interface LnurlPayRequestDetails {
+    callback: string;
+    minSendable: number;
+    maxSendable: number;
+    metadataStr: string;
+    commentAllowed: number;
+    domain: string;
+    url: string;
+    address?: string;
+    allowsNostr?: boolean;
+    nostrPubkey?: string;
 }
 
-export type Network = "mainnet" | "regtest";
-
-export interface Bolt12Offer {
-    offer: string;
-    source: PaymentRequestSource;
+export interface Bolt12InvoiceDetails {
+    amountMsat: number;
+    invoice: Bolt12Invoice;
 }
 
-export interface ReceivePaymentResponse {
-    paymentRequest: string;
-    fee: bigint;
+export interface ListPaymentsResponse {
+    payments: Payment[];
 }
 
-export interface SparkInvoiceDetails {
-    invoice: string;
-    identityPublicKey: string;
-    network: BitcoinNetwork;
-    amount?: bigint;
-    tokenIdentifier?: string;
-    expiryTime?: number;
-    description?: string;
-    senderPublicKey?: string;
-}
+export type PaymentMethod = "lightning" | "spark" | "token" | "deposit" | "withdraw" | "unknown";
 
 export interface UrlSuccessActionData {
     description: string;
@@ -513,56 +428,112 @@ export interface UrlSuccessActionData {
     matchesCallbackDomain: boolean;
 }
 
-export type SendPaymentMethod = { type: "bitcoinAddress"; address: BitcoinAddressDetails; feeQuote: SendOnchainFeeQuote } | { type: "bolt11Invoice"; invoiceDetails: Bolt11InvoiceDetails; sparkTransferFeeSats?: number; lightningFeeSats: number } | { type: "sparkAddress"; address: string; fee: bigint; tokenIdentifier?: string } | { type: "sparkInvoice"; sparkInvoiceDetails: SparkInvoiceDetails; fee: bigint; tokenIdentifier?: string };
+export interface PrepareLnurlPayRequest {
+    amountSats: number;
+    comment?: string;
+    payRequest: LnurlPayRequestDetails;
+    validateSuccessActionUrl?: boolean;
+}
 
-export interface CurrencyInfo {
-    name: string;
-    fractionSize: number;
-    spacing?: number;
-    symbol?: Symbol;
-    uniqSymbol?: Symbol;
-    localizedName: LocalizedName[];
-    localeOverrides: LocaleOverrides[];
+export interface RefundDepositRequest {
+    txid: string;
+    vout: number;
+    destinationAddress: string;
+    fee: Fee;
 }
 
-export type PaymentDetails = { type: "spark"; invoiceDetails?: SparkInvoicePaymentDetails; htlcDetails?: SparkHtlcDetails } | { type: "token"; metadata: TokenMetadata; txHash: string; invoiceDetails?: SparkInvoicePaymentDetails } | { type: "lightning"; description?: string; preimage?: string; invoice: string; paymentHash: string; destinationPubkey: string; lnurlPayInfo?: LnurlPayInfo; lnurlWithdrawInfo?: LnurlWithdrawInfo } | { type: "withdraw"; txId: string } | { type: "deposit"; txId: string };
+export interface ListFiatCurrenciesResponse {
+    currencies: FiatCurrency[];
+}
+
+export type SdkEvent = { type: "synced" } | { type: "unclaimedDeposits"; unclaimedDeposits: DepositInfo[] } | { type: "claimedDeposits"; claimedDeposits: DepositInfo[] } | { type: "paymentSucceeded"; payment: Payment } | { type: "paymentPending"; payment: Payment } | { type: "paymentFailed"; payment: Payment };
+
+export interface GetTokensMetadataResponse {
+    tokensMetadata: TokenMetadata[];
+}
+
+export type SuccessActionProcessed = { type: "aes"; result: AesSuccessActionDataResult } | { type: "message"; data: MessageSuccessActionData } | { type: "url"; data: UrlSuccessActionData };
+
+export interface CheckLightningAddressRequest {
+    username: string;
+}
+
+export interface Bolt11RouteHintHop {
+    srcNodeId: string;
+    shortChannelId: string;
+    feesBaseMsat: number;
+    feesProportionalMillionths: number;
+    cltvExpiryDelta: number;
+    htlcMinimumMsat?: number;
+    htlcMaximumMsat?: number;
+}
+
+export interface ListFiatRatesResponse {
+    rates: Rate[];
+}
 
-export type BitcoinNetwork = "bitcoin" | "testnet3" | "testnet4" | "signet" | "regtest";
+export type OnchainConfirmationSpeed = "fast" | "medium" | "slow";
 
-export interface ClaimDepositResponse {
-    payment: Payment;
+export interface SparkInvoiceDetails {
+    invoice: string;
+    identityPublicKey: string;
+    network: BitcoinNetwork;
+    amount?: bigint;
+    tokenIdentifier?: string;
+    expiryTime?: number;
+    description?: string;
+    senderPublicKey?: string;
 }
 
-export interface Bolt11Invoice {
-    bolt11: string;
-    source: PaymentRequestSource;
+export interface FiatCurrency {
+    id: string;
+    info: CurrencyInfo;
 }
 
-export interface SparkHtlcDetails {
+export interface Bolt11InvoiceDetails {
+    amountMsat?: number;
+    description?: string;
+    descriptionHash?: string;
+    expiry: number;
+    invoice: Bolt11Invoice;
+    minFinalCltvExpiryDelta: number;
+    network: BitcoinNetwork;
+    payeePubkey: string;
     paymentHash: string;
-    preimage?: string;
-    expiryTime: number;
-    status: SparkHtlcStatus;
+    paymentSecret: string;
+    routingHints: Bolt11RouteHint[];
+    timestamp: number;
 }
 
-export type Amount = { type: "bitcoin"; amountMsat: number } | { type: "currency"; iso4217Code: string; fractionalAmount: number };
-
 export interface LnurlWithdrawInfo {
     withdrawUrl: string;
 }
 
-export interface IncomingChange {
-    newState: Record;
-    oldState?: Record;
+export interface SparkAddressDetails {
+    address: string;
+    identityPublicKey: string;
+    network: BitcoinNetwork;
+    source: PaymentRequestSource;
 }
 
-export interface ListPaymentsResponse {
-    payments: Payment[];
+export interface Bolt12InvoiceRequestDetails {}
+
+export interface ListPaymentsRequest {
+    typeFilter?: PaymentType[];
+    statusFilter?: PaymentStatus[];
+    assetFilter?: AssetFilter;
+    sparkHtlcStatusFilter?: SparkHtlcStatus[];
+    fromTimestamp?: number;
+    toTimestamp?: number;
+    offset?: number;
+    limit?: number;
+    sortAscending?: boolean;
 }
 
-export interface AesSuccessActionDataDecrypted {
-    description: string;
-    plaintext: string;
+export interface LnurlReceiveMetadata {
+    nostrZapRequest?: string;
+    nostrZapReceipt?: string;
+    senderComment?: string;
 }
 
 export interface SignMessageRequest {
@@ -570,38 +541,56 @@ export interface SignMessageRequest {
     compact: boolean;
 }
 
-export interface SparkInvoicePaymentDetails {
-    description?: string;
-    invoice: string;
+export type Fee = { type: "fixed"; amount: number } | { type: "rate"; satPerVbyte: number };
+
+export interface ClaimHtlcPaymentRequest {
+    preimage: string;
 }
 
-export interface SilentPaymentAddressDetails {
-    address: string;
-    network: BitcoinNetwork;
-    source: PaymentRequestSource;
+export type PaymentStatus = "completed" | "pending" | "failed";
+
+export interface ClaimHtlcPaymentResponse {
+    payment: Payment;
 }
 
-export interface PaymentMetadata {
-    lnurlPayInfo?: LnurlPayInfo;
-    lnurlWithdrawInfo?: LnurlWithdrawInfo;
-    lnurlDescription?: string;
+export type SendPaymentOptions = { type: "bitcoinAddress"; confirmationSpeed: OnchainConfirmationSpeed } | { type: "bolt11Invoice"; preferSpark: boolean; completionTimeoutSecs?: number } | { type: "sparkAddress"; htlcOptions?: SparkHtlcOptions };
+
+export interface Payment {
+    id: string;
+    paymentType: PaymentType;
+    status: PaymentStatus;
+    amount: bigint;
+    fees: bigint;
+    timestamp: number;
+    method: PaymentMethod;
+    details?: PaymentDetails;
 }
 
-export interface Config {
-    apiKey?: string;
-    network: Network;
-    syncIntervalSecs: number;
-    maxDepositClaimFee?: Fee;
-    lnurlDomain?: string;
-    preferSparkOverLightning: boolean;
-    externalInputParsers?: ExternalInputParser[];
-    useDefaultExternalInputParsers: boolean;
-    realTimeSyncServerUrl?: string;
-    privateEnabledDefault: boolean;
+export interface AesSuccessActionDataDecrypted {
+    description: string;
+    plaintext: string;
 }
 
-export interface GetPaymentResponse {
-    payment: Payment;
+export interface LnurlPayInfo {
+    lnAddress?: string;
+    comment?: string;
+    domain?: string;
+    metadata?: string;
+    processedSuccessAction?: SuccessActionProcessed;
+    rawSuccessAction?: SuccessAction;
+}
+
+export interface PrepareSendPaymentResponse {
+    paymentMethod: SendPaymentMethod;
+    amount: bigint;
+    tokenIdentifier?: string;
+}
+
+export interface SparkHtlcDetails {
+    paymentHash: string;
+    preimage?: string;
+    expiryTime: number;
+    status: SparkHtlcStatus;
 }
 
 export interface Bip21Details {
@@ -614,10 +603,26 @@ export interface Bip21Details {
     paymentMethods: InputType[];
 }
 
-export interface LnurlWithdrawRequest {
-    amountSats: number;
-    withdrawRequest: LnurlWithdrawRequestDetails;
-    completionTimeoutSecs?: number;
+export interface SendPaymentResponse {
+    payment: Payment;
+}
+
+export interface LightningAddressDetails {
+    address: string;
+    payRequest: LnurlPayRequestDetails;
+}
+
+export interface UserSettings {
+    sparkPrivateModeEnabled: boolean;
+}
+
+export interface GetPaymentRequest {
+    paymentId: string;
+}
+
+export interface Bolt11Invoice {
+    bolt11: string;
+    source: PaymentRequestSource;
 }
 
 export interface AesSuccessActionData {
@@ -626,67 +631,77 @@ export interface AesSuccessActionData {
     iv: string;
 }
 
-export interface Bolt11RouteHint {
-    hops: Bolt11RouteHintHop[];
+export interface Bolt12OfferDetails {
+    absoluteExpiry?: number;
+    chains: string[];
+    description?: string;
+    issuer?: string;
+    minAmount?: Amount;
+    offer: Bolt12Offer;
+    paths: Bolt12OfferBlindedPath[];
+    signingPubkey?: string;
 }
 
-export interface GetInfoResponse {
-    balanceSats: number;
-    tokenBalances: Map<string, TokenBalance>;
+export interface Bip21Extra {
+    key: string;
+    value: string;
 }
 
-export type PaymentMethod = "lightning" | "spark" | "token" | "deposit" | "withdraw" | "unknown";
-
-export interface ExternalInputParser {
-    providerId: string;
-    inputRegex: string;
-    parserUrl: string;
+export interface Rate {
+    coin: string;
+    value: number;
 }
 
-export interface ListFiatRatesResponse {
-    rates: Rate[];
-}
+export type AesSuccessActionDataResult = { type: "decrypted"; data: AesSuccessActionDataDecrypted } | { type: "errorStatus"; reason: string };
 
-export interface UpdateUserSettingsRequest {
-    sparkPrivateModeEnabled?: boolean;
-}
+export interface SyncWalletResponse {}
 
-export interface SendOnchainFeeQuote {
-    id: string;
-    expiresAt: number;
-    speedFast: SendOnchainSpeedFeeQuote;
-    speedMedium: SendOnchainSpeedFeeQuote;
-    speedSlow: SendOnchainSpeedFeeQuote;
+export interface UnversionedRecordChange {
+    id: RecordId;
+    schemaVersion: string;
+    updatedFields: Map<string, string>;
 }
 
-export interface BitcoinAddressDetails {
-    address: string;
-    network: BitcoinNetwork;
-    source: PaymentRequestSource;
+export interface ClaimDepositResponse {
+    payment: Payment;
 }
 
-export interface PrepareSendPaymentRequest {
+export interface ReceivePaymentResponse {
     paymentRequest: string;
-    amount?: bigint;
-    tokenIdentifier?: string;
+    fee: bigint;
 }
 
-export type AssetFilter = { type: "bitcoin" } | { type: "token"; tokenIdentifier?: string };
+export interface CurrencyInfo {
+    name: string;
+    fractionSize: number;
+    spacing?: number;
+    symbol?: Symbol;
+    uniqSymbol?: Symbol;
+    localizedName: LocalizedName[];
+    localeOverrides: LocaleOverrides[];
+}
 
-export type PaymentType = "send" | "receive";
+export interface GetInfoRequest {
+    ensureSynced?: boolean;
+}
 
-export interface RegisterLightningAddressRequest {
+export interface Credentials {
     username: string;
-    description?: string;
+    password: string;
 }
 
-export interface SyncWalletRequest {}
+export interface ConnectRequest {
+    config: Config;
+    seed: Seed;
+    storageDir: string;
+}
 
-export interface SparkAddressDetails {
-    address: string;
-    identityPublicKey: string;
-    network: BitcoinNetwork;
-    source: PaymentRequestSource;
+export type SuccessAction = { type: "aes"; data: AesSuccessActionData } | { type: "message"; data: MessageSuccessActionData } | { type: "url"; data: UrlSuccessActionData };
+
+export interface ClaimDepositRequest {
+    txid: string;
+    vout: number;
+    maxFee?: MaxFee;
 }
 
 export interface FreezeIssuerTokenResponse {
@@ -699,8 +714,8 @@ export interface UnfreezeIssuerTokenResponse {
     impactedTokenAmount: bigint;
 }
 
-export interface UnfreezeIssuerTokenRequest {
-    address: string;
+export interface MintIssuerTokenRequest {
+    amount: bigint;
 }
 
 export interface CreateIssuerTokenRequest {
@@ -711,16 +726,16 @@ export interface CreateIssuerTokenRequest {
     maxSupply: bigint;
 }
 
-export interface FreezeIssuerTokenRequest {
-    address: string;
-}
-
 export interface BurnIssuerTokenRequest {
     amount: bigint;
 }
 
-export interface MintIssuerTokenRequest {
-    amount: bigint;
+export interface FreezeIssuerTokenRequest {
+    address: string;
+}
+
+export interface UnfreezeIssuerTokenRequest {
+    address: string;
 }
 
 export interface Storage {
@@ -736,6 +751,7 @@ export interface Storage {
     deleteDeposit: (txid: string, vout: number) => Promise<void>;
     listDeposits: () => Promise<DepositInfo[]>;
     updateDeposit: (txid: string, vout: number, payload: UpdateDepositPayload) => Promise<void>;
+    setLnurlMetadata: (metadata: SetLnurlMetadataItem[]) => Promise<void>;
     syncAddOutgoingChange: (record: UnversionedRecordChange) => Promise<number>;
     syncCompleteOutgoingSync: (record: Record) => Promise<void>;
     syncGetPendingOutgoingChanges: (limit: number) => Promise<OutgoingChange[]>;