Welcome to the SmartDrive subnet, a pioneering initiative designed to provide secure and distributed information storage solutions. Our mission is to harness the power of Commune's decentralized incentive markets to deliver robust, reliable, and highly secure storage services at scale.
The subnet operates similarly to a blockchain, with validators serving as the nodes responsible for writing information into blocks, maintaining data redundancy, and ensuring synchronization across the network. Additionally, validators are tasked with rating miners based on their performance. Miners are responsible for the actual storage of information and its final retrieval, ensuring data is available when needed.
SmartDrive is currently in an early stage where runtime errors may occur. However, the information is safe to store, as only the user who uploads it has the ability to access it, though full data persistence and recovery are not yet guaranteed.
- Install Python 3
sudo apt install python3
- Install pip
curl "https://bootstrap.pypa.io/get-pip.py" >> get-pip.py && python3 get-pip.py
- Include this in your PATH
export PATH=$PATH:$HOME/.local/bin
- Install Poetry
pip install poetry
- At the root of the project, activate the Python environment.
poetry shell
- Install the Python dependencies
poetry install
Validators play a crucial role in maintaining the integrity and security of the SmartDrive storage network. Their responsibilities include:
- Distributing Information: Ensuring data is distributed evenly and securely among miners to prevent single points of failure. Validators manage the distribution process to maintain redundancy and reliability.
- Validating Data: Checking the integrity and availability of stored data by validating chunks across miners. This ensures that the data remains consistent and uncorrupted throughout the network.
- Ensuring Availability: Continuously monitoring the network to ensure that data is always accessible and retrievable. Validators perform regular checks to guarantee that all stored data is available for retrieval when needed.
- Incentivizing Miners: Providing rewards to miners based on their performance in storing and maintaining data integrity. Validators assess miners' contributions and distribute rewards accordingly, encouraging high standards of reliability and performance.
Validators need to run continuously to monitor and validate data, ensuring the network remains robust and secure. Their ongoing efforts are critical in maintaining a high standard of data integrity and availability across the SmartDrive subnet.
Truthful validators are responsible for maintaining the duplication of information across the network, sharing blocks, user events, and more. For a validator to vote in line with the information of the subnet, they must be a trusted validator in order to access the information of the user being voted on. To become a trusted validator, it is necessary to hold the stake amount of TRUTHFUL_STAKE_AMOUNT.
- CPU: Dual-core 2.0 GHz
- RAM: 4 GB
- Storage: 100 GB SSD
- Network: High-speed internet connection
- CPU: Quad-core 3.0 GHz
- RAM: 8 GB
- Storage: 100 GB SSD
- Network: High-speed internet connection
- Register the validator on the SmartDrive subnet
comx module register <your-validator-name> <your-commune-key-name> --ip <your-ip-address> --port <port> --netuid <SmartDrive-netuid>
- Launch the validator (at the root of the project)
pm2 start "python3 -m smartdrive.validator.validator --key-name <your-commune-key-name> --port <8001>"
Important
We recommend using a process manager, such as PM2, to keep the validator running without interruption. With our automatic update detection, you won’t need to perform manual updates, as the system will handle version checks, apply updates, and restart the validator automatically.
- In order for the validators to connect to each other, it is necessary to open a TCP port. Since there is no way to know via any metadata associated with each Commune module which TCP port a validator is using, the system currently uses the port specified in the --port parameter plus 1. For example, if a user's --port parameter is set to 8001, they should open TCP port 8002.
Other useful parameters:
- --database-path: Path to the database.
- --port: Default remote api port (Defaults to 8001).
- --testnet: Use testnet or not.
The miner is the muscle of the SmartDrive subnet, playing a crucial role in securely and distributed storing user information. As an essential component of the system, miners ensure that data remains accessible and protected against loss or corruption. Thanks to the miners, the network can offer a robust decentralized storage solution, where data is efficiently distributed across multiple nodes. In addition to storing data, miners are also responsible for maintaining the integrity of the information, quickly responding to requests for data retrieval and removal. In summary, miners provide the physical and operational infrastructure that enables the SmartDrive subnet to operate with security, efficiency, and resilience.
There are no strict requirements in order to run a miner. However, as a miner, you will be rewarded in base on your service processing requests and storing the data.
- Register the miner on the SmartDrive subnet
comx module register <your-miner-name> <your-commune-key-name> --ip <your-ip-address> --port <port> --netuid <SmartDrive-netuid>
- Launch the miner (at the root of the project)
pm2 start "python3 -m smartdrive.miner.miner --key-name <your-commune-key-name> --port <8000>"
Important
We recommend using a process manager, such as PM2, to keep the miner running without interruption. With our automatic update detection, you won’t need to perform manual updates, as the system will handle version checks, apply updates, and restart the miner automatically.
Other useful parameters:
- --data-path: Path to the data.
- --max-size: Size (in GB) of path to fill.
- --port: Default remote api port (Defaults 8000).
- --testnet: Use testnet or not.
- Make sure to serve and register the miner or the validator using the same key.
- If you are not sure about your public ip address:
curl -4 https://ipinfo.io/ip
You can check the current subnet uid running:
comx subnet list
And look for the name SmartDrive
The SmartDrive subnet client allows users to interact with the SmartDrive network using three main commands: store, retrieve, and remove. Below are the instructions on how to use each command.
pip install -e .
The store command allows users to initiate the process of storing data in the subnet. Upon initiating this process, a unique identifier (UUID) is generated and returned. This UUID must be saved by the user for future retrieval or removal of the data. The actual storage of the data will be completed subsequently.
smartdrive store <file-path> --key-name <your-commune-key-name>
IMPORTANT: After executing the store command, save the returned UUID. You will need this UUID to retrieve or remove the stored data later.
The retrieve command allows users to fetch previously stored data using the unique identifier (UUID) provided at the time of storing.
Usage:
smartdrive retrieve <UUID> <output-path> --key-name <your-commune-key-name>
The remove command allows users to delete previously stored data from the subnet using the unique identifier (UUID).
Usage:
smartdrive remove <UUID> --key-name <your-commune-key-name>
We launched the subnet in an initial launch to gauge the community's opinion and support. In this initial launch, the foundation of our subnet will begin to take shape, showcasing its potential and possibilities to the entire community.
Stay tuned!.