utils

Documentation

Index

• Variables
• func All[T any](slice []T, f func(T) bool) bool
• func DerefSlice[T any](v *[]T) []T
• func Filter[T any](slice []T, f func(T) bool) []T
• func Flatten[T any](sl ...[]T) []T
• func Gzip64Decode(data string) ([]byte, error)
• func Gzip64Encode(data []byte) (string, error)
• func HexToFelt(t testing.TB, hex string) *felt.Felt
• func HexToUint64(t testing.TB, hexStr string) uint64
• func Map[T1, T2 any](slice []T1, f func(T1) T2) []T2
• func NonNilSlice[T any](sl []T) []T
• func Ptr[T any](v T) *T
• func RunAndWrapOnError(runnable func() error, existingErr error) error
• type LogLevel
  • func (l *LogLevel) MarshalJSON() ([]byte, error)
  • func (l LogLevel) MarshalYAML() (interface{}, error)
  • func (l *LogLevel) Set(s string) error
  • func (l LogLevel) String() string
  • func (l *LogLevel) Type() string
  • func (l *LogLevel) UnmarshalText(text []byte) error
• type Logger
• type Network
  • func (n Network) ChainID() *felt.Felt
  • func (n Network) ChainIDString() string
  • func (n Network) CoreContractAddress() (common.Address, error)
  • func (n Network) DefaultL1ChainID() *big.Int
  • func (n Network) FeederURL() string
  • func (n Network) GatewayURL() string
  • func (n *Network) MarshalJSON() ([]byte, error)
  • func (n Network) MarshalYAML() (interface{}, error)
  • func (n Network) ProtocolID() protocol.ID
  • func (n *Network) Set(s string) error
  • func (n Network) String() string
  • func (n *Network) Type() string
  • func (n *Network) UnmarshalText(text []byte) error
• type SimpleLogger
• type Throttler
  • func NewThrottler[T any](concurrencyBudget uint, resource *T) *Throttler[T]
  • func (t *Throttler[T]) Do(doer func(resource *T) error) error
  • func (t *Throttler[T]) QueueLen() int
  • func (t *Throttler[T]) WithMaxQueueLen(maxQueueLen int32) *Throttler[T]
• type ZapLogger
  • func NewNopZapLogger() *ZapLogger
  • func NewZapLogger(logLevel LogLevel, colour bool) (*ZapLogger, error)
  • func (l *ZapLogger) Warningf(msg string, args ...any)

Variables

var ErrResourceBusy = errors.New("resource busy, try again")

var ErrUnknownLogLevel = errors.New("unknown log level (known: debug, info, warn, error)")

var ErrUnknownNetwork = errors.New("unknown network (known: mainnet, goerli, goerli2, integration)")

Functions

func All

func All[T any](slice []T, f func(T) bool) bool

All returns true if all elements match the given predicate

func DerefSlice

func DerefSlice[T any](v *[]T) []T

func Filter

func Filter[T any](slice []T, f func(T) bool) []T

func Flatten

func Flatten[T any](sl ...[]T) []T

func Gzip64Decode

func Gzip64Decode(data string) ([]byte, error)

func Gzip64Encode

func Gzip64Encode(data []byte) (string, error)

func HexToFelt

func HexToFelt(t testing.TB, hex string) *felt.Felt

func HexToUint64

func HexToUint64(t testing.TB, hexStr string) uint64

func Map

func Map[T1, T2 any](slice []T1, f func(T1) T2) []T2

func NonNilSlice

func NonNilSlice[T any](sl []T) []T

func Ptr

func Ptr[T any](v T) *T

func RunAndWrapOnError

func RunAndWrapOnError(runnable func() error, existingErr error) error

Types

type LogLevel

type LogLevel int

const (
	DEBUG LogLevel = iota
	INFO
	WARN
	ERROR
)

func (*LogLevel) MarshalJSON

func (l *LogLevel) MarshalJSON() ([]byte, error)

func (LogLevel) MarshalYAML

func (l LogLevel) MarshalYAML() (interface{}, error)

func (*LogLevel) Set

func (l *LogLevel) Set(s string) error

func (LogLevel) String

func (l LogLevel) String() string

func (*LogLevel) Type

func (l *LogLevel) Type() string

func (*LogLevel) UnmarshalText

func (l *LogLevel) UnmarshalText(text []byte) error

type Logger

type Logger interface {
	SimpleLogger
	pebble.Logger
}

type Network

type Network int

const (
	Mainnet Network = iota + 1
	Goerli
	Goerli2
	Integration
	Sepolia
	SepoliaIntegration
)

func (Network) ChainID

func (n Network) ChainID() *felt.Felt

func (Network) ChainIDString

func (n Network) ChainIDString() string

func (Network) CoreContractAddress

func (n Network) CoreContractAddress() (common.Address, error)

func (Network) DefaultL1ChainID

func (n Network) DefaultL1ChainID() *big.Int

func (Network) FeederURL

func (n Network) FeederURL() string

FeederURL returns URL for read commands

func (Network) GatewayURL

func (n Network) GatewayURL() string

GatewayURL returns URL for write commands

func (*Network) MarshalJSON

func (n *Network) MarshalJSON() ([]byte, error)

func (Network) MarshalYAML

func (n Network) MarshalYAML() (interface{}, error)

func (Network) ProtocolID

func (n Network) ProtocolID() protocol.ID

func (*Network) Set

func (n *Network) Set(s string) error

func (Network) String

func (n Network) String() string

func (*Network) Type

func (n *Network) Type() string

func (*Network) UnmarshalText

func (n *Network) UnmarshalText(text []byte) error

type SimpleLogger

type SimpleLogger interface {
	Debugw(msg string, keysAndValues ...any)
	Infow(msg string, keysAndValues ...any)
	Warnw(msg string, keysAndValues ...any)
	Errorw(msg string, keysAndValues ...any)
}

type Throttler

type Throttler[T any] struct {
	// contains filtered or unexported fields
}

func NewThrottler

func NewThrottler[T any](concurrencyBudget uint, resource *T) *Throttler[T]

func (*Throttler[T]) Do

func (t *Throttler[T]) Do(doer func(resource *T) error) error

Do lets caller acquire the resource within the context of a callback

func (*Throttler[T]) QueueLen

func (t *Throttler[T]) QueueLen() int

QueueLen returns the number of Do calls that is blocked on the resource

func (*Throttler[T]) WithMaxQueueLen

func (t *Throttler[T]) WithMaxQueueLen(maxQueueLen int32) *Throttler[T]

WithMaxQueueLen sets the maximum length the queue can grow to

type ZapLogger

type ZapLogger struct {
	*zap.SugaredLogger
}

func NewNopZapLogger

func NewNopZapLogger() *ZapLogger

func NewZapLogger

func NewZapLogger(logLevel LogLevel, colour bool) (*ZapLogger, error)

func (*ZapLogger) Warningf

func (l *ZapLogger) Warningf(msg string, args ...any)