publisher

Documentation

Index

• func PublishBlockEvents(blockApplied *blockApplied, events *Events, log *logger.Logger)
• type BlockWithTrieRoot
• type Events
• type ISCEvent
  • func (e *ISCEvent[T]) String() string
• type ISCEventType
• type Publisher
  • func New(log *logger.Logger) *Publisher
  • func (p *Publisher) AccessNodesUpdated(chainID isc.ChainID, accessNodes []*cryptolib.PublicKey)
  • func (p *Publisher) BlockApplied(chainID isc.ChainID, block state.Block, latestState kv.KVStoreReader)
  • func (p *Publisher) Run(ctx context.Context)
  • func (p *Publisher) ServerNodesUpdated(chainID isc.ChainID, serverNodes []*cryptolib.PublicKey)
• type ReceiptWithError

Functions

func PublishBlockEvents

func PublishBlockEvents(blockApplied *blockApplied, events *Events, log *logger.Logger)

PublishBlockEvents extracts the events from a block, its returns a chan of ISCEventType, so they can be filtered

Types

type BlockWithTrieRoot

type BlockWithTrieRoot struct {
	BlockInfo *blocklog.BlockInfo
	TrieRoot  trie.Hash
}

type Events

type Events struct {
	BlockEvents    *event.Event1[*ISCEvent[[]*isc.Event]]
	NewBlock       *event.Event1[*ISCEvent[*BlockWithTrieRoot]]
	RequestReceipt *event.Event1[*ISCEvent[*ReceiptWithError]]

	Published *event.Event1[*ISCEvent[any]]
}

type ISCEvent

type ISCEvent[T any] struct {
	Kind      ISCEventType  `json:"kind"`
	Issuer    isc.AgentID   `json:"issuer"`    // (AgentID) nil means issued by the VM
	RequestID isc.RequestID `json:"requestID"` // (isc.RequestID)
	ChainID   isc.ChainID   `json:"chainID"`   // (isc.ChainID)
	Payload   T             `json:"payload"`
}

func (*ISCEvent[T]) String

func (e *ISCEvent[T]) String() string

kind is not printed right now, because it is added when calling p.publish

type ISCEventType

type ISCEventType string

const (
	ISCEventKindNewBlock    ISCEventType = "new_block"
	ISCEventKindReceipt     ISCEventType = "receipt" // issuer will be the request sender
	ISCEventKindBlockEvents ISCEventType = "block_events"
	ISCEventIssuerVM        ISCEventType = "vm"
)

type Publisher

type Publisher struct {
	Events *Events
	// contains filtered or unexported fields
}

func New

func New(log *logger.Logger) *Publisher

func (*Publisher) AccessNodesUpdated

func (p *Publisher) AccessNodesUpdated(chainID isc.ChainID, accessNodes []*cryptolib.PublicKey)

Implements the chain.ChainListener interface. NOTE: Do not block the caller!

func (*Publisher) BlockApplied

func (p *Publisher) BlockApplied(chainID isc.ChainID, block state.Block, latestState kv.KVStoreReader)

Implements the chain.ChainListener interface. NOTE: Do not block the caller!

func (*Publisher) Run

func (p *Publisher) Run(ctx context.Context)

This is called by the component to run this.

func (*Publisher) ServerNodesUpdated

func (p *Publisher) ServerNodesUpdated(chainID isc.ChainID, serverNodes []*cryptolib.PublicKey)

Implements the chain.ChainListener interface. NOTE: Do not block the caller!

type ReceiptWithError

type ReceiptWithError struct {
	RequestReceipt *isc.Receipt
	Error          *isc.VMError
}