sdk

README

raidan-sdk

Neutral Go primitives for portable Ethereum protocol test cases.

Folder	Contents
root	Test function types, targets, execution, and RLP encoding
discovery	ENR, enode, DNS discovery, discv4, and discv5
eth	ETH protocol messages, negotiation, and request matching
gossipsub	Consensus gossip topics and publishing
reqresp	Consensus request/response protocols and SSZ-snappy framing
result	Structured verdicts
rlpx	RLPx authentication, framing, and base messages
rpc	Execution JSON-RPC and chain metadata
session	Context, deadlines, output, metadata, and observation
snap	SNAP protocol messages and request matching
target	Execution and consensus endpoints
utils	Keys, byte formatting, and terminal styles
wit	Witness protocol connections and messages

License

Apache-2.0. See LICENSE.

Documentation

Overview

Package sdk exposes the small, stable execution surface shared by portable Ethereum cases and their host programs. Protocol-specific wire operations remain in the SDK's subpackages.

Index

• Constants
• func EncodeRLPBytes(payload []byte) []byte
• func EncodeRLPList(items ...[]byte) []byte
• type Observer
• type Result
  • func Run(ctx context.Context, test Test, target Target, scope Scope) Result
• type Scope
• type Target
• type Test
• type Verdict
• type Write

Constants

const (
	// VerdictAccept indicates that the target behaved as expected.
	VerdictAccept = result.VerdictAccept
	// VerdictDisconnect indicates that the target disconnected unexpectedly.
	VerdictDisconnect = result.VerdictDisconnect
	// VerdictTimeout indicates that the target did not respond in time.
	VerdictTimeout = result.VerdictTimeout
	// VerdictInvalid indicates an invalid or inconclusive target response.
	VerdictInvalid = result.VerdictInvalid
	// VerdictBug indicates a protocol bug in the target.
	VerdictBug = result.VerdictBug
	// VerdictCrash indicates that the target crashed.
	VerdictCrash = result.VerdictCrash
)

const Version = "v0.1.7"

Version identifies this SDK release.

Functions

func EncodeRLPBytes

func EncodeRLPBytes(payload []byte) []byte

EncodeRLPBytes returns the canonical RLP byte-string encoding of payload.

func EncodeRLPList

func EncodeRLPList(items ...[]byte) []byte

EncodeRLPList wraps caller-supplied, pre-encoded RLP items in one list.

Types

type Observer

type Observer = session.Observer

Observer receives protocol writes emitted by a case.

type Result

type Result = result.Result

Result is the stable machine-readable outcome returned by every case.

func Run

func Run(ctx context.Context, test Test, target Target, scope Scope) Result

Run invokes test with output and client metadata attached to its context. Callers that need additional context values attach them before calling Run.

type Scope

type Scope = session.Scope

Scope supplies case output, client identity, and write observation.

type Target

type Target = target.Target

Target describes the execution and consensus endpoints exercised by a case.

type Test

type Test = target.Test

Test is the canonical portable case signature.

type Verdict

type Verdict = result.Verdict

Verdict classifies the outcome of a portable case.

type Write

type Write = session.Write

Write describes one protocol write observed during a case.