op_service

README

op-service

Issues: monorepo

Pull requests: monorepo

op-service is a collection of Go utilities to build OP-Stack services with.

├── cliapp          - Flag and lifecycle handling for a Urfave v2 CLI app.
├── client          - RPC and HTTP client utils
├── clock           - Clock interface, system clock, tickers, mock/test time utils
├── crypto          - Cryptography utils, complements geth crypto package
├── ctxinterrupt    - Blocking/Interrupt handling
├── dial            - Dialing util functions for RPC clients
├── endpoint        - Abstracts away type of RPC endpoint
├── enum            - Utils to create enums
├── errutil         - Utils to work with customized errors
├── eth             - Common Ethereum data types and OP-Stack extension types
├── flags           - Utils and flag types for CLI usage
├── httputil        - Utils to create enhanced HTTP Server
├── ioutil          - File utils, including atomic files and compression
├── jsonutil        - JSON encoding/decoding utils
├── locks           - Lock utils, like read-write wrapped types
├── log             - Logging CLI and middleware utils
├── metrics         - Metrics types, metering abstractions, server utils
├── oppprof         - P-Prof CLI types and server setup
├── predeploys      - OP-Stack predeploy definitions
├── queue           - Generic queue implementation
├── retry           - Function retry utils
├── rpc             - RPC server utils
├── safego          - Utils to make Go memory more safe
├── serialize       - Binary serialization abstractions
├── signer          - CLI flags and bindings to work with a remote signer
├── solabi          - Utils to encode/decode Solidity ABI formatted data
├── sources         - RPC client bindings
├── tasks           - Err-group with panic handling
├── testlog         - Test logger and log-capture utils for testing
├── testutils       - Simplified Ethereum types, mock RPC bindings, utils for testing.
├── tls             - CLI flags and utils to work with TLS connections
├── txmgr           - Transaction manager: automated nonce, fee and confirmation handling.
└── *.go            - Miscellaneous utils (soon to be deprecated / moved)

Usage

From op-service dir:

# Run Go tests
make test
# Run Go fuzz tests
make fuzz

Product

Optimization target

Provide solid reusable building blocks for all OP-Stack Go services.

Vision

• Remove unused utilities: op-service itself needs to stay maintainable.
• Make all Go services consistent: op-service modules can be used to simplify and improve more Go services.

Design principles

• Reduce boilerplate in Go services: provide service building utils ranging from CLI to testing.
• Protect devs from sharp edges in the Go std-lib: think of providing missing composition, proper resource-closing, well set up network-binding, safe concurrency utils.

Testing

Each op-service package has its own unit-testing. More advanced utils, such as the transaction manager, are covered in op-e2e as well.

Documentation

Index

• func CloseAction(ctx context.Context, fn func(ctx context.Context) error) error
• func FindMonorepoRoot(startDir string) (string, error)
• func FlagNameToEnvVarName(f string, prefix string) string
• func FormatVersion(version string, gitCommit string, gitDate string, meta string) string
• func Parse256BitChainID(in string) (common.Hash, error)
• func ParseAddress(address string) (common.Address, error)
• func PrefixEnvVar(prefix, suffix string) []string
• func U64UtilPtr(in uint64) *hexutil.Uint64
• func ValidateEnvVars(prefix string, flags []cli.Flag, log log.Logger)
• func WarnOnDeprecatedFlags(ctx *cli.Context, deprecatedFlags []cli.Flag, log log.Logger)

Functions

func CloseAction

func CloseAction(ctx context.Context, fn func(ctx context.Context) error) error

CloseAction runs the function in the background, until it finishes or until it is closed by the user with an interrupt.

func FindMonorepoRoot

func FindMonorepoRoot(startDir string) (string, error)

FindMonorepoRoot will recursively search upwards for a go.mod file. This depends on the structure of the monorepo having a go.mod file at the root.

func FlagNameToEnvVarName

func FlagNameToEnvVarName(f string, prefix string) string

func FormatVersion

func FormatVersion(version string, gitCommit string, gitDate string, meta string) string

func Parse256BitChainID

func Parse256BitChainID(in string) (common.Hash, error)

Parse256BitChainID parses a 256-bit chain ID from a string. Chain IDs can be defined as either an integer or a hex string. If the string starts with "0x", it is treated as a hex string, otherwise it is treated as an integer string.

func ParseAddress

func ParseAddress(address string) (common.Address, error)

ParseAddress parses an ETH address from a hex string. This method will fail if the address is not a valid hexadecimal address.

func PrefixEnvVar

func PrefixEnvVar(prefix, suffix string) []string

PrefixEnvVar adds a prefix to the environment variable, and returns the env-var wrapped in a slice for usage with urfave CLI v2.

func U64UtilPtr

func U64UtilPtr(in uint64) *hexutil.Uint64

func ValidateEnvVars

func ValidateEnvVars(prefix string, flags []cli.Flag, log log.Logger)

ValidateEnvVars logs all env vars that are found where the env var is prefixed with the supplied prefix (like OP_BATCHER) but there is no actual env var with that name. It helps validate that the supplied env vars are in fact valid.

func WarnOnDeprecatedFlags

func WarnOnDeprecatedFlags(ctx *cli.Context, deprecatedFlags []cli.Flag, log log.Logger)

WarnOnDeprecatedFlags iterates through the provided deprecatedFlags and logs a warning for each that is set.