message

Documentation

Index

• Constants
• Variables
• type Message
  • func NewMessage(source uint8, destination uint8, depositNonce uint64, ...) *Message
  • func (m Message) ID() string
• type MessageProcessor
  • func AdjustDecimalsForERC20AmountMessageProcessor(args ...interface{}) MessageProcessor
• type Metadata
• type ProposalStatus
• type TransferType

Constants

const (
	ProposalStatusInactive uint8 = iota
	ProposalStatusActive
	ProposalStatusPassed // Ready to be executed
	ProposalStatusExecuted
	ProposalStatusCanceled
)

Variables

var (
	StatusMap = map[uint8]string{ProposalStatusInactive: "inactive", ProposalStatusActive: "active", ProposalStatusPassed: "passed", ProposalStatusExecuted: "executed", ProposalStatusCanceled: "canceled"}
)

Types

type Message

type Message struct {
	Source       uint8  // Source where message was initiated
	Destination  uint8  // Destination chain of message
	DepositNonce uint64 // Nonce for the deposit
	ResourceId   types.ResourceID
	Payload      []interface{} // data associated with event sequence
	Metadata     Metadata      // Arbitrary data that will be most likely be used by the relayer
	Type         TransferType
}

func NewMessage

func NewMessage(
	source uint8,
	destination uint8,
	depositNonce uint64,
	resourceId types.ResourceID,
	transferType TransferType,
	payload []interface{},
	metadata Metadata,
) *Message

func (Message) ID

func (m Message) ID() string

type MessageProcessor

type MessageProcessor func(message *Message) error

func AdjustDecimalsForERC20AmountMessageProcessor

func AdjustDecimalsForERC20AmountMessageProcessor(args ...interface{}) MessageProcessor

AdjustDecimalsForERC20AmountMessageProcessor is a function, that accepts message and map[domainID uint8]{decimal uint} using this params processor converts amount for one chain to another for provided decimals with floor rounding

type Metadata

type Metadata struct {
	Priority uint8
	Data     map[string]interface{}
}

type ProposalStatus

type ProposalStatus struct {
	Status        uint8
	YesVotes      *big.Int
	YesVotesTotal uint8
	ProposedBlock *big.Int
}

type TransferType

type TransferType string

const (
	FungibleTransfer    TransferType = "FungibleTransfer"
	NonFungibleTransfer TransferType = "NonFungibleTransfer"
	GenericTransfer     TransferType = "GenericTransfer"
)