Deployment
IMPORTANT: When node sending or receiving message to/from another node through private channel or message queue, it will store all messages, both inbound and outbound, to Redis (memory). Client app MUST call an API to remove these messages after they've fetched the messages and store them in their local database. If client were to neglect this, node may fail to function. See Private Messages section.
IMPORTANT: When RP node receives data from AS node, it will store data to Redis (memory). RP client app MUST call an API to remove stored data after they've fetched and store them in their local database. If client were to neglect this, node may fail to function. See Data received from AS section.
Requirements Specification
Hardware
Recommended:
- x64 CPU with 4 cores
- At least 8 GB of memory
- SSD with at least 200 IOPS
The specs may vary depending on the load and it may require significant disk space over time.
Operating System
- Linux
- macOS
- Windows
- Not fully supported but it is possible to run the stack on Windows except for Redis which has no native support on Windows. You may use Docker for Windows to run Redis at our own risk.
Another option is to run the stack in Docker containers. System requirements can be found on Docker website.
Security
The software stack is designed to run in a secure controlled environment e.g. behind correctly configured firewall. Connections between processes within a node (Tendermint RPC, API main server, MQ service server, Redis) do not use secure connection by default and some may not have an option to do so. Only connections between nodes are designed to be secured e.g. Tendermint<->Tendermint, MQ<->MQ.
DOS Exposure and Mitigation
There are two parts that exposed to the Internet, P2P communication channel or message queue and blockchain, Tendermint.
Monitoring
API main server and MQ service server can be configured to report and serve Prometheus metrics.
ABCI app (smart-contract) Prometheus metrics are served on the same port as Tendermint.
For Tendermint, refer to Tendermint Documentation.
Private Messages
Private messages are messages which is sent or received via private channel or message queue. They contain data private to participating parties/nodes in a request. These messages should be kept as an evidence in case there is a dispute later on.
Messages are saved to Redis once node sent a message to another node or received a message from another node and they will not be automatically removed. Client MUST call an API to remove these messages themselves. Failure to do so may cause node to stop functioning due to out of memory error or Redis operation timeout.
Related APIs
You can fetch private messages by request ID using API GET /utility/private_messages/{request_id}
You will most likely want to remove messages by request ID through API POST /utility/private_message_removal/{request_id} after the request is closed or timed out and you have fetched and saved messages to your local database.
You can also remove all messages using API POST /utility/private_message_removal.
Data received from AS
When RP receives data message from AS and has internally checked and set data received to the blockchain, it will save data to Redis. Stored data will not be automatically removed. RP client MUST call an API to remove data themselves. Failure to do so may cause node to stop functioning due to out of memory error or Redis operation timeout.
Related APIs
You can fetch data by request ID using API GET /rp/request_data/{request_id}
You will most likely want to remove data by request ID through API POST /rp/request_data_removal/{request_id} after you have fetched and saved data to your local database.
You can also remove all data using API POST /rp/request_data_removal.