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

bitcoin-cli-ts

v28.0.0

Published

Auto-generated Bitcoin client library for bitcoind JSON-RPC API

Downloads

4,905

Readme

bitcoin-cli-ts

Auto-generated Bitcoin client library for Bitcoin Core JSON-RPC API

Installation

Install the package with:

npm i bitcoin-cli-ts
# or
yarn add bitcoin-cli-ts

Usage

Choose the version that corresponds to your Bitcoin Core version.

We use the major and minor versions from Bitcoin Core Releases and reserve the patch version for library fixes related to static code or dependencies.

Config

import { authenticatedBitcoind } from 'bitcoin-cli-ts'

const { host, username, password, port } = getBitcoinCoreRPCConfig()
const bitcoind = authenticatedBitcoind({
  protocol: 'http',
  host: host,
  username,
  password,
  timeout: 30000,
  port: parseInt(port, 10),
  walletName: wallet, // optional
})

Use rpc command

import { getBalance } from 'bitcoin-cli-ts'

const balance = await getBalance({ bitcoind })

Test

Test with Jest framework:

yarn test

Build

Build production (distribution) files in dist folder:

yarn build

It generates CommonJS (in dist/cjs folder), ES Modules (in dist/esm folder), as well as TypeScript declaration files (in dist/types folder).

Local development

Run:

yarn link
# or
npm link

and in your test project run:

yarn link bitcoin-cli-ts
# or
npm link bitcoin-cli-ts

If you want to remove the symlink, run:

# in your test project
yarn unlink bitcoin-cli-ts
# or
npm unlink bitcoin-cli-ts

# in bitcoin-cli-ts folder
yarn unlink
# or
npm unlink

Please check more details in npm link or yarn link

References

This library was developed based on: