amount

Documentation

Overview

Package amount provides utilities for converting numbers to/from the format used internally to stellar-core.

stellar-core represents asset "amounts" as 64-bit integers, but to enable fractional units of an asset, horizon, the client-libraries and other built on top of stellar-core use a convention, encoding amounts as a string of decimal digits with up to seven digits of precision in the fractional portion. For example, an amount shown as "101.001" in horizon would be represented in stellar-core as 1010010000.

Index

• Constants
• func IntStringToAmount(v string) (string, error)
• func MustParse(v string) xdr.Int64
• func Parse(v string) (xdr.Int64, error)
• func ParseInt64(v string) (int64, error)
• func String(v xdr.Int64) string
• func StringFromInt64(v int64) string

Constants

const (
	One = 10000000
)

One is the value of one whole unit of currency. Stellar uses 7 fixed digits for fractional values, thus One is 10 million (10^7).

Functions

func IntStringToAmount

func IntStringToAmount(v string) (string, error)

IntStringToAmount converts string integer value and converts it to stellar "amount". In other words, it divides the given string integer value by 10^7 and returns the string representation of that number. It is safe to use with values exceeding int64 limits.

func MustParse

func MustParse(v string) xdr.Int64

MustParse is the panicking version of Parse.

func Parse

func Parse(v string) (xdr.Int64, error)

Parse parses the provided as a stellar "amount", i.e. a 64-bit signed integer that represents a decimal number with 7 digits of significance in the fractional portion of the number, and returns a xdr.Int64.

func ParseInt64

func ParseInt64(v string) (int64, error)

ParseInt64 parses the provided as a stellar "amount", i.e. a 64-bit signed integer that represents a decimal number with 7 digits of significance in the fractional portion of the number.

func String

func String(v xdr.Int64) string

String returns an "amount string" from the provided raw xdr.Int64 value `v`.

func StringFromInt64

func StringFromInt64(v int64) string

StringFromInt64 returns an "amount string" from the provided raw int64 value `v`.