smeb_y/0g-storage-node
1
0
Fork 0
mirror of https://github.com/0glabs/0g-storage-node.git synced 2025-11-04 08:37:27 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
3545c97c04
0g-storage-node/docs/introduction.md
udhaykumarbala 93f587c407
replaced broken links (#311)
2025-02-11 16:46:00 +08:00

2.9 KiB
Raw Blame History

Introduction

Overview

0G Storage is the storage layer for the ZeroGravity data availability (DA) system. The 0G Storage layer holds three important features:

  • Built-in - It is natively built into the ZeroGravity DA system for data storage and retrieval.
  • General purpose - It is designed to support atomic transactions, mutable kv stores as well as archive log systems to enable a wide range of applications with various data types.
  • Incentive - Instead of being just a decentralized database, 0G Storage introduces PoRA mining algorithm to incentivize storage network participants.

Integration

We provide a SDK for users to easily integrate 0G Storage in their applications with the following features:

  • File Merkle Tree Class
  • Flow Contract Types
  • RPC methods support
  • File upload
  • Support browser environment
  • Tests for different environments (In Progress)
  • File download (In Progress)

Deployment

Please refer to Deployment page for detailed steps to compile and start a 0G Storage node.

Test

Prerequisites

  • Required python version: 3.8, 3.9, 3.10, higher version is not guaranteed (e.g. failed to install pysha3).
  • Install dependencies under root folder: pip3 install -r requirements.txt

Dependencies

Python test framework will launch blockchain fullnodes at local for storage node to interact with. There are 2 kinds of fullnodes supported:

  • Conflux eSpace node (by default).
  • BSC node (geth).

For Conflux eSpace node, the test framework will automatically compile the binary at runtime, and copy the binary to tests/tmp folder. For BSC node, the test framework will automatically download the latest version binary from github to tests/tmp folder.

Alternatively, you could also manually copy specific version binaries (conflux or geth) to the tests/tmp folder. Note, do NOT copy released conflux binary on github, since block height of some CIPs are hardcoded.

For testing, it's also dependent on the following repos:

  • 0G Storage Contract: It essentially provides two abi interfaces for 0G Storage Node to interact with the on-chain contracts.
    • ZgsFlow: It contains apis to submit chunk data.
    • PoraMine: It contains apis to submit PoRA answers.
  • 0G Storage Client: It is used to interact with certain 0G Storage Nodes to upload/download files.

Run Tests

Go to the tests folder and run the following command to run all tests:

python test_all.py

or, run any single test, e.g.

python sync_test.py

Troubleshooting

  1. Test failed due to blockchain full node rpc inaccessible.
    • Traceback: node.wait_for_rpc_connection()
    • Solution: unset the http_proxy and https_proxy environment variables if configured.