utils

Documentation

Index

• Constants
• func CreateSha256Checksum(input []byte) (hash string)
• func DecompressGzip(input []byte) ([]byte, error)
• func FormatGenesisFile(genesisPath string) error
• func GetChainRest(chainId, chainRest string) string
• func GetFromUrl(url string) ([]byte, error)
• func GetFromUrlWithBackoff(url string) (data []byte, err error)
• func GetFromUrlWithOptions(url string, options GetFromUrlOptions) ([]byte, error)
• func GetHomePathFromBinary(binaryPath string) string
• func GetInitialHeightFromGenesisFile(genesisPath string) (int64, error)
• func GetStatusFromRpc(blockRpcConfig types.BlockRpcConfig) (*types.StatusResponse, error)
• func GetVersion() string
• func IsFileGreaterThanOrEqualTo100MB(filePath string) (bool, error)
• func KsyncLogger(moduleName string) zerolog.Logger
• func LogFormatter(keyvals ...interface{}) zerolog.Logger
• func ParseBlockHeightFromKey(key string) (int64, error)
• func ParseSnapshotFromKey(key string) (height int64, chunkIndex int64, err error)
• func StartBinaryProcessForDB(engine types.Engine, binaryPath string, debug bool, args []string) (processId int, err error)
• func StartBinaryProcessForP2P(engine types.Engine, binaryPath string, debug bool, args []string) (processId int, err error)
• func StopProcessByProcessId(processId int) error
• func TrackBackupEvent(backupCompression string, backupKeepRecent int64, optOut bool)
• func TrackEnginesEvent(optOut bool)
• func TrackInfoEvent(chainId string, optOut bool)
• func TrackPruningEvent(untilHeight int64, optOut bool)
• func TrackResetEvent(optOut bool)
• func TrackServeSnapshotsEvent(engine types.Engine, chainId, chainRest, storageRest string, ...)
• func TrackSyncCompletedEvent(stateSyncHeight, blocksSynced, targetHeight int64, elapsed float64, ...)
• func TrackSyncStartEvent(engine types.Engine, syncType, chainId, chainRest, storageRest string, ...)
• func TrackVersionEvent(optOut bool)
• type GetFromUrlOptions

Constants

const (
	ChainIdMainnet  = "kyve-1"
	ChainIdKaon     = "kaon-1"
	ChainIdKorellia = "korellia-2"

	RestEndpointMainnet  = "https://api.kyve.network"
	RestEndpointKaon     = "https://api.kaon.kyve.network"
	RestEndpointKorellia = "https://api.korellia.kyve.network"

	RestEndpointArweave     = "https://arweave.net"
	RestEndpointBundlr      = "https://arweave.net"
	RestEndpointKYVEStorage = "https://storage.kyve.network"

	SegmentKey = "quSEhAvH5fqlHyop9r9mDGxgd97ro3vQ"
)

const (
	KSyncRuntimeTendermint      = "@kyvejs/tendermint"
	KSyncRuntimeTendermintBsync = "@kyvejs/tendermint-bsync"
	KSyncRuntimeTendermintSsync = "@kyvejs/tendermint-ssync"
)

const (
	EngineTendermintV34   = "tendermint-v0.34"
	EngineCometBFTV37     = "cometbft-v0.37"
	EngineCometBFTV38     = "cometbft-v0.38"
	EngineCelestiaCoreV34 = "celestia-core-v0.34"

	EngineTendermintV34Legacy   = "tendermint-v34"
	EngineCometBFTV37Legacy     = "cometbft-v37"
	EngineCometBFTV38Legacy     = "cometbft-v38"
	EngineCelestiaCoreV34Legacy = "celestia-core-v34"

	EngineTendermintLegacy   = "tendermint"
	EngineCometBFTLegacy     = "cometbft"
	EngineCelestiaCoreLegacy = "tendermint-celestiacore"
)

const (
	DefaultEngine             = EngineTendermintV34
	DefaultChainId            = ChainIdMainnet
	DefaultBackupPath         = "~/.ksync/backups"
	DefaultRpcServerPort      = 7777
	DefaultSnapshotServerPort = 7878
)

const (
	BundlesPageLimit            = 1000
	BlockBuffer                 = 300
	PruningInterval             = 100
	SnapshotPruningAheadFactor  = 3
	SnapshotPruningWindowFactor = 6
	BackoffMaxRetries           = 10
	RequestTimeoutMS            = 250
	RequestBlocksTimeoutMS      = 250
)

const (
	SYNC_STARTED    = "SYNC_STARTED"
	SYNC_COMPLETED  = "SYNC_COMPLETED"
	BLOCK_SYNC      = "BLOCK_SYNC"
	STATE_SYNC      = "STATE_SYNC"
	HEIGHT_SYNC     = "HEIGHT_SYNC"
	SERVE_SNAPSHOTS = "SERVE_SNAPSHOTS"
	INFO            = "INFO"
	RESET           = "RESET"
	PRUNE           = "PRUNE"
	BACKUP          = "BACKUP"
	VERSION         = "VERSION"
	ENGINES         = "ENGINES"
)

const (
	DefaultRegistryURL = "https://raw.githubusercontent.com/KYVENetwork/source-registry/main/.github/registry.yml"
)

Functions

func CreateSha256Checksum

func CreateSha256Checksum(input []byte) (hash string)

func DecompressGzip

func DecompressGzip(input []byte) ([]byte, error)

func FormatGenesisFile

func FormatGenesisFile(genesisPath string) error

func GetChainRest

func GetChainRest(chainId, chainRest string) string

func GetFromUrl

func GetFromUrl(url string) ([]byte, error)

GetFromUrl tries to fetch data from url with a custom User-Agent header

func GetFromUrlWithBackoff

func GetFromUrlWithBackoff(url string) (data []byte, err error)

GetFromUrlWithBackoff tries to fetch data from url with exponential backoff

func GetFromUrlWithOptions

func GetFromUrlWithOptions(url string, options GetFromUrlOptions) ([]byte, error)

GetFromUrlWithOptions tries to fetch data from url with a custom User-Agent header and custom options

func GetHomePathFromBinary

func GetHomePathFromBinary(binaryPath string) string

func GetInitialHeightFromGenesisFile

func GetInitialHeightFromGenesisFile(genesisPath string) (int64, error)

func GetStatusFromRpc

func GetStatusFromRpc(blockRpcConfig types.BlockRpcConfig) (*types.StatusResponse, error)

func GetVersion

func GetVersion() string

func IsFileGreaterThanOrEqualTo100MB

func IsFileGreaterThanOrEqualTo100MB(filePath string) (bool, error)

func KsyncLogger

func KsyncLogger(moduleName string) zerolog.Logger

func LogFormatter

func LogFormatter(keyvals ...interface{}) zerolog.Logger

func ParseBlockHeightFromKey

func ParseBlockHeightFromKey(key string) (int64, error)

func ParseSnapshotFromKey

func ParseSnapshotFromKey(key string) (height int64, chunkIndex int64, err error)

func StartBinaryProcessForDB

func StartBinaryProcessForDB(engine types.Engine, binaryPath string, debug bool, args []string) (processId int, err error)

func StartBinaryProcessForP2P

func StartBinaryProcessForP2P(engine types.Engine, binaryPath string, debug bool, args []string) (processId int, err error)

func StopProcessByProcessId

func StopProcessByProcessId(processId int) error

func TrackBackupEvent

func TrackBackupEvent(backupCompression string, backupKeepRecent int64, optOut bool)

func TrackEnginesEvent

func TrackEnginesEvent(optOut bool)

func TrackInfoEvent

func TrackInfoEvent(chainId string, optOut bool)

func TrackPruningEvent

func TrackPruningEvent(untilHeight int64, optOut bool)

func TrackResetEvent

func TrackResetEvent(optOut bool)

func TrackServeSnapshotsEvent

func TrackServeSnapshotsEvent(engine types.Engine, chainId, chainRest, storageRest string, snapshotPort int64, rpcServer bool, rpcServerPort int64, startHeight int64, pruning, keepSnapshots, debug, optOut bool)

func TrackSyncCompletedEvent

func TrackSyncCompletedEvent(stateSyncHeight, blocksSynced, targetHeight int64, elapsed float64, optOut bool)

func TrackSyncStartEvent

func TrackSyncStartEvent(engine types.Engine, syncType, chainId, chainRest, storageRest string, targetHeight int64, optOut bool)

func TrackVersionEvent

func TrackVersionEvent(optOut bool)

Types

type GetFromUrlOptions

type GetFromUrlOptions struct {
	SkipTLSVerification bool
	WithBackoff         bool
}