Go to file
2024-09-14 10:11:40 +08:00
.gitbook/assets @peter/doc (#22) 2024-03-24 22:37:46 +08:00
.github Remove contract abi submodule (#139) 2024-07-22 17:32:51 +08:00
common Fix contract interface build cache (#172) 2024-08-27 18:08:10 +08:00
docs Docs improvements (#82) 2024-07-11 14:10:57 +08:00
node Merge 3957f8b28d into a153955246 2024-09-14 10:11:40 +08:00
run Allow user to configure network bandwidth for file sync (#198) 2024-09-13 16:58:27 +08:00
scripts Update with the most recent storage contract (#142) 2024-07-24 13:01:30 +08:00
storage-contracts-abis Config query context interval & Add config comments (#156) 2024-08-27 17:36:36 +08:00
tests Use 0gchain to test mine tests (#191) 2024-09-11 10:13:31 +08:00
version-meld Check network id in status and ban incompatible peers. (#159) 2024-08-14 11:35:48 +08:00
.bookignore @peter/doc (#22) 2024-03-24 22:37:46 +08:00
.gitignore Change miner id logic & request miner id automatically (#60) 2024-04-27 11:15:57 +08:00
.gitmodules Remove contract abi submodule (#139) 2024-07-22 17:32:51 +08:00
Cargo.lock Add zgs rpc to check file finality (#196) 2024-09-13 07:40:43 +08:00
Cargo.toml Add admin rpc to exports metrics (#162) 2024-08-19 15:18:12 +08:00
codecov.yml Initial commit 2024-01-04 18:05:32 +08:00
contributing.md @peter/doc (#22) 2024-03-24 22:37:46 +08:00
LICENSE.lighthouse Initial commit 2024-01-04 18:05:32 +08:00
NOTICE @peter/doc (#22) 2024-03-24 22:37:46 +08:00
README.md Docs improvements (#82) 2024-07-11 14:10:57 +08:00
requirements.txt add readme for python tests (#5) 2024-01-19 21:26:33 +08:00
rust-toolchain fix build dependency isuse (#12) 2024-01-26 19:48:40 +08:00
rustlint.sh fix build dependency isuse (#12) 2024-01-26 19:48:40 +08:00
SUMMARY.md @peter/doc (#22) 2024-03-24 22:37:46 +08:00

0G Storage

Overview

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

  • Buit-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 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.

To dive deep into the technical details, continue reading 0G Storage Spec.

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

Contributing

To make contributions to the project, please follow the guidelines here.