Skip to content

Regenerate types for payment event API #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amackillop merged 1 commit into from
Jan 27, 2026
Merged

Regenerate types for payment event API #21

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ export interface ReceivedPayment {
paymentHash: string
amount: number
}
export interface PaymentEvent {
eventType: string
paymentHash: string
amountMsat?: number
reason?: string
}
export interface NodeChannel {
channelId: string
counterpartyNodeId: string
Expand All @@ -43,6 +49,21 @@ export declare class MdkNode {
getNodeId(): string
start(): void
stop(): void
/** Start the node and sync wallets. Call once before polling for events. */
startReceiving(): void
/**
* Get the next payment event without ACKing it.
* Returns None if no events are available.
* Call ack_event() after successfully handling the event.
*/
nextEvent(): PaymentEvent | null
/**
* ACK the current event after successfully handling it.
* Must be called after next_event() returns an event, before calling next_event() again.
*/
ackEvent(): void
/** Stop the node. Call when done polling. */
stopReceiving(): void
syncWallets(): void
getBalance(): number
listChannels(): Array<NodeChannel>
Expand Down