hive

README

CoopHive

CoopHive is a two-sided marketplace for computational resources. It enables users to run computational workloads in a permissionless protocol, where anyone can get paid to connect their compute nodes to the network and run jobs.

Getting started

Welcome to the prerelease series of CoopHive v0.

CoopHive v0 Testnet

The testnet has a base currency of ETH and you will also get HIVE to pay for jobs (and nodes to stake).

Metamask:

Network name: CoopHive v0 Testnet
New RPC URL: http://testnet.co-ophive.network:8545
Chain ID: 1337
Currency symbol: ETH
Block explorer URL: (leave blank)

Fund your wallet with ETH and HIVE Token

To obtain funds, go to http://faucet.co-ophive.network:8080

The faucet will give you both ETH (to pay for gas) and HIVE (to stake and pay for jobs).

Install CLI

Download the latest release of CoopHive for your platform. Both the amd64/x86_64 and arm64 variants of macOS and Linux are supported. (If you are on Apple Silicon, you'll want arm64).

To check your version use which hive. It it's an old version, run rm <path> to remove that path, and then reinstall the newest version.

The commands below will automatically detect your OS and processor architecture and download the correct CoopHive build for your machine.

On Command Line

1. Detect your operating system and set it as $OSNAME
2. Detect your machine's architecture and set it as $OSARCH
3. Download the latest production build
4. Check the version
5. Install hive

Installation script for Linux and MacOS

OSARCH=$(uname -m | awk '{if ($0 ~ /arm64|aarch64/) print "arm64"; else if ($0 ~ /x86_64|amd64/) print "amd64"; else print "unsupported_arch"}') && export OSARCH
echo $OSARCH
OSNAME=$(uname -s | awk '{if ($1 == "Darwin") print "darwin"; else if ($1 == "Linux") print "linux"; else print "unsupported_os"}') && export OSNAME;
echo $OSNAME
curl -sSL -o hive https://github.com/CoopHive/hive/releases/download/v0.5.6/hive-$OSNAME-$OSARCH
chmod +x hive
./hive version 

sudo mv hive /usr/local/bin/hive

GUI

1. Go to https://github.com/CoopHive/hive/releases/
2. Navigate to latest stable semver release i.e release of format vX.Y.Z

Go 1.21+

go install github.com/CoopHive/hive@latest

Run a job

First, make sure your Web3 private key is in the environment.

export WEB3_PRIVATE_KEY=<your private key>

Alternatively, arrange for the key to be in your environment in a more secure way that doesn't get written to your shell history.

Cows

Hello World, now with cows.

hive run cowsay:v0.1.1 -i Message="CoopHive"

should output

cat /tmp/coophive/data/downloaded-files/Qmbxgp8wyqrQgYYrAMjyUpNdnTuk1Ly8adv8nqQC69rPVQ/stdout

 __________
< CoopHive >
 ----------
        \   ^__^
         \  (oo)\_______
            (__)\       )\/\
                ||----w |
                ||     ||

SDXL

Stable diffusion:

hive run sdxl:v0.1.0 -i PROMPT="beautiful view of iceland with a record player"

 ___  __    __  ____  _  _  __  _  _  ____ 
 / __)/  \  /  \(  _ \/ )( \(  )/ )( \(  __)
( (__(  O )(  O )) __/) __ ( )( \ \/ / ) _) 
 \___)\__/  \__/(__)  \_)(_/(__) \__/ (____) 0.4.0

  Decentralized Compute Network  https://coophive.network


∙∙● CoopHive submitting job 2024-02-07T05:11:18+05:30 
∙●∙ CoopHive submitting jobEnumerating objects: 11, done.
Counting objects: 100% (11/11), done.
Compressing objects: 100% (10/10), done.
Total 11 (delta 1), reused 11 (delta 1), pack-reused 0
🌟  CoopHive submitting job
🤝  Job submitted. Negotiating deal...
💌  Deal agreed. Running job...
🤔  Results submitted. Awaiting verification...
✅  Results accepted. Downloading result...
🤔  Results submitted. Awaiting verification...
✅  Results accepted. Downloading result...

🍂 CoopHive job completed, try 👇
    open /tmp/coophive/data/downloaded-files/QmYoVjFGY1h6m22c7X8trw27H44wzHat1TUdfVJAPfLzmc
    cat /tmp/coophive/data/downloaded-files/QmYoVjFGY1h6m22c7X8trw27H44wzHat1TUdfVJAPfLzmc/stdout
    cat /tmp/coophive/data/downloaded-files/QmYoVjFGY1h6m22c7X8trw27H44wzHat1TUdfVJAPfLzmc/stderr
    https://ipfs.io/ipfs/Qme2sRKs3kgbz6F4pFkeLT4tx6km13ZiBevvCvpki9T6Sj

Not working? Try rm -rf /tmp/coophive/data/repos. Uninstall hive path, and reinstall from the start.

Run a node, earn HIVE

hive resourceprovider

Deploy seamlessly on linux by utilizing these systemd configuration files.

Available modules

Check the github releases page for each module or just use the git hash as the tag.

• sdxl
• stable-diffusion
• duckdb
• fastchat
• lora-inference
• lora-training
• filecoin-data-prep
• wasm
• cowsay

Write a module

A module is just a git repo, and module versions are just git tags.

In your repo, create a file called module.coophive. For an example, see cowsay.

This is a json template with Go text/template style {{.Message}} sections which will be replaced by CoopHive with json encoded inputs to modules. You can also do fancy things with go templates like setting defaults, see cowsay for example. While developing a module, you can use the git hash to test it.

Pass inputs as:

hive run github.com/username/repo:tag -i InputVar=value

Inputs are a map of strings to strings.

Writing Advanced Modules

1. subt: The subt function allows for substitutions in your template.

This function is a workaround for the lack of direct substitution support in the module. It implements the printf function under the hood, which allows you to format strings with placeholders.

Usage

The `subt` function can be used in the same way as the `printf` function in Go. You pass in a format string, followed by values that correspond to the placeholders in the format string. ``` const templateText = ` {{ subt "Hello %s" .name }} ` ```

Example Code