plasma

package

Go to main page

Versions in this module

v1

v1.9.0

Aug 7, 2024

v1.8.0

Jul 17, 2024

Changes in this version

+ var DaServerAddressFlagAlias = altDAFlags("da-server")

+ var DaServiceFlagAlias = altDAFlags("da-service")

+ var EnabledFlagAlias = altDAFlags("enabled")

+ var VerifyOnReadFlagAlias = altDAFlags("verify-on-read")

+ type Challenge struct

type CommitmentData

+ String func() string

type DA

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

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

type GenericCommitment

+ func (c GenericCommitment) String() string

type Keccak256Commitment

+ func (c Keccak256Commitment) String() string

type State

+ func (s *State) ClearCommitments()

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

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

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

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

+ func (s *State) NoCommitments() bool

+ func (s *State) ResolveChallenge(comm CommitmentData, inclusionBlock eth.BlockID, commBlockNumber uint64, ...) error

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

v1.7.7

Jun 5, 2024

Changes in this version

+ const GenericCommitmentString

+ const KeccakCommitmentString

type CommitmentType

+ func CommitmentTypeFromString(s string) (CommitmentType, error)

type Config

+ CommitmentType CommitmentType

v1.7.6

May 23, 2024

Changes in this version

+ const DaServiceFlag

type CLIConfig

+ GenericDA bool

+ type CommitmentData interface

+ CommitmentType func() CommitmentType

+ Encode func() []byte

+ TxData func() []byte

+ Verify func(input []byte) error

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

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

type CommitmentType

+ const GenericCommitmentType

+ type GenericCommitment []byte

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

+ func NewGenericCommitment(input []byte) GenericCommitment

+ func (c GenericCommitment) CommitmentType() CommitmentType

+ func (c GenericCommitment) Encode() []byte

+ func (c GenericCommitment) TxData() []byte

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

type Keccak256Commitment

+ func NewKeccak256Commitment(input []byte) Keccak256Commitment

+ func (c Keccak256Commitment) CommitmentType() CommitmentType

type MockDAClient

+ CommitmentType CommitmentType

v1.7.4

Apr 23, 2024

Changes in this version

+ type DAServer struct

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

+ func (b *DAServer) Endpoint() string

+ func (b *DAServer) Stop() error

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

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

+ func (d *DAServer) Start() error

+ type KVStore interface

+ Get func(ctx context.Context, key []byte) ([]byte, error)

+ Put func(ctx context.Context, key []byte, value []byte) error

v1.7.3

Apr 8, 2024

v1.7.2

Mar 20, 2024

Changes in this version

+ const MaxInputSize

+ const TxDataVersion1

+ var ChallengeStatusEventABI = "ChallengeStatusChanged(uint256,bytes,uint8)"

+ var ChallengeStatusEventABIHash = crypto.Keccak256Hash([]byte(ChallengeStatusEventABI))

+ var ChallengeStatusEventName = "ChallengeStatusChanged"

+ var Disabled = &PlasmaDisabled

+ var ErrExpiredChallenge = errors.New("challenge expired")

+ var ErrInvalidChallenge = errors.New("invalid challenge")

+ var ErrInvalidCommitment = errors.New("invalid commitment")

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

+ var ErrNotEnabled = errors.New("plasma not enabled")

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

+ var ErrReorgRequired = errors.New("reorg required")

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

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

+ type ChallengeStatus uint8

+ const ChallengeActive

+ const ChallengeExpired

+ const ChallengeResolved

+ const ChallengeUninitialized

+ type CommQueue []*Commitment

+ func (c *CommQueue) Pop() any

+ func (c *CommQueue) Push(x any)

+ func (c CommQueue) Len() int

+ func (c CommQueue) Less(i, j int) bool

+ func (c CommQueue) Swap(i, j int)

+ type Commitment struct

+ type CommitmentType byte

+ const Keccak256CommitmentType

+ type Config struct

+ ChallengeWindow uint64

+ DAChallengeContractAddress common.Address

+ ResolveWindow uint64

type DA

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

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

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

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

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

+ func (d *DA) OnFinalizedHeadSignal(f HeadSignalFn)

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

type DAErrFaker

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

+ type HeadSignalFn func(eth.L1BlockRef)

+ type Keccak256Commitment []byte

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

+ func Keccak256(input []byte) Keccak256Commitment

+ func (c Keccak256Commitment) Encode() []byte

+ func (c Keccak256Commitment) TxData() []byte

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

+ type L1Fetcher interface

+ FetchReceipts func(ctx context.Context, blockHash common.Hash) (eth.BlockInfo, types.Receipts, error)

+ InfoAndTxsByHash func(ctx context.Context, hash common.Hash) (eth.BlockInfo, types.Transactions, error)

+ L1BlockRefByNumber func(context.Context, uint64) (eth.L1BlockRef, error)

+ type Metricer interface

+ RecordActiveChallenge func(commBlock uint64, startBlock uint64, hash []byte)

+ RecordChallengesHead func(name string, num uint64)

+ RecordExpiredChallenge func(hash []byte)

+ RecordResolvedChallenge func(hash []byte)

+ RecordStorageError func()

+ type Metrics struct

+ ChallengesHead *prometheus.GaugeVec

+ ChallengesStatus *prometheus.GaugeVec

+ StorageErrors *metrics.Event

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

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

+ func (m *Metrics) RecordChallenge(status string)

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

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

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

+ func (m *Metrics) RecordStorageError()

+ type NoopMetrics struct

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

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

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

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

+ func (m *NoopMetrics) RecordStorageError()

+ type PlasmaDisabled struct

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

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

+ func (d *PlasmaDisabled) GetInput(ctx context.Context, l1 L1Fetcher, commitment Keccak256Commitment, ...) (eth.Data, error)

+ func (d *PlasmaDisabled) OnFinalizedHeadSignal(f HeadSignalFn)

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

+ type State struct

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

+ func (s *State) ExpireChallenges(bn uint64) (uint64, error)

+ func (s *State) GetOrTrackChallenge(key []byte, bn uint64, challengeWindow uint64) *Commitment

+ func (s *State) GetResolvedInput(key []byte) ([]byte, error)

+ func (s *State) IsTracking(key []byte, bn uint64) bool

+ func (s *State) Prune(bn uint64)

+ func (s *State) Reset()

+ func (s *State) SetActiveChallenge(key []byte, challengedAt uint64, resolveWindow uint64)

+ func (s *State) SetInputCommitment(key []byte, committedAt uint64, challengeWindow uint64) *Commitment

+ func (s *State) SetResolvedChallenge(key []byte, input []byte, resolvedAt uint64)

+ func (s *State) TrackDetachedCommitment(key []byte, bn uint64)

v1.7.0

Feb 22, 2024

v1.6.1

Feb 15, 2024

Changes in this version

+ const DaServerAddressFlagName

+ const EnabledFlagName

+ const VerifyOnReadFlagName

+ var ErrCommitmentMismatch = errors.New("commitment mismatch")

+ var ErrInvalidInput = errors.New("invalid input")

+ var ErrNotFound = errors.New("not found")

+ func CLIFlags(envPrefix string) []cli.Flag

+ type CLIConfig struct

+ DAServerURL string

+ Enabled bool

+ VerifyOnRead bool

+ func ReadCLIConfig(c *cli.Context) CLIConfig

+ func (c CLIConfig) Check() error

+ func (c CLIConfig) NewDAClient() *DAClient

+ type DA struct

+ func NewPlasmaDA(log log.Logger, cfg CLIConfig) *DA

+ func NewPlasmaDAWithStorage(log log.Logger, storage DAStorage) *DA

+ func (d *DA) GetInput(ctx context.Context, commitment []byte, blockNumber uint64) (Input, error)

+ type DAClient struct

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

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

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

+ type DAErrFaker struct

+ Client *MockDAClient

+ func (f *DAErrFaker) ActGetPreImageFail()

+ func (f *DAErrFaker) ActSetPreImageFail()

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

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

+ type DAStorage interface

+ GetInput func(ctx context.Context, key []byte) ([]byte, error)

+ SetInput func(ctx context.Context, img []byte) ([]byte, error)

+ type Input struct

+ Data eth.Data

+ type MockDAClient struct

+ func NewMockDAClient(log log.Logger) *MockDAClient

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

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

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

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL