npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@synonymdev/blocktank-lsp-btc-client

v1.6.0

Published

Blocktank BTC client

Downloads

354

Readme

blocktank-lsp-btc-client

NPM version

Client to interact with the blocktank-lsp-btc service.

Usage

Watched Address

Watched Addresses are onchain addresses that you get notified about in case of a incoming transaction.

Create WatchedAddress

import { LspBtcClient, IWatchedAddress } from '@synonymdev/blocktank-lsp-btc-client';

const daysToWatch = 1 // How long in time this address is watched for. Default: 1
const maxWatchedBlockConfirmations = 6 // How many blockConfirmations you want to receive events for. Default: 6.
const client = new LspBtcClient()
const watched: IWatchedAddress = await client.createAddress(daysToWatch, maxWatchedBlockConfirmations)
console.log('Newly created address', watched.address)

Listen for updates

Update events are sent when a tx gets added/removed to the watched address or the tx confirmation state changes.

  • Enters mempool (also due to reorg).
  • Leaves mempool (rbf).
  • Every block confirmations until maxWatchedBlockConfirmations.

Important: Due to reorgs, the number of block confirmations can go backward!

import {LspBtcClient, IWatchedAddress, LspBtcEventListener, IAddressUpdateEvent, SuspiciousZeroConfReason } from "@synonymdev/blocktank-lsp-btc-client";

const listener = new LspBtcEventListener()
await listener.init()
const client = new LspBtcClient()
await listener.listenToAddressUpdates(async message => {
    const event: IAddressUpdateEvent = message.content

    // Pull the latest invoice
    const watched = await client.getAddress(event.id)

    if (watched.isBlacklisted) {
        // DO NOT TOUCH! Address received a tx from a blacklisted address.
        return;
    }

    const _1ConfirmationTxs = watched.transactions.filter(tx => {
        // Do your own risk analysis here.
        // Block confirmations are great. 
        // 0conf is always risky.
        // Do NOT use 0conf for high value txs or high value products.
        return tx.blockConfirmationCount >= 1 || tx.suspicious0ConfReason === SuspiciousZeroConfReason.NONE;
    })

    const amountSat = _1ConfirmationTxs.reduce((acc, tx) => acc + tx.amountSat, 0)
    console.log(`Received ${amountSat} satoshis on address ${watched.address}`)
})

Important blockConfirmationCount may be higher than maxWatchedBlockConfirmations. blockConfirmationCount may also jump suddendly from 0 to 6. So always check blockConfirmationCount with >=.

Info Always close your event listener with await listener.close() when you are done listening to events.

Regtest methods

For regtest, the client exposes some methods:

  • regtestMineBlocks

Checkout the types to see how to use them. They are very simple.

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.