From fd9c033176dca7ac23a62bd0b7b6c5921f7c8fb2 Mon Sep 17 00:00:00 2001 From: Roy Lu Date: Sat, 12 Oct 2024 14:29:12 -0700 Subject: [PATCH] Updated README --- README.md | 73 ++++++++++++++----------------------------------------- 1 file changed, 18 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 0f25059..61dff73 100644 --- a/README.md +++ b/README.md @@ -2,69 +2,32 @@ ## Overview -0G Storage is the storage layer for the ZeroGravity data availability (DA) system. The 0G Storage layer holds three important features: +0G Storage is a decentralized data storage system designed to address the challenges of high-throughput and low-latency data storage and retrieval, in areas such as AI and gaming. -* 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. +In addition, it forms the storage layer for the 0G data availability (DA) system, with the cross-layer integration abstracted away from Rollup and AppChain builders. -To dive deep into the technical details, continue reading [0G Storage Spec.](docs/) +## System Architecture -## Integration +0G Storage consists of two main components: -We provide a [SDK](https://github.com/0glabs/0g-js-storage-sdk) for users to easily integrate 0G Storage in their applications with the following features: +1. **Data Publishing Lane**: Ensures quick data availability and verification through the 0G Consensus network. +2. **Data Storage Lane**: Manages large data transfers and storage using an erasure-coding mechanism for redundancy and reliability. -* 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) +Across the two lanes, 0G Storage supports the following features: -## Deployment +* **General Purpose Design**: Supports atomic transactions, mutable key-value stores, and archive log systems, enabling a wide range of applications with various data types. +* **Incentivized Participation**: Utilizes the PoRA (Proof of Random Access) mining algorithm to incentivize storage network participants. -Please refer to [Deployment](docs/run.md) page for detailed steps to compile and start a 0G Storage node. +For in-depth technical details about 0G Storage, please read our [Intro to 0G Storage](https://docs.0g.ai/og-storage). -## Test +## Documentation -### Prerequisites +- If you want to run a node, please refer to the [Running a Node](https://docs.0g.ai/run-a-node/storage-node) guide. +- If you want build a project using 0G storage, please refer to the [0G Storage SDK](https://docs.0g.ai/build-with-0g/storage-sdk) guide. -* 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` +## Support and Additional Resources +We want to do everything we can to help you be successful while working on your contribution and projects. Here you'll find various resources and communities that may help you complete a project or contribute to 0G. -### 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](https://github.com/bnb-chain/bsc/releases) 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](https://github.com/0glabs/0g-storage-contracts): 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](https://github.com/0glabs/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](contributing.md). +### Communities +- [0G Telegram](https://t.me/web3_0glabs) +- [0G Discord](https://discord.com/invite/0glabs)