Proper Money Handling (JSON-RPC)

Overview

The original bitcoin client stores all bitcoin values as 64-bit integers, with 1 BTC stored as 100,000,000 (one-hundred-million of the smallest possible bitcoin unit). Values are expressed as double-precision Numbers in the JSON API, with 1 BTC expressed as 1.00000000

If you are writing software that uses the JSON-RPC interface you need to be aware of possible floating-point conversion issues. You, or the JSON library you are using, should convert amounts to either a fixed-point Decimal representation (with 8 digits after the decimal point) or ideally a 64-bit integer representation. In either case, rounding values is required.

Improper value handling can lead to embarrassing errors; for example, if you truncate instead of doing proper rounding and your software will display the value "0.1 BTC" as "0.09999999 BTC" (or, worse, "0.09 BTC").

The original bitcoin client does proper, full-precision rounding for all values passed to it via the RPC interface. So, for example, if the value 0.1 is converted to the value "0.099999999999" by your JSON-RPC library, that value will be rounded to the nearest 0.00000001 bitcoin and will be treated as exactly 0.10 BTC.

The rest of this page gives sample code for various JSON libraries and programming languages.

BASH

 function JSONtoAmount() {
     printf '%.8f' "$1" | tr -d '.'
 }

C/C++

C/C++ JSON libraries return the JavaScript Number type as type 'double'. To convert, without loss of precision, from a double to a 64-bit integer multiply by 100,000,000 and round to the nearest integer:

int64_t JSONtoAmount(double value) {
    return (int64_t)(value * 1e8 + (value < 0.0 ? -.5 : .5));
}

To convert to a JSON value divide by 100,000,000.0, and make sure your JSON implementation outputs doubles with 8 or more digits after the decimal point:

 double forJSON = (double)amount / 1e8;

ECMAScript

function JSONtoAmount(value) {
    return Math.round(1e8 * value);
}

Java

public long JSONtoAmount(double value){
    return (long)(value*100000000L);
 }

Perl

sub JSONtoAmount {
    return sprintf '%.0f', 1e8 * shift;
}

Go

The btcjson package provides a more complete version of this function (error checking and so on), but for illustrative purposes, this is useful.

func JSONToAmount(jsonAmount float64) (int64) {
  var amount int64
  tempVal := 1e8 * jsonAmount
  if tempVal < 0 {
     tempVal = tempVal - 0.5
  }
  if tempVal > 0 {
    tempVal = tempVal + 0.5
  }
  // Then just rely on the integer truncating
  amount = int64(tempVal)
  return amount
}

PHP

function JSONtoAmount($value) {
    return round($value * 1e8);
}

Python

def JSONtoAmount(value):
    return long(round(value * 1e8))
def AmountToJSON(amount):
    return float(amount / 1e8)

Common Lisp

 (defun json-to-amount (n)
   (coerce (round (* n 1e8)) 'integer))

CAUTION: The CL-JSON library parses numbers as single precision floating-point by default. The default parsing behavior can be overridden as follows:

  (set-custom-vars :real (lambda (n)
                            (json::parse-number (concatenate 'string n "d0"))))