messages

Documentation

Index

• Constants
• Variables
• type DataPoint
  • func (d *DataPoint) MarshallBinary() ([]byte, error)
  • func (d *DataPoint) UnmarshallBinary(data []byte) error
• type Event
  • func (e *Event) Copy() *Event
  • func (e *Event) MarshallBinary() ([]byte, error)
  • func (e *Event) UnmarshallBinary(data []byte) error
• type EventSignature
• type MuSigCommitment
  • func (m *MuSigCommitment) MarshallBinary() ([]byte, error)
  • func (m *MuSigCommitment) UnmarshallBinary(bytes []byte) error
• type MuSigInitialize
  • func (m *MuSigInitialize) MarshallBinary() ([]byte, error)
  • func (m *MuSigInitialize) UnmarshallBinary(bytes []byte) (err error)
• type MuSigPartialSignature
  • func (m *MuSigPartialSignature) MarshallBinary() ([]byte, error)
  • func (m *MuSigPartialSignature) UnmarshallBinary(bytes []byte) error
• type MuSigSignature
  • func (m *MuSigSignature) MarshallBinary() ([]byte, error)
  • func (m *MuSigSignature) UnmarshallBinary(bytes []byte) error
• type MuSigTerminate
  • func (m *MuSigTerminate) MarshallBinary() ([]byte, error)
  • func (m *MuSigTerminate) UnmarshallBinary(bytes []byte) error
• type Price
  • func (p *Price) AsV0() *Price
  • func (p *Price) AsV1() *Price
  • func (p *Price) Marshall() ([]byte, error)
  • func (p *Price) MarshallBinary() ([]byte, error)
  • func (p *Price) Unmarshall(b []byte) error
  • func (p *Price) UnmarshallBinary(data []byte) error

Constants

const (
	MuSigStartV1MessageName            = "musig_initialize/v1"
	MuSigTerminateV1MessageName        = "musig_terminate/v1"
	MuSigCommitmentV1MessageName       = "musig_commitment/v1"
	MuSigPartialSignatureV1MessageName = "musig_partial_signature/v1"
	MuSigSignatureV1MessageName        = "musig_signature/v1"
)

const DataPointV1MessageName = "data_point/v1"

const EventV1MessageName = "event/v1"

const PriceV0MessageName = "price/v0"

const PriceV1MessageName = "price/v1"

Variables

var (
	ErrPriceMessageTooLarge       = errors.New("price message too large")
	ErrUnknownPriceMessageVersion = errors.New("unknown message version")
	ErrInvalidPriceMessage        = errors.New("invalid price message")
)

var ErrEventMessageTooLarge = errors.New("event message too large")

Types

type DataPoint

type DataPoint struct {
	// Model of the data point.
	Model string

	// Value is a binary representation of the data point.
	Value datapoint.Point

	Signature types.Signature
}

func (*DataPoint) MarshallBinary

func (d *DataPoint) MarshallBinary() ([]byte, error)

MarshallBinary implements the transport.Message interface.

func (*DataPoint) UnmarshallBinary

func (d *DataPoint) UnmarshallBinary(data []byte) error

UnmarshallBinary implements the transport.Message interface.

type Event

type Event struct {
	// Type of the event.
	Type string

	// Unique ID of the event.
	ID []byte

	// Event index used to search for events.
	Index []byte

	// The date of the event.
	EventDate time.Time

	// The date when the event message was created.
	MessageDate time.Time

	// List of event data.
	Data map[string][]byte

	// List of event signatures.
	Signatures map[string]EventSignature
}

func (*Event) Copy

func (e *Event) Copy() *Event

Copy returns a copy of the event.

func (*Event) MarshallBinary

func (e *Event) MarshallBinary() ([]byte, error)

MarshallBinary implements the transport.Message interface.

func (*Event) UnmarshallBinary

func (e *Event) UnmarshallBinary(data []byte) error

UnmarshallBinary implements the transport.Message interface.

type EventSignature

type EventSignature struct {
	Signer    []byte
	Signature []byte
}

type MuSigCommitment

type MuSigCommitment struct {
	// Unique SessionID of the MuSig session.
	SessionID [32]byte

	CommitmentKeyX *big.Int
	CommitmentKeyY *big.Int

	PublicKeyX *big.Int
	PublicKeyY *big.Int
}

func (*MuSigCommitment) MarshallBinary

func (m *MuSigCommitment) MarshallBinary() ([]byte, error)

func (*MuSigCommitment) UnmarshallBinary

func (m *MuSigCommitment) UnmarshallBinary(bytes []byte) error

type MuSigInitialize

type MuSigInitialize struct {
	// SessionID is the unique ID of the MuSig session.
	SessionID [32]byte

	// CreatedAt is the time when the session was started.
	StartedAt time.Time

	// Type of the message that will be signed.
	MsgType string

	// Message body that will be signed.
	MsgBody types.Hash

	// Meta is a map of metadata that may be necessary to verify the message.
	MsgMeta map[string][]byte

	// Signers is a list of signers that will participate in the MuSig session.
	Signers []types.Address
}

func (*MuSigInitialize) MarshallBinary

func (m *MuSigInitialize) MarshallBinary() ([]byte, error)

func (*MuSigInitialize) UnmarshallBinary

func (m *MuSigInitialize) UnmarshallBinary(bytes []byte) (err error)

type MuSigPartialSignature

type MuSigPartialSignature struct {
	// Unique SessionID of the MuSig session.
	SessionID [32]byte

	// Partial signature of the MuSig session.
	PartialSignature *big.Int
}

func (*MuSigPartialSignature) MarshallBinary

func (m *MuSigPartialSignature) MarshallBinary() ([]byte, error)

func (*MuSigPartialSignature) UnmarshallBinary

func (m *MuSigPartialSignature) UnmarshallBinary(bytes []byte) error

type MuSigSignature

type MuSigSignature struct {
	// Unique SessionID of the MuSig session.
	SessionID [32]byte

	// Type of the data that was signed.
	MsgType string

	// Data that was signed.
	MsgBody types.Hash

	// Commitment of the MuSig session.
	Commitment types.Address

	// SchnorrSignature is a MuSig Schnorr signature calculated from the partial
	// signatures of all participants.
	SchnorrSignature *big.Int

	// ECDSASignature is a ECDSA signature calculated by the MuSig session
	// coordinator.
	ECDSASignature types.Signature
}

func (*MuSigSignature) MarshallBinary

func (m *MuSigSignature) MarshallBinary() ([]byte, error)

func (*MuSigSignature) UnmarshallBinary

func (m *MuSigSignature) UnmarshallBinary(bytes []byte) error

type MuSigTerminate

type MuSigTerminate struct {
	// Unique SessionID of the MuSig session.
	SessionID [32]byte

	// Reason for terminating the MuSig session.
	Reason string
}

func (*MuSigTerminate) MarshallBinary

func (m *MuSigTerminate) MarshallBinary() ([]byte, error)

func (*MuSigTerminate) UnmarshallBinary

func (m *MuSigTerminate) UnmarshallBinary(bytes []byte) error

type Price

type Price struct {
	Price   *median.Price   `json:"price"`
	Trace   json.RawMessage `json:"trace"`
	Version string          `json:"version,omitempty"` // TODO: this should move to some meta field e.g. `feedVersion`
	// contains filtered or unexported fields
}

func (*Price) AsV0

func (p *Price) AsV0() *Price

func (*Price) AsV1

func (p *Price) AsV1() *Price

func (*Price) Marshall

func (p *Price) Marshall() ([]byte, error)

func (*Price) MarshallBinary

func (p *Price) MarshallBinary() ([]byte, error)

MarshallBinary implements the transport.Message interface.

func (*Price) Unmarshall

func (p *Price) Unmarshall(b []byte) error

func (*Price) UnmarshallBinary

func (p *Price) UnmarshallBinary(data []byte) error

UnmarshallBinary implements the transport.Message interface.