shared

package
v0.4.1 Latest Latest
Warning

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

 Go to latest Published: Mar 2, 2023 License: MIT Imports: 12 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInitNotStarted   = errors.New("not started")
	ErrInitCompleted    = errors.New("already completed")
	ErrInitNotCompleted = errors.New("not completed")
	ErrProofNotExist    = errors.New("proof doesn't exist")
)
View Source 
var (
	// OwnerReadWriteExec is a standard owner read / write / exec file permission.
	OwnerReadWriteExec = os.FileMode(0o700)

	// OwnerReadWrite is a standard owner read / write file permission.
	OwnerReadWrite = os.FileMode(0o600)
)
View Source 
var ZeroChallenge = make(Challenge, 32)

Functions

func BinaryRepresentationMinBits 

func BinaryRepresentationMinBits(val uint64) int

func CalcD added in v0.4.0 

func CalcD(numLabels uint64, B uint32) uint

CalcD calculates the number of bytes to use for the difficulty check. numLabels is the number of labels contained in the PoST data. B is a network parameter that defines the number of labels used in one AES Block.

func DataSize 

func DataSize(numLabels uint64, labelSize uint) uint64

func InitFileName 

func InitFileName(index int) string

func IsInitFile 

func IsInitFile(file os.FileInfo) bool

func NumLabels 

func NumLabels(dataSize uint64, labelSize uint) uint64

func PowDifficulty added in v0.2.2 

func PowDifficulty(numLabels uint64) []byte

PowDifficulty returns the target difficulty of finding a nonce in `numLabels` labels. It is calculated such that a high percentage of smeshers find at least one computed label below the difficulty threshold. The difficulty is calculated as follows: 

difficulty = 8 * 2^256 / numLabels

The probability of finding a label below the difficulty threshold within numLabels approaches ~ 99.97% the bigger numLabels gets. Within 1.15 * numLabels the probability approaches 99.99% of finding at least one label below the difficulty threshold.

func ProvingDifficulty 

func ProvingDifficulty(numLabels uint64, k1 uint64) uint64

func ProvingDifficulty2 added in v0.4.0 

func ProvingDifficulty2(numLabels uint64, B, k1 uint32) uint64

ProvingDifficulty2 returns the target difficulty of finding a nonce in `numLabels` labels. d is the number of bytes in the AES output that count for one nonce.

func PutUintBE 

func PutUintBE(b []byte, v uint64)

PutUintBE encodes a uint64 into a big-endian byte slice.

func Size 

func Size(itemBitSize uint, numItems uint) uint

func UInt64LE 

func UInt64LE(b []byte) uint64

func Uint64MulOverflow 

func Uint64MulOverflow(a, b uint64) bool

func UintBE 

func UintBE(b []byte) uint64

func Version 

func Version() string

Version returns the application version as a properly formed string per the semantic versioning 2.0.0 spec (http://semver.org/).

Types

type Challenge 

type Challenge []byte

type ConfigMismatchError 

type ConfigMismatchError struct {
	Param    string
	Expected string
	Found    string
	DataDir  string
}

func (ConfigMismatchError) Error 

func (err ConfigMismatchError) Error() string

type DisabledLogger 

type DisabledLogger struct{}

func (DisabledLogger) Debug 

func (DisabledLogger) Debug(string, ...any)

func (DisabledLogger) Error 

func (DisabledLogger) Error(string, ...any)

func (DisabledLogger) Info 

func (DisabledLogger) Info(string, ...any)

func (DisabledLogger) Panic 

func (DisabledLogger) Panic(string, ...any)

func (DisabledLogger) Warning 

func (DisabledLogger) Warning(string, ...any)

type GranSpecificReader 

type GranSpecificReader struct {
	ReadNext       func() ([]byte, error)
	ReadNextUintBE func() (uint64, error)
}

GranSpecificReader provides a wrapper for io.Reader to allow granularity-specific access to the stream according to the defined item size, where bit-granular and byte-granular sizes are supported via a specialized code path.

func NewGranSpecificReader 

func NewGranSpecificReader(rd io.Reader, itemBitSize uint) *GranSpecificReader

type GranSpecificWriter 

type GranSpecificWriter struct {
	Write       func([]byte) error
	WriteUintBE func(uint64) error
	Flush       func() error
}

GranSpecificWriter provides a wrapper for io.Writer to allow granularity-specific access to the stream according to the defined item size, where bit-granular and byte-granular sizes are supported via a specialized code path.

func NewGranSpecificWriter 

func NewGranSpecificWriter(w io.Writer, itemBitSize uint) *GranSpecificWriter

type Logger 

type Logger interface {
	Info(format string, args ...any)
	Debug(format string, args ...any)
	Warning(format string, args ...any)
	Error(format string, args ...any)
	Panic(format string, args ...any)
}

type PostMetadata added in v0.2.2 

type PostMetadata struct {
	NodeId          []byte
	CommitmentAtxId []byte

	BitsPerLabel  uint8
	LabelsPerUnit uint64
	NumUnits      uint32
	MaxFileSize   uint64
	Nonce         *uint64 `json:",omitempty"`
	LastPosition  *uint64 `json:",omitempty"`
}

PostMetadata is the data associated with the PoST init procedure, persisted in the datadir next to the init files.

type Proof 

type Proof struct {
	Nonce   uint32
	Indices []byte
}

type ProofMetadata 

type ProofMetadata struct {
	NodeId          []byte
	CommitmentAtxId []byte

	Challenge     Challenge
	NumUnits      uint32
	BitsPerLabel  uint8
	LabelsPerUnit uint64

	K1 uint32 // K1 specifies the difficulty for a label to be a candidate for a proof.
	K2 uint32 // K2 is the number of labels below the required difficulty required for a proof.
	B  uint32 // B is the number of labels used per AES invocation when generating a proof. Lower values speed up verification, higher values proof generation.
	N  uint32 // N is the number of nonces tried at the same time when generating a proof.

}

type VRFNonce added in v0.2.4 

type VRFNonce uint64

type VRFNonceMetadata added in v0.2.4 

type VRFNonceMetadata struct {
	NodeId          []byte
	CommitmentAtxId []byte

	NumUnits      uint32
	BitsPerLabel  uint8
	LabelsPerUnit uint64
}

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.