Documentation
¶
Index ¶
- Variables
- type Metrics
- func (m *Metrics) OnWriteConfirmed(ctx context.Context, msg *WriteConfirmed, attrKVs ...any) error
- func (m *Metrics) OnWriteError(ctx context.Context, msg *WriteError, attrKVs ...any) error
- func (m *Metrics) OnWriteInitiated(ctx context.Context, msg *WriteInitiated, attrKVs ...any) error
- func (m *Metrics) OnWriteSent(ctx context.Context, msg *WriteSent, attrKVs ...any) error
- type WriteAccepted
- func (*WriteAccepted) Descriptor() ([]byte, []int)deprecated
- func (x *WriteAccepted) GetBlockData() *common.BlockData
- func (x *WriteAccepted) GetExecutionContext() *common.ExecutionContext
- func (x *WriteAccepted) GetForwarder() string
- func (x *WriteAccepted) GetNode() string
- func (x *WriteAccepted) GetReceiver() string
- func (x *WriteAccepted) GetReportId() uint32
- func (x *WriteAccepted) GetTransactionData() *common.TransactionData
- func (*WriteAccepted) ProtoMessage()
- func (x *WriteAccepted) ProtoReflect() protoreflect.Message
- func (x *WriteAccepted) Reset()
- func (x *WriteAccepted) String() string
- type WriteConfirmed
- func (m *WriteConfirmed) Attributes() []attribute.KeyValue
- func (*WriteConfirmed) Descriptor() ([]byte, []int)deprecated
- func (x *WriteConfirmed) GetBlockData() *common.BlockData
- func (x *WriteConfirmed) GetExecutionContext() *common.ExecutionContext
- func (x *WriteConfirmed) GetForwarder() string
- func (x *WriteConfirmed) GetMetaCapabilityProcessor() string
- func (x *WriteConfirmed) GetNode() string
- func (x *WriteConfirmed) GetReceiver() string
- func (x *WriteConfirmed) GetReport() []byte
- func (x *WriteConfirmed) GetReportContext() []byte
- func (x *WriteConfirmed) GetReportId() uint32
- func (x *WriteConfirmed) GetSignersNum() uint32
- func (x *WriteConfirmed) GetSuccess() bool
- func (x *WriteConfirmed) GetTransmitter() string
- func (*WriteConfirmed) ProtoMessage()
- func (x *WriteConfirmed) ProtoReflect() protoreflect.Message
- func (x *WriteConfirmed) Reset()
- func (x *WriteConfirmed) String() string
- type WriteError
- func (m *WriteError) Attributes() []attribute.KeyValue
- func (*WriteError) Descriptor() ([]byte, []int)deprecated
- func (e *WriteError) Error() string
- func (x *WriteError) GetCause() string
- func (x *WriteError) GetCode() uint32
- func (x *WriteError) GetExecutionContext() *common.ExecutionContext
- func (x *WriteError) GetForwarder() string
- func (x *WriteError) GetNode() string
- func (x *WriteError) GetReceiver() string
- func (x *WriteError) GetReportId() uint32
- func (x *WriteError) GetSummary() string
- func (*WriteError) ProtoMessage()
- func (x *WriteError) ProtoReflect() protoreflect.Message
- func (x *WriteError) Reset()
- func (x *WriteError) String() string
- type WriteInitiated
- func (m *WriteInitiated) Attributes() []attribute.KeyValue
- func (*WriteInitiated) Descriptor() ([]byte, []int)deprecated
- func (x *WriteInitiated) GetExecutionContext() *common.ExecutionContext
- func (x *WriteInitiated) GetForwarder() string
- func (x *WriteInitiated) GetNode() string
- func (x *WriteInitiated) GetReceiver() string
- func (x *WriteInitiated) GetReportId() uint32
- func (*WriteInitiated) ProtoMessage()
- func (x *WriteInitiated) ProtoReflect() protoreflect.Message
- func (x *WriteInitiated) Reset()
- func (x *WriteInitiated) String() string
- type WriteSent
- func (m *WriteSent) Attributes() []attribute.KeyValue
- func (*WriteSent) Descriptor() ([]byte, []int)deprecated
- func (x *WriteSent) GetBlockData() *common.BlockData
- func (x *WriteSent) GetExecutionContext() *common.ExecutionContext
- func (x *WriteSent) GetForwarder() string
- func (x *WriteSent) GetNode() string
- func (x *WriteSent) GetReceiver() string
- func (x *WriteSent) GetReportId() uint32
- func (x *WriteSent) GetTxId() string
- func (*WriteSent) ProtoMessage()
- func (x *WriteSent) ProtoReflect() protoreflect.Message
- func (x *WriteSent) Reset()
- func (x *WriteSent) String() string
- type WriteSkipped
- func (*WriteSkipped) Descriptor() ([]byte, []int)deprecated
- func (x *WriteSkipped) GetExecutionContext() *common.ExecutionContext
- func (x *WriteSkipped) GetForwarder() string
- func (x *WriteSkipped) GetNode() string
- func (x *WriteSkipped) GetReason() string
- func (x *WriteSkipped) GetReceiver() string
- func (x *WriteSkipped) GetReportId() uint32
- func (*WriteSkipped) ProtoMessage()
- func (x *WriteSkipped) ProtoReflect() protoreflect.Message
- func (x *WriteSkipped) Reset()
- func (x *WriteSkipped) String() string
Constants ¶
This section is empty.
Variables ¶
var File_write_accepted_proto protoreflect.FileDescriptor
var File_write_confirmed_proto protoreflect.FileDescriptor
var File_write_error_proto protoreflect.FileDescriptor
var File_write_initiated_proto protoreflect.FileDescriptor
var File_write_sent_proto protoreflect.FileDescriptor
var File_write_skipped_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Metrics ¶
type Metrics struct {
// contains filtered or unexported fields
}
Define a new struct for metrics
func NewMetrics ¶
func (*Metrics) OnWriteConfirmed ¶
func (*Metrics) OnWriteError ¶
func (*Metrics) OnWriteInitiated ¶
type WriteAccepted ¶
type WriteAccepted struct {
Node string `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
Forwarder string `protobuf:"bytes,2,opt,name=forwarder,proto3" json:"forwarder,omitempty"`
Receiver string `protobuf:"bytes,3,opt,name=receiver,proto3" json:"receiver,omitempty"`
// Report Info
ReportId uint32 `protobuf:"varint,4,opt,name=report_id,json=reportId,proto3" json:"report_id,omitempty"`
BlockData *common.BlockData `protobuf:"bytes,6,opt,name=block_data,json=blockData,proto3" json:"block_data,omitempty"`
TransactionData *common.TransactionData `protobuf:"bytes,10,opt,name=transaction_data,json=transactionData,proto3" json:"transaction_data,omitempty"`
ExecutionContext *common.ExecutionContext `protobuf:"bytes,20,opt,name=execution_context,json=executionContext,proto3" json:"execution_context,omitempty"`
// contains filtered or unexported fields
}
WT sent a transaction and it was accepted on-chain
Notice: we publish txId (TXM ref) and txHash (in the future should be available here)
func (*WriteAccepted) Descriptor
deprecated
func (*WriteAccepted) Descriptor() ([]byte, []int)
Deprecated: Use WriteAccepted.ProtoReflect.Descriptor instead.
func (*WriteAccepted) GetBlockData ¶
func (x *WriteAccepted) GetBlockData() *common.BlockData
func (*WriteAccepted) GetExecutionContext ¶
func (x *WriteAccepted) GetExecutionContext() *common.ExecutionContext
func (*WriteAccepted) GetForwarder ¶
func (x *WriteAccepted) GetForwarder() string
func (*WriteAccepted) GetNode ¶
func (x *WriteAccepted) GetNode() string
func (*WriteAccepted) GetReceiver ¶
func (x *WriteAccepted) GetReceiver() string
func (*WriteAccepted) GetReportId ¶
func (x *WriteAccepted) GetReportId() uint32
func (*WriteAccepted) GetTransactionData ¶
func (x *WriteAccepted) GetTransactionData() *common.TransactionData
func (*WriteAccepted) ProtoMessage ¶
func (*WriteAccepted) ProtoMessage()
func (*WriteAccepted) ProtoReflect ¶
func (x *WriteAccepted) ProtoReflect() protoreflect.Message
func (*WriteAccepted) Reset ¶
func (x *WriteAccepted) Reset()
func (*WriteAccepted) String ¶
func (x *WriteAccepted) String() string
type WriteConfirmed ¶
type WriteConfirmed struct {
Node string `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
Forwarder string `protobuf:"bytes,2,opt,name=forwarder,proto3" json:"forwarder,omitempty"`
Receiver string `protobuf:"bytes,3,opt,name=receiver,proto3" json:"receiver,omitempty"`
// Report Info
ReportId uint32 `protobuf:"varint,4,opt,name=report_id,json=reportId,proto3" json:"report_id,omitempty"`
ReportContext []byte `protobuf:"bytes,5,opt,name=report_context,json=reportContext,proto3" json:"report_context,omitempty"`
Report []byte `protobuf:"bytes,6,opt,name=report,proto3" json:"report,omitempty"`
SignersNum uint32 `protobuf:"varint,7,opt,name=signers_num,json=signersNum,proto3" json:"signers_num,omitempty"`
// When was the report confirmed on-chain
BlockData *common.BlockData `protobuf:"bytes,9,opt,name=block_data,json=blockData,proto3" json:"block_data,omitempty"`
// Transmission Info
Transmitter string `protobuf:"bytes,12,opt,name=transmitter,proto3" json:"transmitter,omitempty"`
Success bool `protobuf:"varint,13,opt,name=success,proto3" json:"success,omitempty"` // TODO: what about EVM's TransmissionInfo parity?
// [Execution Context]
ExecutionContext *common.ExecutionContext `protobuf:"bytes,20,opt,name=execution_context,json=executionContext,proto3" json:"execution_context,omitempty"`
// encoder processor info
MetaCapabilityProcessor string `` /* 133-byte string literal not displayed */
// contains filtered or unexported fields
}
WT confirmed the report was successfully written on-chain
func (*WriteConfirmed) Attributes ¶
func (m *WriteConfirmed) Attributes() []attribute.KeyValue
Attributes returns the attributes for the WriteConfirmed message to be used in metrics
func (*WriteConfirmed) Descriptor
deprecated
func (*WriteConfirmed) Descriptor() ([]byte, []int)
Deprecated: Use WriteConfirmed.ProtoReflect.Descriptor instead.
func (*WriteConfirmed) GetBlockData ¶
func (x *WriteConfirmed) GetBlockData() *common.BlockData
func (*WriteConfirmed) GetExecutionContext ¶
func (x *WriteConfirmed) GetExecutionContext() *common.ExecutionContext
func (*WriteConfirmed) GetForwarder ¶
func (x *WriteConfirmed) GetForwarder() string
func (*WriteConfirmed) GetMetaCapabilityProcessor ¶
func (x *WriteConfirmed) GetMetaCapabilityProcessor() string
func (*WriteConfirmed) GetNode ¶
func (x *WriteConfirmed) GetNode() string
func (*WriteConfirmed) GetReceiver ¶
func (x *WriteConfirmed) GetReceiver() string
func (*WriteConfirmed) GetReport ¶
func (x *WriteConfirmed) GetReport() []byte
func (*WriteConfirmed) GetReportContext ¶
func (x *WriteConfirmed) GetReportContext() []byte
func (*WriteConfirmed) GetReportId ¶
func (x *WriteConfirmed) GetReportId() uint32
func (*WriteConfirmed) GetSignersNum ¶
func (x *WriteConfirmed) GetSignersNum() uint32
func (*WriteConfirmed) GetSuccess ¶
func (x *WriteConfirmed) GetSuccess() bool
func (*WriteConfirmed) GetTransmitter ¶
func (x *WriteConfirmed) GetTransmitter() string
func (*WriteConfirmed) ProtoMessage ¶
func (*WriteConfirmed) ProtoMessage()
func (*WriteConfirmed) ProtoReflect ¶
func (x *WriteConfirmed) ProtoReflect() protoreflect.Message
func (*WriteConfirmed) Reset ¶
func (x *WriteConfirmed) Reset()
func (*WriteConfirmed) String ¶
func (x *WriteConfirmed) String() string
type WriteError ¶
type WriteError struct {
Code uint32 `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
Summary string `protobuf:"bytes,2,opt,name=summary,proto3" json:"summary,omitempty"`
Cause string `protobuf:"bytes,3,opt,name=cause,proto3" json:"cause,omitempty"`
Node string `protobuf:"bytes,4,opt,name=node,proto3" json:"node,omitempty"`
Forwarder string `protobuf:"bytes,5,opt,name=forwarder,proto3" json:"forwarder,omitempty"`
Receiver string `protobuf:"bytes,6,opt,name=receiver,proto3" json:"receiver,omitempty"`
// Report Info
ReportId uint32 `protobuf:"varint,7,opt,name=report_id,json=reportId,proto3" json:"report_id,omitempty"`
// [Execution Context]
ExecutionContext *common.ExecutionContext `protobuf:"bytes,20,opt,name=execution_context,json=executionContext,proto3" json:"execution_context,omitempty"`
// contains filtered or unexported fields
}
WT errored while processing write request
func (*WriteError) Attributes ¶
func (m *WriteError) Attributes() []attribute.KeyValue
Attributes returns the attributes for the WriteError message to be used in metrics
func (*WriteError) Descriptor
deprecated
func (*WriteError) Descriptor() ([]byte, []int)
Deprecated: Use WriteError.ProtoReflect.Descriptor instead.
func (*WriteError) Error ¶
func (e *WriteError) Error() string
AsError returns the WriteError message as an (Go) error
func (*WriteError) GetCause ¶
func (x *WriteError) GetCause() string
func (*WriteError) GetCode ¶
func (x *WriteError) GetCode() uint32
func (*WriteError) GetExecutionContext ¶
func (x *WriteError) GetExecutionContext() *common.ExecutionContext
func (*WriteError) GetForwarder ¶
func (x *WriteError) GetForwarder() string
func (*WriteError) GetNode ¶
func (x *WriteError) GetNode() string
func (*WriteError) GetReceiver ¶
func (x *WriteError) GetReceiver() string
func (*WriteError) GetReportId ¶
func (x *WriteError) GetReportId() uint32
func (*WriteError) GetSummary ¶
func (x *WriteError) GetSummary() string
func (*WriteError) ProtoMessage ¶
func (*WriteError) ProtoMessage()
func (*WriteError) ProtoReflect ¶
func (x *WriteError) ProtoReflect() protoreflect.Message
func (*WriteError) Reset ¶
func (x *WriteError) Reset()
func (*WriteError) String ¶
func (x *WriteError) String() string
type WriteInitiated ¶
type WriteInitiated struct {
Node string `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
Forwarder string `protobuf:"bytes,2,opt,name=forwarder,proto3" json:"forwarder,omitempty"`
Receiver string `protobuf:"bytes,3,opt,name=receiver,proto3" json:"receiver,omitempty"`
// Report Info
ReportId uint32 `protobuf:"varint,4,opt,name=report_id,json=reportId,proto3" json:"report_id,omitempty"`
// [Execution Context]
ExecutionContext *common.ExecutionContext `protobuf:"bytes,20,opt,name=execution_context,json=executionContext,proto3" json:"execution_context,omitempty"`
// contains filtered or unexported fields
}
WT initiated the processing of the write request
func (*WriteInitiated) Attributes ¶
func (m *WriteInitiated) Attributes() []attribute.KeyValue
Attributes returns the attributes for the WriteInitiated message to be used in metrics
func (*WriteInitiated) Descriptor
deprecated
func (*WriteInitiated) Descriptor() ([]byte, []int)
Deprecated: Use WriteInitiated.ProtoReflect.Descriptor instead.
func (*WriteInitiated) GetExecutionContext ¶
func (x *WriteInitiated) GetExecutionContext() *common.ExecutionContext
func (*WriteInitiated) GetForwarder ¶
func (x *WriteInitiated) GetForwarder() string
func (*WriteInitiated) GetNode ¶
func (x *WriteInitiated) GetNode() string
func (*WriteInitiated) GetReceiver ¶
func (x *WriteInitiated) GetReceiver() string
func (*WriteInitiated) GetReportId ¶
func (x *WriteInitiated) GetReportId() uint32
func (*WriteInitiated) ProtoMessage ¶
func (*WriteInitiated) ProtoMessage()
func (*WriteInitiated) ProtoReflect ¶
func (x *WriteInitiated) ProtoReflect() protoreflect.Message
func (*WriteInitiated) Reset ¶
func (x *WriteInitiated) Reset()
func (*WriteInitiated) String ¶
func (x *WriteInitiated) String() string
type WriteSent ¶
type WriteSent struct {
Node string `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
Forwarder string `protobuf:"bytes,2,opt,name=forwarder,proto3" json:"forwarder,omitempty"`
Receiver string `protobuf:"bytes,3,opt,name=receiver,proto3" json:"receiver,omitempty"`
// Report Info
ReportId uint32 `protobuf:"varint,4,opt,name=report_id,json=reportId,proto3" json:"report_id,omitempty"`
// Transaction ID - tx reference as created by the WT, to be used for tracking TXM execution
TxId string `protobuf:"bytes,5,opt,name=tx_id,json=txId,proto3" json:"tx_id,omitempty"`
// When was the transaction submitted
BlockData *common.BlockData `protobuf:"bytes,7,opt,name=block_data,json=blockData,proto3" json:"block_data,omitempty"`
// [Execution Context]
ExecutionContext *common.ExecutionContext `protobuf:"bytes,20,opt,name=execution_context,json=executionContext,proto3" json:"execution_context,omitempty"`
// contains filtered or unexported fields
}
WT sent a transaction on-chain
Notice: we publish txId (TXM ref) vs. txHash (N/A here)
func (*WriteSent) Attributes ¶
Attributes returns the attributes for the WriteSent message to be used in metrics
func (*WriteSent) Descriptor
deprecated
func (*WriteSent) GetBlockData ¶
func (*WriteSent) GetExecutionContext ¶
func (x *WriteSent) GetExecutionContext() *common.ExecutionContext
func (*WriteSent) GetForwarder ¶
func (*WriteSent) GetReceiver ¶
func (*WriteSent) GetReportId ¶
func (*WriteSent) ProtoMessage ¶
func (*WriteSent) ProtoMessage()
func (*WriteSent) ProtoReflect ¶
func (x *WriteSent) ProtoReflect() protoreflect.Message
type WriteSkipped ¶
type WriteSkipped struct {
Node string `protobuf:"bytes,1,opt,name=node,proto3" json:"node,omitempty"`
Forwarder string `protobuf:"bytes,2,opt,name=forwarder,proto3" json:"forwarder,omitempty"`
Receiver string `protobuf:"bytes,3,opt,name=receiver,proto3" json:"receiver,omitempty"`
ReportId uint32 `protobuf:"varint,4,opt,name=report_id,json=reportId,proto3" json:"report_id,omitempty"`
Reason string `protobuf:"bytes,5,opt,name=reason,proto3" json:"reason,omitempty"`
// [Execution Context]
ExecutionContext *common.ExecutionContext `protobuf:"bytes,20,opt,name=execution_context,json=executionContext,proto3" json:"execution_context,omitempty"`
// contains filtered or unexported fields
}
WT skipped the write request
func (*WriteSkipped) Descriptor
deprecated
func (*WriteSkipped) Descriptor() ([]byte, []int)
Deprecated: Use WriteSkipped.ProtoReflect.Descriptor instead.
func (*WriteSkipped) GetExecutionContext ¶
func (x *WriteSkipped) GetExecutionContext() *common.ExecutionContext
func (*WriteSkipped) GetForwarder ¶
func (x *WriteSkipped) GetForwarder() string
func (*WriteSkipped) GetNode ¶
func (x *WriteSkipped) GetNode() string
func (*WriteSkipped) GetReason ¶
func (x *WriteSkipped) GetReason() string
func (*WriteSkipped) GetReceiver ¶
func (x *WriteSkipped) GetReceiver() string
func (*WriteSkipped) GetReportId ¶
func (x *WriteSkipped) GetReportId() uint32
func (*WriteSkipped) ProtoMessage ¶
func (*WriteSkipped) ProtoMessage()
func (*WriteSkipped) ProtoReflect ¶
func (x *WriteSkipped) ProtoReflect() protoreflect.Message
func (*WriteSkipped) Reset ¶
func (x *WriteSkipped) Reset()
func (*WriteSkipped) String ¶
func (x *WriteSkipped) String() string