From bfe434972d9135b7ad2a4378f94429f2bcb9f5bd Mon Sep 17 00:00:00 2001
From: Bo QIU <35757521+boqiu@users.noreply.github.com>
Date: Thu, 21 Nov 2024 15:54:26 +0800
Subject: [PATCH] Add new docc page for local testing (#283)

---
 README.md           | 37 +------------------------------------
 docs/onebox-test.md | 38 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 39 insertions(+), 36 deletions(-)
 create mode 100644 docs/onebox-test.md

diff --git a/README.md b/README.md
index a5ff3c46..2d724f90 100644
--- a/README.md
+++ b/README.md
@@ -28,42 +28,7 @@ Please refer to [Deployment](docs/run.md) page for detailed steps to compile and
 
 ## 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](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
-```
+Please refer to the [One Box Test](docs/onebox-test.md) page for local testing purpose.
 
 ## Contributing
 
diff --git a/docs/onebox-test.md b/docs/onebox-test.md
new file mode 100644
index 00000000..9c4ad3f0
--- /dev/null
+++ b/docs/onebox-test.md
@@ -0,0 +1,38 @@
+# One Box Test
+
+0G storage node provides one box test framework for developers to verify system functionalities via RPC.
+
+## Prerequisites
+
+- Requires python version: 3.8, 3.9 or 3.10, higher version is not guaranteed (e.g. failed to install `pysha3`).
+- Installs dependencies under root folder: `pip3 install -r requirements.txt`
+
+## Install Blockchain Nodes
+
+Python test framework will launch blockchain nodes at local machine for storage nodes to interact with. There are 3 kinds of blockchains available:
+
+- 0G blockchain (by default).
+- Conflux eSpace (for chain reorg test purpose).
+- BSC node (geth).
+
+The blockchain node binaries will be compiled or downloaded from github to `tests/tmp` folder automatically. Alternatively, developers could also manually copy binaries of specific version to the `tests/tmp` folder.
+
+## Run Tests
+
+Changes to the `tests` folder and run following command to run all tests:
+
+```
+python test_all.py
+```
+
+or, run any single test, e.g.
+
+```
+python example_test.py
+```
+
+*Note, please ensure blockchain nodes installed before running any single test, e.g. run all tests at first.*
+
+## Add New Test
+
+Please follow the `example_test.py` to add a new `xxx_test.py` file under `tests` folder.