utils

Documentation

Index

• Constants
• Variables
• func BigPow10(e int32) *big.Float
• func CheckNetworkSupported(ctx context.Context, networkIdentifier *types.NetworkIdentifier, ...) (*types.NetworkStatusResponse, error)
• func ContainsString(arr []string, s string) bool
• func CreateCommandPath(dataDirectory string, cmd string, network *types.NetworkIdentifier) (string, error)
• func CreateTempDir() (string, error)
• func CurrencyBalance(ctx context.Context, network *types.NetworkIdentifier, ...) (*types.Amount, *types.BlockIdentifier, error)
• func EnsurePathExists(path string) error
• func Equal(a interface{}, b interface{}) bool
• func LoadAndParse(filePath string, output interface{}) error
• func Milliseconds() int64
• func PrettyAmount(amount *big.Int, currency *types.Currency) string
• func RandomNumber(minimum *big.Int, maximum *big.Int) *big.Int
• func RemoveTempDir(dir string)
• func SerializeAndWrite(filePath string, object interface{}) error
• func Zero() *big.Float

Constants

const (
	// DefaultFilePermissions specifies that the user can
	// read and write the file.
	DefaultFilePermissions = 0600

	// AllFilePermissions specifies anyone can do anything
	// to the file.
	AllFilePermissions = 0777

	// NanosecondsInMillisecond is the number
	// of nanoseconds in a millisecond.
	NanosecondsInMillisecond = 1000000

	// MillisecondsInSecond is the number
	// of milliseconds in a second.
	MillisecondsInSecond = 1000

	// OneHundred is the number 100.
	OneHundred = 100
)

Variables

var (
	// ErrNetworkNotSupported is returned when the network
	// you are attempting to connect to is not supported.
	ErrNetworkNotSupported = errors.New("network not supported")

	// OneHundredInt is a big.Int of value 100.
	OneHundredInt = big.NewInt(OneHundred)

	// ZeroInt is a big.Int of value 0.
	ZeroInt = big.NewInt(0)
)

Functions

func BigPow10

func BigPow10(e int32) *big.Float

BigPow10 computes the value of 10^e. Inspired by: https://steemit.com/tutorial/@gopher23/power-and-root-functions-using-big-float-in-golang

func CheckNetworkSupported

func CheckNetworkSupported(
	ctx context.Context,
	networkIdentifier *types.NetworkIdentifier,
	fetcher *fetcher.Fetcher,
) (*types.NetworkStatusResponse, error)

CheckNetworkSupported checks if a Rosetta implementation supports a given *types.NetworkIdentifier. If it does, the current network status is returned.

func ContainsString

func ContainsString(arr []string, s string) bool

ContainsString returns a boolean indicating whether the string s is in arr.

func CreateCommandPath

func CreateCommandPath(
	dataDirectory string,
	cmd string,
	network *types.NetworkIdentifier,
) (string, error)

CreateCommandPath creates a unique path for a command and network within a data directory. This is used to avoid collision when using multiple commands on multiple networks when the same storage resources are used. If the derived path does not exist, we run os.MkdirAll on the path.

func CreateTempDir

func CreateTempDir() (string, error)

CreateTempDir creates a directory in /tmp for usage within testing.

func CurrencyBalance

func CurrencyBalance(
	ctx context.Context,
	network *types.NetworkIdentifier,
	fetcher *fetcher.Fetcher,
	account *types.AccountIdentifier,
	currency *types.Currency,
	block *types.BlockIdentifier,
) (*types.Amount, *types.BlockIdentifier, error)

CurrencyBalance returns the balance of an account for a particular currency.

func EnsurePathExists

func EnsurePathExists(path string) error

EnsurePathExists creates directories along a path if they do not exist.

func Equal

func Equal(a interface{}, b interface{}) bool

Equal returns a boolean indicating if two interfaces are equal.

func LoadAndParse

func LoadAndParse(filePath string, output interface{}) error

LoadAndParse reads the file at the provided path and attempts to unmarshal it into output.

func Milliseconds

func Milliseconds() int64

Milliseconds gets the current time in milliseconds.

func PrettyAmount

func PrettyAmount(amount *big.Int, currency *types.Currency) string

PrettyAmount returns a currency amount in native format with its symbol.

func RandomNumber

func RandomNumber(minimum *big.Int, maximum *big.Int) *big.Int

RandomNumber returns some number in the range [minimum, maximum). Source: https://golang.org/pkg/math/big/#Int.Rand

func RemoveTempDir

func RemoveTempDir(dir string)

RemoveTempDir deletes a directory at a provided path for usage within testing.

func SerializeAndWrite

func SerializeAndWrite(filePath string, object interface{}) error

SerializeAndWrite attempts to serialize the provided object into a file at filePath.

func Zero

func Zero() *big.Float

Zero returns a float with 256 bit precision.