README
¶
go-string2eth
Go utility library to convert strings to Ether values and vice versa.
When converting strings to numeric values the process is case-insensitive and doesn't care about whitespace, so input values such as "0.1 Ether", "0.1Ether" and "0.1ether" would all result in the same result. The standard unit denominations (Wei, Ether) are supported with or without SI prefixes (micro, milli, kilo, mega etc.), as are common names (Shannon, Babbage).
When converting numeric values to strings the user can select standard mode, in which case all values will be in units of Wei or Ether, or non-standard mode, in which case the full range of values will be used.
This also provides the ability to convert between string and GWei values.
Table of Contents
Install
go-string2eth is a standard Go module which can be installed with:
go get github.com/wealdtech/go-string2eth
Usage
go-string2eth converts from strings to Ether values and back again.
Example
package main
import (
string2eth "github.com/wealdtech/go-string2eth"
)
func main() {
// Convert a string value to a number of Wei
value, err := string2eth.StringToWei("0.05 Ether")
if err != nil {
panic(err)
}
// Convert a number of Wei to a string value
str := string2eth.WeiToString(value, true)
fmt.Printf("0.05 Ether is %v Wei, is %s\n", value, str)
}
Maintainers
Jim McDonald: @mcdee.
Contribute
Contributions welcome. Please check out the issues.
License
Apache-2.0 © 2019 Weald Technology Trading Ltd
Documentation
¶
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GWeiToString ¶ added in v1.1.0
GWeiToString turns a number of GWei in to a string. See WeiToString for details.
func StringToGWei ¶ added in v1.1.0
StringToGWei turns a string in to number of GWei. See StringToWei for details. Any part of the value below 1GWei in denomination is lost.
func StringToWei ¶
StringToWei turns a string in to number of Wei. The string can be a simple number of Wei, e.g. "1000000000000000" or it can be a number followed by a unit, e.g. "10 ether". Unit names are case-insensitive, and can be either given names (e.g. "finney") or metric names (e.g. "mlliether"). Note that this function expects use of the period as the decimal separator.
func UnitToMultiplier ¶
UnitToMultiplier takes the name of an Ethereum unit and returns a multiplier
from Wei
Example ¶
multiplier, err := string2eth.UnitToMultiplier("ether")
if err != nil {
return
}
fmt.Println(multiplier.Text(10))
Output: 1000000000000000000
Types ¶
This section is empty.
Source Files