downstream-node

Master: Devel:

Currently running on https://live.driveshare.org. You can see the status of farmers there.

What is this I don't even?

downstream-node is the server to downstream-farmer. Yep, it's a client/server relationship. downstream-node requires MySQL and a working config.

The implied first step is to download and install MySQL server. For example, on Ubuntu:

$ apt-get -y install mysql-server

Get libcrypto and libgmp which is required for some dependencies of downstream-node.

$ apt-get -y install libcrypto++-dev libgmp-dev mongodb

Get downstream-node:

$ git clone https://github.com/Storj/downstream-node.git
$ cd downstream-node
$ pip install -r requirements.txt .

Set up the database:

mysql> create database downstream;
mysql> create user 'downstream'@'localhost' identified by 'password';
mysql> grant all on downstream.* to 'downstream'@'localhost';
mysql> flush privileges;

It is necessary to pull in the IP lookup database from maxmind:

mkdir data && cd data
curl -o GeoLite2-City.mmdb.gz http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz
gunzip GeoLite2-City.mmdb.gz
cd ..

Create and edit the config with the appropriate details:

$ cp downstream_node/config.py.template downstream_node/config.py
$ nano downstream_node/config.py

Modify the database line for the user configuration we just created in MySQL:

SQLALCHEMY_DATABASE_URI = 'mysql+pymysql://downstream:password@localhost/downstream'

And any file paths you would like to change (like where files and tags are stored) and any configuration options

Create the DB schema, and start the server in development mode (bound to localhost:5000):

$ python runapp.py --initdb
$ python runapp.py

Finally, if you are using a whitelist, you must pull that into the database:

$ python runapp.py --whitelist WHITELIST_FILE

If this is at all confusing, we're doing it as a functional test in the travis.yml file, so watch it in action on Travis-CI.

downstream

Web application where the client downloads and proves file existence to a single node. Used mostly on Metadisk nodes or standalone verification nodes.

Note: This is a proof of concept intended to be used to collect uptime and redundancy statistics. It should not be used for production services as authentication keys are passed in plaintext. Furthermore, data should not be passed from node to client to prevent arbitrary code execution until proper sandboxing is place.

Node library functions

The following functions are available in this prototype

create_token(sjcx_address)
    """Creates a token for the given address. For now, addresses will not be enforced, and anyone
    can acquire a token.

    :param sjcx_address: address to use for token creation.  for now, just allow any address.
    :returns: the token
    """

delete_token(token)
    """Deletes the given token.

    :param token: token to delete
    """

get_chunk_contract(token)
    """In the final version, this function should analyze currently available file chunks and 
    disburse contracts for files that need higher redundancy counts.  
    In this prototype, this function should generate a random file with a seed.  The seed 
    can then be passed to a prototype farmer who can generate the file for themselves.  
    The contract will include the next heartbeat challenge, and the current heartbeat state 
    for the encoded file.

   :param token: the token to associate this contract with
   :returns: the chunk
     """

verify_proof(token,file_hash,proof)
    """This queries the DB to retrieve the heartbeat, state and challenge for the contract id, and 
    then checks the given proof.  Returns true if the proof is valid.

    :param token: the token for the farmer that this proof corresponds to
    :param file_hash: the file hash for this proof
    :param proof: a heartbeat proof object that has been returned by the farmer
    :returns: boolean true if the proof is valid, false otherwise
    """

Database Tables

To write these functions the database models have to be modified to include contracts and tokens tables.

HTTP Routes

Additionally the following prototype routes should be exposed for the public API:

Get a new token for a given address. For now, don't check address, just return a token.

GET /api/downstream/new/<sjcx_address>

Response:

{
    "token": "ceb722d954ef9d1af3eed2bbe0aeb954",
    "heartbeat": "...heartbeat object string representation..."
}

For verified access, use the following:

POST /api/downstream/new/<sjcx_address>

Parameters:

{
	"message": "A Message Of Your Choice"
	"signature": "Base64 signature of message"
}

Response:

{
    "token": "ceb722d954ef9d1af3eed2bbe0aeb954",
    "heartbeat": "...heartbeat object string representation..."
}

Get a new chunk contract for a token. Returns the first challenge and expiration time (in seconds from now), the file hash, a seed for generation of the prototype file, and the file heartbeat tag.

GET /api/downstream/chunk/<token>

which gets a chunk of default size (32768 bytes) or one can specify the size

GET /api/downstream/chunk/<token>/<size>

If chunks are available that fill the required space, this will return an array of chunks:

{
	"chunks": [
		{
			"challenge": "...challenge object string representation...",
			"due": 59,
			"file_hash": "012fb25d2f14bb31bcbad5b8d99703114ed970601b21142c93b50421e8ddb0d7",
			"seed": "70aacdc6a2f7ef0e7c1effde27299eda",
			"size": 1024,
			"tag": "...tag object string representation..."
		},
		{
			"challenge": "...challenge object string representation...",
			"due": 59,
			"file_hash": "1ff230c833a9ebdc01e100f5a9a41668ffcd9dcba13b307dd99271674f668279",
			"seed": "8b7c4859d0ec9a474fafc1c30e9b1911",
			"size": 1024,
			"tag": "...tag object string representation..."
		}
	]
}

otherwise, if no chunks are available, the response will be an empty array of chunks

{
	"chunks": []
}

Gets the currently due challenge for this token and file hash.

GET /api/downstream/challenge/<token>/<file_hash>

Response:

{
   "challenge": "...challenge object string representation...",
   "due": 32,
   "answered": false
}

or, if there are no challenges available for this contract, the response will be

{
	"status": "no more challenges"
}

For larger numbers of contracts, the farmer should request all the due challenges for a token by issuing

GET /api/downstream/challenge/<token>

with no file_hash, and the response will look like: Response:

{
	"challenges": [
		{
			"file_hash": "f04ab97fbf4300e3cdfc2ab56a9662a9f2dbaba9916870b331c53d7d181693ab",
			"challenge": "...challenge object string representation...",
			"due": 8,
			"answered": false
		},
		{
			"file_hash": "e2a8501ddd2ecfb032e652ff291398e2bf683e132a1579c5c5fdcbda84a93a89",
			"challenge": "...challenge object string representation...",
			"due": 41,
			"answered": false
		},
		{
			"file_hash": "7a76d71cd338b285f1c455aa941d840686061d7633955d0b01724d3cfc676d3d",
			"challenge": "...challenge object string representation...",
			"due": 84
			"answered": true
		},
		{
			"file_hash": "1ff230c833a9ebdc01e100f5a9a41668ffcd9dcba13b307dd99271674f668279",
			"status": "no more challenges"
		},
		{
			"file_hash": "012fb25d2f14bb31bcbad5b8d99703114ed970601b21142c93b50421e8ddb0d7",
			"error": "contract expired"
		}
	]
}

or, the farmer can specify which challenges to update by posting a list of contracts:

POST /api/downstream/challenge/<token>

Parameters:

{
	"hashes": [
		"f04ab97fbf4300e3cdfc2ab56a9662a9f2dbaba9916870b331c53d7d181693ab",
		"e2a8501ddd2ecfb032e652ff291398e2bf683e132a1579c5c5fdcbda84a93a89",
		"7a76d71cd338b285f1c455aa941d840686061d7633955d0b01724d3cfc676d3d",
		"1ff230c833a9ebdc01e100f5a9a41668ffcd9dcba13b307dd99271674f668279",
		"012fb25d2f14bb31bcbad5b8d99703114ed970601b21142c93b50421e8ddb0d7"
	]
}

which has the same response as above.

Posts an answer for the current challenge on token and file hash.

POST /api/downstream/answer/<token>/<file_hash>

Parameters:

{
    "proof": "...proof object string representation..."
}

Response:

{
    "status": "ok"
}

Optionally, the farmer can answer multiple challenges with the following request

POST /api/downstream/answer/<token>

Parameters:

{
	"proofs": [
		{
			"file_hash": "f04ab97fbf4300e3cdfc2ab56a9662a9f2dbaba9916870b331c53d7d181693ab",
			"proof": "...proof object string represenation..."
		},
		{
			"file_hash": "e2a8501ddd2ecfb032e652ff291398e2bf683e132a1579c5c5fdcbda84a93a89",
			"proof": "...proof object string represenation..."
		},
		{
			"file_hash": "7a76d71cd338b285f1c455aa941d840686061d7633955d0b01724d3cfc676d3d",
			"proof": "...proof object string represenation..."
		}
	]
}

and the response should be:

{
	"report": [
		{
			"file_hash": "f04ab97fbf4300e3cdfc2ab56a9662a9f2dbaba9916870b331c53d7d181693ab",
			"status": "ok"
		},
		{
			"file_hash": "e2a8501ddd2ecfb032e652ff291398e2bf683e132a1579c5c5fdcbda84a93a89",
			"error": "proof invalid"
		},
		{
			"file_hash": "7a76d71cd338b285f1c455aa941d840686061d7633955d0b01724d3cfc676d3d",
			"error": "contract expired"
		}
	]
}

Finally, some statistics about the node can be retrieved through a status API as follows.

The status API is required to produce the following information for each farmer:

Farmer ID (token hash)
SJCX address
Geographic Location
Percentage uptime since creation
Number of heartbeats completed
Whether the farmer is currently online
A hash of the IP address of the farmer
Total data size hosted by the farmer in bytes

The list of all farmer stats can be retrieved with

GET /api/downstream/status/list

which returns all the farmers and their stats, for example:

{
  "farmers": [
    {
      "address": "18ZCamw21V7RxavSnxR5PUXbueEUJaGJdG",
      "contracts": 1,
      "heartbeats": 2430,
      "id": "3ee8687a1a5580b6b0c2",
      "location": {
        "city": "London",
        "country": "United Kingdom",
        "lat": 51.5508,
        "lon": -0.0912,
        "state": "England",
        "zip": "N5"
      },
      "online": true,
      "size": 100,
      "uptime": 100.0
    },
    {
      "address": "175rDTpkLLZJS5wXhSFTFY2XGdnqLst8Bo",
      "contracts": 9,
      "heartbeats": 549,
      "id": "e33213c51c0d5e53a4f4",
      "location": {
        "city": "Lombard",
        "country": "United States",
        "lat": 41.878,
        "lon": -88.0163,
        "state": "Illinois",
        "zip": "60148"
      },
      "online": true,
      "size": 900,
      "uptime": 88.33
    },
    {
      "address": "1P1eHxxfhsLM3ufQXDuYZKGdM3oBM5jrLh",
      "contracts": 1,
      "heartbeats": 2696,
      "id": "ec6040c0a5a6c324e603",
      "location": {
        "city": "New York",
        "country": "United States",
        "lat": 40.7267,
        "lon": -73.9981,
        "state": "New York",
        "zip": "10012"
      },
      "online": true,
      "size": 100,
      "uptime": 100.0
    },
    {
      "address": "1HSMekTxSDkwgNSnhDqNkd4RwCu4Gn69r9",
      "contracts": 1,
      "heartbeats": 1536,
      "id": "f5faada95cc7f56a2239",
      "location": {
        "city": null,
        "country": "United States",
        "lat": 38.0,
        "lon": -97.0,
        "state": null,
        "zip": null
      },
      "online": true,
      "size": 100,
      "uptime": 100.0
    },
    {
      "address": "1KsTJtNzfYG68B6bpprvmXGgRuFG3h3NHR",
      "contracts": 1,
      "heartbeats": 3786,
      "id": "fa3b14c38664670fd0b0",
      "location": {
        "city": "Boardman",
        "country": "United States",
        "lat": 45.7788,
        "lon": -119.529,
        "state": "Oregon",
        "zip": "97818"
      },
      "online": true,
      "size": 100,
      "uptime": 100.0
    }
  ]
}

It is possible to retrieve only online farmers by specifying the online tag:

GET /api/downstream/status/list/online

which will return only online farmer statistics.

Optionally, one may sort in ascending order by id, address, uptime, heartbeats, contracts, size, or online by using

GET /api/downstream/status/list/by/<sortby>

or in descending order

GET /api/downstream/status/list/by/d/<sortby>

It is also possible to limit the number of responses

GET /api/downstream/status/list/by/<sortby>/<limit>

and specify a page number

GET /api/downstream/status/list/by/<sortby>/<limit>/<page>

So some examples:

GET /api/downstream/status/list/by/d/uptime/25

will return the 25 farmers with the highest uptime percentage

GET /api/downstream/status/list/by/d/contracts/15/2

will return the third page (rows 30-44) of the farmers with the most contracts.

Individual farmer information can be retrieved with:

GET /api/downstream/status/show/<id>

{
      "address": "18d6KhnTg9dM9jtb1MWXdbibu3Pwt1QHQt",
      "contracts": 2,
      "heartbeats": 241,
      "id": "45bd945fa10e3f059834",
      "location": {"city": "West Jerusalem", "country": "Israel", "lon": 35.21961, "zip": "", "state": "Jerusalem District", "lat": 31.78199},
      "online": true,
      "size": 200,
      "uptime": 96.015
}

The farmer id is the first 20 characters of the hex representation of the token sha-256 hash.

This product includes GeoLite2 data created by MaxMind, available from http://www.maxmind.com.

davidxv/downstream-node

downstream-node

What is this I don't even?

downstream

Node library functions

Database Tables

HTTP Routes