plasma

package
v1.9.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 7, 2024 License: MIT Imports: 28 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	Keccak256CommitmentType CommitmentType = 0
	GenericCommitmentType   CommitmentType = 1
	KeccakCommitmentString  string         = "KeccakCommitment"
	GenericCommitmentString string         = "GenericCommitment"
)

CommitmentType describes the binary format of the commitment. KeccakCommitmentType is the default commitment type for the centralized DA storage. GenericCommitmentType indicates an opaque bytestring that the op-node never opens.

View Source 
const MaxInputSize = 130672

MaxInputSize ensures the canonical chain cannot include input batches too large to challenge in the Data Availability Challenge contract. Value in number of bytes. This value can only be changed in a hard fork.

View Source 
const TxDataVersion1 = 1

TxDataVersion1 is the version number for batcher transactions containing plasma commitments. It should not collide with DerivationVersion which is still used downstream when parsing the frames.

Variables

View Source 
var (
	EnabledFlagName, EnabledFlagAlias                 = altDAFlags("enabled")
	DaServerAddressFlagName, DaServerAddressFlagAlias = altDAFlags("da-server")
	VerifyOnReadFlagName, VerifyOnReadFlagAlias       = altDAFlags("verify-on-read")
	DaServiceFlag, DaServiceFlagAlias                 = altDAFlags("da-service")
)
View Source 
var (
	ChallengeStatusEventName    = "ChallengeStatusChanged"
	ChallengeStatusEventABI     = "ChallengeStatusChanged(uint256,bytes,uint8)"
	ChallengeStatusEventABIHash = crypto.Keccak256Hash([]byte(ChallengeStatusEventABI))
)
View Source 
var Disabled = &PlasmaDisabled{}
View Source 
var ErrCommitmentMismatch = errors.New("commitment mismatch")

ErrCommitmentMismatch is returned when the commitment does not match the given input.

View Source 
var ErrExpiredChallenge = errors.New("challenge expired")

ErrExpiredChallenge is returned when a challenge was not resolved and derivation should skip this input.

View Source 
var ErrInvalidChallenge = errors.New("invalid challenge")

ErrInvalidChallenge is returned when a challenge event does is decoded but does not relate to the actual chain commitments.

View Source 
var ErrInvalidCommitment = errors.New("invalid commitment")

ErrInvalidCommitment is returned when the commitment cannot be parsed into a known commitment type.

View Source 
var ErrInvalidInput = errors.New("invalid input")

ErrInvalidInput is returned when the input is not valid for posting to the DA storage.

View Source 
var ErrMissingPastWindow = errors.New("data missing past window")

ErrMissingPastWindow is returned when the input data is MIA and cannot be challenged. This is a protocol fatal error.

View Source 
var ErrNotEnabled = errors.New("plasma not enabled")
View Source 
var ErrNotFound = errors.New("not found")

ErrNotFound is returned when the server could not find the input.

View Source 
var ErrPendingChallenge = errors.New("not found, pending challenge")

ErrPendingChallenge is returned when data is not available but can still be challenged/resolved so derivation should halt temporarily.

View Source 
var ErrReorgRequired = errors.New("reorg required")

ErrReorgRequired is returned when a commitment was derived but for which the challenge expired. This requires a reorg to rederive without the input even if the input was previously available.

Functions

func CLIFlags 

func CLIFlags(envPrefix string, category string) []cli.Flag

func DecodeChallengeStatusEvent added in v1.7.2 

func DecodeChallengeStatusEvent(log *types.Log) (*bindings.DataAvailabilityChallengeChallengeStatusChanged, error)

DecodeChallengeStatusEvent decodes the challenge status event from the log data and the indexed challenged hash and block number from the topics.

func DecodeResolvedInput added in v1.7.2 

func DecodeResolvedInput(data []byte) ([]byte, error)

DecodeResolvedInput decodes the preimage bytes from the tx input data.

Types

type CLIConfig 

type CLIConfig struct {
	Enabled      bool
	DAServerURL  string
	VerifyOnRead bool
	GenericDA    bool
}

func ReadCLIConfig 

func ReadCLIConfig(c *cli.Context) CLIConfig

func (CLIConfig) Check 

func (c CLIConfig) Check() error

func (CLIConfig) NewDAClient 

func (c CLIConfig) NewDAClient() *DAClient

type Challenge added in v1.8.0 

type Challenge struct {
	// contains filtered or unexported fields
}

Challenges are used to track the status of a challenge against a commitment.

type ChallengeStatus added in v1.7.2 

type ChallengeStatus uint8
const (
	ChallengeUninitialized ChallengeStatus = iota
	ChallengeActive
	ChallengeResolved
	ChallengeExpired
)

type Commitment added in v1.7.2 

type Commitment struct {
	// contains filtered or unexported fields
}

Commitment keeps track of the onchain state of an input commitment.

type CommitmentData added in v1.7.6 

type CommitmentData interface {
	CommitmentType() CommitmentType
	Encode() []byte
	TxData() []byte
	Verify(input []byte) error
	String() string
}

CommitmentData is the binary representation of a commitment.

func DecodeCommitmentData added in v1.7.6 

func DecodeCommitmentData(input []byte) (CommitmentData, error)

DecodeCommitmentData parses the commitment into a known commitment type. The input type is determined by the first byte of the raw data. The input type is discarded and the commitment is passed to the appropriate constructor.

func NewCommitmentData added in v1.7.6 

func NewCommitmentData(t CommitmentType, input []byte) CommitmentData

NewCommitmentData creates a new commitment from the given input and desired type.

type CommitmentType added in v1.7.2 

type CommitmentType byte

CommitmentType is the commitment type prefix.

func CommitmentTypeFromString added in v1.7.7 

func CommitmentTypeFromString(s string) (CommitmentType, error)

type Config added in v1.7.2 

type Config struct {
	// Required for filtering contract events
	DAChallengeContractAddress common.Address
	// Allowed CommitmentType
	CommitmentType CommitmentType
	// The number of l1 blocks after the input is committed during which one can challenge.
	ChallengeWindow uint64
	// The number of l1 blocks after a commitment is challenged during which one can resolve.
	ResolveWindow uint64
}

Config is the relevant subset of rollup config for plasma DA.

type DA 

type DA struct {
	// contains filtered or unexported fields
}

func NewPlasmaDA 

func NewPlasmaDA(log log.Logger, cli CLIConfig, cfg Config, metrics Metricer) *DA

NewPlasmaDA creates a new PlasmaDA instance with the given log and CLIConfig.

func NewPlasmaDAWithState added in v1.7.2 

func NewPlasmaDAWithState(log log.Logger, cfg Config, storage DAStorage, metrics Metricer, state *State) *DA

NewPlasmaDAWithState creates a plasma storage from initial state used for testing in isolation. We pass the L1Fetcher to each method so it is kept in sync with the conf depth of the pipeline.

func NewPlasmaDAWithStorage 

func NewPlasmaDAWithStorage(log log.Logger, cfg Config, storage DAStorage, metrics Metricer) *DA

NewPlasmaDAWithStorage creates a new PlasmaDA instance with the given log and DAStorage interface.

func (*DA) AdvanceChallengeOrigin added in v1.8.0 

func (d *DA) AdvanceChallengeOrigin(ctx context.Context, l1 L1Fetcher, block eth.BlockID) error

AdvanceChallengeOrigin reads & stores challenge events for the given L1 block

func (*DA) AdvanceCommitmentOrigin added in v1.8.0 

func (d *DA) AdvanceCommitmentOrigin(ctx context.Context, l1 L1Fetcher, block eth.BlockID) error

AdvanceCommitmentOrigin updates the commitment origin and the finalized head.

func (*DA) AdvanceL1Origin added in v1.7.2 

func (d *DA) AdvanceL1Origin(ctx context.Context, l1 L1Fetcher, block eth.BlockID) error

AdvanceL1Origin syncs any challenge events included in the l1 block, expires any active challenges after the new resolveWindow, computes and signals the new finalized head and sets the l1 block as the new head for tracking challenges and commitments. If forwards an error if any new challenge have expired to trigger a derivation reset.

func (*DA) Finalize added in v1.7.2 

func (d *DA) Finalize(l1Finalized eth.L1BlockRef)

Finalize sets the L1 finalized head signal and calls the handler function if set.

func (*DA) GetInput 

func (d *DA) GetInput(ctx context.Context, l1 L1Fetcher, comm CommitmentData, blockId eth.L1BlockRef) (eth.Data, error)

GetInput returns the input data for the given commitment bytes. blockNumber is required to lookup the challenge status in the DataAvailabilityChallenge L1 contract.

func (*DA) LookAhead added in v1.7.2 

func (d *DA) LookAhead(ctx context.Context, l1 L1Fetcher) error

LookAhead increments the challenges origin and process the new block if it exists. It is used when the derivation pipeline stalls due to missing data and we need to continue syncing challenge events until the challenge is resolved or expires.

func (*DA) OnFinalizedHeadSignal added in v1.7.2 

func (d *DA) OnFinalizedHeadSignal(f HeadSignalFn)

OnFinalizedHeadSignal sets the callback function to be called when the finalized head is updated. This will signal to the engine queue that will set the proper L2 block as finalized.

func (*DA) Reset added in v1.7.2 

func (d *DA) Reset(ctx context.Context, base eth.L1BlockRef, baseCfg eth.SystemConfig) error

Reset the challenge event derivation origin in case of L1 reorg

type DAClient 

type DAClient struct {
	// contains filtered or unexported fields
}

DAClient is an HTTP client to communicate with a DA storage service. It creates commitments and retrieves input data + verifies if needed.

func NewDAClient 

func NewDAClient(url string, verify bool, pc bool) *DAClient

func (*DAClient) GetInput 

func (c *DAClient) GetInput(ctx context.Context, comm CommitmentData) ([]byte, error)

GetInput returns the input data for the given encoded commitment bytes.

func (*DAClient) SetInput 

func (c *DAClient) SetInput(ctx context.Context, img []byte) (CommitmentData, error)

SetInput sets the input data and returns the respective commitment.

type DAErrFaker 

type DAErrFaker struct {
	Client *MockDAClient
	// contains filtered or unexported fields
}

func (*DAErrFaker) ActGetPreImageFail 

func (f *DAErrFaker) ActGetPreImageFail()

func (*DAErrFaker) ActSetPreImageFail 

func (f *DAErrFaker) ActSetPreImageFail()

func (*DAErrFaker) GetInput 

func (f *DAErrFaker) GetInput(ctx context.Context, key CommitmentData) ([]byte, error)

func (*DAErrFaker) SetInput added in v1.7.2 

func (f *DAErrFaker) SetInput(ctx context.Context, data []byte) (CommitmentData, error)

type DAServer added in v1.7.4 

type DAServer struct {
	// contains filtered or unexported fields
}

func NewDAServer added in v1.7.4 

func NewDAServer(host string, port int, store KVStore, log log.Logger, useGenericComm bool) *DAServer

func (*DAServer) Endpoint added in v1.7.4 

func (b *DAServer) Endpoint() string

func (*DAServer) HandleGet added in v1.7.4 

func (d *DAServer) HandleGet(w http.ResponseWriter, r *http.Request)

func (*DAServer) HandlePut added in v1.7.4 

func (d *DAServer) HandlePut(w http.ResponseWriter, r *http.Request)

func (*DAServer) Start added in v1.7.4 

func (d *DAServer) Start() error

func (*DAServer) Stop added in v1.7.4 

func (b *DAServer) Stop() error

type DAStorage 

type DAStorage interface {
	GetInput(ctx context.Context, key CommitmentData) ([]byte, error)
	SetInput(ctx context.Context, img []byte) (CommitmentData, error)
}

DAStorage interface for calling the DA storage server.

type GenericCommitment added in v1.7.6 

type GenericCommitment []byte

GenericCommitment is an implementation of CommitmentData that treats the commitment as an opaque bytestring.

func DecodeGenericCommitment added in v1.7.6 

func DecodeGenericCommitment(commitment []byte) (GenericCommitment, error)

DecodeGenericCommitment validates and casts the commitment into a GenericCommitment.

func NewGenericCommitment added in v1.7.6 

func NewGenericCommitment(input []byte) GenericCommitment

NewGenericCommitment creates a new commitment from the given input.

func (GenericCommitment) CommitmentType added in v1.7.6 

func (c GenericCommitment) CommitmentType() CommitmentType

CommitmentType returns the commitment type of Generic Commitment.

func (GenericCommitment) Encode added in v1.7.6 

func (c GenericCommitment) Encode() []byte

Encode adds a commitment type prefix self describing the commitment.

func (GenericCommitment) String added in v1.8.0 

func (c GenericCommitment) String() string

func (GenericCommitment) TxData added in v1.7.6 

func (c GenericCommitment) TxData() []byte

TxData adds an extra version byte to signal it's a commitment.

func (GenericCommitment) Verify added in v1.7.6 

func (c GenericCommitment) Verify(input []byte) error

Verify always returns true for GenericCommitment because the DA Server must validate the data before returning it to the op-node.

type HeadSignalFn added in v1.7.2 

type HeadSignalFn func(eth.L1BlockRef)

HeadSignalFn is the callback function to accept head-signals without a context.

type KVStore added in v1.7.4 

type KVStore interface {
	// Get retrieves the given key if it's present in the key-value data store.
	Get(ctx context.Context, key []byte) ([]byte, error)
	// Put inserts the given value into the key-value data store.
	Put(ctx context.Context, key []byte, value []byte) error
}

type Keccak256Commitment added in v1.7.2 

type Keccak256Commitment []byte

Keccak256Commitment is an implementation of CommitmentData that uses Keccak256 as the commitment function.

func DecodeKeccak256 added in v1.7.2 

func DecodeKeccak256(commitment []byte) (Keccak256Commitment, error)

DecodeKeccak256 validates and casts the commitment into a Keccak256Commitment.

func NewKeccak256Commitment added in v1.7.6 

func NewKeccak256Commitment(input []byte) Keccak256Commitment

NewKeccak256Commitment creates a new commitment from the given input.

func (Keccak256Commitment) CommitmentType added in v1.7.6 

func (c Keccak256Commitment) CommitmentType() CommitmentType

CommitmentType returns the commitment type of Keccak256.

func (Keccak256Commitment) Encode added in v1.7.2 

func (c Keccak256Commitment) Encode() []byte

Encode adds a commitment type prefix self describing the commitment.

func (Keccak256Commitment) String added in v1.8.0 

func (c Keccak256Commitment) String() string

func (Keccak256Commitment) TxData added in v1.7.2 

func (c Keccak256Commitment) TxData() []byte

TxData adds an extra version byte to signal it's a commitment.

func (Keccak256Commitment) Verify added in v1.7.2 

func (c Keccak256Commitment) Verify(input []byte) error

Verify checks if the commitment matches the given input.

type L1Fetcher added in v1.7.2 

type L1Fetcher interface {
	InfoAndTxsByHash(ctx context.Context, hash common.Hash) (eth.BlockInfo, types.Transactions, error)
	FetchReceipts(ctx context.Context, blockHash common.Hash) (eth.BlockInfo, types.Receipts, error)
	L1BlockRefByNumber(context.Context, uint64) (eth.L1BlockRef, error)
}

L1Fetcher is the required interface for syncing the DA challenge contract state.

type Metricer added in v1.7.2 

type Metricer interface {
	RecordActiveChallenge(commBlock uint64, startBlock uint64, hash []byte)
	RecordResolvedChallenge(hash []byte)
	RecordExpiredChallenge(hash []byte)
	RecordChallengesHead(name string, num uint64)
	RecordStorageError()
}

type Metrics added in v1.7.2 

type Metrics struct {
	ChallengesStatus *prometheus.GaugeVec
	ChallengesHead   *prometheus.GaugeVec

	StorageErrors *metrics.Event
}

func MakeMetrics added in v1.7.2 

func MakeMetrics(ns string, factory metrics.Factory) *Metrics

func (*Metrics) RecordActiveChallenge added in v1.7.2 

func (m *Metrics) RecordActiveChallenge(commBlock uint64, startBlock uint64, hash []byte)

RecordActiveChallenge records when a commitment is challenged including the block where the commitment is included, the block where the commitment was challenged and the commitment hash.

func (*Metrics) RecordChallenge added in v1.7.2 

func (m *Metrics) RecordChallenge(status string)

func (*Metrics) RecordChallengesHead added in v1.7.2 

func (m *Metrics) RecordChallengesHead(name string, num uint64)

func (*Metrics) RecordExpiredChallenge added in v1.7.2 

func (m *Metrics) RecordExpiredChallenge(hash []byte)

func (*Metrics) RecordResolvedChallenge added in v1.7.2 

func (m *Metrics) RecordResolvedChallenge(hash []byte)

func (*Metrics) RecordStorageError added in v1.7.2 

func (m *Metrics) RecordStorageError()

type MockDAClient 

type MockDAClient struct {
	CommitmentType CommitmentType
	// contains filtered or unexported fields
}

MockDAClient mocks a DA storage provider to avoid running an HTTP DA server in unit tests.

func NewMockDAClient 

func NewMockDAClient(log log.Logger) *MockDAClient

func (*MockDAClient) DeleteData 

func (c *MockDAClient) DeleteData(key []byte) error

func (*MockDAClient) GetInput 

func (c *MockDAClient) GetInput(ctx context.Context, key CommitmentData) ([]byte, error)

func (*MockDAClient) SetInput 

func (c *MockDAClient) SetInput(ctx context.Context, data []byte) (CommitmentData, error)

type NoopMetrics added in v1.7.2 

type NoopMetrics struct{}

func (*NoopMetrics) RecordActiveChallenge added in v1.7.2 

func (m *NoopMetrics) RecordActiveChallenge(commBlock uint64, startBlock uint64, hash []byte)

func (*NoopMetrics) RecordChallengesHead added in v1.7.2 

func (m *NoopMetrics) RecordChallengesHead(name string, num uint64)

func (*NoopMetrics) RecordExpiredChallenge added in v1.7.2 

func (m *NoopMetrics) RecordExpiredChallenge(hash []byte)

func (*NoopMetrics) RecordResolvedChallenge added in v1.7.2 

func (m *NoopMetrics) RecordResolvedChallenge(hash []byte)

func (*NoopMetrics) RecordStorageError added in v1.7.2 

func (m *NoopMetrics) RecordStorageError()

type PlasmaDisabled added in v1.7.2 

type PlasmaDisabled struct{}

PlasmaDisabled is a noop plasma DA implementation for stubbing.

func (*PlasmaDisabled) AdvanceL1Origin added in v1.7.2 

func (d *PlasmaDisabled) AdvanceL1Origin(ctx context.Context, l1 L1Fetcher, blockId eth.BlockID) error

func (*PlasmaDisabled) Finalize added in v1.7.2 

func (d *PlasmaDisabled) Finalize(ref eth.L1BlockRef)

func (*PlasmaDisabled) GetInput added in v1.7.2 

func (d *PlasmaDisabled) GetInput(ctx context.Context, l1 L1Fetcher, commitment CommitmentData, blockId eth.L1BlockRef) (eth.Data, error)

func (*PlasmaDisabled) OnFinalizedHeadSignal added in v1.7.2 

func (d *PlasmaDisabled) OnFinalizedHeadSignal(f HeadSignalFn)

func (*PlasmaDisabled) Reset added in v1.7.2 

func (d *PlasmaDisabled) Reset(ctx context.Context, base eth.L1BlockRef, baseCfg eth.SystemConfig) error

type State added in v1.7.2 

type State struct {
	// contains filtered or unexported fields
}

State tracks the commitment and their challenges in order of l1 inclusion. Commitments and Challenges are tracked in L1 inclusion order. They are tracked in two separate queues for Active and Expired commitments. When commitments are moved to Expired, if there is an active challenge, the DA Manager is informed that a commitment became invalid. Challenges and Commitments can be pruned when they are beyond a certain block number (e.g. when they are finalized). In the special case of a L2 reorg, challenges are still tracked but commitments are removed. This will allow the plasma fetcher to find the expired challenge.

func NewState added in v1.7.2 

func NewState(log log.Logger, m Metricer, cfg Config) *State

func (*State) ClearCommitments added in v1.8.0 

func (s *State) ClearCommitments()

ClearCommitments removes all tracked commitments but not challenges. This should be used to retain the challenge state when performing a L2 reorg

func (*State) CreateChallenge added in v1.8.0 

func (s *State) CreateChallenge(comm CommitmentData, inclusionBlock eth.BlockID, commBlockNumber uint64)

CreateChallenge creates & tracks a challenge. It will overwrite earlier challenges if the same commitment is challenged again.

func (*State) ExpireChallenges added in v1.7.2 

func (s *State) ExpireChallenges(origin eth.BlockID)

ExpireChallenges moves challenges from the active state map to the expired state map. challenges are considered expired when the oirgin is beyond the challenge's resolve window. This function processess challenges in order of inclusion until it finds a commitment which has not expired. This function must be called for every block because there is no contract event to expire challenges.

func (*State) ExpireCommitments added in v1.8.0 

func (s *State) ExpireCommitments(origin eth.BlockID) error

ExpireCommitments moves commitments from the acive state map to the expired state map. commitments are considered expired when the challenge window ends without a challenge, or when the resolve window ends without a resolution to the challenge. This function processess commitments in order of inclusion until it finds a commitment which has not expired. If a commitment expires which did not resolve its challenge, it returns ErrReorgRequired to indicate that a L2 reorg should be performed.

func (*State) GetChallenge added in v1.8.0 

func (s *State) GetChallenge(comm CommitmentData, commBlockNumber uint64) (*Challenge, bool)

GetChallenge looks up a challenge against commitment + inclusion block.

func (*State) GetChallengeStatus added in v1.8.0 

func (s *State) GetChallengeStatus(comm CommitmentData, commBlockNumber uint64) ChallengeStatus

GetChallengeStatus looks up a challenge's status, or returns ChallengeUninitialized if there is no challenge.

func (*State) NoCommitments added in v1.8.0 

func (s *State) NoCommitments() bool

NoCommitments returns true iff it is not tracking any commitments or challenges.

func (*State) Prune added in v1.7.2 

func (s *State) Prune(origin eth.BlockID)

Prune removes challenges & commitments which have an expiry block number beyond the given block number.

func (*State) Reset added in v1.7.2 

func (s *State) Reset()

Reset clears the state. It should be used when a L1 reorg occurs.

func (*State) ResolveChallenge added in v1.8.0 

func (s *State) ResolveChallenge(comm CommitmentData, inclusionBlock eth.BlockID, commBlockNumber uint64, input []byte) error

ResolveChallenge marks a challenge as resolved. It will return an error if there was not a corresponding challenge.

func (*State) TrackCommitment added in v1.8.0 

func (s *State) TrackCommitment(comm CommitmentData, inclusionBlock eth.L1BlockRef)

TrackCommitment stores a commitment in the State

Source Files

View all Source files

Directories

Path Synopsis
cmd
daserver

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.