Documentation
¶
Overview ¶
nolint
nolint
nolint
nolint
Index ¶
- func ActivationTxFromWireV1(atx *ActivationTxV1, blob ...byte) *types.ActivationTx
- func NiPostFromWireV1(nipost *NIPostV1) *types.NIPost
- func PostFromWireV1(post *PostV1) *types.Post
- type ATXMetadataV1
- type ActivationTxV1
- func (t *ActivationTxV1) DecodeScale(dec *scale.Decoder) (total int, err error)
- func (t *ActivationTxV1) EncodeScale(enc *scale.Encoder) (total int, err error)
- func (atx *ActivationTxV1) HashInnerBytes() (result types.Hash32)
- func (atx *ActivationTxV1) ID() types.ATXID
- func (atx *ActivationTxV1) MarshalLogObject(encoder zapcore.ObjectEncoder) error
- func (atx *ActivationTxV1) Published() types.EpochID
- func (atx *ActivationTxV1) SetID(id types.ATXID)
- func (atx *ActivationTxV1) Sign(signer *signing.EdSigner)
- func (atx *ActivationTxV1) SignedBytes() []byte
- func (atx *ActivationTxV1) TotalNumUnits() uint32
- type ActivationTxV2
- func (t *ActivationTxV2) DecodeScale(dec *scale.Decoder) (total int, err error)
- func (t *ActivationTxV2) EncodeScale(enc *scale.Encoder) (total int, err error)
- func (atx *ActivationTxV2) ID() types.ATXID
- func (atx *ActivationTxV2) MarshalLogObject(encoder zapcore.ObjectEncoder) error
- func (atx *ActivationTxV2) Published() types.EpochID
- func (atx *ActivationTxV2) Sign(signer *signing.EdSigner)
- func (atx *ActivationTxV2) SignedBytes() []byte
- func (atx *ActivationTxV2) TotalNumUnits() uint32
- type InitialAtxPartsV2
- type InnerActivationTxV1
- type MarriageCertificate
- func (t *MarriageCertificate) DecodeScale(dec *scale.Decoder) (total int, err error)
- func (t *MarriageCertificate) EncodeScale(enc *scale.Encoder) (total int, err error)
- func (marriage *MarriageCertificate) MarshalLogObject(encoder zapcore.ObjectEncoder) error
- func (mc *MarriageCertificate) Root() []byte
- type MerkleProofV1
- type MerkleProofV2
- type NIPostChallengeV1
- type NIPostChallengeV2
- type NIPostV1
- type NiPostsV2
- type PostMetadataV1
- type PostV1
- type SubPostV2
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ActivationTxFromWireV1 ¶
func ActivationTxFromWireV1(atx *ActivationTxV1, blob ...byte) *types.ActivationTx
func NiPostFromWireV1 ¶ added in v1.6.0
func PostFromWireV1 ¶ added in v1.6.0
Types ¶
type ATXMetadataV1 ¶
func (*ATXMetadataV1) DecodeScale ¶
func (t *ATXMetadataV1) DecodeScale(dec *scale.Decoder) (total int, err error)
func (*ATXMetadataV1) EncodeScale ¶
func (t *ATXMetadataV1) EncodeScale(enc *scale.Encoder) (total int, err error)
type ActivationTxV1 ¶
type ActivationTxV1 struct { InnerActivationTxV1 SmesherID types.NodeID Signature types.EdSignature // contains filtered or unexported fields }
func (*ActivationTxV1) DecodeScale ¶
func (t *ActivationTxV1) DecodeScale(dec *scale.Decoder) (total int, err error)
func (*ActivationTxV1) EncodeScale ¶
func (t *ActivationTxV1) EncodeScale(enc *scale.Encoder) (total int, err error)
func (*ActivationTxV1) HashInnerBytes ¶
func (atx *ActivationTxV1) HashInnerBytes() (result types.Hash32)
func (*ActivationTxV1) ID ¶ added in v1.5.3
func (atx *ActivationTxV1) ID() types.ATXID
func (*ActivationTxV1) MarshalLogObject ¶ added in v1.6.0
func (atx *ActivationTxV1) MarshalLogObject(encoder zapcore.ObjectEncoder) error
func (*ActivationTxV1) Published ¶ added in v1.6.0
func (atx *ActivationTxV1) Published() types.EpochID
func (*ActivationTxV1) SetID ¶ added in v1.6.0
func (atx *ActivationTxV1) SetID(id types.ATXID)
func (*ActivationTxV1) Sign ¶ added in v1.6.0
func (atx *ActivationTxV1) Sign(signer *signing.EdSigner)
func (*ActivationTxV1) SignedBytes ¶
func (atx *ActivationTxV1) SignedBytes() []byte
func (*ActivationTxV1) TotalNumUnits ¶ added in v1.6.0
func (atx *ActivationTxV1) TotalNumUnits() uint32
type ActivationTxV2 ¶ added in v1.6.0
type ActivationTxV2 struct { PublishEpoch types.EpochID PositioningATX types.ATXID // Must be present in the initial ATX. // Nil in subsequent ATXs unless smesher wants to change it. // If Nil, the value is inferred from the previous ATX of this smesher. // It's not allowed to pass the same coinbase as already used by the previous ATX // to avoid spamming the network with redundant information. Coinbase *types.Address // only present in initial ATX Initial *InitialAtxPartsV2 PreviousATXs []types.ATXID `scale:"max=256"` NiPosts []NiPostsV2 `scale:"max=2"` // The VRF nonce must be valid for the collected space of all included IDs. // only present when: // - the nonce changed (included more/heavier IDs) // - it's an initial ATX VRFNonce *uint64 // The list of marriages with other IDs. // A marriage is permanent and cannot be revoked or repeated. // All new IDs that are married to this ID are added to the equivocation set // that this ID belongs to. Marriages []MarriageCertificate `scale:"max=256"` // The ID of the ATX containing marriage for the included IDs. // Only required when the ATX includes married IDs. MarriageATX *types.ATXID SmesherID types.NodeID Signature types.EdSignature // contains filtered or unexported fields }
func (*ActivationTxV2) DecodeScale ¶ added in v1.6.0
func (t *ActivationTxV2) DecodeScale(dec *scale.Decoder) (total int, err error)
func (*ActivationTxV2) EncodeScale ¶ added in v1.6.0
func (t *ActivationTxV2) EncodeScale(enc *scale.Encoder) (total int, err error)
func (*ActivationTxV2) ID ¶ added in v1.6.0
func (atx *ActivationTxV2) ID() types.ATXID
func (*ActivationTxV2) MarshalLogObject ¶ added in v1.6.0
func (atx *ActivationTxV2) MarshalLogObject(encoder zapcore.ObjectEncoder) error
func (*ActivationTxV2) Published ¶ added in v1.6.0
func (atx *ActivationTxV2) Published() types.EpochID
func (*ActivationTxV2) Sign ¶ added in v1.6.0
func (atx *ActivationTxV2) Sign(signer *signing.EdSigner)
func (*ActivationTxV2) SignedBytes ¶ added in v1.6.0
func (atx *ActivationTxV2) SignedBytes() []byte
func (*ActivationTxV2) TotalNumUnits ¶ added in v1.6.0
func (atx *ActivationTxV2) TotalNumUnits() uint32
type InitialAtxPartsV2 ¶ added in v1.6.0
func (*InitialAtxPartsV2) DecodeScale ¶ added in v1.6.0
func (t *InitialAtxPartsV2) DecodeScale(dec *scale.Decoder) (total int, err error)
func (*InitialAtxPartsV2) EncodeScale ¶ added in v1.6.0
func (t *InitialAtxPartsV2) EncodeScale(enc *scale.Encoder) (total int, err error)
func (*InitialAtxPartsV2) MarshalLogObject ¶ added in v1.6.0
func (parts *InitialAtxPartsV2) MarshalLogObject(encoder zapcore.ObjectEncoder) error
func (*InitialAtxPartsV2) Root ¶ added in v1.6.0
func (i *InitialAtxPartsV2) Root() []byte
type InnerActivationTxV1 ¶
type InnerActivationTxV1 struct { NIPostChallengeV1 Coinbase types.Address NumUnits uint32 NIPost *NIPostV1 NodeID *types.NodeID // only present in initial ATX to make hash of the first InnerActivationTxV2 unique VRFNonce *uint64 // only present when the nonce changed (or initial ATX) }
InnerActivationTxV1 is a set of all of an ATX's fields, except the signature. To generate the ATX signature, this structure is serialized and signed.
func (*InnerActivationTxV1) DecodeScale ¶
func (t *InnerActivationTxV1) DecodeScale(dec *scale.Decoder) (total int, err error)
func (*InnerActivationTxV1) EncodeScale ¶
func (t *InnerActivationTxV1) EncodeScale(enc *scale.Encoder) (total int, err error)
type MarriageCertificate ¶ added in v1.6.0
type MarriageCertificate struct { ID types.NodeID // Signature over the other ID that this ID marries with // If Alice marries Bob, then Alice signs Bob's ID // and Bob includes this certificate in his ATX. Signature types.EdSignature }
MarriageCertificate proves the will of ID to be married with the ID that includes this certificate. A marriage allows for publishing a merged ATX, which can contain PoST for all married IDs. Any ID from the marriage can publish a merged ATX on behalf of all married IDs.
func (*MarriageCertificate) DecodeScale ¶ added in v1.6.0
func (t *MarriageCertificate) DecodeScale(dec *scale.Decoder) (total int, err error)
func (*MarriageCertificate) EncodeScale ¶ added in v1.6.0
func (t *MarriageCertificate) EncodeScale(enc *scale.Encoder) (total int, err error)
func (*MarriageCertificate) MarshalLogObject ¶ added in v1.6.0
func (marriage *MarriageCertificate) MarshalLogObject(encoder zapcore.ObjectEncoder) error
func (*MarriageCertificate) Root ¶ added in v1.6.0
func (mc *MarriageCertificate) Root() []byte
type MerkleProofV1 ¶
type MerkleProofV1 struct { // Nodes on path from leaf to root (not including leaf) Nodes []types.Hash32 `scale:"max=32"` LeafIndex uint64 }
func (*MerkleProofV1) DecodeScale ¶
func (t *MerkleProofV1) DecodeScale(dec *scale.Decoder) (total int, err error)
func (*MerkleProofV1) EncodeScale ¶
func (t *MerkleProofV1) EncodeScale(enc *scale.Encoder) (total int, err error)
type MerkleProofV2 ¶ added in v1.6.0
type MerkleProofV2 struct { // Nodes on path from leaf to root (not including leaf) Nodes []types.Hash32 `scale:"max=32"` LeafIndices []uint64 `scale:"max=256"` // support merging up to 256 IDs }
MerkleProofV2 proves membership of multiple challenges in a PoET membership merkle tree.
func (*MerkleProofV2) DecodeScale ¶ added in v1.6.0
func (t *MerkleProofV2) DecodeScale(dec *scale.Decoder) (total int, err error)
func (*MerkleProofV2) EncodeScale ¶ added in v1.6.0
func (t *MerkleProofV2) EncodeScale(enc *scale.Encoder) (total int, err error)
type NIPostChallengeV1 ¶
type NIPostChallengeV1 struct { PublishEpoch types.EpochID // Sequence number counts the number of ancestors of the ATX. It sequentially increases for each ATX in the chain. // Two ATXs with the same sequence number from the same miner can be used as the proof of malfeasance against // that miner. Sequence uint64 // the previous ATX's ID (for all but the first in the sequence) PrevATXID types.ATXID PositioningATXID types.ATXID // CommitmentATXID is the ATX used in the commitment for initializing the PoST of the node. CommitmentATXID *types.ATXID InitialPost *PostV1 }
func NIPostChallengeToWireV1 ¶
func NIPostChallengeToWireV1(c *types.NIPostChallenge) *NIPostChallengeV1
func (*NIPostChallengeV1) DecodeScale ¶
func (t *NIPostChallengeV1) DecodeScale(dec *scale.Decoder) (total int, err error)
func (*NIPostChallengeV1) EncodeScale ¶
func (t *NIPostChallengeV1) EncodeScale(enc *scale.Encoder) (total int, err error)
func (*NIPostChallengeV1) Hash ¶
func (c *NIPostChallengeV1) Hash() types.Hash32
Hash serializes the NIPostChallenge and returns its hash. The serialized challenge is first prepended with a byte 0x00, and then hashed for second preimage resistance of poet membership merkle tree.
func (*NIPostChallengeV1) MarshalLogObject ¶ added in v1.6.0
func (c *NIPostChallengeV1) MarshalLogObject(encoder zapcore.ObjectEncoder) error
type NIPostChallengeV2 ¶ added in v1.6.0
type NIPostChallengeV2 struct { PublishEpoch types.EpochID PrevATXID types.ATXID PositioningATXID types.ATXID InitialPost *PostV1 }
NIPostChallengeV2 collects information needed to generate a PoET challenge. It's hash is the challenge registered in the PoET.
func NIPostChallengeToWireV2 ¶ added in v1.6.0
func NIPostChallengeToWireV2(c *types.NIPostChallenge) *NIPostChallengeV2
func (*NIPostChallengeV2) DecodeScale ¶ added in v1.6.0
func (t *NIPostChallengeV2) DecodeScale(dec *scale.Decoder) (total int, err error)
func (*NIPostChallengeV2) EncodeScale ¶ added in v1.6.0
func (t *NIPostChallengeV2) EncodeScale(enc *scale.Encoder) (total int, err error)
func (*NIPostChallengeV2) Hash ¶ added in v1.6.0
func (c *NIPostChallengeV2) Hash() types.Hash32
Hash serializes the NIPostChallenge and returns its hash. The serialized challenge is first prepended with a byte 0x00, and then hashed for second preimage resistance of poet membership merkle tree.
func (*NIPostChallengeV2) MarshalLogObject ¶ added in v1.6.0
func (c *NIPostChallengeV2) MarshalLogObject(encoder zapcore.ObjectEncoder) error
type NIPostV1 ¶
type NIPostV1 struct { // Membership proves that the challenge for the PoET, which is // constructed from fields in the activation transaction, // is a member of the poet's proof. // Proof.Root must match the Poet's POSW statement. Membership MerkleProofV1 // Post is the proof that the prover data is still stored (or was recomputed) at // the time he learned the challenge constructed from the PoET. Post *PostV1 // PostMetadata is the Post metadata, associated with the proof. // The proof should be verified upon the metadata during the syntactic validation, // while the metadata should be verified during the contextual validation. PostMetadata *PostMetadataV1 }
func NiPostToWireV1 ¶ added in v1.6.0
func (*NIPostV1) DecodeScale ¶
func (*NIPostV1) EncodeScale ¶
func (*NIPostV1) MarshalLogObject ¶ added in v1.6.0
func (nipost *NIPostV1) MarshalLogObject(encoder zapcore.ObjectEncoder) error
type NiPostsV2 ¶ added in v1.6.0
type NiPostsV2 struct { // Single membership proof for all IDs in `Posts`. // The index of ID in `Posts` is the index of the challenge in the proof (`LeafIndices`). Membership MerkleProofV2 // The root of the PoET proof, that serves as the challenge for PoSTs. Challenge types.Hash32 Posts []SubPostV2 `scale:"max=256"` // support merging up to 256 IDs }
func (*NiPostsV2) DecodeScale ¶ added in v1.6.0
func (*NiPostsV2) EncodeScale ¶ added in v1.6.0
func (*NiPostsV2) MarshalLogObject ¶ added in v1.6.0
func (posts *NiPostsV2) MarshalLogObject(encoder zapcore.ObjectEncoder) error
type PostMetadataV1 ¶
func (*PostMetadataV1) DecodeScale ¶
func (t *PostMetadataV1) DecodeScale(dec *scale.Decoder) (total int, err error)
func (*PostMetadataV1) EncodeScale ¶
func (t *PostMetadataV1) EncodeScale(enc *scale.Encoder) (total int, err error)
type PostV1 ¶
func PostToWireV1 ¶ added in v1.6.0
func (*PostV1) DecodeScale ¶
func (*PostV1) EncodeScale ¶
func (*PostV1) MarshalLogObject ¶ added in v1.6.0
func (p *PostV1) MarshalLogObject(encoder zapcore.ObjectEncoder) error
type SubPostV2 ¶ added in v1.6.0
type SubPostV2 struct { // Index of marriage certificate for this ID in the 'Marriages' slice. Only valid for merged ATXs. // Can be used to extract the nodeID and verify if it is married with the smesher of the ATX. // Must be 0 for non-merged ATXs. MarriageIndex uint32 PrevATXIndex uint32 // Index of the previous ATX in the `InnerActivationTxV2.PreviousATXs` slice Post PostV1 NumUnits uint32 }
func (*SubPostV2) DecodeScale ¶ added in v1.6.0
func (*SubPostV2) EncodeScale ¶ added in v1.6.0
func (*SubPostV2) MarshalLogObject ¶ added in v1.6.0
func (post *SubPostV2) MarshalLogObject(encoder zapcore.ObjectEncoder) error