protocol

package
v0.0.0-...-5bffa0e Latest Latest
Warning

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

 Go to latest Published: Feb 5, 2025 License: AGPL-3.0 Imports: 17 Imported by: 12

Documentation

Index

Constants

View Source 
const (
	// StateProofBasic is our initial state proof setup. using falcon keys and subset-sum hash
	StateProofBasic StateProofType = 0

	// NumStateProofTypes is the max number of types of state proofs
	// that we support.  This is used as an allocation bound for a map
	// containing different stateproof types in msgpack encoding.
	NumStateProofTypes int = 1
)
View Source 
const AgreementVoteTagMaxSize = 1228

AgreementVoteTagMaxSize is the maximum size of an AgreementVoteTag message

View Source 
const ConsensusCurrentVersion = ConsensusV40

ConsensusCurrentVersion is the latest version and should be used when a specific version is not provided.

View Source 
const ConsensusFuture = ConsensusVersion(
	"future",
)

ConsensusFuture is a protocol that should not appear in any production network, but is used to test features before they are released.

View Source 
const ConsensusV10 = ConsensusVersion("v10")

ConsensusV10 introduces fast partition recovery.

View Source 
const ConsensusV11 = ConsensusVersion("v11")

ConsensusV11 introduces efficient encoding of SignedTxn using SignedTxnInBlock.

View Source 
const ConsensusV12 = ConsensusVersion("v12")

ConsensusV12 increases the maximum length of a version string.

View Source 
const ConsensusV13 = ConsensusVersion(

	"https://github.com/algorand/spec/tree/0c8a9dc44d7368cc266d5407b79fb3311f4fc795",
)

ConsensusV13 makes the consensus version a meaningful string.

View Source 
const ConsensusV14 = ConsensusVersion(
	"https://github.com/algorand/spec/tree/2526b6ae062b4fe5e163e06e41e1d9b9219135a9",
)

ConsensusV14 adds tracking of closing amounts in ApplyData, and enables genesis hash in transactions.

View Source 
const ConsensusV15 = ConsensusVersion(
	"https://github.com/algorand/spec/tree/a26ed78ed8f834e2b9ccb6eb7d3ee9f629a6e622",
)

ConsensusV15 adds tracking of reward distributions in ApplyData.

View Source 
const ConsensusV16 = ConsensusVersion(
	"https://github.com/algorand/spec/tree/22726c9dcd12d9cddce4a8bd7e8ccaa707f74101",
)

ConsensusV16 fixes domain separation in Credentials and requires GenesisHash.

View Source 
const ConsensusV17 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/5615adc36bad610c7f165fa2967f4ecfa75125f0",
)

ConsensusV17 points to 'final' spec commit for 2019 june release

View Source 
const ConsensusV18 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/6c6bd668be0ab14098e51b37e806c509f7b7e31f",
)

ConsensusV18 points to reward calculation spec commit

View Source 
const ConsensusV19 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/0e196e82bfd6e327994bec373c4cc81bc878ef5c",
)

ConsensusV19 points to 'final' spec commit for 2019 nov release

View Source 
const ConsensusV20 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/4a9db6a25595c6fd097cf9cc137cc83027787eaa",
)

ConsensusV20 points to adding the decimals field to assets

View Source 
const ConsensusV21 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/8096e2df2da75c3339986317f9abe69d4fa86b4b",
)

ConsensusV21 fixes a bug in credential.lowestOutput

View Source 
const ConsensusV22 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/57016b942f6d97e6d4c0688b373bb0a2fc85a1a2",
)

ConsensusV22 allows tuning the upgrade delay.

View Source 
const ConsensusV23 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/e5f565421d720c6f75cdd186f7098495caf9101f",
)

ConsensusV23 fixes lease behavior.

View Source 
const ConsensusV24 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/3a83c4c743f8b17adfd73944b4319c25722a6782",
)

ConsensusV24 include the applications, rekeying and AVM v2

View Source 
const ConsensusV25 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/bea19289bf41217d2c0af30522fa222ef1366466",
)

ConsensusV25 adds support for AssetCloseAmount in the ApplyData

View Source 
const ConsensusV26 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/ac2255d586c4474d4ebcf3809acccb59b7ef34ff",
)

ConsensusV26 adds support for TEAL 3, initial rewards calculation and merkle tree hash commitments

View Source 
const ConsensusV27 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/d050b3cade6d5c664df8bd729bf219f179812595",
)

ConsensusV27 updates ApplyDelta.EvalDelta.LocalDeltas format

View Source 
const ConsensusV28 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/65b4ab3266c52c56a0fa7d591754887d68faad0a",
)

ConsensusV28 introduces new TEAL features, larger program size, fee pooling and longer asset max URL

View Source 
const ConsensusV29 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/abc54f79f9ad679d2d22f0fb9909fb005c16f8a1",
)

ConsensusV29 fixes application update by using ExtraProgramPages in size calculations

View Source 
const ConsensusV30 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/bc36005dbd776e6d1eaf0c560619bb183215645c",
)

ConsensusV30 introduces AVM 1.0 and TEAL 5, increases the app opt in limit to 50, and allows costs to be pooled in grouped stateful transactions.

View Source 
const ConsensusV31 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/85e6db1fdbdef00aa232c75199e10dc5fe9498f6",
)

ConsensusV31 enables the batch verification for ed25519 signatures, Fix reward calculation issue, introduces the ability to force an expired participation offline, enables TEAL 6 ( AVM 1.1 ) and add support for creating state proof keys.

View Source 
const ConsensusV32 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/d5ac876d7ede07367dbaa26e149aa42589aac1f7",
)

ConsensusV32 enables the unlimited assets.

View Source 
const ConsensusV33 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/830a4e673148498cc7230a0d1ba1ed0a5471acc6",
)

ConsensusV33 enables large blocks, the deeper block history for TEAL and catchpoint generation round after lowering in-memory deltas size (320 -> 4).

View Source 
const ConsensusV34 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/2dd5435993f6f6d65691140f592ebca5ef19ffbd",
)

ConsensusV34 enables the TEAL v7 opcodes, stateproofs, shorter lambda to 1.7s.

View Source 
const ConsensusV35 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/433d8e9a7274b6fca703d91213e05c7e6a589e69",
)

ConsensusV35 updates the calculation of total stake in state proofs.

View Source 
const ConsensusV36 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/44fa607d6051730f5264526bf3c108d51f0eadb6",
)

ConsensusV36 adds box storage in TEAL v8

View Source 
const ConsensusV37 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/1ac4dd1f85470e1fb36c8a65520e1313d7dfed5e",
)

ConsensusV37 is a technical upgrade and released in the same time as ConsensusV38. It is needed to allow nodes to build up a necessary state to support state proofs related options in ConsensusV38

View Source 
const ConsensusV38 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/abd3d4823c6f77349fc04c3af7b1e99fe4df699f",
)

ConsensusV38 enables state proof verification using a special tracker, TEAL v9 resources sharing, pre-check ECDSA curve and extra features, and shortens the lambda to 1.5s.

View Source 
const ConsensusV39 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/925a46433742afb0b51bb939354bd907fa88bf95",
)

ConsensusV39 enables dynamic filter timeouts, a deadline timeout of 4 seconds, TEAL v10 logicSig opcode budget pooling along with elliptic curve ops on some pairing friendly curves.

View Source 
const ConsensusV40 = ConsensusVersion(
	"https://github.com/algorandfoundation/specs/tree/236dcc18c9c507d794813ab768e467ea42d1b4d9",
)

ConsensusV40 enables consensus incentives and TEAL v11 featuring the mimc opcode

View Source 
const ConsensusV7 = ConsensusVersion("v7")

ConsensusV7 increases MaxBalLookback to 320 in preparation for the twin seeds change.

View Source 
const ConsensusV8 = ConsensusVersion("v8")

ConsensusV8 uses the new parameters and seed derivation policy from the agreement protocol's security analysis.

View Source 
const ConsensusV9 = ConsensusVersion("v9")

ConsensusV9 increases min balance to 100,000 microAlgos.

View Source 
const ConsensusVAlpha1 = ConsensusVersion("alpha1")

ConsensusVAlpha1 is the first consensus protocol for AlphaNet, which is the same as v32, but with a 2-second filter timeout and 5M block size.

View Source 
const ConsensusVAlpha2 = ConsensusVersion("alpha2")

ConsensusVAlpha2 is the second consensus protocol for AlphaNet, which increases the filter timeout to 3.5 seconds and uses 5MiB blocks.

View Source 
const ConsensusVAlpha3 = ConsensusVersion("alpha3")

ConsensusVAlpha3 uses the same parameters as ConsensusV33.

View Source 
const ConsensusVAlpha4 = ConsensusVersion("alpha4")

ConsensusVAlpha4 uses the same parameters as ConsensusV34.

View Source 
const ConsensusVAlpha5 = ConsensusVersion("alpha5")

ConsensusVAlpha5 uses the same parameters as ConsensusV36.

View Source 
const DEPRECATEDConsensusV0 = ConsensusVersion("v0")

DEPRECATEDConsensusV0 is a baseline version of the Algorand consensus protocol. at the time versioning was introduced. It is now deprecated.

View Source 
const DEPRECATEDConsensusV1 = ConsensusVersion("v1")

DEPRECATEDConsensusV1 adds support for Genesis ID in transactions, but does not require it (transactions missing a GenesisID value are still allowed). It is now deprecated.

View Source 
const DEPRECATEDConsensusV2 = ConsensusVersion("v2")

DEPRECATEDConsensusV2 fixes a bug in the agreement protocol where proposalValues fail to commit to the original period and sender of a block.

View Source 
const DEPRECATEDConsensusV3 = ConsensusVersion("v3")

DEPRECATEDConsensusV3 adds support for fine-grained ephemeral keys.

View Source 
const DEPRECATEDConsensusV4 = ConsensusVersion("v4")

DEPRECATEDConsensusV4 adds support for a min balance and a transaction that closes out an account.

View Source 
const DEPRECATEDConsensusV5 = ConsensusVersion("v5")

DEPRECATEDConsensusV5 sets MinTxnFee to 1000 and fixes a blance lookback bug

View Source 
const DEPRECATEDConsensusV6 = ConsensusVersion("v6")

DEPRECATEDConsensusV6 adds support for explicit ephemeral-key parameters

View Source 
const MsgDigestSkipTagMaxSize = 69

MsgDigestSkipTagMaxSize is the maximum size of a MsgDigestSkipTag message

View Source 
const MsgOfInterestTagMaxSize = 45

MsgOfInterestTagMaxSize is the maximum size of a MsgOfInterestTag message

View Source 
const NetIDVerificationTagMaxSize = 215

NetIDVerificationTagMaxSize is the maximum size of a NetIDVerificationTag message

View Source 
const NetPrioResponseTagMaxSize = 850

NetPrioResponseTagMaxSize is the maximum size of a NetPrioResponseTag message

View Source 
const ProposalPayloadTagMaxSize = 5250313

ProposalPayloadTagMaxSize is the maximum size of a ProposalPayloadTag message This value is dominated by the MaxTxnBytesPerBlock

View Source 
const StateProofSigTagMaxSize = 6378

StateProofSigTagMaxSize is the maximum size of a StateProofSigTag message

View Source 
const TagLength = 2

TagLength specifies the length of protocol tags.

View Source 
const TopicMsgRespTagMaxSize = 6 * 1024 * 1024

TopicMsgRespTagMaxSize is the maximum size of a TopicMsgRespTag message This is a response to a topic message request (either UE or MI) and the largest possible response is the largest possible block. Matches current network.MaxMessageLength

View Source 
const TxnTagMaxSize = 5_000_000

TxnTagMaxSize is the maximum size of a TxnTag message. The TxnTag is used to send entire transaction groups. So, naively, we might set it to the maximum group size times the maximum transaction size (plus a little bit for msgpack encoding). But there are several reasons not to do that. First, the function we have for estimating max transaction size (transactions.SignedTxnMaxSize())) wildly overestimates the maximum transaction size because it is generated code that assumes _every_ transaction field can be set, but each transaction type has mutually exclusive fields. Second, the stateproof transaction is the biggest transaction by far, but it can only appear as a singleton, so it would not make sense to multiply it by 16. Finally, we're going to pool logicsig code size, so while it's true that one transaction in a group could have a 16k logicsig, that would only be true if the other transactions had 0 bytes of logicsig. So we will use a bound that is a bit bigger that a txn group can be, but avoid trying to be precise. See TestMaxSizesCorrect for the detailed reasoning.

View Source 
const UniEnsBlockReqTagMaxSize = 67

UniEnsBlockReqTagMaxSize is the maximum size of a UniEnsBlockReqTag message

View Source 
const VoteBundleTagMaxSize = 6 * 1024 * 1024

VoteBundleTagMaxSize is the maximum size of a VoteBundleTag message Matches current network.MaxMessageLength

Variables

View Source 
var CodecHandle *codec.MsgpackHandle

CodecHandle is used to instantiate msgpack encoders and decoders with our settings (canonical, paranoid about decoding errors)

View Source 
var DeprecatedTagList = []Tag{
	PingTag,
	PingReplyTag,
}

DeprecatedTagList contains tags that are no longer used, but may still show up in MsgOfInterest messages.

View Source 
var DeprecatedTagMap map[Tag]struct{}

DeprecatedTagMap is a map of all deprecated protocol tags.

View Source 
var ErrInvalidObject = errors.New("unmarshalled object is invalid")

ErrInvalidObject is used to state that an object decoding has failed because it's invalid.

View Source 
var JSONHandle *codec.JsonHandle

JSONHandle is used to instantiate JSON encoders and decoders with our settings (canonical, paranoid about decoding errors)

View Source 
var JSONStrictHandle *codec.JsonHandle

JSONStrictHandle is the same as JSONHandle but with MapKeyAsString=true for correct maps[int]interface{} encoding

View Source 
var TagList = []Tag{
	AgreementVoteTag,
	MsgOfInterestTag,
	MsgDigestSkipTag,
	NetIDVerificationTag,
	NetPrioResponseTag,
	ProposalPayloadTag,
	StateProofSigTag,
	TopicMsgRespTag,
	TxnTag,
	UniEnsBlockReqTag,
	VoteBundleTag,
}

TagList is a list of all currently used protocol tags.

View Source 
var TagMap map[Tag]struct{}

TagMap is a map of all currently used protocol tags.

Functions

func ConsensusVersionMaxSize 

func ConsensusVersionMaxSize() (s int)

MaxSize returns a maximum valid message size for this message type

func Decode 

func Decode(b []byte, objptr msgp.Unmarshaler) error

Decode attempts to decode a msgpack-encoded byte buffer into an object instance pointed to by objptr.

func DecodeJSON 

func DecodeJSON(b []byte, objptr interface{}) error

DecodeJSON attempts to decode a JSON-encoded byte buffer into an object instance pointed to by objptr

func DecodeMsgp 

func DecodeMsgp(b []byte, objptr msgp.Unmarshaler) (err error)

DecodeMsgp attempts to decode a msgpack-encoded byte buffer into an object instance pointed to by objptr, requiring that we pre- generated the code for doing so using msgp.

func DecodeReflect 

func DecodeReflect(b []byte, objptr interface{}) error

DecodeReflect attempts to decode a msgpack-encoded byte buffer into an object instance pointed to by objptr, using reflection.

func DecodeStream 

func DecodeStream(r io.Reader, objptr interface{}) error

DecodeStream is like Decode but reads from an io.Reader instead.

func Encode 

func Encode(obj msgp.Marshaler) []byte

Encode returns a msgpack-encoded byte buffer for a given object.

func EncodeJSON 

func EncodeJSON(obj interface{}) []byte

EncodeJSON returns a JSON-encoded byte buffer for a given object

func EncodeJSONStrict 

func EncodeJSONStrict(obj interface{}) []byte

EncodeJSONStrict returns a JSON-encoded byte buffer for a given object It is the same EncodeJSON but encodes map's int keys as strings

func EncodeMsgp 

func EncodeMsgp(obj msgp.Marshaler) []byte

EncodeMsgp returns a msgpack-encoded byte buffer, requiring that we pre-generated the code for doing so using msgp.

func EncodeReflect 

func EncodeReflect(obj interface{}) []byte

EncodeReflect returns a msgpack-encoded byte buffer for a given object, using reflection.

func EncodeStream 

func EncodeStream(w io.Writer, obj interface{})

EncodeStream is like Encode but writes to an io.Writer instead.

func EncodingTest 

func EncodingTest(template msgpMarshalUnmarshal) error

EncodingTest tests that our two msgpack codecs (msgp and go-codec) agree on encodings and decodings of random values of the type of template, returning an error if there is a mismatch.

func ErrorMaxSize 

func ErrorMaxSize() (s int)

MaxSize returns a maximum valid message size for this message type

func HashIDMaxSize 

func HashIDMaxSize() (s int)

MaxSize returns a maximum valid message size for this message type

func NetworkIDMaxSize 

func NetworkIDMaxSize() (s int)

MaxSize returns a maximum valid message size for this message type

func NewEncoder 

func NewEncoder(w io.Writer) *codec.Encoder

NewEncoder returns an encoder object writing bytes into [w].

func NewJSONEncoder 

func NewJSONEncoder(w io.Writer) *codec.Encoder

NewJSONEncoder returns an encoder object writing bytes into [w].

func PutEncodingBuf 

func PutEncodingBuf(buf *EncodingBuf)

PutEncodingBuf places a byte slice into the pool of temporary buffers for encoding. The caller gives up ownership of the byte slice when passing it to PutEncodingBuf().

func RandomizeObject 

func RandomizeObject(template interface{}) (interface{}, error)

RandomizeObject returns a random object of the same type as template

func RandomizeObjectField 

func RandomizeObjectField(template interface{}) (interface{}, error)

RandomizeObjectField returns a random object of the same type as template where a single field was modified.

func RunEncodingTest 

func RunEncodingTest(t *testing.T, template msgpMarshalUnmarshal)

RunEncodingTest runs several iterations of encoding/decoding consistency testing of object type specified by template.

func StateProofTypeMaxSize 

func StateProofTypeMaxSize() (s int)

MaxSize returns a maximum valid message size for this message type

func TagMaxSize 

func TagMaxSize() (s int)

MaxSize returns a maximum valid message size for this message type

func TxTypeMaxSize 

func TxTypeMaxSize() (s int)

MaxSize returns a maximum valid message size for this message type

Types

type ConsensusVersion 

type ConsensusVersion string

ConsensusVersion is a string that identifies a version of the consensus protocol.

func (ConsensusVersion) CanMarshalMsg 

func (_ ConsensusVersion) CanMarshalMsg(z interface{}) bool

func (*ConsensusVersion) CanUnmarshalMsg 

func (_ *ConsensusVersion) CanUnmarshalMsg(z interface{}) bool

func (ConsensusVersion) MarshalMsg 

func (z ConsensusVersion) MarshalMsg(b []byte) (o []byte)

MarshalMsg implements msgp.Marshaler

func (ConsensusVersion) MsgIsZero 

func (z ConsensusVersion) MsgIsZero() bool

MsgIsZero returns whether this is a zero value

func (ConsensusVersion) Msgsize 

func (z ConsensusVersion) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ConsensusVersion) UnmarshalMsg 

func (z *ConsensusVersion) UnmarshalMsg(bts []byte) (o []byte, err error)

func (*ConsensusVersion) UnmarshalMsgWithState 

func (z *ConsensusVersion) UnmarshalMsgWithState(bts []byte, st msgp.UnmarshalState) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type Decoder 

type Decoder interface {
	Decode(objptr interface{}) error
}

Decoder is our interface for a thing that can decode objects.

func NewDecoder 

func NewDecoder(r io.Reader) Decoder

NewDecoder returns a decoder object reading bytes from [r].

func NewDecoderBytes 

func NewDecoderBytes(b []byte) Decoder

NewDecoderBytes returns a decoder object reading bytes from [b].

func NewJSONDecoder 

func NewJSONDecoder(r io.Reader) Decoder

NewJSONDecoder returns a json decoder object reading bytes from [r].

type EncodingBuf 

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

EncodingBuf is a wrapper for a byte slice that can be used for encoding

func GetEncodingBuf 

func GetEncodingBuf() *EncodingBuf

GetEncodingBuf returns a byte slice that can be used for encoding a temporary message. The byte slice has zero length but potentially non-zero capacity. The caller gets full ownership of the byte slice, but is encouraged to return it using PutEncodingBuf().

func (*EncodingBuf) Bytes 

func (eb *EncodingBuf) Bytes() []byte

Bytes returns the underlying byte slice

func (*EncodingBuf) Update 

func (eb *EncodingBuf) Update(v []byte) *EncodingBuf

Update updates the underlying byte slice to the given one if its capacity exceeds the current one.

type Error 

type Error ConsensusVersion

Error is used to indicate that an unsupported protocol has been detected.

func (Error) CanMarshalMsg 

func (_ Error) CanMarshalMsg(z interface{}) bool

func (*Error) CanUnmarshalMsg 

func (_ *Error) CanUnmarshalMsg(z interface{}) bool

func (Error) Error 

func (err Error) Error() string

Error satisfies builtin interface `error`

func (Error) MarshalMsg 

func (z Error) MarshalMsg(b []byte) (o []byte)

MarshalMsg implements msgp.Marshaler

func (Error) MsgIsZero 

func (z Error) MsgIsZero() bool

MsgIsZero returns whether this is a zero value

func (Error) Msgsize 

func (z Error) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*Error) UnmarshalMsg 

func (z *Error) UnmarshalMsg(bts []byte) (o []byte, err error)

func (*Error) UnmarshalMsgWithState 

func (z *Error) UnmarshalMsgWithState(bts []byte, st msgp.UnmarshalState) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type HashID 

type HashID string

HashID is a domain separation prefix for an object type that might be hashed This ensures, for example, the hash of a transaction will never collide with the hash of a vote 

const (
	AppIndex HashID = "appID"

	// ARCReserved is used to reserve prefixes starting with `arc` to
	// ARCs-related hashes https://github.com/algorandfoundation/ARCs
	// The prefix for ARC-XXXX should start with:
	// "arcXXXX" (where "XXXX" is the 0-padded number of the ARC)
	// For example ARC-0003 can use any prefix starting with "arc0003"
	ARCReserved HashID = "arc"

	AuctionBid        HashID = "aB"
	AuctionDeposit    HashID = "aD"
	AuctionOutcomes   HashID = "aO"
	AuctionParams     HashID = "aP"
	AuctionSettlement HashID = "aS"

	AgreementSelector                HashID = "AS"
	BlockHeader256                   HashID = "B256"
	BlockHeader                      HashID = "BH"
	BalanceRecord                    HashID = "BR"
	Credential                       HashID = "CR"
	Genesis                          HashID = "GE"
	KeysInMSS                        HashID = "KP"
	MerkleArrayNode                  HashID = "MA"
	MerkleVectorCommitmentBottomLeaf HashID = "MB"
	Message                          HashID = "MX"
	NetIdentityChallenge             HashID = "NIC"
	NetIdentityChallengeResponse     HashID = "NIR"
	NetIdentityVerificationMessage   HashID = "NIV"
	NetPrioResponse                  HashID = "NPR"
	OnlineAccount                    HashID = "OA"
	OnlineRoundParams                HashID = "ORP"
	OneTimeSigKey1                   HashID = "OT1"
	OneTimeSigKey2                   HashID = "OT2"
	PaysetFlat                       HashID = "PF"
	Payload                          HashID = "PL"
	Program                          HashID = "Program"
	ProgramData                      HashID = "ProgData"
	ProposerSeed                     HashID = "PS"
	ParticipationKeys                HashID = "PK"
	Seed                             HashID = "SD"
	SpecialAddr                      HashID = "SpecialAddr"
	SignedTxnInBlock                 HashID = "STIB"

	StateProofCoin    HashID = "spc"
	StateProofMessage HashID = "spm"
	StateProofPart    HashID = "spp"
	StateProofSig     HashID = "sps"
	StateProofVerCtx  HashID = "spv"

	TestHashable  HashID = "TE"
	TxGroup       HashID = "TG"
	TxnMerkleLeaf HashID = "TL"
	Transaction   HashID = "TX"
	Vote          HashID = "VO"
)

Hash IDs for specific object types, in lexicographic order. Hash IDs must be PREFIX-FREE (no hash ID is a prefix of another).

func (HashID) CanMarshalMsg 

func (_ HashID) CanMarshalMsg(z interface{}) bool

func (*HashID) CanUnmarshalMsg 

func (_ *HashID) CanUnmarshalMsg(z interface{}) bool

func (HashID) MarshalMsg 

func (z HashID) MarshalMsg(b []byte) (o []byte)

MarshalMsg implements msgp.Marshaler

func (HashID) MsgIsZero 

func (z HashID) MsgIsZero() bool

MsgIsZero returns whether this is a zero value

func (HashID) Msgsize 

func (z HashID) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*HashID) UnmarshalMsg 

func (z *HashID) UnmarshalMsg(bts []byte) (o []byte, err error)

func (*HashID) UnmarshalMsgWithState 

func (z *HashID) UnmarshalMsgWithState(bts []byte, st msgp.UnmarshalState) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type MsgpDecoderBytes 

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

MsgpDecoderBytes is a []byte decoder into msgp-encoded objects

func NewMsgpDecoderBytes 

func NewMsgpDecoderBytes(b []byte) *MsgpDecoderBytes

NewMsgpDecoderBytes returns a decoder object reading bytes from [b]. that works with msgp-serialized objects

func (*MsgpDecoderBytes) Consumed 

func (d *MsgpDecoderBytes) Consumed() int

Consumed returns number of bytes consumed so far.

func (*MsgpDecoderBytes) Decode 

func (d *MsgpDecoderBytes) Decode(objptr msgp.Unmarshaler) error

Decode an objptr from from a byte stream

func (*MsgpDecoderBytes) Remaining 

func (d *MsgpDecoderBytes) Remaining() int

Remaining returns number of bytes remained in the input buffer.

type NetworkID 

type NetworkID string

The NetworkID type is used for strings that identify distinct named networks

func (NetworkID) CanMarshalMsg 

func (_ NetworkID) CanMarshalMsg(z interface{}) bool

func (*NetworkID) CanUnmarshalMsg 

func (_ *NetworkID) CanUnmarshalMsg(z interface{}) bool

func (NetworkID) MarshalMsg 

func (z NetworkID) MarshalMsg(b []byte) (o []byte)

MarshalMsg implements msgp.Marshaler

func (NetworkID) MsgIsZero 

func (z NetworkID) MsgIsZero() bool

MsgIsZero returns whether this is a zero value

func (NetworkID) Msgsize 

func (z NetworkID) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*NetworkID) UnmarshalMsg 

func (z *NetworkID) UnmarshalMsg(bts []byte) (o []byte, err error)

func (*NetworkID) UnmarshalMsgWithState 

func (z *NetworkID) UnmarshalMsgWithState(bts []byte, st msgp.UnmarshalState) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type SortStateProofType 

type SortStateProofType []StateProofType

SortStateProofType implements sorting by StateProofType keys for canonical encoding of maps in msgpack format.

func (SortStateProofType) Len 

func (a SortStateProofType) Len() int

func (SortStateProofType) Less 

func (a SortStateProofType) Less(i, j int) bool

func (SortStateProofType) Swap 

func (a SortStateProofType) Swap(i, j int)

type StateProofType 

type StateProofType uint64

StateProofType identifies a particular configuration of state proofs.

func (StateProofType) CanMarshalMsg 

func (_ StateProofType) CanMarshalMsg(z interface{}) bool

func (*StateProofType) CanUnmarshalMsg 

func (_ *StateProofType) CanUnmarshalMsg(z interface{}) bool

func (StateProofType) MarshalMsg 

func (z StateProofType) MarshalMsg(b []byte) (o []byte)

MarshalMsg implements msgp.Marshaler

func (StateProofType) MsgIsZero 

func (z StateProofType) MsgIsZero() bool

MsgIsZero returns whether this is a zero value

func (StateProofType) Msgsize 

func (z StateProofType) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*StateProofType) UnmarshalMsg 

func (z *StateProofType) UnmarshalMsg(bts []byte) (o []byte, err error)

func (*StateProofType) UnmarshalMsgWithState 

func (z *StateProofType) UnmarshalMsgWithState(bts []byte, st msgp.UnmarshalState) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type Tag 

type Tag string

Tag represents a message type identifier. Messages have a Tag field. Handlers can register to a given Tag. e.g., the agreement service can register to handle agreements with the Agreement tag. 

const (
	AgreementVoteTag     Tag = "AV"
	MsgOfInterestTag     Tag = "MI"
	MsgDigestSkipTag     Tag = "MS"
	NetPrioResponseTag   Tag = "NP"
	NetIDVerificationTag Tag = "NI"
	PingTag              Tag = "pi" // was removed in 3.2.1
	PingReplyTag         Tag = "pj" // was removed in 3.2.1
	ProposalPayloadTag   Tag = "PP"
	StateProofSigTag     Tag = "SP"
	TopicMsgRespTag      Tag = "TS"
	TxnTag               Tag = "TX"
	//UniCatchupReqTag   Tag = "UC" was replaced by UniEnsBlockReqTag
	UniEnsBlockReqTag Tag = "UE"
	//UniEnsBlockResTag  Tag = "US" was used for wsfetcherservice
	//UniCatchupResTag   Tag = "UT" was used for wsfetcherservice
	VoteBundleTag Tag = "VB"
)

Tags, in lexicographic sort order of tag values to avoid duplicates. These tags must not contain a comma character because lists of tags are encoded using a comma separator (see network/msgOfInterest.go). The tags must be 2 bytes long.

func (Tag) CanMarshalMsg 

func (_ Tag) CanMarshalMsg(z interface{}) bool

func (*Tag) CanUnmarshalMsg 

func (_ *Tag) CanUnmarshalMsg(z interface{}) bool

func (Tag) MarshalMsg 

func (z Tag) MarshalMsg(b []byte) (o []byte)

MarshalMsg implements msgp.Marshaler

func (Tag) MaxMessageSize 

func (tag Tag) MaxMessageSize() uint64

MaxMessageSize returns the maximum size of a message for a given tag

func (Tag) MsgIsZero 

func (z Tag) MsgIsZero() bool

MsgIsZero returns whether this is a zero value

func (Tag) Msgsize 

func (z Tag) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*Tag) UnmarshalMsg 

func (z *Tag) UnmarshalMsg(bts []byte) (o []byte, err error)

func (*Tag) UnmarshalMsgWithState 

func (z *Tag) UnmarshalMsgWithState(bts []byte, st msgp.UnmarshalState) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type TxType 

type TxType string

TxType is the type of the transaction written to the ledger 

const (
	// PaymentTx indicates a payment transaction
	PaymentTx TxType = "pay"

	// KeyRegistrationTx indicates a transaction that registers participation keys
	KeyRegistrationTx TxType = "keyreg"

	// AssetConfigTx creates, re-configures, or destroys an asset
	AssetConfigTx TxType = "acfg"

	// AssetTransferTx transfers assets between accounts (optionally closing)
	AssetTransferTx TxType = "axfer"

	// AssetFreezeTx changes the freeze status of an asset
	AssetFreezeTx TxType = "afrz"

	// ApplicationCallTx allows creating, deleting, and interacting with an application
	ApplicationCallTx TxType = "appl"

	// StateProofTx records a state proof
	StateProofTx TxType = "stpf"

	// HeartbeatTx demonstrates the account is alive
	HeartbeatTx TxType = "hb"

	// UnknownTx signals an error
	UnknownTx TxType = "unknown"
)

func (TxType) CanMarshalMsg 

func (_ TxType) CanMarshalMsg(z interface{}) bool

func (*TxType) CanUnmarshalMsg 

func (_ *TxType) CanUnmarshalMsg(z interface{}) bool

func (TxType) MarshalMsg 

func (z TxType) MarshalMsg(b []byte) (o []byte)

MarshalMsg implements msgp.Marshaler

func (TxType) MsgIsZero 

func (z TxType) MsgIsZero() bool

MsgIsZero returns whether this is a zero value

func (TxType) Msgsize 

func (z TxType) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*TxType) UnmarshalMsg 

func (z *TxType) UnmarshalMsg(bts []byte) (o []byte, err error)

func (*TxType) UnmarshalMsgWithState 

func (z *TxType) UnmarshalMsgWithState(bts []byte, st msgp.UnmarshalState) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

Source Files

View all Source files

Directories

Path Synopsis

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.