To get started with the shdwDrive CLI:

1. Install NodeJS LTS 16.17.1

2. Install the shdwDrive CLI

3. Follow the CLI Guide

   • After installing Solana, make sure you have both SHDW and SOL in your wallet in order to reserve storage.

To get started with the shdwDrive SDKs:

1. JavaScript, Rust, and Python are your choices.

2. Follow the SDK Guide

   • You can build directly on top of the API.

Submitting Bugs & Security Issues

https://github.com/GenesysGo/shdw-drive-bug-reports

We adhere to a responsible disclosure process for security related issues. To ensure the responsible disclosure and handling of security vulnerabilities, we ask that you follow the process outlined below.

Bug Reporting Process

1. For non-security-related bugs, please submit a new bug report here. For security-related reports, please open a "security vulnerability" report here.

2. Please provide a clear and concise description of the issue, steps to reproduce it, and any relevant screenshots or logs.

Important: For security-related issues, please include as much information as possible for reproduction and what its related to. Please be sure to use the report a security vulnerability feature in the repository listed above. If you submit a security vulnerability as a public bug report, we reserve the right to remove the report and move any communications to private channels until a resolution is made.

Security related issues should only be reported through this repository.

While we strongly encourage the use of this repository for bug reports and security issues, you may also reach out to us via our Discord server. Join the #shdw-drive-technical-support channel for assistance. However, please note that we will redirect you to submit the bug report through this GitHub repository for proper handling and tracking.

Twitter: https://twitter.com/genesysgo

Discord: https://discord.com/invite/shdwdrive

Blog: https://shdwdrive.com/blog

Our SDK options provide the simplest means of linking your application to shdwDrive. With a variety of environments to choose from, developers can enjoy a robust and constantly evolving platform that leverages the full potential of shdwDrive. GenesysGo is dedicated to maintaining these SDKs, continuously enhancing developer capabilities, and streamlining the building process. We value your feedback and welcome any suggestions to help us improve these valuable resources.

Download shdwDrive:

Direct Download | App Store Link (coming soon) | Play Store Link (coming soon)

Reimagining Cloud Storage

shdwDrive v2 transforms cloud storage into a decentralized ecosystem where users can not only store their files securely but also participate in and earn from the network. Our platform eliminates traditional centralized storage providers, replacing them with a community-driven network where everyone can contribute and benefit.

What Makes shdwDrive Different?

shdwDrive creates a marketplace where:

• Users get reliable, secure decentralized storage

• SHDW tokens allows shdwOperators to provide storage capacity

• The community shapes the network's future

• Everyone benefits from transparent, mathematically-proven fairness

• Read about shdwDrive v2 Economics

Want to dive deeper into how shdwDrive works? Check out our technical deep dive to learn about the network's economic model, proof systems, and mathematical foundations that ensure fair rewards for all participants.

How this resource is organized

Guides

Your complete resource for using shdwDrive v2 – whether you're storing files or earning rewards as a network operator. Now that we have launched our latest technology, stay tuned for frequent updates to our guides!

Build

This section is being re-designed as we support the latest shdwDrive v2! What remains are previous versioning guides that focus on easy and actionable information to help you quickly get started building on the previous version 1.5 (soon deprecated) shdwDrive. Step by step guides, and line by line CLI instruction offer developers the quickest path to working concepts.

Reference

Much like an appendix, the reference section is a quick navigation hub for key resources. Our media kit, social media presence, and more can be found here.

Bugs and Feedback

This resource will be updated frequently and the developer community should feel empowered to submit Issues for edits they would like to see or platform enhancement ideas. We also have a process for Bug submissions.

In order to use the S3-Compatible gateway for the shdwDrive network, head over to , connect your wallet and sign in, and then navigate to the storage account you'd like to generate an access key/secret key pair. Select the "Addons" tab and then you'll be able to enable & add s3-compatible key/secret pairs.

Obtaining your credentials

Once you've enabled the S3 Access addon for a given storage account, you can view and add more s3-compatible key/secret pairs by navigating to the storage account of your choosing on .

To get your credentials, simply click "View Credentials".

Permissions

Once enabled, you can manage individual permissions of each key/secret pair you generate for a given storage account. The list of permissions are configured to be compatible with existing s3 clients. Some examples of compatible s3 clients are rclone, s3cmd, and even the aws s3 cli. There's a plethora of tooling that exists for s3-compatible gateways, which is why we chose to build this into the shdwDrive network.

In general, if you want to enable uploads with one of your keys, you'll need to enable the following permissions:

You can also control if a key is able to read, which allows you to have read, write, and read+write keys for various use cases.

Gateway endpoints

In order to access the s3 compatible gateways on the shdwDrive network, you'll need to configure your s3 client to use one of the following gateways:

1. https://us.shadow.cloud

2. https://eu.shadow.cloud

These endpoints proxy requests to the shdwDrive network and allows you to have the best network connectivity possible given your geographical preference. All uploads are synced and available globally, so you can use either endpoint.

Example client configurations

RCLONE

The following is an example that you can add to your rclone configuration file. Typically, this is located in `~/.config/rclone/rclone.conf`.

Speed

In order to ensure the stability of the shdwDrive network, speeds are initially limited to 20 MiB/s. You can opt to upgrade the bandwidth rate limit for each individual key/secret pair you generate. The upgraded rate limit is 40 MiB/s

Security

In the event a s3 key has been compromised, you can easily rotate the key. Simply navigate to , connect your wallet, select a storage account, and then click on the "Addons" tab. From there, you can click "Rotate" button to rotate a given key/secret pair to generate a fresh pair.

Download shdwDrive:

| Solana App Store Link (coming soon) | Play Store Link (coming soon)

Getting Started is Simple

As a User:

1. the shdwDrive mobile app

2. Connect your Solana wallet

3. Choose a storage plan (start with 5GB free!)

4. Create your first bucket

5. Start uploading your files securely

As an Operator:

1. the shdwDrive mobile app

2. properly

3. Navigate to the Operator tab

4. Select your storage level

5. Acquire a valid

6. Connect your shdwNode!

As a Developer:

1. - integrate shdwDrive in your app

Need specific information? Jump to:

• - New to shdwDrive? Start here

• - Learn how to participate in the network

• - integrate shdwDrive with your app

• - Dive into the network architecture

• - Dive deeper into how the protocol works

Have questions? Our comprehensive sections below cover everything you need to know about using and operating on shdwDrive v2. Have feedback? Let us know .

Getting Started

Prerequisites: Install on any OS.

Then run the following command

Next steps

• After you install ShdwDrive, learn how to use the .

• If you prefer, here is a step by step .

• Further streamline your integrations with ShdwDrive using the and .

Get Support

• Review the

• Visit us in for support and feedback!

Submitting Bugs

We adhere to a responsible disclosure process for security related issues. To ensure the responsible disclosure and handling of security vulnerabilities, we ask that you follow the process outlined below.

Bug Reporting Process

1. For non-security-related bugs, please submit a new bug report . For security-related reports, please open a "security vulnerability" report .

2. Please provide a clear and concise description of the issue, steps to reproduce it, and any relevant screenshots or logs.

Important: For security-related issues, please include as much information as possible for reproduction and what its related to. Please be sure to use the report a security vulnerability feature in the repository listed above. If you submit a security vulnerability as a public bug report, we reserve the right to remove the report and move any communications to private channels until a resolution is made.

Security related issues should only be reported through this repository.

While we strongly encourage the use of this repository for bug reports and security issues, you may also reach out to us via our server. Join the #shdw-drive-technical-support channel for assistance. However, please note that we will redirect you to submit the bug report through this GitHub repository for proper handling and tracking.

Discover benefits and use cases of ShdwDrive:

about why ShdwDrive is growing so quickly and what makes it a strong product market fit.

shdwDrive

Support

Social Media

Media Kit

• Install Python SDK

• Examples

• Github

• Methods

Installing ShdwDrive

pip install shadow-drive

Also for running the examples:

pip install solders

Check out the examples directory for a demonstration of the functionality.

https://shdw-drive.genesysgo.net/[STORAGE_ACCOUNT_ADDRESS]

Example - Create Account, File Upload, Add or Reduce Storage, and Delete Account using Python

from shadow_drive import ShadowDriveClient
from solders.keypair import Keypair
import argparse

parser = argparse.ArgumentParser()
parser.add_argument('--keypair', metavar='keypair', type=str, required=True,
                    help='The keypair file to use (e.g. keypair.json, dev.json)')
args = parser.parse_args()

# Initialize client
client = ShadowDriveClient(args.keypair)
print("Initialized client")

# Create account
size = 2 ** 20
account, tx = client.create_account("full_test", size, use_account=True)
print(f"Created storage account {account}")

# Upload files
files = ["./files/alpha.txt", "./files/not_alpha.txt"]
urls = client.upload_files(files)
print("Uploaded files")

# Add and Reduce Storage
client.add_storage(2**20)
client.reduce_storage(2**20)

# Get file
current_files = client.list_files()
file = client.get_file(current_files[0])
print(f"got file {file}")

# Delete files
client.delete_files(urls)
print("Deleted files")

# Delete account
client.delete_account(account)
print("Closed account")

About the Github Repo

This package uses PyO3 to build a wrapper around the official ShdwDrive Rust SDK. For more information, see the Rust SDK documentation.

Methods

Section under development.

Full Detail - Version Releases & Fixes:

Consolidated Summary

D.A.G.G.E.R. - Launch of - January 16th

D.A.G.G.E.R. - Launch of - September 29, 2023

shdwDrive - Release S3 Compatible Gateway - August 29, 2023

shdwDrive

shdwDrive Rust

shdwDrive

shdwDrive

Apr 5, 2023- shdwDrive Rust

Mar 16, 2023 - shdwDrive

Mar 15, 2023 - shdwDrive Rust

Feb 28, 2023 - shdwDrive Rust

Feb 27, 2023 - shdwDrive CLI

Feb 27, 2023 - shdwDrive

Feb 27, 2023 - shdwDrive

Feb 9, 2023 - shdwDrive

Feb 8, 2023 - shdwDrive

Feb 9, 2023 - shdwDrive CLI

Dec 13, 2022 - shdwDrive CLI

Nov 28, 2022 - shdwDrive

Nov 28, 2022 - shdwDrive

Sep 22, 2022 - shdwDrive CLI

Sep 22, 2022 - shdwDrive CLI

Sep 22, 2022 - shdwDrive CLI

Sep 21, 2022 - shdwDrive CLI

Sep 21, 2022 - shdwDrive

Sep 21, 2022 - shdwDrive

Sep 21, 2022 - shdwDrive CLI

Aug 26, 2022 - Digital Asset RPC Infrastructure

Jul 26, 2022 - shdwDrive

Jul 22, 2022 - shdwDrive

Jul 12, 2022 - shdwDrive

Jul 8, 2022 - shdwDrive

Contents

shdwDrive SDK

• Installation

• Local Development

• Features

• Quick Start

• Usage Examples

• API Reference

shdwDrive CLI

• Features

• Installation

• Configuration

• Usage

• Development

shdwDrive SDK

shdwDrive SDK is a typeScript SDK for interacting with ShdwDrive, providing simple and efficient methods for file operations on the decentralized storage platform.

Installation

# Install from npm
npm install @shdwdrive/sdk

# Or install from repository
git clone https://github.com/GenesysGo/shdwdrive-v2-sdk.git
cd shdwdrive-v2-sdk
npm install
npm run build

Local Development

cd shdwdrive-v2-sdk
npm link
cd your-project
npm link @shdw-drive/sdk

Features

• 📤 File uploads (supports both small and large files)

• 📥 File deletion

• 📋 File listing

• 📊 Bucket usage statistics

• 🗂️ Folder creation and management

• 🔐 Secure message signing

• ⚡ Progress tracking for uploads

• 🔄 Multipart upload support for large files

Quick Start

import ShdwDriveSDK from '@shdwdrive/sdk';
// Initialize with wallet
const drive = new ShdwDriveSDK({}, { wallet: yourWalletAdapter });
// Or initialize with keypair
const drive = new ShdwDriveSDK({}, { keypair: yourKeypair });

Usage Examples

Upload a File

const file = new File(['Hello World'], 'hello.txt', { type: 'text/plain' });
const uploadResponse = await drive.uploadFile('your-bucket', file, {
  onProgress: (progress) => {
    console.log(`Upload progress: ${progress.progress}%`);
  }
});
console.log('File uploaded:', uploadResponse.finalized_location);

Create a Folder

const folderResponse = await drive.createFolder('your-bucket', 'folder-name');
console.log('Folder created:', folderResponse.folder_location);

Delete a Folder

const deleteFolderResponse = await drive.deleteFolder('your-bucket', 'folder-url');
console.log('Folder deleted:', deleteFolderResponse.success);

List Files

const files = await drive.listFiles('your-bucket');
console.log('Files in bucket:', files);

Delete a File

const deleteResponse = await drive.deleteFile('your-bucket', 'file-url');
console.log('Delete status:', deleteResponse.success);

API Reference

ShdwDriveSDK

Constructor Options

interface ShdwDriveConfig {
  endpoint?: string; // Optional custom endpoint (defaults to https://v2.shdwdrive.com)
}

// Initialize with either wallet or keypair
new ShdwDriveSDK(config, { wallet: WalletAdapter });
new ShdwDriveSDK(config, { keypair: Keypair });

Methods

• uploadFile(bucket: string, file: File, options?: FileUploadOptions)

• deleteFile(bucket: string, fileUrl: string)

• listFiles(bucket: string)

• getBucketUsage(bucket: string)

• createFolder(bucket: string, folderName: string)

• deleteFolder(bucket: string, folderUrl: string)

shdwDrive CLI

A command-line interface for interacting with shdwDrive storage.

Features

• 📤 File uploads (supports both small and large files)

• 📁 Folder support (create, delete, and manage files in folders)

• 📥 File and folder deletion

• 📋 File listing

• 📊 Bucket usage statistics

• 🔐 Secure message signing

• 🔄 Multipart upload support for large files

Installation

You can install the CLI globally using npm:

npm install -g @shdwdrive/cli

Or use it directly from the repository:

git clone https://github.com/genesysgo/shdwdrive-v2-cli.git
cd shdwdrive-v2-cli
npm install
npm run build
npm link

Configuration

The CLI uses environment variables for configuration:

• SHDW_ENDPOINT: The shdwDrive API endpoint (defaults to https://v2.shdwdrive.com)

Usage

Upload a file

shdw-drive upload \
  --keypair ~/.config/solana/id.json \
  --bucket your-bucket-identifier \
  --file path/to/your/file.txt \
  --folder optional/folder/path

Delete a file

# Delete a file from root of bucket
shdw-drive delete \
  --keypair ~/.config/solana/id.json \
  --bucket your-bucket-identifier \
  --file filename.txt

# Delete a file from a folder
shdw-drive delete \
  --keypair ~/.config/solana/id.json \
  --bucket your-bucket-identifier \
  --file folder/subfolder/filename.jpg

Create a folder

shdw-drive create-folder \
  --keypair ~/.config/solana/id.json \
  --bucket your-bucket-identifier \
  --name my-folder/subfolder

List files in a bucket

shdw-drive list \
  --keypair ~/.config/solana/id.json \
  --bucket your-bucket-identifier

Check bucket storage usage

shdw-drive usage \
  --keypair ~/.config/solana/id.json \
  --bucket your-bucket-identifier

Command Options

Upload Options

• -k, --keypair - Path to your Solana keypair file

• -b, --bucket - Your bucket identifier

• -f, --file - Path to the file you want to upload

• -F, --folder - (Optional) Folder path within the bucket

Delete Options

• -k, --keypair - Path to your Solana keypair file

• -b, --bucket - Your bucket identifier

• -f, --file - URL or path of the file to delete

Create Folder Options

• -k, --keypair - Path to your Solana keypair file

• -b, --bucket - Your bucket identifier

• -n, --name - Name/path of the folder to create

Delete Folder Options

• -k, --keypair - Path to your Solana keypair file

• -b, --bucket - Your bucket identifier

• -p, --path - Path of the folder to delete

Development

1. Clone the repository:

git clone https://github.com/genesysgo/shdwdrive-v2-cli.git

1. Install dependencies:

cd shdwdrive-v2-cli
npm install

1. Build the project:

npm run build

1. Link the CLI locally:

npm link

Contents

Getting Started

• What is shdwDrive?

• Basic Setup

• Storage Plans

Becoming an Operator

• Understanding Operators

• Requirements & Setup

• Node Operation

• Join Tickets

Technical Details

• Understanding Logs

• Network Architecture

• Troubleshooting

Revenue & Operations

• Storage & Network Participation

• Account Management

• Support & Maintenance

Getting Started

What is shdwDrive?

shdwDrive is a decentralized mobile storage platform that allows you to store files securely while also providing opportunities to participate in the network as an operator.

Basic Setup

Q: How do I start using shdwDrive? A: Getting started is simple:

1. Download and install the shdwDrive mobile app on your Android device

2. Connect your wallet

3. Create a storage bucket or choose a storage plan

4. Begin uploading your files

Q: Do I need a specific wallet to use shdwDrive? A: Yes, shdwDrive requires a Solana-compatible wallet. The app will guide you through connecting your preferred wallet during setup.

Q: What happens after I connect my wallet? A: After connecting your wallet, you'll be guided through:

1. A brief onboarding process

2. Options to create storage space

3. Access to the main dashboard where you can manage files and operator settings

Q: What is a bucket? A: A bucket is your personal storage space on shdwDrive where you can store and organize your files. Think of it as your private folder in the decentralized network.

Q: How do I create a bucket? A: To create a bucket:

1. Open the shdwDrive app

2. Look for the "Create Bucket" button on the home screen

3. Follow the prompts to set up your new storage space

Q: Is there an iOS app? A: No, not at this time. Android dominates global market share with approximately 70-75% of all smartphones worldwide, while iOS (iPhone) accounts for about 25-30%. We will complete the majority of our feature rollout on Android first, refining the user and operator experience, before moving to support the iOS device family.

Q: Why do I need to authorize each file upload separately? A: Currently, each file upload requires a separate authorization through your wallet for security purposes. This is an intentional security feature that:

• Ensures proper authorization of all file operations

• Prevents unauthorized bulk uploads

• Maintains a clear record of file ownership

• Protects your data and storage space

• Allows you to monitor and control your storage usage

• Enables us to better iterate the rolling out of more robust handling

Q: Can I upload multiple files at once? A: At this time, files must be uploaded individually. Each upload requires:

• Selecting the file

• Authorizing the transaction through your wallet

• Waiting for confirmation This process ensures proper tracking and verification of each file upload. Future updates will be introduce batch upload features while maintaining security standards.

Q: What happens if my upload is interrupted? A: If an upload is interrupted:

• The partial upload is automatically cancelled

• No storage space is consumed

• No transaction fee is charged

• You can simply restart the upload Always ensure a stable connection when uploading larger files.

Storage Plans

Q: Is there a free storage option? A: Yes, shdwDrive offers a free 5GB storage plan to get started.

Q: What can I store in shdwDrive? A: You can store various file types including:

• Photos and images

• Documents

• Videos

• Custom folders and file structures

Q: Can I see how much storage I'm currently using? A: Yes, the app displays:

• Your current storage usage

• Available space in your bucket

• Storage contribution level (if you're an operator)

• Visual indicators of space usage

• Standard Android app level information is also accessible

Becoming an Operator

Understanding Operators

Q: What is a shdwDrive Operator? A: A shdwDrive Operator contributes storage space from their Android device to the decentralized network. Operators provide real utility by making their device's unused storage available for secure file storage.

Q: What are the benefits of becoming an operator? A: As an operator, you:

• Earn real revenue in USDC from user storage fees (in future releases)

• Participate in a decentralized storage network

• Contribute to network infrastructure

• Receive programmatic revenue sharing based on your contribution

Q: What's the difference between being a storage user and an operator? A: Key differences:

• Users pay for storage services in USDC

• Operators provide storage capacity to the network

• SHDW tokens serve as operator collateral

• Operators earn revenue from actual storage fees

Requirements & Setup

Q: What do I need to become an operator? A: To become an operator, you need:

• An Android device (version 12.0L or higher)

• Sufficient free storage space (minimum varies by contribution level)

• Stable internet connection (WiFi required at this time)

• A "Join Ticket" for network access

• SHDW tokens for network collateral

• Proper settings for the Android OS and app

Q: What are the recommended device requirements to run shdwDrive? A: To run shdwDrive effectively, your device should meet these specifications:

• Android 12L or newer

• Minimum 6 CPU cores

• At least 8GB RAM

• Sufficient free storage space for your chosen contribution level

Q: Which devices are supported? A: Here's a non-comprehensive list of compatible devices:

Premium/Flagship Devices

• Google Pixel: 7, 7 Pro, 8, 8 Pro, 9, 9 Pro

• Samsung Galaxy S: S22/+/Ultra, S23/+/Ultra, S24/+/Ultra

• OnePlus: 10 Pro, 10T, 11, 11R

• ASUS ROG Phone: 6, 6 Pro, 7, 7 Ultimate

• Nothing Phone: 1, 2

• Xiaomi POCO: X6, X6 Pro

Mid-Range Devices

• Google Pixel a-series: 6a, 7a

• Samsung Galaxy A-series: A53 5G, A54 5G

• OnePlus Nord: N20, N200

• Motorola Edge (2022, 30)

Specialty Devices (minimum storage spec)

• Solana Saga

• Seeker

Q: Can I run shdwDrive on older devices? A: No. While older devices might run the app, we recommend meeting the minimum specifications for optimal performance and reliability. Devices that don't meet these specs may experience:

• Slower proof generation

• Reduced storage efficiency

• Reduced revenue potential

• Potential stability issues

• Eventual slashing and malice tracking in the global view manager

Q: Can I operate multiple nodes with the same wallet? A: No. Each wallet can only operate one node at a time. This means:

• One wallet can only stake to one node

• If you want to run multiple nodes, you'll need separate wallets for each

• When switching devices, you must fully deactivate your current node before setting up the new one with the same wallet. Unstake before deactivating means waiting one Solana epoch before being able to withdraw.

• When changing your storage allocation (therefore stake allocation), you must fully unstake, wait the cooldown of one Solana epoch, and restake up to your desired allocation.

Q: What if I want to switch my node to a different device? A: To switch devices:

• First deactivate and unstake on your current device

• Wait the cooldown and complete the withdrawal process

• Set up the new device using the same wallet, remembering only one wallet per one node

• Stake and activate your new node

Remember: Never try to run nodes on multiple devices with the same wallet as this can cause conflicts and operational issues at this time.

Q: How much storage can I contribute? A: Storage contribution levels are based on 1 SHDW per ~51.2MB. Choose based on your device's available storage, with buffer for critical system, and desired SHDW stake level.

Q: Why doesn't my device's full storage capacity show as available? A: Available storage is affected by several factors:

• System files and OS requirements consume a portion of your total storage

• Existing apps and data reduce available space

• Android reserves space for system operations and updates

• The app maintains a safety buffer to ensure stable operation

For example, a 512GB device might show only 400GB as available because:

• Android OS and pre-installed apps use ~50GB

• System reserves ~30GB for updates and cache

• Your personal apps and data use a portion

• A safety margin is maintained for optimal performance

The app shows only safely usable storage capacity to ensure reliable node operations.

Q: Are external storage options such as Micro SD cards supported? A: Not at this time. While we have tested this feature and confirmed it to work, there is more work needed to ensure the shdwDrive runtime plays nice with how Android OS manages peripheral user storage.

Node Operation

Q: How do I pass verification to join the network? A: Use one of our many Join Ticket:

Ticket1:

XHGA5LRCCKLCCAW3KCDU44SHKJEQFXZEYYKGS43BJRLSQV2ALH2QCAAB6X6SVVUSV32H6KQ4M7BNEMGCR4XTSVZTE4GBTEJQUZSJ7UTGKEJQBOE2MJ6AIAFQ5IAQDMXKAEBLJ2QBAO3OUAI=

Ticket2:

XHGA5LRCCKLCCAW3KCDU44SHKJEQFXZEYYKGS43BJRLSQV2ALH2QCAABEW6OOCQO7EMA7JKC6PQSK274ZBATDSWD2V7LJ6EA5BBCVN6HTF3QAL5ZVNGQCAEU5MAQ====

Ticket3:

XHGA5LRCCKLCCAW3KCDU44SHKJEQFXZEYYKGS43BJRLSQV2ALH2QCAABSU42N6PY6HFGSVBHDU7AOGSDUBY3KBCM3RQGNMVU7VNJWTF5TGFQAL5ZVNGQCAE65MAQ====

Ticket4:

XHGA5LRCCKLCCAW3KCDU44SHKJEQFXZEYYKGS43BJRLSQV2ALH2QCAABMI3Z7RMH4XD72UMXHBTRXXV2GGWJP75WYIFSBB5WSLZVBJADC5JAAL5ZVNGQCAFI5MAQ====

Ticket5:

XHGA5LRCCKLCCAW3KCDU44SHKJEQFXZEYYKGS43BJRLSQV2ALH2QCAABE34WB2TIQREIRXJRM6YUS2VS26BNDCO57HR3TBREHWNIK4O77MHAAL5ZVNGQCAFS5MAQ====

Ticket6:

XHGA5LRCCKLCCAW3KCDU44SHKJEQFXZEYYKGS43BJRLSQV2ALH2QCAAB7VYWWCU2O7S4QRMICVTDZNSUHV5B75F6XYHND4QKKSVTELF4F3FAAL5ZVNGQCAF45MAQ====

Ticket 7:

XHGA5LRCCKLCCAW3KCDU44SHKJEQFXZEYYKGS43BJRLSQV2ALH2QCAABIKUOVHCXUM45VSK6URD5KE3JJXAIQNSR65I5YC552CBRRAG6NMGQAL5ZVNGQCAGG5MAQ====

Q: How do I manage my node? A: The Operator section of the app provides:

• Node On/Off toggle

• Current storage contribution level

• Network connection status

• Monitor logs

• Maintain good WiFi connection

Q: What does the operator interface show me? A: The operator interface displays:

1. Current Status:

   • Storage Level: Your contributed storage amount

   • SHDW Collateral: Current network security deposit

2. Node Controls:

   • "Deactivate & Release Collateral" button: Stops node operation

   • "Withdraw" button: Retrieves your SHDW collateral after cooldown

   • Node On/Off toggle: Controls active participation

3. Configuration:

   • Gossip Ticket: Network access credential

   • RPC Endpoint: Network connection point

4. Node Information:

   • Node ID: Your unique identifier

   • Backup Key: Recovery information

Q: What happens when I toggle my node on? A: When you toggle your node on:

1. The app verifies your WiFi connection

2. Connects to the network using your gossip ticket

3. Begins participating in network operations

4. Starts monitoring for storage requests Note: A stable WiFi connection is required to start your node

Q: What should I check before starting my node? A: Before toggling your node on, ensure:

1. You have a stable WiFi connection

2. Your gossip ticket is properly entered

3. The RPC is pre-filled correctly with an endpoint

4. Your device is charged or plugged in

5. You have sufficient free storage space

Q: Can I run my node while using mobile data? A: Not at this time, but soon. Your node requires a WiFi connection to:

• Maintain stable network connections

• Ensure efficient data transfer

• Reduce mobile data usage

• Provide consistent network participation The node will automatically stop if WiFi connection is lost.

Q: What is a Gossip Ticket? A: A Gossip Ticket is your node's access credential for joining the network. It contains necessary information for establishing secure connections with other nodes.

Q: What are the storage fragments I see in my Downloads folder? A: These are secure storage units that your device uses to participate in the network. Each fragment (fragment.000, fragment.001, etc.) contains portions of the distributed storage system. Don't delete these manually - the app manages them automatically.

Q: What's the process for changing my storage/stake level? A: Currently, changing levels requires:

1. Deactivating your current node

2. Unstaking your SHDW tokens

3. Completing the withdrawal process

4. Reactivating with your new desired storage level Direct storage updates are not supported - you must go through the full deactivation process.

Q: Are there staking time requirements? A: Yes, there are important timing considerations:

• Initial stake requires a warmup period (one Solana epoch)

• Unstaking requires a cooldown period (one Solana epoch)

• You cannot deactivate/unstake during the warmup period

• Revenue can be claimed once per 24-hour period

• Withdrawal is only available after the cooldown period completes

Q: What if I want to switch to a different device? A: When switching devices:

1. Wait for your initial stake warmup period to complete

2. Deactivate and unstake on your current device

3. Wait for the cooldown period to complete

4. Withdraw your SHDW tokens

5. Set up the new device with the same wallet

6. Stake and activate your new node

Technical Details

Understanding Logs

Q: How do I access and share node logs? A: Logs can be accessed through:

1. The "View Logs" section in the operator dashboard

2. Use "Copy Logs" to copy to clipboard

3. Use "Send Logs" to share with support

Q: What are the key log message types?

Network Status Messages

• Global View Updates:

  Copy

  ├─ 🌐 Global Consensus View
  ├─ peers: [number]
  └─ Network Messages: [number]

  Shows network-wide state synchronization.

• Event Processing:

  Copy

  ├─ Events Received
  └─ Network Messages: [number]

  Indicates successful message processing.

• Network Maintenance:

  Copy

  ├─ ✂️ Cleanup
  └─ Network Msgs: [number]

  Shows network optimization activities.

Peer Management Messages

• Join Operations:

  Copy

  ├─ 🌐 Join
  └─ Proof: [true|false]

  Indicates new peer verification.

• Synchronization:

  Copy

  ├─ 🔄 Recieved Peer Sync
  └─ Network Messages: [number]

  Shows peer data synchronization.

• Network Updates:

  Copy

  ├─ ⚙️ Network Update
  ├─ Active: [number]
  └─ Pending: [number]

  Displays connection status changes.

Q: What are Storage Proof logs? A: Storage Proof logs demonstrate that your node is actively storing and validating data as part of the decentralized network. These logs confirm that your node is fulfilling its role in maintaining data integrity. A typical storage proof log entry may look like this:

└─ CID: Hash("ab3f875881b3c9c04e3ee73f9a7fb1afac4466ba246e6da2d664cde23a4ef7d8")
├─ Operation: Generate
[INFO] shdw_dht::dht_gossip: Storage Proof

Each entry shows:

• A CID (Content Identifier) that uniquely identifies the data chunk.

• The Operation performed (e.g., Generate).

• A log message indicating that a Storage Proof has been processed.

Note: Not every node will necessarily display storage proof logs. Whether or not these logs appear depends on the node’s active/passive view and the network topology—that is, whether your node is selected to participate in the storage proof process as part of the active set.

Q: What indicates healthy node operation?

Normal Operation Patterns

1. Regular Network Activity:

   • Regular "Events Received" messages

   • Incrementing "Network Messages" count

   • Periodic "Global Consensus View" updates

2. Healthy Connection Status:

   • Stable or growing active edges

   • Low pending connection counts

   • Regular shuffle cycles

   • Successful peer syncs

3. Network Participation:

   • Regular cleanup operations

   • Periodic shuffle cycles

   • Consistent message processing

   • Stable peer count in consensus view

Warning Signs

• Network Messages not incrementing

• Frequent "Disconnect" messages with "unhealthy" status

• High number of pending connections

• No Global Consensus View updates

• Frequent connection status changes

• Missing periodic cleanup operations

Troubleshooting

Q: Why won't my node connect? A: Common issues and solutions:

• Check WiFi connection stability

• Ensure Gossip Ticket is correct

• Confirm device has sufficient storage

• Check for any system power restrictions

• Confirm proper port forwarding (30000-60000) and that you are not behind a restrictive firewall

Q: What do I do if I see error messages? A: Common errors and fixes:

• "Permission denied": Check app storage permissions

• "Node disconnected": Check internet connection

• "Storage allocation failed": Verify free space

Q: Why did my node automatically turn off? A: Your node may automatically stop if:

1. WiFi connection is lost

2. Device battery is critically low

3. Available storage drops below required level

4. Network connection becomes unstable

5. You run too low on memory

6. You swipe the app out of your active list, thereby hard closing it

7. You approve an Android system update that reboots your connections

Q: How do I diagnose connection issues using logs?

Initial Connection Problems

1. Network Status:

   Copy

   ├─ 🌐 graph edges=2 pending=1

   If edges are 0 or pending stays high, check:

   • Internet connection

   • Router UPnP settings

   • Port forwarding (30000-60000)

   • Firewall restrictions

2. Peer Connection Issues:

   Copy

   ├─ 🌐 Peer Disconnected
   ├─ Active: 1
   └─ Pending: 2

   High pending counts indicate connection problems. Check:

   • Router settings

   • Network restrictions

   • Gossip ticket validity

Ongoing Operation Issues

1. Network Isolation Signs:

   Copy

   ├─ Events Received
   └─ Network Messages: [not incrementing]

   Solutions:

   • Verify gossip ticket

   • Check network configuration

   • Restart node if persistent

2. Connection Quality Issues:

   Copy

   ├─ 🌐 Disconnect
   └─ Status: unhealthy

   Indicates:

   • Network instability

   • Connection timeouts

   • Possible firewall issues

Additional Note on Storage Proof Logs: While storage proof logs are a key indicator that your node is actively contributing to data storage and validation, their absence does not imply a problem. Depending on your node’s current role (active versus passive) and the overall network topology, you might not see these logs—even when your node is operating normally. As long as you observe the other critical indicators of network health (such as regular event updates and stable connection metrics), your node is functioning as expected.

Q: What should I do if my node automatically stops? A: Common causes and solutions:

1. Connection Loss:

   • WiFi disconnection

   • Network configuration changes

   • Router reboots Solution: Restore stable network connection

2. Device Issues:

   • Critical battery level

   • Insufficient storage

   • Memory constraints

   • App forced close Solution: Address resource constraints

3. System Changes:

   • Android OS updates

   • Security policy changes

   • Power management interventions Solution: Reconfigure after system changes

Q: What should I do if my app becomes unresponsive or stuck at loading? A: If your app becomes unresponsive or stuck follow these recovery steps:

1. Initial Recovery Steps:

   • Backup your node key if possible

   • Preserve the shdwDrive folder in Downloads

   • Uninstall the app

   • Install the latest version

   • Connect using your original wallet

2. Post-Installation Process:

   • The app will automatically show your existing stake status (stored on-chain)

   • You MUST complete the unstake process before creating a new stake:

     • Click "Deactivate & Unstake"

     • Wait for the cooldown period

     • Use "Withdraw" to claim your tokens

     • Only then proceed with new stake creation

3. Important Considerations:

   • Never attempt to create a new stake without unstaking first

   • Your original stake is accessible on-chain as long as you use the same wallet

   • Future versions will support direct node ID keypair restoration

   • New stake will generate a new node ID

4. Recovery Timeline:

   • Unstaking cooldown: One Solana epoch

   • Withdrawal availability: After cooldown

   • New stake activation: After withdrawal

5. Warning Signs During Recovery:

   • If your active stake doesn't appear after reinstall

   • If you see multiple stake positions

   • If unstake option isn't available Stop all operations and contact support immediately

Note: We are working on implementing direct node ID keypair restoration functionality for smoother recovery in future updates.

Revenue & Operations

Storage & Staking

Q: How does the revenue model work? A: The revenue model is based on real utility:

• Users pay storage fees in USDC

• Fees are distributed to operators based on contribution

• Revenue sharing is tied to actual storage provision

• No artificial token rewards or inflation

• Read more here

Q: What is the purpose of SHDW tokens? A: SHDW tokens serve specific functions:

• Act as network collateral for operators

• Enable slashing for malicious behavior

• Support network security

• Not designed for speculative value or rewards

Q: How do I navigate the operator staking interface? A: The operator interface can be accessed through the Operator tab in the bottom navigation bar. Here you'll find:

• Current Node Level and SHDW Staked amounts at the top

• Deactivate & Unstake button for stopping your node

• Withdraw button for accessing staked tokens after cooldown

• Node On/Off toggle for controlling node operation

• Node ID and Backup Key options

• Gossip Ticket and RPC Endpoint configuration

Q: How do I check my current stake and storage levels? A: Your current status is displayed at the top of the Operator screen showing:

• Current Node Level (storage amount)

• Current SHDW Staked amount These values are automatically updated when changes occur.

Q: How do I initiate the unstaking process? A: To unstake:

1. Navigate to the Operator tab

2. Click the "Deactivate & Unstake" button

3. Confirm the transaction in your wallet

4. Wait for the cooldown period

5. Use the "Withdraw" button to claim your tokens

Q: What are the available storage and staking tiers? A: Storage levels are now based on the amount of SHDW you choose to stake with a ratio of 1 SHDW per ~51.2MB and a min. floor of 1,000 SHDW to qualify.

You must have sufficient SHDW tokens and available device storage to select a tier. All storage tiers require meeting the minimum device specifications outlined in the "Requirements & Setup" section.

Note: Future releases will introduce more granular and dynamic staking and storage options.

Q: What's the process for changing my storage level? A: Changing storage levels requires:

1. Deactivating your current node

2. Releasing your SHDW collateral

3. Completing the withdrawal process

4. Reactivating with new storage level and corresponding collateral

Q: What happens during deactivation? A: The deactivation process includes:

1. Node is stopped

2. Current stake enters pending withdrawal state

3. Storage allocation is released

4. Node configuration is preserved for potential reactivation

Q: What happens when I deactivate and unstake? A: The process involves several steps:

1. Deactivate & Unstake: Initiates the unstaking process

2. Withdrawal Period: Your tokens enter a pending withdrawal state

3. Withdraw: After the cooling period, you can withdraw your staked SHDW

4. Your node will be turned off but your operator account remains initialized

Q: What happens to my revenues when I unstake? A: When unstaking:

• Any unclaimed revenue remain available

• You can still claim revenue from your previous contribution

• New revenue stop accruing once unstaked

• Your operator account retains access to claim functions

Q: Are there staking time requirements? A: Yes, there are important timing considerations:

• Initial stake requires a warmup period (one Solana epoch)

• Unstaking requires a cooldown period (one Solana epoch)

• You cannot deactivate/unstake during the warmup period

• Revenue can be claimed once per 24-hour period

• Withdrawal is only available after the cooldown period completes

Q: What if I want to switch to a different device? A: When switching devices:

1. Wait for your initial stake warmup period to complete

2. Deactivate and unstake on your current device

3. Wait for the cooldown period to complete

4. Withdraw your SHDW tokens

5. Set up the new device with the same wallet

6. Stake and activate your new node

Account Management

Q: How do I change my storage contribution? A: To modify your contribution:

1. Access the "Update Storage Contribution" section

2. Select a new storage level

3. Adjust stake if required

4. Confirm the changes

Q: What happens to my settings when I update my storage contribution? A: When updating your storage contribution:

1. Your current node status is preserved

2. The app verifies available device storage

3. Stake requirements are recalculated

4. You'll see a confirmation before changes apply

5. Node may need to restart with new settings

Q: What happens if I want to stop being an operator? A: To deactivate:

1. Use the "Deactivate & Unstake" option

2. Your node will properly disconnect

3. Storage fragments will be cleaned up

4. Staked SHDW tokens will be returned

5. Earned revenue remain available for claim

Support & Maintenance

Q: Where can I get help? A: Support resources:

• In-app help buttons provide contextual guidance

• View and share logs for technical support

• Community forums and documentation

• Official support channels

• Report bugs through the app feedback system

Q: How do I report bugs or submit feedback? A: We have a dedicated system for bug reports and feedback:

1. Visit our Airtable form: https://airtable.com/appUQgLU7dOMvGB5J/pagZ4dkosLyEqjvBs/form

2. Fill out the relevant information

3. Include any error messages or screenshots

4. Describe the steps to reproduce the issue

5. Submit the form for our team to review

Q: What information should I include in a bug report? A: To help us resolve issues quickly, please include:

• Your device model and Android version

• App version number

• Specific steps that led to the issue

• Any error messages you received

• Screenshots if applicable

• Node logs if the issue is operator-related

Q: How can I check if my bug has already been reported? A: Before submitting a new bug report:

1. Check the FAQ for known issues and solutions

2. Review recent app updates for fixed issues

3. Look for similar issues in community discussions

4. If in doubt, submit a new report - we prefer duplicate reports to missing issues

Q: What happens after I submit feedback? A: After submission:

1. Our team reviews all feedback and bug reports

2. Critical issues are prioritized for immediate attention

3. Feature requests are evaluated for future updates

4. Common issues may be added to the FAQ

5. Major fixes are announced in app updates

Q: How do I backup my node information? A: Important backup steps:

1. Save your keypair backup securely

2. Document your node configuration

3. Keep recovery phrases safe

4. Never share private keys or sensitive data

5. Use the app's built-in backup features

Q: What is the "Backup Key" option in my operator dashboard? A: The Backup Key feature:

• Downloads your node's keypair information

• Stores it securely in your downloads folder

• Should be kept safe and private

• Is essential for node recovery

• Should never be shared with others

Q: When should I backup my node key? A: It's recommended to backup your key:

1. Immediately after node activation

2. Before making major node changes

3. When updating the app

4. As part of regular security maintenance Never share your backup key with anyone, even if they claim to be support.

Q: Is my personal data safe when operating a node? A: Yes, the app uses encrypted storage and secure communication protocols. Your device's personal data is completely separated from the storage space you contribute to the network.

Q: What information is shared with the network? A: Only technical information necessary for network operation is shared:

• Your operator public key

• Storage contribution metrics

• Network connection details

• Node performance statistics

Table of Contents

1. General Android Power Settings

2. App Background Behavior

3. Battery Management

4. System-Level Optimization

5. Manufacturer-Specific Settings

   • Samsung (S21 & Newer)

   • Google Pixel (6 & Newer)

   • OnePlus (10 & Newer)

   • Xiaomi / POCO (Newer Models)

   • OPPO / Realme (Android 12L+)

   • ASUS (ZenFone / ROG on 12L+)

   • Motorola (2022+ Models)

   • Nothing Phone (1, 2)

   • Sony Xperia (Recent Models)

   • Vivo (Android 12L+)

   • Nokia (2022+ Models)

   • TCL (12L+ Releases)

   • ZTE (12L+ Releases)

   • Lenovo (Recent Tablets / Phones)

   • Black Shark (5 Series & Newer)

   • Infinix / Tecno (Current 12L+ Models)

6. Final Tips

General Android Power Settings

1. Battery Optimization

1. Go to Settings → Battery (or Battery saver / Battery optimization).

2. Locate shdwDrive in the list.

3. Set it to Not optimized or Unrestricted.

4. This ensures the system does not close the app in the background.

2. App-Specific Power Controls

1. Settings → Apps → shdwDrive → Battery (or similar).

2. Toggle Allow background activity to On.

3. Disable any “Battery optimization” or “Restrict background data” specifically for shdwDrive.

App Background Behavior

1. App Management Settings

• Never manually force-stop the shdwDrive app.

• Keep shdwDrive in your Recent Apps (avoid swiping it away).

• If there’s an Auto-start / Auto-launch feature, turn it on for shdwDrive.

• Allow it to run in the background continuously.

2. Memory Management

• Exclude shdwDrive from any memory cleaners or “one-tap boost” apps.

• Turn off automatic hibernation for the app.

• Confirm shdwDrive is on any “Do not optimize” or “White list” for battery/memory.

Battery Management

1. Power Maintenance

• If possible, keep your device plugged in while the node runs.

• Avoid or disable aggressive power-saving modes that close apps at low battery.

• Set your low-battery threshold to around 15% so shdwDrive won’t be shut down prematurely.

• A dedicated power supply can help if you’re running the node for extended periods.

2. Battery Optimization

• Disable Adaptive Battery specifically for shdwDrive.

• Turn off “Optimize for battery life” for shdwDrive.

• Remove it from any “sleeping apps” or “deep-sleep” lists.

System-Level Optimization

1. Memory Settings

• If your device has Developer Options:

  • Set Background process limit to Standard or No limit.

• Disable or reduce any “memory optimization” tools that might kill background processes.

2. Performance Mode

• Use High performance mode if available for stable connectivity.

• Reduce or disable thermal throttling on gaming/performance phones if comfortable.

• Ensure the device has adequate cooling to avoid forced closures.

Manufacturer-Specific Settings

Below are recommendations for devices running Android 12L or later. Menu names may vary by region or device.

Samsung Settings

Applies to: Galaxy S21, S22, S23, A53, A54, etc. (on Android 12L+)

1. Battery Settings

   • Settings → Battery → Background usage limits

     • Add shdwDrive to Unrestricted apps.

   • More battery settings: Disable Adaptive battery and Put unused apps to sleep.

2. App Management

   • Settings → Apps → shdwDrive → Battery → Unrestricted

   • Under Mobile data, enable background data.

   • Keep shdwDrive in memory if such an option is present.

3. Device Care

   • Settings → Device care → Battery → Turn off Adaptive power saving

   • Choose High performance mode if needed.

Google Pixel Settings

Applies to: Pixel 6, 6 Pro, 7, 7 Pro, 8, etc. (Android 12L+)

1. Battery Settings

   • Settings → Battery → Battery Saver

     • Turn it off or only use it manually.

   • Settings → Apps → shdwDrive → Battery → Unrestricted.

2. Background Process

   • Settings → Apps → Special app access → Background restrictions

   • Make sure shdwDrive is allowed in the background.

3. Memory Management

   • Settings → Developer options → Background process limit → Standard.

OnePlus Settings

Applies to: OnePlus 10, 10T, 11, etc. (Android 12L+)

1. Battery Optimization

   • Settings → Battery → Advanced → Battery optimization → shdwDrive → Don’t optimize.

2. Background Process

   • Settings → Apps → shdwDrive → Battery → Don’t optimize

   • Allow background data usage.

3. System Settings

   • Settings → System settings → RAM boost → Disable if it kills background tasks.

   • Battery → Intelligent Control → Turn off for shdwDrive.

Xiaomi Settings

Applies to: Xiaomi / Redmi / POCO (2022+ devices running 12L+)

1. Battery & Performance

   • Settings → Battery & performance

   • Turn off Battery saver for shdwDrive or set to Unrestricted.

2. App Management

   • Settings → Apps → Manage apps → shdwDrive

   • Autostart → Enable

   • Battery saver → No restrictions

3. Security App (If applicable)

   • In Security → Battery optimization → Disable for shdwDrive.

   • Exclude from memory optimization as well.

OPPO / Realme Settings

Applies to: OPPO/Realme devices running Android 12L+

1. Battery Settings

   • Settings → Battery → select High performance mode or exclude from Power saver.

2. App Management

   • Settings → Apps → shdwDrive

     • Battery → Allow background activity

     • Startup/Auto-launch → Enable

3. System Settings

   • Settings → Additional Settings → Background app management → Allow shdwDrive.

ASUS Settings

Applies to: ZenFone 8/9, ROG Phone 5/6/7 on 12L+

1. Power Management

   • Settings → Battery → PowerMaster

   • Disable optimization for shdwDrive.

   • Auto-start manager → Allow shdwDrive.

2. Mobile Manager

   • Mobile Manager → PowerMaster → High performance

   • Keep shdwDrive unrestricted in background.

3. App Specific

   • Settings → Apps → shdwDrive → allow auto-start and background activity.

Motorola Settings

Applies to: 2022+ models running Android 12L or later

1. Battery Settings

   • Settings → Battery → Turn off Adaptive Battery for shdwDrive or pick Unrestricted.

2. App Management

   • Settings → Apps → shdwDrive → Battery → Unrestricted

   • Mobile data & Wi-Fi → Allow background data.

3. Performance

   • Settings → System → (Developer options or Gestures) → ensure no forced app closures.

Nothing Phone Settings

Applies to: Nothing Phone (1) & (2)

1. Battery Settings

   • Settings → Battery → Battery optimization → shdwDrive → Don’t optimize.

2. App Management

   • Settings → Apps → shdwDrive

   • Battery usage → Unrestricted

   • Background process → Allow

3. System Settings

   • Settings → System → Developer options → set Background process limit to Standard or no limit.

Sony Settings

Applies to: Xperia devices launched or updated to 12L+

1. Battery Settings

   • Settings → Battery → turn off Adaptive Battery for shdwDrive.

   • Disable or bypass STAMINA mode if it kills the node.

2. App Management

   • Settings → Apps → shdwDrive → Advanced → Battery optimization → Don’t optimize.

   • Allow background data usage.

3. Power Management

   • Check that Adaptive battery is off or not affecting shdwDrive.

   • Let the app run freely in background settings.

Vivo Settings

Applies to: Vivo (OriginOS/Funtouch OS 12L+)

1. Battery Settings

   • Settings → Battery → Background power consumption → Allow for shdwDrive.

   • Exclude from power saving mode.

2. iManager Settings

   • iManager → App Manager → Auto-start → Enable for shdwDrive.

   • Background running → Allow.

3. App Management

   • Settings → Apps → shdwDrive → Background wake up → Allow

   • Background running permission → Allow

Nokia Settings

Applies to: Nokia models from 2022 onward running 12L+

1. Power Settings

   • Settings → Battery → Battery optimization → Don’t optimize for shdwDrive.

   • Disable Adaptive Battery for the app if possible.

2. App Management

   • Settings → Apps & notifications → shdwDrive → Advanced → Background restrictions → Off

   • Battery → Unrestricted

3. Background Activity

   • Settings → System → Developer options → Background process limit → Standard

TCL Settings

Applies to: TCL devices on Android 12L+ (2022 releases and newer)

1. Battery Management

   • Settings → Battery & Performance → App power saving mode → Off for shdwDrive

   • Smart Manager → auto-launch → Enable for shdwDrive

2. App Settings

   • Settings → Apps → shdwDrive → Battery → Don’t restrict

   • Background process → Allow

3. System Optimization

   • Settings → Privacy → Smart Manager → Battery optimization → Disable for shdwDrive

ZTE Settings

Applies to: ZTE devices on Android 12L+ (e.g., Axon series)

1. Power Settings

   • Settings → Battery → power saving mode → exclude shdwDrive

   • App power saving → Off for shdwDrive

2. App Management

   • Settings → Apps → shdwDrive → Battery → Unrestricted

   • Auto-start → Enable

3. System Settings

   • Settings → Power Manager → Battery optimization → Don’t optimize for shdwDrive

Lenovo Settings

Applies to: Recent Lenovo tablets / phones with 12L or later

1. Battery Settings

   • Settings → Battery → Allow background app management for shdwDrive

   • Exclude from power saving modes.

2. Security Settings

   • Security Center → App management → Auto-start → enable for shdwDrive

   • Background apps → allow

3. App Specific

   • Settings → Apps → shdwDrive → Battery → Don’t optimize

   • Background mobile data → Allow

BlackShark Settings

Applies to: Black Shark 5 Series and later (Android 12L+)

1. Game Dock Settings

   • Game Dock → Performance → CPU/GPU → Performance mode

   • Background process → Allow shdwDrive

2. Battery Settings

   • Settings → Battery → App battery saver → disable for shdwDrive

   • Performance mode → On when plugged in

3. System Settings

   • Settings → Additional settings → Developer options → Background process → Standard

Infinix / Tecno Settings

Applies to: Infinix/Tecno models running 12L+

1. Power Management

   • Settings → Battery → Power Management → Off for shdwDrive

   • Background apps → Allow

2. Phone Master

   • Phone Master → Auto-start → Enable shdwDrive

   • Background running → Allow

3. App Management

   • Settings → Apps → shdwDrive → Power usage → Don’t restrict

   • Auto-launch → Enable

Final Tips

• Check Settings After Updates: System updates can revert your battery or background settings. Review them after each update.

• Stay Plugged In: A stable power source ensures you won’t lose node connectivity when battery runs low.

• Monitor Node Activity: If the node goes offline, revisit settings to confirm none have changed.

By following these instructions on your Android 12L+ device, you’ll help keep shdwDrive running reliably in the background for maximum node uptime. Good luck and happy node-running!

Technical

General

Contents

• Example - Sign and upload a file

• Example - Edit a file

• Example - Delete a file

storage-account

POST https://shadow-storage.genesysgo.net

Creates a new storage account

Request content type: application/json

Request Body

{
    "shdw_bucket": String,
    "transaction_signature": String
}

storage-account-info

POST https://shadow-storage.genesysgo.net

Gets on-chain and ShdwDrive Network data about a storage account

Request content type: application/json

Request Body

{
  storage_account: PublicKey,
  reserved_bytes: Number,
  current_usage: Number,
  immutable: Boolean,
  to_be_deleted: Boolean,
  delete_request_epoch: Number,
  owner1: PublicKey,
  owner2: PublicKey,
  accountCoutnerSeed: Number,
  creation_time: Number,
  creation_epoch: Number,
  last_fee_epoch: Number,
  identifier: String
  version: "V1"
}

{
  storage_account: PublicKey,
  reserved_bytes: Number,
  current_usage: Number,
  immutable: Boolean,
  to_be_deleted: Boolean,
  delete_request_epoch: Number,
  owner1: PublicKey,
  accountCoutnerSeed: Number,
  creation_time: Number,
  creation_epoch: Number,
  last_fee_epoch: Number,
  identifier: String,
  version: "V2"
}json

upload

POST https://shadow-storage.genesysgo.net

Uploads a single file or multiple files at once Request content type: multipart/form-data Example Implementation

Parameters (FormData fields)

Request Body

{
    "finalized_locations": [String],
    "message": String
    "upload_errors": [{file: String, storage_account: String, error: String}] or [] if no errors
}

edit

POST https://shadow-storage.genesysgo.net

Edits an existing file

Request content type: multipart/form-data

Example Implementation

Parameters (FormData fields)

Request Body

{
    "finalized_location": String,
    "error": String or not provided if no error
}

list-objects

POST https://shadow-storage.genesysgo.net

Get a list of all files associated with a storage account

Request content type: application/json

Request Body

{
    "keys": [String]
}

list-objects-and-sizes

POST https://shadow-storage.genesysgo.net

Get a list of all files and their size associated with a storage account

Request content type: application/json

Request Body

{
    "files": [{"file_name": String, size: Number}]
}

get-object-data

POST https://shadow-storage.genesysgo.net

Get information about an object

Request content type: application/json

Request Body

JSON object of the file's metadata in the ShdwDrive Network or an error

delete-file

POST https://shadow-storage.genesysgo.net

Deletes a file from a given Storage Account

Request content type: application/json

Example Implementation

Request Body

{
    "message": String,
    "error": String or not passed if no error
}

add-storage

POST https://shadow-storage.genesysgo.net

Adds storage

Request content type: application/json

Request Body

{
    message: String,
    transaction_signature: String,
    error: String or not provided if no error
}

reduce-storage (updated)

POST https://shadow-storage.genesysgo.net

Reduces storage

Request content type: application/json

Request Body

{
    message: String,
    transaction_signature: String,
    error: String or not provided if no error
}

make-immutable (updated)

POST https://shadow-storage.genesysgo.net

Makes file immutable

Request content type: application/json

Request Body

{
    message: String,
    transaction_signature: String,
    error: String or not provided if no error
}

Example - Secure Sign and Upload File to ShdwDrive using API

This example demonstrates how to securely upload files to the ShdwDrive using the provided API. It includes the process of hashing file names, creating a signed message, and sending the files along with the necessary information to the ShdwDrive endpoint.

import bs58 from 'bs58'
import nacl from 'tweetnacl'
import crypto from 'crypto'

// `files` is an array of each file passed in.
const allFileNames = files.map(file => file.fileName)
const hashSum = crypto.createHash("sha256")
// `allFileNames.toString()` creates a comma-separated list of all the file names.
const hashedFileNames = hashSum.update(allFileNames.toString())
const fileNamesHashed = hashSum.digest("hex")
// `storageAccount` is the string representation of a storage account pubkey
let msg = `Shadow Drive Signed Message:\nStorage Account: ${storageAccount}\nUpload files with hash: ${fileNamesHashed}`;
const fd = new FormData();
// `files` is an array of each file passed in
for (let j = 0; j < files.length; j++) {
    fd.append("file", files[j].data, {
        contentType: files[j].contentType as string,
        filename: files[j].fileName,
    });
}
// Expect the final message string to look something like this if you were to output it
// ShdwDrive Signed Message:
// Storage Acount: ABC123
// Upload files with hash: hash1

// If the message is not formatted like above exactly, it will fail message signature verification
// on the ShdwDrive Network side.
const encodedMessage = new TextEncoder().encode(message);
// Uses https://github.com/dchest/tweetnacl-js to sign the message. If it's not signed in the same manor,
// the message will fail signature verification on the ShdwNetwork side.
// This will return a base58 byte array of the signature.
const signedMessage = nacl.sign.detached(encodedMessage, keypair.secretKey);
// Convert the byte array to a bs58-encoded string
const signature = bs58.encode(signedMessage)
fd.append("message", signature);
fd.append("signer", keypair.publicKey.toString());
fd.append("storage_account", storageAccount.toString());
fd.append("fileNames", allFileNames.toString());
const request = await fetch(`${SHDW_DRIVE_ENDPOINT}/upload`, {
    method: "POST",
    body: fd,
});

Example - Editing a File in ShdwDrive using API and Message Signature Verification

In this example, we demonstrate how to edit a file in ShdwDrive using the API and message signature verification. The code imports necessary libraries, constructs a message to be signed, encodes and signs the message, and sends an API request to edit the file on ShdwDrive.

import bs58 from 'bs58'
import nacl from 'tweetnacl'

// `storageAccount` is the string representation of a storage account pubkey
// `fileName` is the name of the file to be edited
// `sha256Hash` is the sha256 hash of the new file's contents
const message = `ShdwDrive Signed Message:\n StorageAccount: ${storageAccount}\nFile to edit: ${fileName}\nNew file hash: ${sha256Hash}`
// Expect the final message string to look something like this if you were to output it
// ShdwDrive Signed Message:
// Storage Acount: ABC123
// File to delete: https://shadow-drive.genesysgo.net/ABC123/file.png

// If the message is not formatted like above exactly, it will fail message signature verification
// on the ShdwDrive Network side.
const encodedMessage = new TextEncoder().encode(message);
// Uses https://github.com/dchest/tweetnacl-js to sign the message. If it's not signed in the same manor,
// the message will fail signature verification on the Shdw Network side.
// This will return a base58 byte array of the signature.
const signedMessage = nacl.sign.detached(encodedMessage, keypair.secretKey);
// Convert the byte array to a bs58-encoded string
const signature = bs58.encode(signedMessage)


const fd = new FormData();
fd.append("file", fileData, {
    contentType: fileContentType as string,
    filename: fileName,
});
fd.append("signer", keypair.publicKey.toString())
fd.append("message", signature)
fd.append("storage_account", storageAccount)

const uploadResponse = await fetch(`${SHDW_DRIVE_ENDPOINT}/edit`, {
    method: "POST",
    body: fd,
});

Example - Deleting a File from ShdwDrive using Signed Message and API

In this example, we demonstrate how to delete a file from the ShdwDrive using a signed message and the ShdwDrive API. The code first constructs a message containing the storage account and the file URL to be deleted. It then encodes and signs the message using the tweetnacl library. The signed message is then converted to a bs58-encoded string. Finally, a POST request is sent to the ShdwDrive API endpoint to delete the file.

import bs58 from 'bs58'
import nacl from 'tweetnacl'

// `storageAccount` is the string representation of a storage account pubkey
// `url` is the link to the ShdwDrive file, just like the previous implementation needed the url input
const message = `ShdwDrive Signed Message:\nStorageAccount: ${storageAccount}\nFile to delete: ${url}`
// Expect the final message string to look something like this if you were to output it
// ShdwDrive Signed Message:
// Storage Acount: ABC123
// File to delete: https://shadow-drive.genesysgo.net/ABC123/file.png

// If the message is not formatted like above exactly, it will fail message signature verification
// on the ShdwDrive Network side.
const encodedMessage = new TextEncoder().encode(message);
// Uses https://github.com/dchest/tweetnacl-js to sign the message. If it's not signed in the same manor,
// the message will fail signature verification on the Shdw Network side.
// This will return a base58 byte array of the signature.
const signedMessage = nacl.sign.detached(encodedMessage, keypair.secretKey);
// Convert the byte array to a bs58-encoded string
const signature = bs58.encode(signedMessage)
const deleteRequestBody = {
    signer: keypair.publicKey.toString(),
    message: signature,
    location: options.url
}
const deleteRequest = await fetch(`${SHDW_DRIVE_ENDPOINT}/delete-file`, {
    method: "POST",
    headers: {
        "Content-Type": "application/json"
    },
    body: JSON.stringify(deleteRequestBody)
})

Contents

• Install shdwDrive CLI

  • Video Walkthrough

  • Install Solana CLI

  • Create a Storage Account

  • Upload a FIle

  • Upload Multiple FIles

  • Edit a File

  • Delete a File

  • Add Storage

  • Reduce Storage

  • Make File Immutable

• Install Rust CLI - Experimental!

Introduction

The CLI is the easiest way to interact with shdwDrive. You can use your favorite shell scripting language, or just type the commands one at a time. For test driving shdwDrive, this is the best way to get started.

Install the shdwDrive CLI

Prerequisites: Install NodeJS LTS 16.17.1 on any OS.

Then run the following command

npm install -g @shadow-drive/cli

Video Guide and Walkthrough

Install the Solana CLI

In order to interact with shdwDrive, we're going to need a Solana wallet and CLI to interact with the Solana blockchain.

NOTE: The shdwDrive CLI uses it's own RPC configuration. It does not use your Solana environment configuration.

Check HERE for the latest version.

sh -c "$(curl -sSfL https://release.solana.com/v1.14.3/install)"

Upon install, follow that up immediately with:

export PATH="/home/sol/.local/share/solana/install/active_release/bin:$PATH"

Create a Keypair file

We need to have a keypair in .json format to use the shdwDrive CLI. This is going to be the wallet that owns the storage account. If you want, you can convert your browser wallet into a .json file by exporting the private keys. Solflare by default exports it in a .json format (it looks like a standard array of integers, [1,2,3,4...]. Phantom, however, needs some help and we have just the tool to do that.

If you want to create a new wallet, just use

solana-keygen new -o ~/shdw-keypair.json

You will see it write a new keypair file and it was display the pubkey which is your wallet address.

You'll need to send a small amount of SOL and SHDW to that wallet address to proceed! The SOL is used to pay for transaction fees, the SHDW is used to create (and expand) the storage account!

Context-Sensitive Help

shdwDrive CLI comes with integrated help. All shdwDrive commands begin with shdw-drive.

shdw-drive help

The above command will yield the following output

You can get further help on each of these commands by typing the full command, followed by the --help option.

shdw-drive create-storage-account --help

Create a Storage Account

This is one of the few commands where you will need SHDW. Before the command executes, it will prompt you as to how much SHDW will be required to reserve the storage account. There are three required options:

-kp, --keypair

• Path to wallet that will create the storage account

-n, --name

• What you want your storage account to be named. (Does not have to be unique)

-s, --size

• Amount of storage you are requesting to create. This should be in a string like '1KB', '1MB', '1GB'. Only KB, MB, and GB storage delineations are supported.

Example:

shdw-drive create-storage-account -kp ~/shdw-keypair.json -n "pony storage drive" -s 1GB

Upload File to shdwDrive

Options for this command:

-kp, --keypair

• Path to wallet that will upload the file

-f, --file

• File path. Current file size limit is 1GB through the CLI.

If you have multiple storage accounts it will present you with a list of owned storage accounts to choose from. You can optionally provide your storage account address with:

-s, --storage-account

• Storage account to upload file to.

--rpc <your-RPC-endpoint>

• RPC endpoint to pass custom endpoint. This can resolve 410 errors if you are using methods not available from the default free public endpoint.

Example 1:

shdw-drive upload-file -kp ~/shdw-keypair.json -f ~/AccountHolders.csv

Example 2 with RPC:

shdw-drive upload-file -kp ~/shdw-keypair.json -f ~/AccountHolders.csv --rpc <https://some-solana-api.com>

Upload Multiple Files to shdwDrive

A more realistic use case is to upload an entire directory of, say, NFT images and metadata. It's basically the same thing, except we point the command to a directory.

Options:

-kp, --keypair

• Path to wallet that will upload the files

-d, --directory

• Path to folder of files you want to upload.

-s, --storage-account

• Storage account to upload file to.

-c, --concurrent

• Number of concurrent batch uploads. (default: "3")

--rpc <your-RPC-endpoint>

• RPC endpoint to pass custom endpoint. This can resolve 410 errors if you are using methods not available from the default free public endpoint.

Example 1:

shdw-drive upload-multiple-files -kp ~/shdw-keypair.json -d ~/ponyNFT/assets/

Example 2 with RPC:

shdw-drive upload-multiple-files -kp ~/shdw-keypair.json -d ~/ponyNFT/assets/ --rpc <https://some-solana-api.com>

Edit a File (aka Overwrite a File aka Replace a File)

This command is used to replace an existing file that has the exact same name. If you attempt to upload this file using edit-file and an existing file with the same name is not already there, the request will fail.

There are three requirements for this command:

-kp, --keypair

• Path to wallet that will upload the file

-f, --file

• File path. Current file size limit is 1GB through the CLI. File must be named the same as the one you originally uploaded

-u, --url

• ShdwDrive URL of the file you are requesting to delete

Example:

shdw-drive edit-file --keypair ~/shdw-keypair.json --file ~/ponyNFT/01.json --url https://shdw-drive.genesysgo.net/abc123def456ghi789/0.json

Delete a File

This is straightforward and it's important to note once it's deleted, it's gone for good.

There are two requirements and there aren't any options outside of the standard ones:

-kp, --keypair

• Path to the keypair file for the wallet that owns the storage account and file

-u, --url ShdwDrive URL of the file you are requesting to delete