Go to file
0g-peterzhb 06a335add2
@peter/doc (#22)
* add documentation
2024-03-24 22:37:46 +08:00
.gitbook/assets @peter/doc (#22) 2024-03-24 22:37:46 +08:00
.github Save updated mpt nodes from proof to DB. (#20) 2024-02-06 18:46:35 +08:00
0g-storage-client@1d09ec4f0b @peter/update submodule (#25) 2024-03-12 18:49:51 +08:00
0g-storage-contracts@d466311abb Test mining with the simple market (#31) 2024-03-19 14:09:17 +08:00
common Migrate to the new contract interfaces (#29) 2024-03-14 13:56:17 +08:00
docs @peter/doc (#22) 2024-03-24 22:37:46 +08:00
node Test mining with the simple market (#31) 2024-03-19 14:09:17 +08:00
run Rpc enhancements (#15) 2024-01-30 16:50:35 +08:00
tests @peter/doc (#22) 2024-03-24 22:37:46 +08:00
version-meld fix build dependency isuse (#12) 2024-01-26 19:48:40 +08:00
.bookignore @peter/doc (#22) 2024-03-24 22:37:46 +08:00
.gitignore Initial commit 2024-01-04 18:05:32 +08:00
.gitmodules update url (#26) 2024-03-12 20:33:06 +08:00
Cargo.lock Cache zero hash results. (#24) 2024-03-01 10:08:10 +08:00
Cargo.toml Migrate to the new contract interfaces (#29) 2024-03-14 13:56:17 +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 @peter/doc (#22) 2024-03-24 22:37:46 +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 versoin 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 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.

Contributing

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