Boltzmann

@samouraiwallet/boltzmann

This library is a Typescript port of the Java library - boltzmann-java.

Table of Contents

• Requirements
• Installation
• Usage
  • CLI
  • Node.js

Requirements

• Node.js v18 or newer
• NPM (or yarn or pnpm)

Installation

npm i @samouraiwallet/boltzmann

OR

pnpm add @samouraiwallet/boltzmann

OR

yarn add @samouraiwallet/boltzmann

Usage

CLI

See @samouraiwallet/boltzmann-cli

Node.js

Boltzmann computation is CPU bound and blocking, so it is recommended to run it in a separate worker thread or dedicated process to prevent blocking of the main thread.

Boltzmann will throw TimeoutError or TooManyTxosError when either of these limits is encountered.

import {Boltzmann, BoltzmannResult, TimeoutError, TooManyTxosError} from '@samouraiwallet/boltzmann';

// instantiate Boltzmann
const boltzmann = new Boltzmann({
  maxDuration: 30,
  maxTxos: 16,
  logLevel: "INFO"
});

// transaction object with entries for inputs and outputs
const transaction = {
  inputs: [
    ["address1", 1000],
    ["address2", 2000]
  ],
  outputs: [
    ["address3", 500],
    ["address4", 2200]
  ]
}

try {
  const result: BoltzmannResult = boltzmann.process(transaction);

  console.log(result.toJSON());
} catch (error) {
  if (error instanceof TimeoutError) {
    console.error("Timeout has been reached")
  }
  if (error instanceof TooManyTxosError) {
    console.error("Too many txos to compute")
  }
}
/*
{
  nbCmbn: number,
  matLnkCombinations: number[][] | null,
  matLnkProbabilities: number[][] | null,
  entropy: number,
  dtrmLnksById: [number, number][],
  dtrmLnks: [string, string][],
  txos: {
    inputs: [string, number][],
    outputs: [string, number][],
  },
  fees: number,
  intraFees: {
    feesMaker: number,
    feesTaker: number,
    hasFees: boolean,
  },
  efficiency: number | null,
  nbCmbnPrfctCj: string | null,
  nbTxosPrfctCj: {
    nbIns: number
    nbOuts: number
  },
}
 */