Developer Center

Developer Center

  • Getting Started
  • Built-in Features
  • REST API Endpoints
  • Guides
  • Cheat Sheet

›Storage

Getting Started

  • What is Sirius Chain
  • Setting up your workstation
  • Writing your first application

Built-in Features

  • Account
  • Mosaic (SDA)
  • Namespace
  • Transfer Transaction
  • Aggregate Transaction
  • Multisig Account
  • Metadata
  • Account Restriction
  • Cross-Chain Swaps
  • Exchange Market
  • Decentralized Exchange Market
  • Liquidity Provider
  • Storage

Protocol

  • Node
  • Block
  • Cryptography
  • Transaction
  • Validating
  • Consensus Algorithms
  • Receipt
  • Inflation

REST API

  • Overview
  • Tools
  • Serialization
  • Websockets
  • Status Errors

SDKs

  • Overview
  • Architecture
  • Languages
  • Extending Sirius Chain Capabilities
  • SDK Development
  • SDK Documentation

Wallets & Explorers

  • Wallets & Explorers

Cheat Sheet

  • Sirius Chain Cheat Sheet

Guides

  • Overview
  • External Guides
  • Account

    • Creating and opening an account
    • Getting account information
    • Getting the amount of XPX sent to an account
    • Reading transactions from an account

    Account Restriction

    • Preventing spam attacks with account restrictions

    Aggregate Transaction

    • Sending payouts with aggregate-complete transaction
    • Creating an escrow with aggregate bonded transaction
    • Asking for mosaics with aggregate-bonded transaction
    • Signing announced aggregate-bonded transactions

    Block

    • Listening to New Blocks
    • Getting block by height

    Cross Chain Swaps

    • Atomic cross-chain swap between Sirius public and private chains

    Metadata

    • Account Metadata
    • Mosaic Metadata
    • Namespace Metadata
    • Account Metadata (Deprecated since 0.7.0 Sirius Chain release)
    • Mosaic Metadata (Deprecated since 0.7.0 Sirius Chain release)
    • Namespace Metadata (Deprecated since 0.7.0 Sirius Chain release)

    Monitoring

    • Monitor transaction

    Mosaic

    • Creating a mosaic (SDA)
    • Getting the mosaic information
    • Getting the asset identifier behind a namespace with receipts

    Mosaic Levy

    • Modifying Mosaic Supply

    Multisig Account

    • Converting an account to multisig
    • Modifying a multisig account
    • Creating a multi-level multisig-account
    • Sending a multisig transaction

    Namespace

    • Registering a namespace
    • Registering a subnamespace
    • Getting the Namespace information
    • Linking a namespace to a mosaic
    • Linking namespace to account

    Transfer Transaction

    • Transfer transaction
    • Sending an encrypted message

    Storage

    • Data Modification Cancel
    • Data Modification
    • Download Channel
    • Download Payment
    • Drive Closure
    • Finish Download Channel
    • Prepare Bc Drive
    • Replicator Offboarding
    • Replicator Onboarding
    • Storage Payment
    • Verification Payment

Storage

  • Overview
  • Participate
  • External Economy
  • Roles
  • Verification
  • Challenge
  • Rewards
  • Transaction Schemas
  • Built-In Features

    • Drive
    • Replicator
    • Verifier
    • Supercontracts

    Protocols

    • Cross-Block Protocol
    • Fair Streaming

    Storage User Application

    • Overview
    • Getting Started
    • Managing Drives
    • Managing Drive Files
    • Downloading Data

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. This two types are all in the different binary and each has its own purpose.

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

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

Participate in the Storage Sirius network ecosystem

Run a Client node

In a fact Client node it is a native pre-build application (Storage Tool). Web-client will be added in future. You can configure and download it via the reference

Run a Replicator Node

In order to run a replicator node, we need to install the additional tools first. 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 Replicator 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

Run a Replicator Node

In order to run a storage drive node, we need to install the dfmsr. For more details about Replicator Node, follow the reference.

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
← OverviewExternal Economy →
  • Sirius Storage nodes
  • Participate in the Storage Sirius network ecosystem
    • Run a Client node
    • Run a Replicator Node
    • Run a Replicator Node
    • SuperContract
    • More commands
  • Follow our profile
  • Ask development questions
  • Join our Discord channel
  • Explore our Youtube channel
  • Explore Github
Protocol
BlockConsensus AlgorithmsCryptographyInflationNodeReceiptTransactionValidating
Built-in Features
AccountAggregate TransactionCross-Chain SwapsExchange MarketDecentralized Exchange MarketMetadataMosaicMultisig AccountNamespaceTransfer TransactionStorageLiquidity Provider
References
REST APISDKsCheat Sheet
Includes Documentation Forked from NEM
Copyright © 2025 Sirius Chain