Getting started as a supplier

(Updated on 20-11-2018)

  1. Overview
  2. Requirements
  3. Master-account settings
  4. Installation
  5. View your current stats
  6. Worker maintenance
  7. Withdraw tokens
  8. Finding help

Overview

The Supplier is a Sonm user who owns computational resources and provides them to Sonm for rent. Suppliers can earn tokens by selling their computing power peer-to-peer to customers and executing their tasks.

Getting started as a Sonm supplier takes several steps, as described below. It includes the installation, settings, and monitoring the process.

Requirements

You'll need to consider the following before starting the installation:

  • You should have one or several worker PCs with a Linux x64 OS (Debian-based Os such as Ubuntu are preferred).
  • Ensure you have an internet connection and browser.

Master-account settings

All suppliers should have an Ethereum address as their unique identifier. This address is called the “Master address” and is used:

  • to receive payments in SNM tokens for resources that you have sold on Sonm (marketplace smart contract send all payments from all your workers to this address)
  • to link profile certificates, deal statistics, contact information, etc
  • to keep a personal blacklist (common for all supplier workers to not enter into deals with specified Sonm users)
  • for Sonm worker control.

Important!

Do not use your main Ethereum address for master purposes! A better option is to generate a new one in the Sonm Market.

The best option is to keep your Master address safe and use an Admin address instead. Admin keys do not receive payment for rented resources and are used only for worker node management and authentication purposes within the Sonm network.

To create your Master address:

  1. Open the Sonm Market.
  2. Create a new wallet using the “Create wallet” button. Input the name, password, and password confirmation and choose “livenet” as the Ethereum network (“rinkeby” is a testnet). Then, click “Create wallet”.
  3. Select “Wallet” -> “Accounts” in the main menu. This will bring up the account list.
  4. Click the "Create account" button. Enter the account name, password, and password confirmation. Click “Create” to finish.
  5. You will see your new account in the list.

IMPORTANT

DON'T FORGET to make a BACK-UP of your KEYSTORE or WHOLE WALLET. You cannot get access to your funds if you loose the keystore.

To export wallet:

  1. Click the "Export wallet" button on the "Accounts" page.
  2. Choose the local folder and click "Save".

Installation

Supplier should have the following components to use Sonm:

  • one or several PCs with Linux x64 OS (Debian-based OS such as Ubuntu are preferred), running:
    • Docker CE
    • Sonm Worker (interacts with other Sonm components to provide computational resources)
    • Sonm Optimus (optional Sonm component, a seller-bot that analyzes the Sonm marketplace and manages Sonm Worker resources to conclude the most profitable deals);
  • these components for worker management:
    • Sonm Node (provides an external API to interact with the Sonm platform);
    • Sonm CLI (uses Node API to interact with the Sonm platform).

Notice. After installation, Sonm Optimus starts selling your computing resources automatically. You will receive income in SNM tokens on your Master account.

There are three ways to install Sonm components for supplier. Choose the appropriate one for you. We recommend you use Sonm OS.

1. Sonm OS installation from a bootable flash drive

Sonm OS is an operating system designed specifically to help suppliers of computing resources connect to the decentralized Sonm platform and start working as quickly and easily as possible. Sonm OS is based on Ubuntu 18.04 Server Edition and includes all Sonm components and environments for suppliers. To install Sonm OS, follow the guide steps.

2. The auto-installation script

Follow the steps below:

  • Open cmd and execute these commands:

    • sudo apt-get install curl;
    • sudo bash -c "$(curl -s https://raw.githubusercontent.com/sonm-io/autodeploy/master/sonm-auto-deploy-supplier.sh)" -s YOUR_MASTER_ADDRESS
  • After installation, check your token balance to make sure that the Sonm Node is working correctly: sonmcli token balance.
  • Sonm Worker launches several benchmarks upon its initial launch. You can check them and any tasks running on your machine using the command: sudo docker ps.

    Note: Sonm Worker may not respond during the benchmarking process, so you need to wait until its completion. If you have several GPUs on board, the benchmarking process may take about an hour.

  • Confirm that this particular worker belongs to your master via the Sonm Market:
    • check worker address waiting for confirmation using sonmcli master list <MASTER_ADDR>.
    • open Sonm Market, go to "Market” -> “Workers".
    • press "Confirm";
    • enter your master account password.
  • Check your worker confirmation by running sonmcli master list <MASTER_ADDR> again
  • Check your Worker status: sonmcli worker status.
  • Check your Worker resources: sonmcli worker devices.

You may see other CLI commands in Sonm CLI Guide.

Video version of Sonm platform installation using auto-installation script:

3. Manual installation

You may also perform configuration manually:

  • Install Docker CE;
  • Install Sonm components for supplier (Node, CLI, Worker, Optimus):
    • from DEB packages (Debian-based Linux distributions only), or
    • from repository (Debian-based Linux distributions only);
  • Configure Sonm Worker:
    • run sonmcli login to generate new Ethereum address (tthis will create a new UTC/JSON keystore with a given passphrase that will be your 'Admin address');
    • edit the worker configs ('sudo nano /etc/sonm/worker-default.yaml'):
      • set your “Master address” (generated in the Sonm Market) and “Admin address” (locally generated with the Sonm CLI);
      • if you have GPU on worker PC, enable appropriate setting (“nvidia” or “radeon”);
    • start Sonm Worker: sudo service sonm-worker start;
    • edit the node config: sudo nano /etc/sonm/node-default.yaml:
      • set your keystore path for Admin key and passphrase;
    • start Sonm Node: sudo service sonm-node start.
  • Worker will launch and perform hardware benchmarks.
  • Confirm the Worker in the Sonm Market (see the above steps).
  • Configure Sonm Optimus:
    • set the localy installed Sonm Node endpoint ([email protected]:15030)
    • set your worker Ethereum address in the config file: sudo nano /etc/sonm/optimus-default.yaml ([email protected]:15010);
    • start Sonm Optimus: sudo service sonm-optimus start.

View your current stats

After installation, Sonm Optimus starts selling your computing resources automatically. You will receive income in SNM tokens on your Master account.

View your active deals using:

View your current balance in SNM using:

View your current income using:

  • Sonm Market on the top panel (Market stat);
  • Worker status screen (if you installed Sonm OS).

View your resources sold using:

Worker maintenance

Maintenance mode allows you to gracefully shut down your worker for maintenance without the risk of being blacklisted by customers or Connor bots. It will stop your tasks, remove your sell orders from Market, and close all deals automatically. Maintenance mode can be engaged via the maintenance scheduler in the Sonm CLI.

Read this article to use the maintenance mode.

Withdraw tokens

The withdraw operation is needed to transfer your earned tokens from the Sonm blockchain to the Ethereum blockchain.

In the onm CLI use the command: sonmcli token withdraw <amount>.

In the Sonm Market, go to “Market” -> “Withdraw” and follow the guide steps.

Please NOTE

We use special Gate smart contracts and Gatekeeper masternodes to validate transactions for depositing SNM tokens to SONM blockchain and withdrawing them to the main Ethereum network. The transactions are not instantaneous – there are delays:

  • validation of transactions (including transactions to the blockchain) – this depends on the current workload of the main Ethereum network and your transaction settings("gas limit" and "gas price");
  • quarantine period for the gate – 15 minutes.

Taking this into account, the normal time it takes to deposit funds in the respective other blockchain is <the time it takes to mine your transaction + 15 minutes>.

Finding help

If you get stuck, help is always available. We provide you with 24/7 technical support.

If you experience any errors or difficulties with our product, you can get support via:

Please be ready to provide all the required information to help us solve your issue. Check if your Sonm platform components working correctly using our self-check guide.

Also, please write up a step-by-step description of the actions that led to the error and provide us with the command outputs.