Documentation
¶
Index ¶
- Constants
- Variables
- func AtTip(tipDelay int64, blockTimestamp int64) bool
- func BigPow10(e int32) *big.Float
- func BtoMb(b float64) float64
- func CheckAtTip(ctx context.Context, networkIdentifier *types.NetworkIdentifier, ...) (bool, error)
- func CheckNetworkSupported(ctx context.Context, networkIdentifier *types.NetworkIdentifier, ...) (*types.NetworkStatusResponse, error)
- func ContainsAccountIdentifier(arr []*types.AccountIdentifier, s *types.AccountIdentifier) bool
- func ContainsString(arr []string, s string) bool
- func ContextSleep(ctx context.Context, duration time.Duration) error
- func CreateCommandPath(dataDirectory string, cmd string, network *types.NetworkIdentifier) (string, error)
- func CreateTempDir() (string, error)
- func CurrencyBalance(ctx context.Context, network *types.NetworkIdentifier, helper FetcherHelper, ...) (*types.Amount, *types.BlockIdentifier, []*types.Coin, 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 SizeOf(v interface{}) int
- func TimeToTip(blocksPerSecond float64, lastSyncedIndex int64, tipIndex int64) time.Duration
- func Zero() *big.Float
- type AccountBalance
- type AccountBalanceRequest
- type FetcherHelper
- type MemoryUsage
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 AtTip ¶ added in v0.4.7
AtTip returns a boolean indicating if a block timestamp is within tipDelay from the current time.
func BigPow10 ¶
BigPow10 computes the value of 10^e. Inspired by: https://steemit.com/tutorial/@gopher23/power-and-root-functions-using-big-float-in-golang
func CheckAtTip ¶ added in v0.4.7
func CheckAtTip( ctx context.Context, networkIdentifier *types.NetworkIdentifier, helper FetcherHelper, tipDelay int64, ) (bool, error)
CheckAtTip returns a boolean indicating if a Rosetta implementation is at tip.
func CheckNetworkSupported ¶
func CheckNetworkSupported( ctx context.Context, networkIdentifier *types.NetworkIdentifier, helper FetcherHelper, ) (*types.NetworkStatusResponse, error)
CheckNetworkSupported checks if a Rosetta implementation supports a given *types.NetworkIdentifier. If it does, the current network status is returned.
func ContainsAccountIdentifier ¶ added in v0.4.1
func ContainsAccountIdentifier(arr []*types.AccountIdentifier, s *types.AccountIdentifier) bool
ContainsAccountIdentifier returns a boolean indicating whether the struct s is in arr.
func ContainsString ¶
ContainsString returns a boolean indicating whether the string s is in arr.
func ContextSleep ¶ added in v0.4.8
ContextSleep sleeps for the provided duration and returns an error if context is canceled.
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 ¶
CreateTempDir creates a directory in /tmp for usage within testing.
func CurrencyBalance ¶
func CurrencyBalance( ctx context.Context, network *types.NetworkIdentifier, helper FetcherHelper, account *types.AccountIdentifier, currency *types.Currency, block *types.BlockIdentifier, ) (*types.Amount, *types.BlockIdentifier, []*types.Coin, error)
CurrencyBalance returns the balance of an account for a particular currency.
func EnsurePathExists ¶
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 ¶
LoadAndParse reads the file at the provided path and attempts to unmarshal it into output.
func PrettyAmount ¶
PrettyAmount returns a currency amount in native format with its symbol.
func RandomNumber ¶
RandomNumber returns some number in the range [minimum, maximum). Source: https://golang.org/pkg/crypto/rand/#Int
func RemoveTempDir ¶
func RemoveTempDir(dir string)
RemoveTempDir deletes a directory at a provided path for usage within testing.
func SerializeAndWrite ¶
SerializeAndWrite attempts to serialize the provided object into a file at filePath.
func SizeOf ¶ added in v0.4.1
func SizeOf(v interface{}) int
SizeOf returns the size of 'v' in bytes. If there is an error during calculation, Of returns -1.
Types ¶
type AccountBalance ¶
type AccountBalance struct {
Account *types.AccountIdentifier
Amount *types.Amount
Coins []*types.Coin
Block *types.BlockIdentifier
}
AccountBalance defines an account's balance, including either balance or coins, as well as the block which this balance was fetched at.
func GetAccountBalances ¶
func GetAccountBalances( ctx context.Context, fetcher FetcherHelper, balanceRequests []*AccountBalanceRequest, ) ([]*AccountBalance, error)
GetAccountBalances returns an array of AccountBalances for an array of AccountBalanceRequests
type AccountBalanceRequest ¶
type AccountBalanceRequest struct {
Account *types.AccountIdentifier
Network *types.NetworkIdentifier
Currency *types.Currency
}
AccountBalanceRequest defines the required information to get an account's balance.
type FetcherHelper ¶
type FetcherHelper interface {
NetworkList(
ctx context.Context,
metadata map[string]interface{},
) (*types.NetworkListResponse, *fetcher.Error)
NetworkStatusRetry(
ctx context.Context,
network *types.NetworkIdentifier,
metadata map[string]interface{},
) (*types.NetworkStatusResponse, *fetcher.Error)
AccountBalanceRetry(
ctx context.Context,
network *types.NetworkIdentifier,
account *types.AccountIdentifier,
block *types.PartialBlockIdentifier,
) (*types.BlockIdentifier, []*types.Amount, []*types.Coin, map[string]interface{}, *fetcher.Error)
}
FetcherHelper is used by util functions to mock Fetcher
type MemoryUsage ¶ added in v0.4.8
type MemoryUsage struct {
Heap float64 `json:"heap"`
Stack float64 `json:"stack"`
OtherSystem float64 `json:"other_system"`
System float64 `json:"system"`
GarbageCollections uint32 `json:"garbage_collections"`
}
MemoryUsage contains memory usage stats converted to MBs.
func MonitorMemoryUsage ¶ added in v0.4.8
func MonitorMemoryUsage( ctx context.Context, maxHeapUsage int, ) *MemoryUsage
MonitorMemoryUsage returns a collection of memory usage stats in MB. It will also run garbage collection if the heap is greater than maxHeapUsage in MB.
Source Files