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

@xdefi/bitcoin

v0.1.1

Published

Bitcoin Connector for XDEFI Bitcoin dApps

Downloads

5

Readme

xDeFi bitcoin sdk

Getting started

npm install @xdefi/bitcoin

Initialize

import XDEFIBitcoin from "@xdefi/bitcoin";

let bitcoinClient;
if (window.xfi.bitcoin) {
  bitcoinClient = new XDEFIBitcoin(window.xfi.bitcoin);
}

Get accounts

bitcoinClient.getAccounts()
.then((accounts) => {
  // do something
})
.catch((error) => {
  // do something else
})

Get Unspent UTXOs (Get Balance)

bitcoinClient.getUnspentUTXOs("btcAddress")
.then((utxos) => {
  // do something
})
.catch((error) => {
  // do something else
})

Transfer

bitcoinClient.transfer(
  "btcAddressFrom", // sender
  "btcAddressTo", // recipient
  "1044", // amount in satoshis
  "100" // fee rate
  )
.then((txHash) => {
  // do something
})
.catch((error) => {
  // do something else
})

Sign Bitcoin Transaction

import * as Bitcoin from "bitcoinjs-lib";


const valueOut = 1;
const returnedUTXOS = await bitcoinClient.getUnspentUTXOs("btcAddress")
// generate Pbst for demo
const psbt = new Bitcoin.Psbt({ network: Bitcoin.networks.testnet }); // Network-specific
returnedUTXOS.forEach((UTXO) => {
  let formattedWitnessUtxo = {
    script: Buffer.from(UTXO.witnessUtxo.script),
    value: UTXO.witnessUtxo.value,
  };
  psbt.addInput({
    hash: UTXO.hash,
    index: UTXO.index,
    witnessUtxo: formattedWitnessUtxo,
  });
});
psbt.addOutput({ address: "otherAddress", value: valueOut }); // Add output {address, value}
const hexPbst = psbt.toHex();
console.log("pbsthex", hexPbst)
bitcoinClient.signTransaction("btcAddressFrom", hexPbst)
  .then((resultSignature) => {
    console.log(resultSignature);
    this.resultSignature = resultSignature;
    // TODO: broadcast
  })
  .catch(console.error);

NPM scripts

  • npm t: Run test suite
  • npm start: Run npm run build in watch mode
  • npm run test:watch: Run test suite in interactive watch mode
  • npm run test:prod: Run linting and generate coverage
  • npm run build: Generate bundles and typings, create docs
  • npm run lint: Lints code
  • npm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't :wink:)

Excluding peerDependencies

On library development, one might want to set some peer dependencies, and thus remove those from the final bundle. You can see in Rollup docs how to do that.

Good news: the setup is here for you, you must only include the dependency name in external property within rollup.config.js. For example, if you want to exclude lodash, just write there external: ['lodash'].