Storage DFMS

Storage DFMS

  • Getting Started
  • CLI
  • Guides
  • API Endpoints
  • Help

›Getting Started

Getting Started

  • What is Distributed File Management System (DFMS)?
  • The External Economy
  • Participate

Roles

  • Storage Director Node
  • Storage Replicator Node
  • Supercontract Executor

Built-In Features

    Drive

    • Overview
    • Lifecycle
    • State

    Replicator

    • Overview

    Verifier

    • Overview

    SuperContract

    • Overview
    • Lifecycle
    • State
    • SC files
    • WasmVM

    Challenge

    • Overview

    Rewards

    • Overview

Protocols

  • Cross-block protocol
  • Fair streaming

Algorithms

  • Verification
  • Consensus

Participate

This guide explains what software you need to install and how to start using the Sirius Storage.

Sirius Storage nodes

It's important to understand that there are two types of storage nodes, Client and a Replicator in which the latter can have multiple roles, e.i verifier and executor. This two types are all in the same binary but each has it's own purpose.

  • Storage Drive Node is primarily used by the client to access different Sirius Storage file management commands. This is an intermediary tool to allow users to manage files on Sirius Storage platform which are then pushed (flushed) to replicators.

  • Storage Replicator Node are primarily the replication node where content uploaded by the Sirius Storage node client is propagated. Replicators are inherintly verifiers and executors as well.

Partipcate in the Storage network ecosystem

  • Before running the DFMS node the PubSub lib should be installed. Otherwise, you cannot use the DFMS.

Run a Storage Drive node

In order to run a storage drive node, we need to install the dfms client. There are several ways to do this:

Using docker:

Install docker and git

$ curl -fsSL https://get.docker.com -o get-docker.sh
$ sh get-docker.sh
$ sudo apt install git

Clone the onboarding repository (choose between mainnet and testnet )

$ git clone https://github.com/proximax-storage/sirius-storage-<network>-onboarding.git // testnet
$ cd sirius-storage<network>-onboarding

At this point, we now have the entire binary on your local environment. We now need to run a few commands to properly participate as a Storage drive node.

Go to the onboarding document for further steps:

NetworkLink
Test Networkhttps://github.com/proximax-storage/sirius-storage-testnet-onboarding/blob/master/drive/README.md
Main Networkhttps://github.com/proximax-storage/sirius-storage-mainnet-onboarding/blob/master/drive/README.md

Using command line (available soon)

We can pull the new changes from the go-xpx-dfms repository.

git clone https://github.com/proximax-storage/go-xpx-dfms.git
cd git-xpx-dfms
./install.sh

Run the storage drive node with the generate private key.

$ dfms --key=<your_private_key> // generate key via wallet

For more details about Storage drive node, go to dfms - used by the client (owner);

Run a Replicator Node

In order to run a storage drive node, we need to install the dfmsr.

Using command line (available soon)

We can pull the new changes from the go-xpx-dfms repository.

git clone https://github.com/proximax-storage/go-xpx-dfms.git
cd git-xpx-dfms
./install.sh

Run the storage replicator node with the generate private key.

$ dfmsr --key=<your_private_key> // generate key via wallet

For more details about Storage replicator node, go to dfmsr - used by the client Storage Replicator Node

Note
To get more information about any command and its flags you need to use -h flag, for example dfms contract -h or dfmsr contract -h Both have similar commands to interact with the network. For more details, see the CLI item. Also, see how to connect to the other nodes.

SuperContract

For the correct work with SC a user should install the wabt. This toolkit needed for the correct compilation from *.wat to *.wasm. After instalation it should be added to the $PATH env var. More about wabt you can find by reference.

More commands

More commands are availabe via the links below.

  • For dfms
  • For dfmsr
← The External EconomyStorage Director Node →
  • Sirius Storage nodes
  • Partipcate in the Storage network ecosystem
    • Run a Storage Drive node
    • Run a Replicator Node
    • SuperContract
    • More commands
Storage DFMS
Roles
SDNSRNVerifierSC Executor
Built-in Features
DriveSuperContractChallengeRewards
Protocols
Cross-block protocolFair streaming
Algorithms
VerificationConsensus
CLI
dfms-clientdfms-replicatorsupercontracts
Giudes
ContractDriveSupercontractsNetwork
Copyright © 2021 ProximaX