3.9 KiB

Raw Permalink Blame History

Using Codex

Codex's web-API is documented: Here This document will show you several useful API calls.

Overview

Debug
Upload a file
Download a file
Local data
Create storage availability
Purchase storage
View purchase status

Debug

An easy way to check that your node is up and running is:

curl --request GET \
  --url http://localhost:8080/api/codex/v1/debug/info

This will return a JSON structure with plenty of information about your local node. It contains peer information that may be useful when troubleshooting connection issues.

Upload a file

Warning Once you upload a file to Codex, other nodes in the testnet can download it. Please do not upload anything you don't want others to access, or, properly encrypt your data first.

curl --request POST \
  --url http://localhost:8080/api/codex/v1/data \
  --header 'Content-Type: application/octet-stream' \
  -T <FILE>

On successful upload, you'll receive a CID. This can be used to download the file from any node in the network.

Download a file

When you have a CID of data you want to download, you can use the following commands:

export CID="..." # paste your CID from the previous step here between the quotes

curl --request GET \
  --url http://localhost:8080/api/codex/v1/data/$CID/network

Note that Codex does not store content-type or extension information.

If you get an error, run echo ${CID} to verify your CID is set properly.

Local data

You can view which datasets are currently being stored by your node.

curl --request GET \
  --url http://localhost:8080/api/codex/v1/data

Create storage availability

In order to start selling storage space to the network, you must configure your node with the following command. Once configured, the node will monitor on-chain requests-for-storage and will automatically enter into contracts that meet these specifications.

curl --request POST \
  --url http://localhost:8080/api/codex/v1/sales/availability \
  --header 'Content-Type: application/json' \
  --data '{
	"totalSize": "8000000",
	"duration": "7200",
	"minPrice": "10",
	"maxCollateral": "10"
  }'

For descriptions of each parameter, please view the Spec.

Purchase storage

To purchase storag space from the network, first you must upload your file. Once you have the CID, use the following to create a request-for-storage contract.

First create two variables for the request:

export CID="..." # paste your CID from the previous step here between the quotes
export EXPIRY_TIME=$((1000 + $(date +%s))) # current time + 1000 seconds
echo CID: $CID
echo EXPIRY_TIME: $EXPIRY_TIME

Next you can run:

curl --request POST \
   --url http://localhost:8080/api/codex/v1/storage/request/$CID \
   --header 'Content-Type: application/json' \
   --data '{
    "duration": "3600",
    "reward": "1",
    "proofProbability": "3",
    "expiry": "'${EXPIRY_TIME}'",
    "nodes": 2,
    "tolerance": 1,
    "collateral": "1"
  }'

For descriptions of each parameter, please view the Spec.

'Expiry' must be a Unix timestamp in the future, but not further than 'duration' seconds from now. You can use this to generate one.

On successful, this request will return a Purchase-ID.

View purchase status

Using a Purchase-ID, you can check the status of your request-for-storage contract:

export PURCHASE_ID="..."

Then:

curl --request GET \
  --url http://localhost:8080/api/codex/v1/storage/purchases/$PURCHASE_ID

3.9 KiB Raw Permalink Blame History