Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@synonymdev/bitkit-notification-client

Package Overview
Dependencies
Maintainers
5
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@synonymdev/bitkit-notification-client

Bitkit Notification Server client

  • 0.1.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
5
Created
Source

bitkit-notification-client

NPM version

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.

FAQs

Package last updated on 09 Feb 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc