Feature/list files

[jcnelson]

This PR adds support for POST /list-files/${address}/ as well as supporting documentation.

How to Test

You send a POST request to /list-files/${address}/ with content-type: application/json that encodes the driver-specific page identifier (initially null). You get back a JSON object with the structure {"entries": [list of file names], "page": "driver-specific-next-page-token"}. The configuration file specifies the maximum length of entries, under the pageSize directive.

Sample disk driver configuration:

{
  "servername": "localhost",
  "port": 4000,
  "driver": "disk",
  "readURL": "http://localhost:4001/",
  "proofsConfig": {
    "proofsRequired" : 0
  },
  "diskSettings": {
     "storageRootDirectory": "/tmp/gaia-disk"
  },
  "pageSize": 20,
  "argsTransport": {
    "level": "debug",
    "handleExceptions": true,
    "stringify": true,
    "timestamp": true,
    "colorize": false,
    "json": true
  }
}

Contents of /tmp/gaia-disk/:

$ ls /tmp/gaia-disk/1GNJ12dwU4F5vpVXZBH4Pm5sKNszEgGko6/ | more
gaia-config.json
gaia-config.json.10
gaia-config.json.10.sig
gaia-config.json.11
gaia-config.json.11.sig
gaia-config.json.12
gaia-config.json.12.sig
gaia-config.json.13
gaia-config.json.13.sig
gaia-config.json.2
gaia-config.json.3
gaia-config.json.4
gaia-config.json.4.sig
gaia-config.json.5
gaia-config.json.5.sig
gaia-config.json.6
gaia-config.json.6.sig
gaia-config.json.7
gaia-config.json.7.sig
gaia-config.json.8
gaia-config.json.8.sig
gaia-config.json.9
gaia-config.json.9.sig

Sample POST payload:

{'page': '0'}

Sample response:

{ entries:
   [ 'gaia-config.json',
     'gaia-config.json.10',
     'gaia-config.json.10.sig',
     'gaia-config.json.11',
     'gaia-config.json.11.sig',
     'gaia-config.json.12',
     'gaia-config.json.12.sig',
     'gaia-config.json.13',
     'gaia-config.json.13.sig',
     'gaia-config.json.2',
     'gaia-config.json.3',
     'gaia-config.json.4',
     'gaia-config.json.4.sig',
     'gaia-config.json.5',
     'gaia-config.json.5.sig',
     'gaia-config.json.6',
     'gaia-config.json.6.sig',
     'gaia-config.json.7',
     'gaia-config.json.7.sig',
     'gaia-config.json.8' ],
  page: '1' }

Sample POST payload, as a follow-up to the above:

{'page': '1'}

Sample response:

{ entries:
   [ 'gaia-config.json.8.sig',
     'gaia-config.json.9',
     'gaia-config.json.9.sig' ],
  page: '2' }

You can test this with blockstack-cli:

$ blockstack-cli gaia_listfiles http://localhost:4000 304d7f6f1cf78a9260648f656deca0feec014be23d96ed190dd5ca45128fafac

[x5engine]

Hello Guys, can you please add AppendToFile ?

it will be a huge performance benefiets for GAIA and the apps built so they won't have to getFile the full file then upload it again!
What do you think? Thanks

Append to an object or array in the file...

[jcnelson]

@meteorplus please open this as a separate issue

[CLAassistant]

All committers have signed the CLA.

[kantai]

This worked great for me, thanks @jcnelson -- merging into develop now.