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

@hirosystems/chainhook-client

v2.3.0

Published

Chainhook TypeScript client

Downloads

1,114

Readme

Chainhook Client

A TypeScript client library that allows you to configure and listen for fully-typed Chainhook predicate events.

You can either create predicates and send them to a Chainhook node manually or use the included web server helpers to handle all node interactions transparently.

Quick Start

  1. Install npm package

    npm install @hirosystems/chainhook-client
  2. Create a Predicate object for every Chainhook event you're interested in. See the Chainhook README for more examples.

    import { ServerPredicate } from "@hirosystems/chainhook-client";
    import { randomUUID } from "crypto";
    
    const uuid = randomUUID();
    const predicate: ServerPredicate = {
        uuid,
        name: "test",
        version: 1,
        chain: "stacks",
        networks: {
            mainnet: {
                // `then_that` will be filled in automatically.
                if_this: {
                    scope: 'block_height',
                    higher_than: 100000,
                }
            }
        }
    };
  3. Create configuration objects for the local server and the Chainhook node you'll be interacting with

    import { ServerOptions, ChainhookNodeOptions } from "@hirosystems/chainhook-client";
    
    // Local server options
    const opts: ServerOptions = {
        hostname: "0.0.0.0",
        port: 3000,
        auth_token: "<random_string>",
        // Configure this value to a hostname the Chainhook node can use to reach our local server.
        // e.g. http://local.server:3000
        external_base_url: "<external_base_url>"
    };
    
    // Chainhook node options
    const chainhook: ChainhookNodeOptions = {
        base_url: "<node_base_url>"
    };
  4. Declare and start the event server

    import { Payload } from "@hirosystems/chainhook-client";
    
    const server = new ChainhookEventObserver(opts, chainhook);
    server.start(
        [predicate],
        async (uuid: string, payload: Payload) => {
            // This handler will be called for every chainhook event received by our server
            console.log(uuid);
            console.log(payload);
        }
    )
        .catch(e => console.error(e));
    const close = async () => {
        await server.close();
    }
    process.once('SIGINT', close);
    process.once('unhandledRejection', close);
    process.once('uncaughtException', close);
    process.once('beforeExit', close);

    Make sure you close the server gracefully in the event of an error so we can de-register our predicates correctly from the remote Chainhook node.

Type Definitions

This library includes type definitions for all possible Chainhook predicate configurations and event payloads in the form of Typebox schemas. If you need to compile or validate any of the supplied types, generate JSON schemas, etc., you can use all of Typebox's tools to do so.