message

Documentation

Overview

Package message implements the supported runtime messages.

Index

• func MessagesHash(msgs []Message) (h hash.Hash)
• type Message
  • func (m *Message) ValidateBasic() error
• type RegistryMessage
  • func (rm *RegistryMessage) ValidateBasic() error
• type StakingMessage
  • func (sm *StakingMessage) ValidateBasic() error

Functions

func MessagesHash

func MessagesHash(msgs []Message) (h hash.Hash)

MessagesHash returns a hash of provided runtime messages.

Types

type Message

type Message struct {
	Staking  *StakingMessage  `json:"staking,omitempty"`
	Registry *RegistryMessage `json:"registry,omitempty"`
}

Message is a message that can be sent by a runtime.

func (*Message) ValidateBasic

func (m *Message) ValidateBasic() error

ValidateBasic performs basic validation of the runtime message.

type RegistryMessage

type RegistryMessage struct {
	cbor.Versioned

	UpdateRuntime *registry.Runtime `json:"update_runtime,omitempty"`
}

RegistryMessage is a runtime message that allows a runtime to perform staking operations.

func (*RegistryMessage) ValidateBasic

func (rm *RegistryMessage) ValidateBasic() error

ValidateBasic performs basic validation of the runtime message.

type StakingMessage

type StakingMessage struct {
	cbor.Versioned

	Transfer      *staking.Transfer      `json:"transfer,omitempty"`
	Withdraw      *staking.Withdraw      `json:"withdraw,omitempty"`
	AddEscrow     *staking.Escrow        `json:"add_escrow,omitempty"`
	ReclaimEscrow *staking.ReclaimEscrow `json:"reclaim_escrow,omitempty"`
}

StakingMessage is a runtime message that allows a runtime to perform staking operations.

func (*StakingMessage) ValidateBasic

func (sm *StakingMessage) ValidateBasic() error

ValidateBasic performs basic validation of the runtime message.