Skip to content
This repository was archived by the owner on Feb 24, 2024. It is now read-only.

Contributing

Jump to bottom
Pun Butrach edited this page Jan 13, 2024 · 14 revisions

Please remember that the GitHub Community Guidelines, Terms of Service, and other relevant policies apply here and elsewhere on GitHub - we're human beings too.

Violating these repeatedly may result in being blocked from contributing and/or being banned from GitHub.

💻 Contributing code

Setting up the environment

You'll need to install Node.js (external site), Node.js LTS version is recommended for beginners.

Once you have cloned the repository, open a terminal in your folder and run npm install.

🛠️ Testing your changes

You can run SaladBind by typing node src/index in the terminal window.

Compiling

If you want to try out your changes with a real binary, you can compile SaladBind.

  1. Open a terminal in your folder and run npm run compile (This may display a warning, but it's safe to ignore it)
  2. Your compiled binary will be in the bin folder

🔧 Contributing to under-the-hood stuff!

Note:

  • pools.json is (still in-use for Stratum Security protocol) and reversed for compatibility with older versions of SaladBind and detivatives.
  • pools-v2.json is pools.json but switched from NiceHash Stratum to NiceHash SSL.

Bumping the miner version.

Here are links to the miners listed in ./internal/miner.json

T-Rex: https://github.com/trexminer/T-Rex/releases

NBMiner: https://github.com/NebuTech/NBMiner/releases

TeamRedMiner: https://github.com/todxx/teamredminer/releases

lolMiner: https://github.com/Lolliedieb/lolMiner-releases/releases

XMRig: https://github.com/xmrig/xmrig/releases

Contributing to DAG-size.

I won't be accepting DAG-size-related updates any time soon, as this little helper is still working.

Tip: When disabling the algorithm, set the DAG value of the algorithm that you want to disable to 2147483647, DO NOT SET IT TO 0, -1 OR NULL or else SaladBind will think that the algorithm is compatible because the GPU VRAM is higher than 0 or -1 or doesn't have a requirement null.

  1. Setting up the environment
  2. Open a terminal in your folder and run npm run compile (This may display a warning, but it's safe to ignore it)
  3. Run node ./internal/alfurDagUpdater.js

✨ Last, Get your code into SaladBind!

You can make a pull request on GitHub. This GitHub help article may be useful.

Clone this wiki locally