bitkit-notification-client

Client to interact with the bitkit-notification-server.

Usage

Send notification

Sends a push notification to the Bitkit device that is associated with the nodeId.

import { BitkitNotificationsClient } from '@synonymdev/bitkit-notification-client';

const client = new BitkitNotificationsClient()
try {
    const nodeId = '03864ef025fde8fb587d989186ce6a4a186895ee44a926bfc370e2c366597a3f8f'; // Lightning Node Id of Bitkit
    const source = 'blocktank'; // Service name which sends this notification. Shown to the device.
    const eventType = 'newPayment'; // Name of the event
    const payload = {  // Arbitrary data to send to the device. Max 3800 bytes, be careful.
        "hello": "world"
    }
    await client.sendNotification(nodeId: string, eventType: string, payload: any, source: string)
} catch (e) {
    const deviceNotFound = e.errorType !== 'deviceNotFound'
    if (deviceNotFound) {
        // Device is not registered to receive push notifications
    } else {
        // Genuine error
    }
}

Versioning

1. Increase version in package.json.
2. Add changes to CHANGELOG.md.
3. Commit changes.
4. Tag new version: git tag v0.1.0.
5. Push tag git push origin v0.1.0.
6. Build: npm run build.
7. Publish to npm: npm publish.