utils

Documentation

Index

• Constants
• func CalcPastMedianTime(timestamps []int) (time.Time, error)
• func DecodeAndReverseHashString(hexStr string) ([32]byte, error)
• func DecodeAndReverseHexString(hexStr string) ([]byte, error)
• func DisableCanonicalMode(optionalLogger ...Logger) *ttyState
• func GetBitcoinHash(b []byte) []byte
• func GetGRPCClient(ctx context.Context, address string, connectionOptions *ConnectionOptions) (*grpc.ClientConn, error)
• func GetGRPCServer(connectionOptions *ConnectionOptions) (*grpc.Server, error)
• func GetIPAddressesWithHint(hintRegex string) ([]string, error)
• func GetPublicIPAddress() (string, error)
• func ISOFormat(timestamp time.Time) string
• func InitGlobalTracer(serviceName string) (opentracing.Tracer, io.Closer, error)
• func RestoreTTY(state *ttyState)
• func ReverseAndHexEncodeHash(b32 [32]byte) string
• func ReverseAndHexEncodeSlice(b []byte) string
• func ReverseHash(a [32]byte) [32]byte
• func ReverseHashInPlace(a *[32]byte)
• func ReverseSlice[T any](a []T) []T
• func ReverseSliceInPlace[T any](a []T)
• func SafeSend[T any](ch chan T, t T, timeoutOption ...time.Duration) bool
• func Sha256d(b []byte) []byte
• func UTXOHash(previousTxid *chainhash.Hash, index uint32, lockingScript []byte, ...) (*chainhash.Hash, error)
• type ConnectionOptions
• type Logger
• type Pair
  • func NewPair[F, S any](f F, s S) Pair[F, S]
  • func (p Pair[F, S]) String() string
• type PasswordCredentials
  • func NewPassCredentials(m map[string]string) PasswordCredentials
  • func (pc PasswordCredentials) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error)
  • func (PasswordCredentials) RequireTransportSecurity() bool

Constants

const ONE_GIGABYTE = 1024 * 1024 * 1024

Functions

func CalcPastMedianTime

func CalcPastMedianTime(timestamps []int) (time.Time, error)

CalcPastMedianTime calculates the median time of the previous few blocks prior to, and including, the block node.

This function is safe for concurrent access.

func DecodeAndReverseHashString

func DecodeAndReverseHashString(hexStr string) ([32]byte, error)

func DecodeAndReverseHexString

func DecodeAndReverseHexString(hexStr string) ([]byte, error)

DecodeAndReverseHexString decodes the given hex string and then reverses the bytes. This is useful for converting Bitcoin hex strings to byte slices in little endian format.

func DisableCanonicalMode

func DisableCanonicalMode(optionalLogger ...Logger) *ttyState

DisableCanonicalMode disables canonical mode on the terminal. This allows for reading single characters without pressing enter. The previous state is returned and can be used to restore the previous state. The optionalLogger can be used a preferred logger. If no optionalLogger is provided, a default logger is used.

Usage in main.go: defer utils.RestoreTTY(utils.DisableCanonicalMode())

func GetBitcoinHash

func GetBitcoinHash(b []byte) []byte

GetBitcoinHash calculates the Bitcoin hash of the given bytes. The Bitcoin hash is the double SHA-256 hash of the given bytes which is then reversed. For transactions the entire transaction bytes are hashed; for blocks only the header (80 bytes) is hashed.

func GetGRPCClient

func GetGRPCClient(ctx context.Context, address string, connectionOptions *ConnectionOptions) (*grpc.ClientConn, error)

func GetGRPCServer

func GetGRPCServer(connectionOptions *ConnectionOptions) (*grpc.Server, error)

func GetIPAddressesWithHint

func GetIPAddressesWithHint(hintRegex string) ([]string, error)

func GetPublicIPAddress

func GetPublicIPAddress() (string, error)

func ISOFormat

func ISOFormat(timestamp time.Time) string

ISOFormat formats a date to ISO 8601 format

func InitGlobalTracer

func InitGlobalTracer(serviceName string) (opentracing.Tracer, io.Closer, error)

func RestoreTTY

func RestoreTTY(state *ttyState)

RestoreTTY restores the previous state of the terminal. The previous state is returned by DisableCanonicalMode. If the ttyState is nil, nothing is done.

func ReverseAndHexEncodeHash

func ReverseAndHexEncodeHash(b32 [32]byte) string

func ReverseAndHexEncodeSlice

func ReverseAndHexEncodeSlice(b []byte) string

ReverseAndHexEncodeSlice encodes the given byte slice to a hex string and then reverses the bytes.

func ReverseHash

func ReverseHash(a [32]byte) [32]byte

func ReverseHashInPlace

func ReverseHashInPlace(a *[32]byte)

Reverse the elements of a 32 byte hash in place

func ReverseSlice

func ReverseSlice[T any](a []T) []T

ReverseSlice reverses the order of the items in the slice. A copy of the slice is returned.

func ReverseSliceInPlace

func ReverseSliceInPlace[T any](a []T)

ReverseSliceInPlace reverses the given slice in place.

func SafeSend

func SafeSend[T any](ch chan T, t T, timeoutOption ...time.Duration) bool

SafeSend is a helper function that sends a value on a channel and returns. It is safe to use with closed channels. It uses go generics to allow for any type of channel.

func Sha256d

func Sha256d(b []byte) []byte

Sha256d calculates hash(hash(b)) and returns the resulting bytes.

func UTXOHash

func UTXOHash(previousTxid *chainhash.Hash, index uint32, lockingScript []byte, satoshis uint64) (*chainhash.Hash, error)

Types

type ConnectionOptions

type ConnectionOptions struct {
	MaxMessageSize int                 // Max message size in bytes
	SecurityLevel  int                 // 0 = insecure, 1 = secure, 2 = secure with client cert
	OpenTelemetry  bool                // Enable OpenTelemetry tracing
	OpenTracing    bool                // Enable OpenTelemetry tracing
	Prometheus     bool                // Enable Prometheus metrics
	CertFile       string              // CA cert file if SecurityLevel > 0
	CaCertFile     string              // CA cert file if SecurityLevel > 0
	KeyFile        string              // Client key file if SecurityLevel > 1
	MaxRetries     int                 // Max number of retries for transient errors
	RetryBackoff   time.Duration       // Backoff between retries
	Credentials    PasswordCredentials // Credentials to pass to downstream middleware (optional)
}

type Logger

type Logger interface {
	LogLevel() int
	Debugf(format string, args ...interface{})
	Infof(format string, args ...interface{})
	Warnf(format string, args ...interface{})
	Errorf(format string, args ...interface{})
	Fatalf(format string, args ...interface{})
}

type Pair

type Pair[F, S any] struct {
	First  F
	Second S
}

Pair is a simple struct that holds two values.

func NewPair

func NewPair[F, S any](f F, s S) Pair[F, S]

func (Pair[F, S]) String

func (p Pair[F, S]) String() string

type PasswordCredentials

type PasswordCredentials map[string]string

--------------------------------------------------------------------- The PasswordCredentials type and the receivers it implements, allow us to use the grpc.WithPerRPCCredentials() dial option to pass credentials to downstream middleware

func NewPassCredentials

func NewPassCredentials(m map[string]string) PasswordCredentials

func (PasswordCredentials) GetRequestMetadata

func (pc PasswordCredentials) GetRequestMetadata(ctx context.Context, uri ...string) (map[string]string, error)

func (PasswordCredentials) RequireTransportSecurity

func (PasswordCredentials) RequireTransportSecurity() bool