commitments

Documentation

Index

• Constants
• Variables
• func EncodeCommitment(b []byte, c CommitmentMode) ([]byte, error)
• func StringToDecodedCommitment(key string, c CommitmentMode) ([]byte, error)
• type CertCommitment
• type CertCommitmentV0
  • func DecodeCertCommitment(commitment []byte) (CertCommitmentV0, error)
  • func NewV0CertCommitment(input []byte) CertCommitmentV0
  • func (c CertCommitmentV0) CommitmentType() CertEncodingCommitment
  • func (c CertCommitmentV0) Encode() []byte
• type CertEncodingCommitment
• type CommitmentMeta
• type CommitmentMode
  • func StringToCommitmentMode(s string) (CommitmentMode, error)
• type DAServiceOPCommitmentType
• type DaSvcCommitment
• type EigenDASvcCommitment
  • func DecodeEigenDASvcCommitment(commitment []byte) (EigenDASvcCommitment, error)
  • func NewEigenDASvcCommitment(input []byte) EigenDASvcCommitment
  • func (c EigenDASvcCommitment) CommitmentType() DAServiceOPCommitmentType
  • func (c EigenDASvcCommitment) Encode() []byte
• type GenericCommitment
  • func DecodeGenericCommitment(commitment []byte) (GenericCommitment, error)
  • func NewGenericCommitment(input []byte) GenericCommitment
  • func (c GenericCommitment) CommitmentType() OPCommitmentType
  • func (c GenericCommitment) Encode() []byte
  • func (c GenericCommitment) Verify(_ []byte) error
• type Keccak256Commitment
  • func DecodeKeccak256(commitment []byte) (Keccak256Commitment, error)
  • func NewKeccak256Commitment(input []byte) Keccak256Commitment
  • func (c Keccak256Commitment) CommitmentType() OPCommitmentType
  • func (c Keccak256Commitment) Encode() []byte
  • func (c Keccak256Commitment) Verify(input []byte) error
• type OPCommitment
  • func DecodeOPCommitment(input []byte) (OPCommitment, error)
  • func NewOPCommitment(t OPCommitmentType, input []byte) OPCommitment
• type OPCommitmentType
  • func CommitmentTypeFromString(s string) (OPCommitmentType, error)

Constants

const (
	Keccak256CommitmentType OPCommitmentType = 0
	GenericCommitmentType   OPCommitmentType = 1
	KeccakCommitmentString  string           = "KeccakCommitment"
	GenericCommitmentString string           = "GenericCommitment"
)

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

Variables

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

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

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

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

Functions

func EncodeCommitment

func EncodeCommitment(b []byte, c CommitmentMode) ([]byte, error)

func StringToDecodedCommitment

func StringToDecodedCommitment(key string, c CommitmentMode) ([]byte, error)

Types

type CertCommitment

type CertCommitment interface {
	CommitmentType() CertEncodingCommitment
	Encode() []byte
	Verify(input []byte) error
}

OPCommitment is the binary representation of a commitment.

type CertCommitmentV0

type CertCommitmentV0 []byte

func DecodeCertCommitment

func DecodeCertCommitment(commitment []byte) (CertCommitmentV0, error)

DecodeCertCommitment validates and casts the commitment into a Keccak256Commitment.

func NewV0CertCommitment

func NewV0CertCommitment(input []byte) CertCommitmentV0

NewV0CertCommitment creates a new commitment from the given input.

func (CertCommitmentV0) CommitmentType

func (c CertCommitmentV0) CommitmentType() CertEncodingCommitment

CommitmentType returns the commitment type of Keccak256.

func (CertCommitmentV0) Encode

func (c CertCommitmentV0) Encode() []byte

Encode adds a commitment type prefix self describing the commitment.

type CertEncodingCommitment

type CertEncodingCommitment byte

const (
	CertV0 CertEncodingCommitment = 0
)

type CommitmentMeta

type CommitmentMeta struct {
	Mode CommitmentMode
	// CertVersion is shared for all modes and denotes version of the EigenDA certificate
	CertVersion byte
}

type CommitmentMode

type CommitmentMode string

const (
	OptimismKeccak       CommitmentMode = "optimism_keccak256"
	OptimismGeneric      CommitmentMode = "optimism_generic"
	SimpleCommitmentMode CommitmentMode = "simple"
)

func StringToCommitmentMode

func StringToCommitmentMode(s string) (CommitmentMode, error)

type DAServiceOPCommitmentType

type DAServiceOPCommitmentType byte

const (
	EigenDACommitmentType DAServiceOPCommitmentType = 0
)

type DaSvcCommitment

type DaSvcCommitment interface {
	CommitmentType() DAServiceOPCommitmentType
	Encode() []byte
	Verify(input []byte) error
}

OPCommitment is the binary representation of a commitment.

type EigenDASvcCommitment

type EigenDASvcCommitment []byte

func DecodeEigenDASvcCommitment

func DecodeEigenDASvcCommitment(commitment []byte) (EigenDASvcCommitment, error)

DecodeEigenDASvcCommitment validates and casts the commitment into a Keccak256Commitment.

func NewEigenDASvcCommitment

func NewEigenDASvcCommitment(input []byte) EigenDASvcCommitment

NewEigenDASvcCommitment creates a new commitment from the given input.

func (EigenDASvcCommitment) CommitmentType

func (c EigenDASvcCommitment) CommitmentType() DAServiceOPCommitmentType

CommitmentType returns the commitment type of Keccak256.

func (EigenDASvcCommitment) Encode

func (c EigenDASvcCommitment) Encode() []byte

Encode adds a commitment type prefix self describing the commitment.

type GenericCommitment

type GenericCommitment []byte

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

func DecodeGenericCommitment

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

DecodeGenericCommitment validates and casts the commitment into a GenericCommitment.

func NewGenericCommitment

func NewGenericCommitment(input []byte) GenericCommitment

NewGenericCommitment creates a new commitment from the given input.

func (GenericCommitment) CommitmentType

func (c GenericCommitment) CommitmentType() OPCommitmentType

CommitmentType returns the commitment type of Generic Commitment.

func (GenericCommitment) Encode

func (c GenericCommitment) Encode() []byte

Encode adds a commitment type prefix self describing the commitment.

func (GenericCommitment) Verify

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

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

type Keccak256Commitment

type Keccak256Commitment []byte

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

func DecodeKeccak256

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

DecodeKeccak256 validates and casts the commitment into a Keccak256Commitment.

func NewKeccak256Commitment

func NewKeccak256Commitment(input []byte) Keccak256Commitment

NewKeccak256Commitment creates a new commitment from the given input.

func (Keccak256Commitment) CommitmentType

func (c Keccak256Commitment) CommitmentType() OPCommitmentType

CommitmentType returns the commitment type of Keccak256.

func (Keccak256Commitment) Encode

func (c Keccak256Commitment) Encode() []byte

Encode adds a commitment type prefix self describing the commitment.

func (Keccak256Commitment) Verify

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

Verify checks if the commitment matches the given input.

type OPCommitment

type OPCommitment interface {
	CommitmentType() OPCommitmentType
	Encode() []byte
	Verify(input []byte) error
}

OPCommitment is the binary representation of a commitment.

func DecodeOPCommitment

func DecodeOPCommitment(input []byte) (OPCommitment, error)

DecodeOPCommitment 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 NewOPCommitment

func NewOPCommitment(t OPCommitmentType, input []byte) OPCommitment

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

type OPCommitmentType

type OPCommitmentType byte

OPCommitmentType is the commitment type prefix.

func CommitmentTypeFromString

func CommitmentTypeFromString(s string) (OPCommitmentType, error)