[Guide] [First steps] NuBot as gateway

[masterOfDisaster]

Continuing the discussion from Dealing with gateways in particular and liquidity provision in general.

I thought it might be good to share some background information.
This might not really be a guide for the whole setup, but will help with the first step.
This is from a private conversation I recently had, when a community member was interested in details about running gateways:

I run those on a RaspberryPi2 (1 GB RAM) along with nud to make maintaining the system easy (I only need to backup one SD card to have a full backup).
I could put all on a virtual server, but I’m too paranoid to put private keys of custodial addresses on a virtual server as such a private key in the wrong hands might make some trouble.
And without the custodial address broadcasting the liquidity information isn’t possible, but as pool operator you know that.

So what have I done to create the gateways?
I’ve created dedicated Poloniex accounts, one for each gateway, to have separate API credentials (both with 2FA, API credentials are only allowed to do order management, but no withdrawal).
I’ve created a blank wallet (walletB.dat) and imported the private keys of the custodial addresses.
I’ve downloaded NuBot and created two directories - one for buy side, one for sell side NuBot.
I’ve created configs (there’s sample configs in the config directory) for each NuBot.

That’s pretty much it.

I had some trouble running the gateways with configuration setting "dualside": false, although that’s what I want to do. I had to limit the side, where I don’t want to have orders on, to 0.0 to make the gateways run fine.
And I don’t know why the parametric order book is effectively disabled and only one order is being placed (with my settings I’d expect to have two orders), but as I consider this a minor issue, I didn’t dig deeper to resolve this issue.
It turned out that there is already an issue raised for that.

I run the NuBots in screen sessions.
That allows me to detach from them and attach to them later.

The logs created by the NuBots are quite exhaustive. If you run the NuBots for some days, you will have hundreds of MB logs.
That’s a problem for my RaPi2 (which more than once caused crashes of nud due to low disk space) and for that reason I switched the gateways for most of the time to standby a few days ago.
One remark about crashed nud: if nud crashes, the broadcast liquidity can’t be reset when NuBot gets shutdown.
The liquidity for that session needs to be reset manually:

nud liquidityinfo B 0 0 BBZ4h88BwYCyE9q268LoArps6eodq9PDGH $nubot_session

With nud requiring over 700 MB, it’s close to the limit of the RaPi2 to run nud and NuBot instances on the same machine:

PID USER      PR  NI  VIRT  RES  SHR S  %CPU %MEM    TIME+  COMMAND
2377 pi        20   0  878m 697m  37m S  60.9 71.6   2199:27 nud

I hope this gets better with version 2.1.
An instance of NuBot needs a little bit over 100 MB RAM and a lot of CPU power during startup and on wall shifts, but very little CPU power most of the time:

PID USER      PR  NI  VIRT  RES  SHR S  %CPU %MEM    TIME+  COMMAND
9750 pi        20   0  325m 120m 8364 S   0.0 12.3   9:02.87 java

If you have any questions, feel free to ask.
The config below might help you get started.
An explanation of the options can be found here

Following are the config files. They have been reworked massively over time.
This is the most recent configuration at the time of writing, which seems to do the job quite well:

NuBot 1
{
“exchangename”:“poloniex”,
“apikey”: “redacted”,
“apisecret”: “redacted”,
“txfee”: 0.1,
“pair”:“nbt_btc”,

“dualside”: true,
“multiplecustodians”:true,
“executeorders”:true,
“verbosity”:“normal”,
“gitter”:true,
“mailnotifications”:“severe”,
“mailrecipient”:“redacted”,
“emergencytimeout”:60,
“keepproceeds”:0,
“priceincrement”: 0.002,
“bypassStreaming”: false,
“streamingServer” : “stream.tradingbot.nu:5556”,
“webport”:6668,

“submitliquidity”: true,
“nubitaddress”: “redacted”,
“nudip”: “127.0.0.1”,
“nudport”: 9091,
“rpcuser”: “redacted”,
“rpcpass”: “redacted”,

“wallchangeThreshold”: 0.1,

“bookDisabletier2”: false,

“bookSellwall”: 1000.0,
“bookSellOffset”: 0.009,
“bookSellInterval”: 0.002,
“bookSellMaxVolumeCumulative” : 4000,
“bookSellType”: “exp”,
“bookSellSteepness”: “high”,

“bookBuywall”: 1000.0,
“bookBuyOffset”: 0.009,
“bookBuyInterval”: 0.002,
“bookBuyMaxVolumeCumulative” : 4000,
“bookBuyType”: “exp”,
“bookBuySteepness”: “high”
}

NuBot 2 .json file
{
“exchangename”:“poloniex”,
“apikey”: “redacted”,
“apisecret”: “redacted”,
“txfee”: 0.1,
“pair”:“nbt_btc”,

“dualside”: true,
“multiplecustodians”:true,
“executeorders”:true,
“verbosity”:“normal”,
“gitter”:true,
“mailnotifications”:“severe”,
“mailrecipient”:“redacted”,
“emergencytimeout”:60,
“keepproceeds”:0,
“priceincrement”: 0.002,
“bypassStreaming”: false,
“streamingServer” : “stream.tradingbot.nu:5556”,
“webport”:6667,

“submitliquidity”: true,
“nubitaddress”: “redacted”,
“nudip”: “127.0.0.1”,
“nudport”: 9091,
“rpcuser”: “redacted”,
“rpcpass”: “redacted”,

“wallchangeThreshold”: 0.1,

“bookDisabletier2”: false,

“bookSellwall”: 1500.0,
“bookSellOffset”: 0.01,
“bookSellInterval”: 0.002,
“bookSellMaxVolumeCumulative” : 6000,
“bookSellType”: “exp”,
“bookSellSteepness”: “high”,

“bookBuywall”: 1500.0,
“bookBuyOffset”: 0.01,
“bookBuyInterval”: 0.002,
“bookBuyMaxVolumeCumulative” : 6000,
“bookBuyType”: “exp”,
“bookBuySteepness”: “high”
}

[zoro]

have you tried nubot in a windows pc?
even in a new dual core laptop (i3-i5) with 8GB ram and 128 SSD running 24/7 you can have a very low power consumption less than 10W.

[masterOfDisaster]

I appreciate your recommendation, but I’m afraid I have no such device.
Besides I prefer Linux for jobs like that.
It’s hard to beat the noise level generated by a RaPi2 (0 dB) or the power consumption (typically less than 2W) of it

[huafei]

usually i use nohup at my VPS when i running the pybot for LP

[masterOfDisaster]

Have you tried screen yet?
You might like it

[huafei]

try it first , but crash myself when i switch different screen ,
i use nohup now , and still have log file can see what happen.

[masterOfDisaster]

If you create a named screen session with the command like
screen -dmS buySideGateway
you can thereafter attach it with
screen -r buySideGateway (or use the process ID instead of the name)
and execute commands within it.

To detach from it, press CTRL+a, CTRL+d (keep CTRL pressed, while you hit first the “a” key, then the “d” key).

[masterOfDisaster]

More recent config version (including enabled parametric order book) taken from here:

{
“exchangename”:“poloniex”,
“apikey”: “redacted”,
“apisecret”: “redacted”,
“txfee”: 0.1,
“pair”:“nbt_btc”,

“dualside”: true,
“multiplecustodians”:true,
“executeorders”:true,
“verbosity”:“normal”,
“gitter”:true,
“mailnotifications”:“severe”,
“mailrecipient”:“redacted”,
“emergencytimeout”:60,
“keepproceeds”:0,
“priceincrement”: 0.002,
“bypassStreaming”: false,
“streamingServer” : “stream.tradingbot.nu:5556”,
“webport”:6668,

“submitliquidity”: true,
“nubitaddress”: “redacted”,
“nudip”: “127.0.0.1”,
“nudport”: 9091,
“rpcuser”: “redacted”,
“rpcpass”: “redacted”,

“wallchangeThreshold”: 0.1,

“bookDisabletier2”: false,

“bookSellwall”: 2000.0,
“bookSellOffset”: 0.01,
“bookSellInterval”: 0.002,
“bookSellMaxVolumeCumulative” : 4000,
“bookSellType”: “lin”,
“bookSellSteepness”: “low”,

“bookBuywall”: 2000.0,
“bookBuyOffset”: 0.01,
“bookBuyInterval”: 0.002,
“bookBuyMaxVolumeCumulative” : 4000,
“bookBuyType”: “lin”,
“bookBuySteepness”: “low”
}