envelopes

package
v1.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 18, 2026 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package envelopes implements methods to create and manipulate different types of envelopes. Types implemented are ClientEnvelope, PayerEnvelope, and OriginatorEnvelope.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ClientEnvelope 

type ClientEnvelope struct {
	// contains filtered or unexported fields
}

func NewClientEnvelope 

func NewClientEnvelope(proto *envelopesProto.ClientEnvelope) (*ClientEnvelope, error)

func NewClientEnvelopeFromBytes 

func NewClientEnvelopeFromBytes(bytes []byte) (*ClientEnvelope, error)

func (*ClientEnvelope) Aad 

func (c *ClientEnvelope) Aad() *envelopesProto.AuthenticatedData

func (*ClientEnvelope) Bytes 

func (c *ClientEnvelope) Bytes() ([]byte, error)

func (*ClientEnvelope) Payload 

func (c *ClientEnvelope) Payload() any

func (*ClientEnvelope) Proto 

func (c *ClientEnvelope) Proto() *envelopesProto.ClientEnvelope

func (*ClientEnvelope) TargetTopic 

func (c *ClientEnvelope) TargetTopic() topic.Topic

func (*ClientEnvelope) TopicMatchesPayload 

func (c *ClientEnvelope) TopicMatchesPayload() bool

type OriginatorEnvelope 

type OriginatorEnvelope struct {
	UnsignedOriginatorEnvelope UnsignedOriginatorEnvelope
	// contains filtered or unexported fields
}

func NewOriginatorEnvelope 

func NewOriginatorEnvelope(proto *envelopesProto.OriginatorEnvelope) (*OriginatorEnvelope, error)

func NewOriginatorEnvelopeFromBytes added in v0.1.1 

func NewOriginatorEnvelopeFromBytes(bytes []byte) (*OriginatorEnvelope, error)

func (*OriginatorEnvelope) Bytes 

func (o *OriginatorEnvelope) Bytes() ([]byte, error)

func (*OriginatorEnvelope) OriginatorNodeID added in v0.1.1 

func (o *OriginatorEnvelope) OriginatorNodeID() uint32

func (*OriginatorEnvelope) OriginatorNs added in v0.2.0 

func (o *OriginatorEnvelope) OriginatorNs() int64

func (*OriginatorEnvelope) OriginatorSequenceID added in v0.1.1 

func (o *OriginatorEnvelope) OriginatorSequenceID() uint64

func (*OriginatorEnvelope) OriginatorTime added in v0.3.0 

func (o *OriginatorEnvelope) OriginatorTime() time.Time

func (*OriginatorEnvelope) Proto 

func (o *OriginatorEnvelope) Proto() *envelopesProto.OriginatorEnvelope

func (*OriginatorEnvelope) TargetTopic added in v0.1.1 

func (o *OriginatorEnvelope) TargetTopic() topic.Topic

type PayerEnvelope 

type PayerEnvelope struct {
	ClientEnvelope   ClientEnvelope
	TargetOriginator uint32
	// contains filtered or unexported fields
}

func NewPayerEnvelope 

func NewPayerEnvelope(proto *envelopesProto.PayerEnvelope) (*PayerEnvelope, error)

func NewPayerEnvelopeFromBytes added in v0.3.0 

func NewPayerEnvelopeFromBytes(bytes []byte) (*PayerEnvelope, error)

func (*PayerEnvelope) Bytes 

func (p *PayerEnvelope) Bytes() ([]byte, error)

func (*PayerEnvelope) Proto 

func (p *PayerEnvelope) Proto() *envelopesProto.PayerEnvelope

func (*PayerEnvelope) RecoverSigner 

func (p *PayerEnvelope) RecoverSigner() (*common.Address, error)

func (*PayerEnvelope) RetentionDays added in v0.4.0 

func (p *PayerEnvelope) RetentionDays() uint32

func (*PayerEnvelope) TargetTopic added in v0.1.1 

func (p *PayerEnvelope) TargetTopic() topic.Topic

type UnsignedOriginatorEnvelope 

type UnsignedOriginatorEnvelope struct {
	PayerEnvelope PayerEnvelope
	// contains filtered or unexported fields
}

func NewUnsignedOriginatorEnvelope 

func NewUnsignedOriginatorEnvelope(
	proto *envelopesProto.UnsignedOriginatorEnvelope,
) (*UnsignedOriginatorEnvelope, error)

NewUnsignedOriginatorEnvelope constructs an UnsignedOriginatorEnvelope and perform validations on any child fields. Does not verify signatures.

func NewUnsignedOriginatorEnvelopeFromBytes 

func NewUnsignedOriginatorEnvelopeFromBytes(bytes []byte) (*UnsignedOriginatorEnvelope, error)

func (*UnsignedOriginatorEnvelope) BaseFee added in v0.3.0 

func (u *UnsignedOriginatorEnvelope) BaseFee() currency.PicoDollar

func (*UnsignedOriginatorEnvelope) CongestionFee added in v0.3.0 

func (u *UnsignedOriginatorEnvelope) CongestionFee() currency.PicoDollar

func (*UnsignedOriginatorEnvelope) OriginatorNodeID 

func (u *UnsignedOriginatorEnvelope) OriginatorNodeID() uint32

func (*UnsignedOriginatorEnvelope) OriginatorNs 

func (u *UnsignedOriginatorEnvelope) OriginatorNs() int64

func (*UnsignedOriginatorEnvelope) OriginatorSequenceID 

func (u *UnsignedOriginatorEnvelope) OriginatorSequenceID() uint64

func (*UnsignedOriginatorEnvelope) PayerEnvelopeBytes added in v0.3.0 

func (u *UnsignedOriginatorEnvelope) PayerEnvelopeBytes() []byte

func (*UnsignedOriginatorEnvelope) Proto 

func (u *UnsignedOriginatorEnvelope) Proto() *envelopesProto.UnsignedOriginatorEnvelope

func (*UnsignedOriginatorEnvelope) TargetTopic added in v0.1.1 

func (u *UnsignedOriginatorEnvelope) TargetTopic() topic.Topic

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.