logos-storage/logos-storage-testnet-starter
1
0
Fork 0
mirror of https://github.com/logos-storage/logos-storage-testnet-starter.git synced 2026-01-02 13:33:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

small readme update

Browse Source
This commit is contained in:
Ben 2024-03-29 14:27:10 +01:00
parent 2de1a374b9
commit 62f53bff2f
No known key found for this signature in database
GPG Key ID: 541B9D8C9F1426A1
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -14,7 +14,7 @@ Using the Testnet Starter, you can run a (mostly preconfigured) Codex node on yo
## [How to start](#codex-testnet-starter)
- Create a public/private key pair.
- Create an Ethereum public/private key pair.
- Have Docker installed.
- Have Discord installed.
- Clone this repo.
@ -31,7 +31,7 @@ Using the Testnet Starter, you can run a (mostly preconfigured) Codex node on yo
## [How to get ready](#codex-testnet-starter)
When starting the Testnet Starter for the first time, (or restarting after a long pause) please keep in mind:
- Your local Geth node will need time to sync.
- Codex should automatically wait until Geth is ready. However, in some situations Codex will attempt to start and promptly crash too soon. This is a known issue. When this happens, please manually restart Codex's container when your Geth node is synced.
- Codex should automatically wait until Geth is ready. However, in some situations Codex will attempt to start too soon and promptly crash. This is a known issue. When this happens, please manually restart Codex's container when your Geth node is synced.
Before you can use the marketplace functionality of Codex, you will need to obtain some tokens in the testnet.
1. Join the Codex Discord server: [Here](LINK PENDING)

6
USINGCODEX.md
View File

@ -42,7 +42,7 @@ When you have a CID of data you want to download, you can use the following:
```shell
curl --request GET \
--url http://localhost:8080/api/codex/v1/data/<<<CID HERE>>>/network
--url http://localhost:8080/api/codex/v1/data/{CID HERE}/network
```
Note that Codex does not store content-type or extension information.
@ -77,7 +77,7 @@ To purchase storag space from the network, first you must upload your file. Once
```shell
curl --request POST \
--url http://localhost:8080/api/codex/v1/storage/request/<<<CID HERE>>> \
--url http://localhost:8080/api/codex/v1/storage/request/{CID HERE} \
--header 'Content-Type: application/json' \
--data '{
"duration": "3600",
@ -98,6 +98,6 @@ On successful, this request will return a Purchase-ID.
Using a Purchase-ID, you can check the status of your request-for-storage contract:
```shell
curl --request GET \
--url http://localhost:8080/api/codex/v1/storage/purchases/<<<PURCHASE ID HERE>>>
--url http://localhost:8080/api/codex/v1/storage/purchases/{PURCHASE ID HERE}
```