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

@tatumio/utxo-wallet-provider

v1.0.5

Published

UTXO provider with local wallet operations

Downloads

712

Readme

🌍 UTXO Wallet Provider

UTXO Wallet Provider integrates seamlessly with Tatum SDK to provide extended wallet capabilities for UTXO-based blockchains.

📖 Description

The UTXO Wallet Provider provides an array of tools for:

  • Generating mnemonics for seed phrases.
  • Creating extended public keys (xpubs) from mnemonics.
  • Deriving private keys and addresses from mnemonics and xpubs.
  • Signing and broadcasting transactions to the UTXO-based networks.

It is built upon popular packages like bitcoinjs-lib, bitcore-lib, bip39, and bip32, ensuring a robust and secure foundation.

🚀 Quick Start

  1. Installation

    Firstly, ensure that the @tatumio/utxo-wallet-provider package is set as a dependency within your project. Next, import the UTXO Wallet Provider extension:

    import { UtxoWalletProvider } from '@tatumio/utxo-wallet-provider';
  2. Initialization

    Create an instance of Tatum SDK passing UtxoWalletProvider as one of wallet providers.

    const tatumSdk = await TatumSDK.init<Bitcoin>({
         network: Network.BITCOIN,
         configureWalletProviders: [
             UtxoWalletProvider,
         ]
     })

⚙️ Configuration

You can configure the UtxoWalletProvider as below to have all the checks skipped. This is useful for development and testing purposes.

const tatumSdk = await TatumSDK.init<Bitcoin>({
     network: Network.BITCOIN,
     configureWalletProviders: [
        {type: UtxoWalletProvider, config: {skipAllChecks: true}},
     ]
 })

🛠️ How to Use

  1. Generate Mnemonic

    const mnemonic = tatumSdk.walletProvider.use(UtxoWalletProvider).generateMnemonic()
  2. Generate xpub with or without Mnemonic

    const xpubDetails = await tatumSdk.walletProvider.use(UtxoWalletProvider).generateXpub(mnemonic)
  3. Generate Private Key from Mnemonic

    const privateKey = await tatumSdk.walletProvider.use(UtxoWalletProvider).generatePrivateKeyFromMnemonic(mnemonic, 0)
  4. Generate Address from Mnemonic or xpub

    const addressFromMnemonic = await tatumSdk.walletProvider.use(UtxoWalletProvider).generateAddressFromMnemonic(mnemonic, 0)
    const addressFromXpub = await tatumSdk.walletProvider.use(UtxoWalletProvider).generateAddressFromXpub(xpubDetails.xpub, 0)
  5. Sign and Broadcast a Transaction

    Define your payload according to the UtxoTxPayload type using address as the source of payments:

    const payloadUtxo = {
       fromAddress: [{ address: 'YOUR_WALLET_ADDRESS', privateKey: 'YOUR_PRIVATE_KEY'}],
       to: [{ address: 'TARGET_WALLET_ADDRESS', value: 0.0001 }], // BTC_AMOUNT
       fee: '0.00001', // BTC_AMOUNT
       changeAddress: 'CHANGE_WALLET_ADDRESS',
       }
    const txHash = await tatumSdk.walletProvider.use(UtxoWalletProvider).signAndBroadcast(payloadUtxo)

    or using UTXOs as the source of payments:

    const payloadUtxo = {
       fromUTXO: [
          {
             txHash: '9bfddffd79a7af830a4070173b1f93547ee4eae9cdb542b153e2daaea1885f3d',
             index: 1,
             privateKey: 'YOUR_PRIVATE_KEY',
          },
         ],
       to: [{ address: 'TARGET_WALLET_ADDRESS', value: 0.0001 }], // BTC_AMOUNT
       fee: '0.00001', // BTC_AMOUNT
       changeAddress: 'CHANGE_WALLET_ADDRESS',
       }
    const txHash = await tatumSdk.walletProvider.use(UtxoWalletProvider).signAndBroadcast(payloadUtxo)

Remember to always ensure the safety of mnemonics, private keys, and other sensitive data. Never expose them in client-side code or public repositories.

🔗🔗 Supported Networks

Network.BITCOIN,
Network.DOGECOIN,
Network.LITECOIN,
Network.BITCOIN_TESTNET,
Network.DOGECOIN_TESTNET,
Network.LITECOIN_TESTNET