README.md

Post Service

Post service allows to separate expensive PoST proving from a node by allowing to generate a proof on a different machine. It connects to the node via GRPC (on an address pointed by --address) and awaits commands from the node.

How to run

First of all, the service currently doesn't support initializing PoST data. The data must be initialized separately (presumably using postcli and placed in a directory pointed to by --dir).

Example running on an un-encrypted channel, with the default configuration of threads and nonces

service --address=http://my-node-address.org --dir=./post-data

Example running on an encrypted (mTLS) channel, with the custom threads and nonces

For mTLS, you need to pass the certificate and private key of the post-service with --cert and -key, as well as the CA of the server with --ca-cert:

service --address=https://my-node-address.org --cert=client.pem --key=client-key.pem --ca-cert=server-rootCA.pem --dir=./post-data --threads=8 --nonces=288

A full usage/help can be viewed with

service --help

Operator API

The operator API is a set of HTTP endpoints allowing control of the post service.

It is enabled by providing --operator-address=<address>, i.e. --operator-address=127.0.0.1:50051 CLI argument.

Example usage

Querying post service status

# Not doing anything
❯ curl http://localhost:50051/status
"Idle"

# Proving
❯ curl http://localhost:50051/status
{"Proving":{"nonces":{"start":0,"end":128},"position":0}}

# Proving, read some data already
❯ curl http://localhost:50051/status
{"Proving":{"nonces":{"start":0,"end":128},"position":10000}}

# Started second pass
❯ curl http://localhost:50051/status
{"Proving":{"nonces":{"start":128,"end":256},"position":10000}}

# Finished proving, but the node has not fetched the proof yet
❯ curl http://localhost:50051/status
"DoneProving"

# Finished proving and the node has fetched the proof
❯ curl http://localhost:50051/status
"Idle"