sidechain

package

Go to main page

Versions in this module

v3

v3.11.3

Jun 7, 2024

v3.11.2

Jun 7, 2024

v3.11.1

Jun 7, 2024

v3.11.0

Jun 3, 2024

Changes in this version

+ const MaxUncleCount

+ const PoolBlockMaxSideChainHeight

+ var PoolBlockMaxCumulativeDifficulty = types.NewDifficulty(13019633956666736640, 1710)

v3.8.0

Apr 23, 2024

v3.7.0

Apr 14, 2024

v3.6.4

Apr 13, 2024

v3.6.3

Apr 13, 2024

v3.6.2

Apr 13, 2024

Changes in this version

type PoolBlockReceptionMetadata

+ func (m *PoolBlockReceptionMetadata) MarshalBinary() ([]byte, error)

+ func (m *PoolBlockReceptionMetadata) UnmarshalBinary(buf []byte) error

v3.6.1

Apr 13, 2024

v3.6.0

Apr 13, 2024

Changes in this version

type PoolBlock

+ Metadata PoolBlockReceptionMetadata

+ type PoolBlockReceptionMetadata struct

+ AddressPort netip.AddrPort

+ LocalTime time.Time

+ PeerId uint64

+ SoftwareId uint32

+ SoftwareVersion uint32

v3.5.0

Apr 12, 2024

Changes in this version

type Consensus

+ Extra string

type NetworkType

+ func (n NetworkType) MustAddressNetwork() uint8

v3.4.0

Apr 10, 2024

Changes in this version

+ const MaxMerkleProofSize

+ const SideIdentifierHash

type Consensus

+ MergeMiningId types.Hash

type PoolBlock

+ func (b *PoolBlock) FastSideTemplateId(consensus *Consensus) types.Hash

+ func (b *PoolBlock) MergeMiningTag() merge_mining.Tag

type ShareVersion

+ const ShareVersion_V3

type SideChain

+ func (c *SideChain) GetPoolBlockByCoinbaseExtraIdentifier(version ShareVersion, id types.Hash) *PoolBlock

+ func (c *SideChain) GetPoolBlockByMerkleRoot(id types.Hash) *PoolBlock

+ func (c *SideChain) PoolBlockExternalVerify(block *PoolBlock) (missingBlocks []types.Hash, err error, ban bool)

type SideData

+ MerkleProof crypto.MerkleProof

v3.3.0

Apr 7, 2024

v3.2.1

Apr 6, 2024

v3.2.0

Apr 6, 2024

Changes in this version

+ func LoadSideChainTestData(c *SideChain, reader io.Reader, patchedBlocks ...[]byte) error

type Consensus

+ func (c *Consensus) SeedNodes() []string

+ type SideDataExtraBuffer struct

+ RandomNumber uint32

+ SideChainExtraNonce uint32

+ SoftwareId p2pooltypes.SoftwareId

+ SoftwareVersion p2pooltypes.SoftwareVersion

v3.1.0

Apr 5, 2024

v3.0.2

Apr 5, 2024

v3.0.1

Apr 3, 2024

v3.0.0

Apr 3, 2024

Changes in this version

+ const BlockSaveEpochSize

+ const BlockSaveFieldSizeInBits

+ const BlockSaveOffsetAddress

+ const BlockSaveOffsetMainFields

+ const BlockSaveOptionDeterministicBlobs

+ const BlockSaveOptionDeterministicPrivateKeySeed

+ const BlockSaveOptionTemplate

+ const BlockSaveOptionUncles

+ const FullIdSize

+ const LargestMinimumDifficulty

+ const PoolBlockMaxTemplateSize

+ const SideCoinbasePublicKey

+ const SideExtraNonce

+ const SideExtraNonceMaxSize

+ const SideExtraNonceSize

+ const SideTemplateId

+ const SmallestMinimumDifficulty

+ const UncleBlockDepth

+ var ConsensusDefault = &Consensus

+ var ConsensusMini = &Consensus

+ func BlocksInPPLNSWindow(tip *PoolBlock, consensus *Consensus, ...) (bottomHeight uint64, err error)

+ func CalculateOutputs(block *PoolBlock, consensus *Consensus, ...) (outputs transaction.Outputs, bottomHeight uint64)

+ func GetDifficultyForNextBlock(tip *PoolBlock, consensus *Consensus, getByTemplateId GetByTemplateIdFunc, ...) (difficulty types.Difficulty, verifyError, invalidError error)

+ func IsLongerChain(block, candidate *PoolBlock, consensus *Consensus, ...) (isLonger, isAlternative bool)

+ func IterateBlocksInPPLNSWindow(tip *PoolBlock, consensus *Consensus, ...) error

+ func NetworkMajorVersion(consensus *Consensus, height uint64) uint8

+ func NextDifficulty(consensus *Consensus, timestamps []uint64, difficultyData []DifficultyData) (nextDifficulty types.Difficulty, err error)

+ func ShuffleSequence(shareVersion ShareVersion, privateKeySeed types.Hash, items int, ...)

+ func ShuffleShares[T any](shares []T, shareVersion ShareVersion, privateKeySeed types.Hash)

+ func SplitReward(preAllocatedRewards []uint64, reward uint64, shares Shares) (rewards []uint64)

+ func SplitRewardAllocate(reward uint64, shares Shares) (rewards []uint64)

+ type Cache interface

+ GetBlob func(key []byte) (blob []byte, err error)

+ RemoveBlob func(key []byte) (err error)

+ SetBlob func(key, blob []byte) (err error)

+ type ChainMain struct

+ Difficulty types.Difficulty

+ Height uint64

+ Id types.Hash

+ Reward uint64

+ Timestamp uint64

+ type CoinbaseExtraTag int

+ type Consensus struct

+ ChainWindowSize uint64

+ HardForks []HardFork

+ Id types.Hash

+ MinimumDifficulty uint64

+ NetworkType NetworkType

+ PoolName string

+ PoolPassword string

+ TargetBlockTime uint64

+ UnclePenalty uint64

+ func NewConsensus(networkType NetworkType, poolName, poolPassword string, ...) *Consensus

+ func NewConsensusFromJSON(data []byte) (*Consensus, error)

+ func (c *Consensus) ApplyUnclePenalty(weight types.Difficulty) (uncleWeight, unclePenalty types.Difficulty)

+ func (c *Consensus) CalculateId() types.Hash

+ func (c *Consensus) CalculateSideChainIdFromBlobs(mainBlob, sideBlob []byte) (result types.Hash)

+ func (c *Consensus) CalculateSideTemplateId(share *PoolBlock) (result types.Hash)

+ func (c *Consensus) CalculateSideTemplateIdPreAllocated(share *PoolBlock, buf []byte) (result types.Hash)

+ func (c *Consensus) DefaultPort() uint16

+ func (c *Consensus) GetHasher() randomx.Hasher

+ func (c *Consensus) InitHasher(n int, flags ...randomx.Flag) error

+ func (c *Consensus) IsDefault() bool

+ func (c *Consensus) IsMini() bool

+ func (c *Consensus) SeedNode() string

+ type ConsensusProvider interface

+ Consensus func() *Consensus

+ type DerivationCache struct

+ func NewDerivationLRUCache() *DerivationCache

+ func NewDerivationMapCache() *DerivationCache

+ func (d *DerivationCache) Clear()

+ func (d *DerivationCache) GetDeterministicTransactionKey(seed types.Hash, prevId types.Hash) *crypto.KeyPair

+ func (d *DerivationCache) GetEphemeralPublicKey(a *address.PackedAddress, txKeySlice crypto.PrivateKeySlice, ...) (crypto.PublicKeyBytes, uint8)

+ type DerivationCacheInterface interface

+ GetDeterministicTransactionKey func(seed types.Hash, prevId types.Hash) *crypto.KeyPair

+ GetEphemeralPublicKey func(a *address.PackedAddress, txKeySlice crypto.PrivateKeySlice, ...) (crypto.PublicKeyBytes, uint8)

+ type DifficultyData struct

+ type FakeServer struct

+ func GetFakeTestServer(consensus *Consensus) *FakeServer

+ func (s *FakeServer) Broadcast(block *PoolBlock)

+ func (s *FakeServer) ClearCachedBlocks()

+ func (s *FakeServer) ClientRPC() *client.Client

+ func (s *FakeServer) Consensus() *Consensus

+ func (s *FakeServer) Context() context.Context

+ func (s *FakeServer) GetBlob(key []byte) (blob []byte, err error)

+ func (s *FakeServer) GetChainMainByHash(hash types.Hash) *ChainMain

+ func (s *FakeServer) GetChainMainByHeight(height uint64) *ChainMain

+ func (s *FakeServer) GetChainMainTip() *ChainMain

+ func (s *FakeServer) GetDifficultyByHeight(height uint64) types.Difficulty

+ func (s *FakeServer) GetMinerDataTip() *p2pooltypes.MinerData

+ func (s *FakeServer) GetMinimalBlockHeaderByHash(hash types.Hash) *mainblock.Header

+ func (s *FakeServer) GetMinimalBlockHeaderByHeight(height uint64) *mainblock.Header

+ func (s *FakeServer) RemoveBlob(key []byte) (err error)

+ func (s *FakeServer) SetBlob(key, blob []byte) (err error)

+ func (s *FakeServer) Store(block *PoolBlock)

+ func (s *FakeServer) SubmitBlock(block *mainblock.Block)

+ func (s *FakeServer) UpdateBlockFound(data *ChainMain, block *PoolBlock)

+ func (s *FakeServer) UpdateTip(tip *PoolBlock)

+ type FullId [FullIdSize]byte

+ func FullIdFromString(s string) (FullId, error)

+ func (id FullId) ExtraNonce() uint32

+ func (id FullId) Nonce() uint32

+ func (id FullId) String() string

+ func (id FullId) TemplateId() (h types.Hash)

+ type GetByMainHeightFunc func(height uint64) UniquePoolBlockSlice

+ type GetByMainIdFunc func(h types.Hash) *PoolBlock

+ type GetBySideHeightFunc func(height uint64) UniquePoolBlockSlice

+ type GetByTemplateIdFunc func(h types.Hash) *PoolBlock

+ type GetChainMainByHashFunc func(h types.Hash) *ChainMain

+ type HardFork struct

+ Height uint64

+ Threshold uint8

+ Time uint64

+ Version uint8

+ func NetworkHardFork(consensus *Consensus) []HardFork

+ type IterationCache struct

+ Parent *PoolBlock

+ Uncles []*PoolBlock

+ type NetworkType int

+ const NetworkInvalid

+ const NetworkMainnet

+ const NetworkStagenet

+ const NetworkTestnet

+ func (n *NetworkType) UnmarshalJSON(b []byte) error

+ func (n NetworkType) AddressNetwork() (uint8, error)

+ func (n NetworkType) MarshalJSON() ([]byte, error)

+ func (n NetworkType) String() string

+ type NilDerivationCache struct

+ func (d *NilDerivationCache) Clear()

+ func (d *NilDerivationCache) GetDeterministicTransactionKey(seed types.Hash, prevId types.Hash) *crypto.KeyPair

+ func (d *NilDerivationCache) GetEphemeralPublicKey(a *address.PackedAddress, _ crypto.PrivateKeySlice, ...) (crypto.PublicKeyBytes, uint8)

+ type P2PoolInterface interface

+ Broadcast func(block *PoolBlock)

+ ClearCachedBlocks func()

+ ClientRPC func() *client.Client

+ Context func() context.Context

+ GetChainMainByHash func(hash types.Hash) *ChainMain

+ GetChainMainByHeight func(height uint64) *ChainMain

+ GetChainMainTip func() *ChainMain

+ GetDifficultyByHeight func(height uint64) types.Difficulty

+ GetMinerDataTip func() *p2pooltypes.MinerData

+ GetMinimalBlockHeaderByHash func(hash types.Hash) *mainblock.Header

+ GetMinimalBlockHeaderByHeight func(height uint64) *mainblock.Header

+ Store func(block *PoolBlock)

+ SubmitBlock func(block *mainblock.Block)

+ UpdateBlockFound func(data *ChainMain, block *PoolBlock)

+ UpdateTip func(tip *PoolBlock)

+ type PoolBlock struct

+ Broadcasted atomic.Bool

+ CachedShareVersion ShareVersion

+ Depth atomic.Uint64

+ Invalid atomic.Bool

+ LocalTimestamp uint64

+ Main mainblock.Block

+ Side SideData

+ Verified atomic.Bool

+ WantBroadcast atomic.Bool

+ func NewShareFromExportedBytes(buf []byte, consensus *Consensus, cacheInterface DerivationCacheInterface) (*PoolBlock, error)

+ func (b *PoolBlock) AppendBinaryFlags(preAllocatedBuf []byte, pruned, compact bool) (buf []byte, err error)

+ func (b *PoolBlock) BufferLength() int

+ func (b *PoolBlock) CalculateFullId(consensus *Consensus) FullId

+ func (b *PoolBlock) CalculateShareVersion(consensus *Consensus) ShareVersion

+ func (b *PoolBlock) CalculateTransactionPrivateKeySeed() types.Hash

+ func (b *PoolBlock) CoinbaseExtra(tag CoinbaseExtraTag) []byte

+ func (b *PoolBlock) CoinbaseId() types.Hash

+ func (b *PoolBlock) ExtraNonce() uint32

+ func (b *PoolBlock) FillPrivateKeys(derivationCache DerivationCacheInterface)

+ func (b *PoolBlock) FillTransactionParentIndices(parent *PoolBlock) bool

+ func (b *PoolBlock) FillTransactionsFromTransactionParentIndices(parent *PoolBlock) error

+ func (b *PoolBlock) FromCompactReader(consensus *Consensus, derivationCache DerivationCacheInterface, ...) (err error)

+ func (b *PoolBlock) FromReader(consensus *Consensus, derivationCache DerivationCacheInterface, ...) (err error)

+ func (b *PoolBlock) FullId() FullId

+ func (b *PoolBlock) GetAddress() address.PackedAddress

+ func (b *PoolBlock) GetPrivateKeySeed() types.Hash

+ func (b *PoolBlock) GetTransactionOutputType() uint8

+ func (b *PoolBlock) IsProofHigherThanDifficulty(hasher randomx.Hasher, f mainblock.GetSeedByHeightFunc) bool

+ func (b *PoolBlock) IsProofHigherThanDifficultyWithError(hasher randomx.Hasher, f mainblock.GetSeedByHeightFunc) (bool, error)

+ func (b *PoolBlock) IsProofHigherThanMainDifficulty(hasher randomx.Hasher, difficultyFunc mainblock.GetDifficultyByHeightFunc, ...) bool

+ func (b *PoolBlock) IsProofHigherThanMainDifficultyWithError(hasher randomx.Hasher, difficultyFunc mainblock.GetDifficultyByHeightFunc, ...) (bool, error)

+ func (b *PoolBlock) MainDifficulty(f mainblock.GetDifficultyByHeightFunc) types.Difficulty

+ func (b *PoolBlock) MainId() types.Hash

+ func (b *PoolBlock) MarshalBinary() ([]byte, error)

+ func (b *PoolBlock) MarshalBinaryFlags(pruned, compact bool) ([]byte, error)

+ func (b *PoolBlock) NeedsCompactTransactionFilling() bool

+ func (b *PoolBlock) NeedsPreProcess() bool

+ func (b *PoolBlock) PowHash(hasher randomx.Hasher, f mainblock.GetSeedByHeightFunc) types.Hash

+ func (b *PoolBlock) PowHashWithError(hasher randomx.Hasher, f mainblock.GetSeedByHeightFunc) (powHash types.Hash, err error)

+ func (b *PoolBlock) PreProcessBlock(consensus *Consensus, derivationCache DerivationCacheInterface, ...) (missingBlocks []types.Hash, err error)

+ func (b *PoolBlock) PreProcessBlockWithOutputs(getTemplateById GetByTemplateIdFunc, ...) (missingBlocks []types.Hash, err error)

+ func (b *PoolBlock) ShareVersion() ShareVersion

+ func (b *PoolBlock) ShareVersionSignaling() ShareVersion

+ func (b *PoolBlock) SideTemplateId(consensus *Consensus) types.Hash

+ func (b *PoolBlock) UnmarshalBinary(consensus *Consensus, derivationCache DerivationCacheInterface, data []byte) error

+ type PoolBlockWindowAddWeightFunc func(b *PoolBlock, weight types.Difficulty)

+ type PoolBlockWindowSlot struct

+ Block *PoolBlock

+ Uncles UniquePoolBlockSlice

+ type PreAllocatedSharesPool struct

+ func NewPreAllocatedSharesPool[T uint64 | int](n T) *PreAllocatedSharesPool

+ func (p *PreAllocatedSharesPool) Get() Shares

+ func (p *PreAllocatedSharesPool) Put(s Shares)

+ type Share struct

+ Address address.PackedAddress

+ Weight types.Difficulty

+ type ShareVersion uint8

+ const ShareVersion_None

+ const ShareVersion_V1

+ const ShareVersion_V2

+ func P2PoolShareVersion(consensus *Consensus, timestamp uint64) ShareVersion

+ func (v ShareVersion) String() string

+ type Shares []*Share

+ func GetShares(tip *PoolBlock, consensus *Consensus, ...) (shares Shares, bottomHeight uint64)

+ func GetSharesOrdered(tip *PoolBlock, consensus *Consensus, ...) (shares Shares, bottomHeight uint64)

+ func PreAllocateShares[T uint64 | int](n T) Shares

+ func (s Shares) Clone() (o Shares)

+ func (s Shares) Compact() Shares

+ func (s Shares) Index(addr address.PackedAddress) int

+ func (s Shares) Sort()

+ type SideChain struct

+ func NewSideChain(server P2PoolInterface) *SideChain

+ func (c *SideChain) AddPoolBlock(block *PoolBlock) (err error)

+ func (c *SideChain) AddPoolBlockExternal(block *PoolBlock) (missingBlocks []types.Hash, err error, ban bool)

+ func (c *SideChain) BlockSeen(block *PoolBlock) bool

+ func (c *SideChain) BlockUnsee(block *PoolBlock)

+ func (c *SideChain) Consensus() *Consensus

+ func (c *SideChain) DerivationCache() *DerivationCache

+ func (c *SideChain) Difficulty() types.Difficulty

+ func (c *SideChain) GetChainTip() *PoolBlock

+ func (c *SideChain) GetDifficulty(tip *PoolBlock) (difficulty types.Difficulty, verifyError, invalidError error)

+ func (c *SideChain) GetHighestKnownTip() *PoolBlock

+ func (c *SideChain) GetMissingBlocks() []types.Hash

+ func (c *SideChain) GetParent(block *PoolBlock) *PoolBlock

+ func (c *SideChain) GetPoolBlockByTemplateId(id types.Hash) *PoolBlock

+ func (c *SideChain) GetPoolBlockCount() int

+ func (c *SideChain) GetPoolBlocksByHeight(height uint64) []*PoolBlock

+ func (c *SideChain) GetPoolBlocksFromTip(id types.Hash) (chain, uncles UniquePoolBlockSlice)

+ func (c *SideChain) GetPoolBlocksFromTipWithDepth(id types.Hash, depth uint64) (chain, uncles UniquePoolBlockSlice)

+ func (c *SideChain) GetPossibleUncles(tip *PoolBlock, forHeight uint64) (uncles []types.Hash)

+ func (c *SideChain) IsLongerChain(block, candidate *PoolBlock) (isLonger, isAlternative bool)

+ func (c *SideChain) LastUpdated() uint64

+ func (c *SideChain) PreCalcFinished() bool

+ func (c *SideChain) PreprocessBlock(block *PoolBlock) (missingBlocks []types.Hash, err error)

+ func (c *SideChain) Server() P2PoolInterface

+ func (c *SideChain) WatchMainChainBlock(mainData *ChainMain, possibleId types.Hash)

+ type SideData struct

+ CoinbasePrivateKey crypto.PrivateKeyBytes

+ CoinbasePrivateKeySeed types.Hash

+ CumulativeDifficulty types.Difficulty

+ Difficulty types.Difficulty

+ ExtraBuffer struct{ ... }

+ Height uint64

+ Parent types.Hash

+ PublicKey address.PackedAddress

+ Uncles []types.Hash

+ func (b *SideData) AppendBinary(preAllocatedBuf []byte, version ShareVersion) (buf []byte, err error)

+ func (b *SideData) BufferLength() int

+ func (b *SideData) FromReader(reader utils.ReaderAndByteReader, version ShareVersion) (err error)

+ func (b *SideData) MarshalBinary(version ShareVersion) (buf []byte, err error)

+ func (b *SideData) UnmarshalBinary(data []byte, version ShareVersion) error

+ type UniquePoolBlockSlice []*PoolBlock

+ func (s UniquePoolBlockSlice) Get(id types.Hash) *PoolBlock

+ func (s UniquePoolBlockSlice) GetHeight(height uint64) (result UniquePoolBlockSlice)

Other modules containing this package

git.gammaspectra.live/P2Pool/consensus/v4

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL