context

Documentation

Index

• Variables
• func BlockHeightFromContext(ctx context.Context) (uint64, error)
• func ChainIDFromContext(ctx context.Context) (string, error)
• func InProgressSnapshotRestore(ctx context.Context) bool
• func InProgressUpgrade(ctx context.Context) bool
• func InProgressUpgradeFrom(ctx context.Context, from string) bool
• func InProgressUpgradeFromMultiple(ctx context.Context, versions ...string) bool
• func RemoteIPAddrFromContext(ctx context.Context) (string, bool)
• func TraceIDFromContext(ctx context.Context) (context.Context, string)
• func TxHashFromContext(ctx context.Context) (string, error)
• func WithBlockHeight(ctx context.Context, h uint64) context.Context
• func WithChainID(ctx context.Context, chainID string) context.Context
• func WithRemoteIPAddr(ctx context.Context, addr string) context.Context
• func WithSnapshotInfo(ctx context.Context, version string, upgrade bool) context.Context
• func WithTraceID(ctx context.Context, tID string) context.Context
• func WithTxHash(ctx context.Context, txHash string) context.Context

Variables

var (
	ErrBlockHeightMissing = errors.New("no or invalid block height set on context")
	ErrChainIDMissing     = errors.New("no or invalid chain id set on context")
	ErrTxHashMissing      = errors.New("no or invalid transaction hash set on context")
)

Functions

func BlockHeightFromContext

func BlockHeightFromContext(ctx context.Context) (uint64, error)

func ChainIDFromContext

func ChainIDFromContext(ctx context.Context) (string, error)

func InProgressSnapshotRestore

func InProgressSnapshotRestore(ctx context.Context) bool

InProgressSnapshotRestore returns whether the data in the contexts tells us that a snapshot restore is in progress.

func InProgressUpgrade

func InProgressUpgrade(ctx context.Context) bool

InProgressUpgrade returns whether the data in the contexts tells us that the node is restoring from a snapshot taken for a protocol-upgrade.

func InProgressUpgradeFrom

func InProgressUpgradeFrom(ctx context.Context, from string) bool

InProgressUpgradeFrom returns whether the data in the contexts tells us that the node is restoring from a snapshot taken for a protocol-upgrade by the given version.

func InProgressUpgradeFromMultiple

func InProgressUpgradeFromMultiple(ctx context.Context, versions ...string) bool

InProgressUpgradeFromMultiple returns whether the data in the contexts tells us that the node is restoring from a snapshot taken for a protocol-upgrade by one of the given versions. This can be useful in situations where mainnet and fairground are running different versions.

func RemoteIPAddrFromContext

func RemoteIPAddrFromContext(ctx context.Context) (string, bool)

RemoteIPAddrFromContext returns the remote IP addr value stored in ctx, if any.

func TraceIDFromContext

func TraceIDFromContext(ctx context.Context) (context.Context, string)

TraceIDFromContext get traceID from context (add one if none is set).

func TxHashFromContext

func TxHashFromContext(ctx context.Context) (string, error)

func WithBlockHeight

func WithBlockHeight(ctx context.Context, h uint64) context.Context

func WithChainID

func WithChainID(ctx context.Context, chainID string) context.Context

func WithRemoteIPAddr

func WithRemoteIPAddr(ctx context.Context, addr string) context.Context

WithRemoteIPAddr wrap the context into a new context and embed the ip addr as a key.

func WithSnapshotInfo

func WithSnapshotInfo(ctx context.Context, version string, upgrade bool) context.Context

func WithTraceID

func WithTraceID(ctx context.Context, tID string) context.Context

WithTraceID returns a context with a traceID value.

func WithTxHash

func WithTxHash(ctx context.Context, txHash string) context.Context