Add support for KASPA (KAS)

[blackmennewstyle]

Commit a88b84d officially adds support for KASPA (KAS) 🔥 🚀

In order to work properly the following procedure details how to setup a KAS node for pool mining.

Very good guide in order to install, configure and understand how the two daemons (daemon-node & wallet-daemon) work: https://wiki.kaspa.org/en/getting-started

How to configure kaspad config file?

(TESTNET)

GOLANG kaspad

[Application Options]
uacomment=<anything_you_want>
maxinpeers=25
outpeers=4
; enablebanning=1
listen=:16211
rpclisten=:16210
rpcmaxclients=10
rpcmaxwebsockets=10
rpcmaxconcurrentreqs=10
maxorphantx=25
blockmaxmass=2500000
sigcachemaxsize=25000
maxutxocachesize=1250000000
; Debug logging level.
; Valid levels are {trace, debug, info, warn, error, critical}
; You may also specify <subsystem>=<level>,<subsystem2>=<level>,... to set
; log level for individual subsystems. Use kaspad --loglevel=show to list
; available subsystems.
loglevel=debug

Replace respectively:
uacomment= is not mandatory, you can skip it, but if you want to use it avoid those special characters /, :, (, )

RUST kaspad

testnet=true
utxoindex=true
disable-upnp=true
maxinpeers=25
outpeers=4
listen="0.0.0.0:16211"
rpclisten="0.0.0.0:16210"
rpcmaxclients=10
async-threads=1
ram-scale=0.6
addpeer=["37.27.12.216", "82.165.188.245", "194.247.182.32", "156.67.63.17", "213.33.74.88", "79.160.218.211"]
perf-metrics=true
perf-metrics-interval-sec=10
loglevel="info"

(MAINNET)

GOLANG kaspad

[Application Options]
uacomment=<anything_you_want>
maxinpeers=25
outpeers=4
; enablebanning=1
listen=:16111
rpclisten=:16110
rpcmaxclients=10
rpcmaxwebsockets=10
rpcmaxconcurrentreqs=10
maxutxocachesize=1250000000
; Debug logging level.
; Valid levels are {trace, debug, info, warn, error, critical}
; You may also specify <subsystem>=<level>,<subsystem2>=<level>,... to set
; log level for individual subsystems. Use kaspad --loglevel=show to list
; available subsystems.
loglevel=debug

Replace respectively:
uacomment= is not mandatory, you can skip it, but if you want to use it avoid those special characters /, :, (, )

RUST kaspad

utxoindex=true
disable-upnp=true
maxinpeers=25
outpeers=4
listen="0.0.0.0:16111"
rpclisten="0.0.0.0:16110"
rpcmaxclients=10
async-threads=1
ram-scale=0.6
perf-metrics=true
perf-metrics-interval-sec=10
loglevel="info"

About RUST and GOLANG

miningcore is fully compatible with protobuf so you can run either RUST or GOLANG kaspad node daemon. Both daemons are also compatible with GOLANG kaspawallet, so even if you switch to RUST kaspad node daemon, you must still use GOLANG kaspawallet daemon. Just make sure to always use the latest release of GOLANG in order to avoid any incompatibility issue.

How to configure confg.json for KAS?

A pool configuration for KAS be found inside the examples folder: https://github.com/blackmennewstyle/miningcore/blob/dev/examples/kaspa_pool.json

Replace all the specific options with the correct expected values.

WARNING: KASPA is a very fast and performant blockchain, make sure your server is up for the challenge (Very fast SSD is mandatory). KASPA has also a very complex block reward: https://wiki.kaspa.org/en/merging-and-rewards, i tried my best to implement it but there could be margin of error, so keep an eye on your blocks and pool wallet balance. Good luck.

[mamafunny]

<pool_address> with a valid KAS address owned by the keys.json
for pool address, using the public key or kaspa:xxx?

[blackmennewstyle]

pool_address means kaspa address, so kaspa:xxxxx, the keys.json is your wallet. Sorry for the confusion. I meant to say the pool address, created within (owned by) your wallet.

[mamafunny]

whenever i use kaspa:xxxx in that
loadConfig: The following characters must not appear in user agent comments: '/', ':', '(', ')' error showing cannot run kaspa daemon

[blackmennewstyle]

My bad, you are right, it does not like those characters, i just realized in my conf, i put just my mining pool domain address.
I will rectify the example.

[mamafunny]

nice thank you, and could you check the problem i faced with karlsen also? thanks

[blackmennewstyle]

Commit 8f73bf2 improves performances with a better utilization of gRPC dual streaming communication for blockTemplate. It fixes also a missing CPU instruction sse2 in blake3 and build issue on Windows, although Linux is the recommended way to run miningcore.

[Arcazulus]

Would you happen to know the config to make this work with ASICS? as I am pretty sure they don't work well with vardiff and have to change the nonce?

[blackmennewstyle]

I don't know where your claims are coming from but i have been seeing all the IceRiver lineup being able to mine fine on my pool, even the Bitmain KS3 is able to mine since i actually helped the dev of the Kaspa-stratum bridge in order to support them.

So far, all the pools using my code have no issue as well, everyone have done their homework correctly i guess.

The key is to setup the right dedicated ports with the correct initial and minimum difficulty, ASICs have actually no problem with varDiff as long as these two parameters are adjusted correctly.

[Arcazulus]

Thank you! glad to hear this! would you happen to know the values needed for KS0?

[Arcazulus]

I found the info in your API. thanks again.

[blackmennewstyle]

You could have found all these info on the github repository of the Kaspa-stratum bridge since my implementation is based on it.
Enjoy the rest of your week

[blackmennewstyle]

Commit 49378e9 fixes the latest issues left for the KASPA family: Effort, Difficulty and share difficulty calculations are now the correct ones.

[Mini-Digger]

What should I write in the ProtobufWalletRpcServiceName of pyi?

[blackmennewstyle]

The package name they use in the protobuf protocol for their wallet daemon https://github.com/Pyrinpyi/pyipad/blob/401d864b26ddac792eee6efbe17752f7da2ed0fb/cmd/pyrinwallet/daemon/pb/pyrinwalletd.proto#L4

You should respect the same nomenclature used by KAS:

miningcore/src/Miningcore/Blockchain/Kaspa/Configuration/KaspaPoolConfigExtra.cs

Line 31 in 49378e9

/// Default: "kaspawalletd.kaspawalletd"

Seeking for information and know how nodes work are things you should master as a mining pool operator.

[blackmennewstyle]

Commit 64e8d16 adds support for more KAS forks, since it was one of the most requested feature so far lol

[blackmennewstyle]

Commit c65b3ba is a huge optimization for the KAS family.

Improves stratum RPC protocol
Add support for more KAS forks
Support for PYI is totally abandoned since it's a scam, so don't expect much from me anymore regarding that sh*ty project.
Add support for KarlsenHashV2
Improves drastically the process for adding more KAS kHeavyHash forks, it just a matter of adding a new entry in the coins.json and using the correct "protobufWalletRpcServiceName": "", 🔥 🚀

KAS has now a transaction fee market which fluctuates along network activities. In order to take advantage of it and not paying an excessive amount of transactions fee, two options have been implemented within https://github.com/blackmennewstyle/miningcore/blob/dev/examples/kaspa_pool.json

            "versionEnablingMaxFee": "v0.12.18-rc5",
            "maxFee": 200000,

"versionEnablingMaxFee" refers to the GOLANG kaspawallet which implements compatibility for the transaction fee control, so please at least upgrade your GOLANG kaspawallet daemon to that version or any superior version.
"maxFee" is the maximum amount of fee (in SOMPI) that the pool is willing to pay per transaction. As long as the transaction market fee will not be inferior or equal to that amount, your transaction will not be broadcasted on the network, avoiding you to pay a fortune per transaction. Default value is: 20000 (0.0002 KAS) if not specified.

Major security improvement (NOT NECESSARY for KAS, so please remove these lines from your KAS pool config.json)

In the past months, i came across a malicious miner which was attacking pools running my implementation, it was able to mine all the forks. So i decided to study it in order to release some countermeasures against it:

• staticDiff is disable by default. It still can be enable but please use at your own risks: :enableStaticDifficulty": true.

• miner can now be banned based on their own effort:

        "banning": {
            "enabled": true,
            "time": 600,
            "invalidPercent": 50,
            "checkThreshold": 50,
            "minerEffortPercent": 0.00000000465661287,
            "minerEffortTime": 259200
        },

An example is provided within https://github.com/blackmennewstyle/miningcore/blob/dev/examples/kaspa_pool.json
"minerEffortTime": is expressed in seconds. The miner will be banned for that amount of time as long as the pool is running, if the pool restarts the ban will be removed.
"minerEffortPercent": must be a double, and its calculation must respect the following targeted miner effort percentage / 100 / shareMultiplier. Quick example for KAS: 1500 / 100 / (2 ^ 31) = 0.000000006984

[mamafunny]

coins.json and config.json for spectre and astrix is the same kaspa and other fork?

[blackmennewstyle]

Commit 1669d3f is a mandatory update for anyone running a KAS pool, with GOLANG kaspad being officially DEPRECATED: https://github.com/kaspanet/kaspad/releases/tag/v0.12.19

However GOLANG kaspawallet is NOT DEPRECATED and is still required for sending payments.

Improves drastically job distribution and efficiency for RUST kaspad node. If you do not upgrade your source code with that commit, you will not have the best experience when running a RUST kaspad node. You will face huge amount of job not found when the KAS network will go over 4~5 BPS

Make sure as well that you read carefully my initial post #57 (comment) when i provide more details about how to proceed with RUST kaspad and GOLANG kaspawallet

Also pay attention to the additional instructions here #57 (comment)

[jvxis]

Hi @blackmennewstyle,
Considering ~ 1s per Block, Should the targetTime parameter in kaspa_pool.json be lower than 15?
What do you think?
Do you know a good setup for a KS5L?
Thanks,
JVX

[blackmennewstyle]

It does not really matter honestly, targetTime ( https://github.com/oliverw/miningcore/wiki/Configuration ) only affects the shareDiff and also more importantly how fast your shares database table will fill up and growing in size lol

My advice, do your own tests and decide if you are happy with them or not.

[jvxis]

It does not really matter honestly, targetTime ( https://github.com/oliverw/miningcore/wiki/Configuration ) only affects the shareDiff and also more importantly how fast your shares database table will fill up and growing in size lol

My advice, do your own tests and decide if you are happy with them or not.

Thanks, man. KS5L is working very well with this config, pool effort is under 90%.

"name": "ASICs - Iceriver KS5L/KS5M/KS5 | Initial Diff:8192 - Minimum Diff:4096",
                "listenAddress": "0.0.0.0",
                "difficulty": 8192,
                "varDiff": {
                    "minDiff": 4096,
                    "maxDiff": null,
                    "targetTime": 3,
                    "retargetTime": 15,
                    "variancePercent": 25,
                    "maxDelta": 512
                }
                ```

[jvxis]

Hi @blackmennewstyle maybe you can help. I notice that the payment handler always leaves one miner without payment with the message that insufficient funds exist. There are funds, and 10 minutes later this miner is paid, even though no new funds are available in the wallet.
Is this a safe measure on Miningcore?

[2024-11-21 23:11:52.2924] [E] [kas1] [Kaspa Payout Handler] Failed to transfer the following balances: kaspa:qypqd6x62qpmu6s488fu8vsyeaaeus57hfuttqk086xecj7m846g5qgpfehgvsn 25.03078 KAS: Status(StatusCode="Unknown", Detail="Insufficient funds for send: 25.030782 required, while only 0.000000 available")

[blackmennewstyle]

This is the expected behavior, GOLANG kaspawallet does not have a method for sending payments to multiple recipients, it only sends to one recipient.

What is happening here is previous payments have been sent but the change for them is not ready yet, so that payment can not be processed.

It will succeed later on.

Not much can be done here, we are tied to GOLANG kaspawallet own UTXO transfer design.

[jvxis]

This is the expected behavior, GOLANG kaspawallet does not have a method for sending payments to multiple recipients, it only sends to one recipient.

What is happening here is previous payments have been sent but the change for them is not ready yet, so that payment can not be processed.

It will succeed later on.

Not much can be done here, we are tied to GOLANG the kaspwallet own UTXO transfer design.

Thanks for the explanation! Great!