Merge pull request karlsen-network#58 from karlsen-network/mainnet_ka…

…rlsenhashv2

Mainnet karlsenhashv2

.github/workflows/SetPageFileSize.ps1

@@ -11,8 +11,8 @@
 #>
 
 param(
-    [System.UInt64] $MinimumSize = 16gb ,
-    [System.UInt64] $MaximumSize = 16gb ,
+    [System.UInt64] $MinimumSize = 32gb ,
+    [System.UInt64] $MaximumSize = 32gb ,
     [System.String] $DiskRoot = "D:"
 )
 
@@ -193,4 +193,4 @@ namespace Util
 Add-Type -TypeDefinition $source
 
 # Set SetPageFileSize
-[Util.PageFile]::SetPageFileSize($minimumSize, $maximumSize, $diskRoot)
+[Util.PageFile]::SetPageFileSize($minimumSize, $maximumSize, $diskRoot)

.github/workflows/tests.yaml

@@ -28,28 +28,36 @@ jobs:
         if: runner.os == 'Windows'
         run: powershell -command .github\workflows\SetPageFileSize.ps1
 
+      # Increase the swap size on Linux to aviod running out of memory
+      - name: Increase swap size on Linux
+        if: runner.os == 'Linux'
+        uses: thejerrybao/setup-swap-space@v1
+        with:
+          swap-size-gb: 12
+
       - name: Setup Go
         uses: actions/setup-go@v4
         with:
           go-version: 1.21
 
-      # Source: https://github.com/actions/cache/blob/main/examples.md#go---modules
-      - name: Go Cache
-        uses: actions/cache@v4
-        with:
-          path: ~/go/pkg/mod
-          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-          restore-keys: |
-            ${{ runner.os }}-go-
-
       - name: Test
         shell: bash
+        env:
+          NO_PARALLEL: 1
         run: ./build_and_test.sh
 
   stability-test-fast:
     runs-on: ubuntu-latest
     name: Fast stability tests
     steps:
+
+      # Increase the swap size on Linux to aviod running out of memory
+      - name: Increase swap size on Linux
+        if: runner.os == 'Linux'
+        uses: thejerrybao/setup-swap-space@v1
+        with:
+          swap-size-gb: 12
+
       - name: Setup Go
         uses: actions/setup-go@v4
         with:
@@ -71,6 +79,14 @@ jobs:
     runs-on: ubuntu-latest
     name: Produce code coverage
     steps:
+
+      # Increase the swap size on Linux to aviod running out of memory
+      - name: Increase swap size on Linux
+        if: runner.os == 'Linux'
+        uses: thejerrybao/setup-swap-space@v1
+        with:
+          swap-size-gb: 12
+
       - name: Check out code into the Go module directory
         uses: actions/checkout@v4
 
@@ -83,7 +99,7 @@ jobs:
         run: rm -r stability-tests
 
       - name: Create coverage file
-        run: go test -v -covermode=atomic -coverpkg=./... -coverprofile coverage.txt ./...
+        run: go test -timeout 120m -parallel=1 -v -covermode=atomic -coverpkg=./... -coverprofile coverage.txt ./...
 
       - name: Upload coverage file
         run: bash <(curl -s https://codecov.io/bash)

README.md

@@ -38,18 +38,15 @@ miners. We will ensure long-term GPU-friendly mining.
 ### Hashing Function
 
 We initially started with `kHeavyHash` and `blake3` modifications
-on-top. This algorithm is called `KarlsenHashv1`. However `kHeavyHash`
-and `blake3` are not future proof in ASIC resistence. Therefore we've
-launched already our `testnet-1` with [FishHash](https://github.com/iron-fish/fish-hash/blob/main/FishHash.pdf).
-It is the worlds first implementation of FishHash with Golang in a
-1bps blockchain.
+on-top. This algorithm is called `KarlsenHashv1`.
 
 `KarlsenHashv1` is currently used in [mainnet](https://github.com/karlsen-network/karlsend/releases/tag/v1.1.0)
 and can be mined using the following miners maintained by the Karlsen
 developers:
 
 * Built-in CPU miner from `karlsend`
-* Karlsen [GPU miner](https://github.com/karlsen-network/karlsen-miner) as reference implementation of `kHeavyHash` with `blake3`.
+* Karlsen [GPU miner](https://github.com/karlsen-network/karlsen-miner)
+  as reference implementation of `kHeavyHash` with `blake3`.
 
 The following third-party miners are available and have added
 `KarlsenHashv1`:
@@ -61,14 +58,42 @@ The following third-party miners are available and have added
 * [Rigel](https://github.com/rigelminer/rigel)
 * [GMiner](https://github.com/develsoftware/GMinerRelease)
 
-`KarlsenHashv2` is currently being investigated and tested in [testnet-1](https://github.com/karlsen-network/karlsend/releases/tag/v2.0.0-testnet-1-fishhash)
+`KarlsenHashv2` will become active via hardfork at DAA score `26.962.009`.
+It is based on [FishHash](https://github.com/iron-fish/fish-hash/blob/main/FishHash.pdf)
+written from scratch in our Golang node implementation. It is FPGA/ASIC
+resistent. It is the worlds first implementation of FishHash with Golang
+in `mainnet` in a 1bps blockchain.
+
+`KarlsenHashv2` is currently used in [mainnet](https://github.com/karlsen-network/karlsend/releases/tag/v2.1.0)
 and can be mined using the following miners maintained by the Karlsen
 developers:
 
 * Built-in CPU miner from `karlsend`
-* Karlsen [GPU miner](https://github.com/wam-rd/karlsen-miner/releases/tag/v2.0.0-alpha) as bleeding edge and unoptimized reference implementation of FishHash.
+* Karlsen [GPU miner](https://github.com/karlsen-network/karlsen-miner/releases/tag/v2.0.0)
+  as bleeding edge and unoptimized reference implementation of
+  `KarlsenHashv2`. Please follow the steps in the [README.md](https://github.com/karlsen-network/karlsen-miner/blob/main/README.md)
+  to generate a DAG file.
+
+The following third-party miners are available and have added
+`KarlsenHashv2`:
+
+* [SRBMiner](https://github.com/doktor83/SRBMiner-Multi)
+
+### DAG Generation
+
+To start mining using the built-in CPU miner it needs a pre-generated
+DAG file. `KarlsenHashv2` miner uses a 4GB DAG for efficient mining.
+It generates this DAG with 8 CPU threads and saves it as `hashes.dat`
+for faster subsequent runs.
+
+* First Run: Generates a 4GB DAG using 8 CPU threads. This may take
+  time depending on your computer. Saves the DAG as `hashes.dat` for
+  future use.
+* Next Runs: Loads `hashes.dat` to skip DAG generation, speeding up
+  startup.
 
-There are no third-party miners available as of now.
+If you need to regenerate the DAG, delete `hashes.dat` and run the
+`karlsenminer` again.
 
 ## Smart Contracts
 

app/app.go

@@ -7,6 +7,7 @@ import (
 	"runtime"
 	"time"
 
+	"github.com/karlsen-network/karlsend/domain/consensus/utils/pow"
 	"github.com/karlsen-network/karlsend/infrastructure/config"
 	"github.com/karlsen-network/karlsend/infrastructure/db/database"
 	"github.com/karlsen-network/karlsend/infrastructure/db/database/ldb"
@@ -82,6 +83,7 @@ func (app *karlsendApp) main(startedChan chan<- struct{}) error {
 
 	// Show version at startup.
 	log.Infof("Version %s", version.Version())
+	log.Infof("Using KarlsenHashV2 impl: %s", pow.GetHashingAlgoVersion())
 
 	// Enable http profiling server if requested.
 	if app.cfg.Profile != "" {

app/protocol/manager.go

@@ -70,6 +70,9 @@ func (m *Manager) AddTransaction(tx *externalapi.DomainTransaction, allowOrphan
 
 // AddBlock adds the given block to the DAG and propagates it.
 func (m *Manager) AddBlock(block *externalapi.DomainBlock) error {
+	//TODO switch this to debug level
+	log.Infof("NEW BLOCK ADDED ***************************************")
+	log.Infof("BlueWork[%s] BlueScore[%d] DAAScore[%d] Bits[%d] Version[%d]", block.Header.BlueWork(), block.Header.BlueScore(), block.Header.DAAScore(), block.Header.Bits(), block.Header.Version())
 	return m.context.AddBlock(block)
 }
 

build_and_test.sh

@@ -24,7 +24,7 @@ go build -v -o karlsend .
 
 # check if parallel tests are enabled.
 [ -n "${NO_PARALLEL}" ] && {
-	go test -timeout 20m -parallel=1 -v ./...
+	go test -timeout 30m -parallel=1 -v ./...
 } || {
-	go test -timeout 20m -v ./...
+	go test -timeout 30m -v ./...
 }

cmd/karlsenminer/main.go

@@ -12,6 +12,7 @@ import (
 
 	_ "net/http/pprof"
 
+	"github.com/karlsen-network/karlsend/domain/consensus/utils/pow"
 	"github.com/karlsen-network/karlsend/infrastructure/os/signal"
 	"github.com/karlsen-network/karlsend/util/panics"
 	"github.com/karlsen-network/karlsend/util/profiling"
@@ -29,6 +30,7 @@ func main() {
 
 	// Show version at startup.
 	log.Infof("Version %s", version.Version())
+	log.Infof("Using KarlsenHashV2 impl: %s", pow.GetHashingAlgoVersion())
 
 	// Enable http profiling server if requested.
 	if cfg.Profile != "" {

cmd/karlsenminer/mineloop.go

@@ -19,6 +19,7 @@ import (
 )
 
 var hashesTried uint64
+var dagReady = false
 
 const logHashRateInterval = 10 * time.Second
 
@@ -97,6 +98,12 @@ func logHashRate() {
 	spawn("logHashRate", func() {
 		lastCheck := time.Now()
 		for range time.Tick(logHashRateInterval) {
+
+			if !dagReady {
+				log.Infof("Generating DAG, please wait ...")
+				continue
+			}
+
 			currentHashesTried := atomic.LoadUint64(&hashesTried)
 			currentTime := time.Now()
 			kiloHashesTried := float64(currentHashesTried) / 1000.0
@@ -138,7 +145,11 @@ func handleFoundBlock(client *minerClient, block *externalapi.DomainBlock) error
 func mineNextBlock(mineWhenNotSynced bool) *externalapi.DomainBlock {
 	nonce := rand.Uint64() // Use the global concurrent-safe random source.
 	for {
+		if !dagReady {
+			continue
+		}
 		nonce++
+		//fmt.Printf("mineNextBlock -- log1\n")
 		// For each nonce we try to build a block from the most up to date
 		// block template.
 		// In the rare case where the nonce space is exhausted for a specific
@@ -165,7 +176,6 @@ func getBlockForMining(mineWhenNotSynced bool) (*externalapi.DomainBlock, *pow.S
 
 	for {
 		tryCount++
-
 		shouldLog := (tryCount-1)%10 == 0
 		template, state, isSynced := templatemanager.Get()
 		if template == nil {
@@ -207,7 +217,10 @@ func templatesLoop(client *minerClient, miningAddr util.Address, errChan chan er
 			errChan <- errors.Wrapf(err, "Error getting block template from %s", client.Address())
 			return
 		}
-		err = templatemanager.Set(template)
+		err = templatemanager.Set(template, backendLog)
+		// after first template DAG is supposed to be ready
+		// TODO: refresh dag status in real time
+		dagReady = true
 		if err != nil {
 			errChan <- errors.Wrapf(err, "Error setting block template from %s", client.Address())
 			return

cmd/karlsenminer/templatemanager/templatemanager.go

@@ -6,6 +6,7 @@ import (
 	"github.com/karlsen-network/karlsend/app/appmessage"
 	"github.com/karlsen-network/karlsend/domain/consensus/model/externalapi"
 	"github.com/karlsen-network/karlsend/domain/consensus/utils/pow"
+	"github.com/karlsen-network/karlsend/infrastructure/logger"
 )
 
 var currentTemplate *externalapi.DomainBlock
@@ -27,15 +28,16 @@ func Get() (*externalapi.DomainBlock, *pow.State, bool) {
 }
 
 // Set sets the current template to work on
-func Set(template *appmessage.GetBlockTemplateResponseMessage) error {
+func Set(template *appmessage.GetBlockTemplateResponseMessage, backendLog *logger.Backend) error {
 	block, err := appmessage.RPCBlockToDomainBlock(template.Block)
 	if err != nil {
 		return err
 	}
 	lock.Lock()
 	defer lock.Unlock()
 	currentTemplate = block
-	currentState = pow.NewState(block.Header.ToMutable())
+	pow.SetLogger(backendLog, logger.LevelTrace)
+	currentState = pow.NewState(block.Header.ToMutable(), true)
 	isSynced = template.IsSynced
 	return nil
 }

domain/consensus/factory.go

@@ -349,6 +349,7 @@ func (f *factory) NewConsensus(config *Config, db infrastructuredatabase.Databas
 		config.MaxBlockParents,
 		config.TimestampDeviationTolerance,
 		config.TargetTimePerBlock,
+		config.HFDAAScore,
 		config.MaxBlockLevel,
 
 		dbManager,
@@ -397,6 +398,7 @@ func (f *factory) NewConsensus(config *Config, db infrastructuredatabase.Databas
 	blockBuilder := blockbuilder.New(
 		dbManager,
 		genesisHash,
+		config.HFDAAScore,
 
 		difficultyManager,
 		pastMedianTimeManager,

domain/consensus/model/interface_processes_difficultymanager.go

@@ -10,4 +10,5 @@ type DifficultyManager interface {
 	StageDAADataAndReturnRequiredDifficulty(stagingArea *StagingArea, blockHash *externalapi.DomainHash, isBlockWithTrustedData bool) (uint32, error)
 	RequiredDifficulty(stagingArea *StagingArea, blockHash *externalapi.DomainHash) (uint32, error)
 	EstimateNetworkHashesPerSecond(startHash *externalapi.DomainHash, windowSize int) (uint64, error)
+	GenesisDifficulty() uint32
 }