bitnodes/export.py at master · rebroad/bitnodes · GitHub

History

executable file

256 lines (208 loc) · 8.26 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

#!/usr/bin/env python

# -*- coding: utf-8 -*-

# export.py - Export enumerated data for reachable nodes into a JSON file.

# Copyright (c) Bitnodes <info@bitnodes.io>

# Permission is hereby granted, free of charge, to any person obtaining

# a copy of this software and associated documentation files (the

# "Software"), to deal in the Software without restriction, including

# without limitation the rights to use, copy, modify, merge, publish,

# distribute, sublicense, and/or sell copies of the Software, and to

# permit persons to whom the Software is furnished to do so, subject to

# the following conditions:

# The above copyright notice and this permission notice shall be

# included in all copies or substantial portions of the Software.

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE

# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION

# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

"""

Export enumerated data for reachable nodes into a JSON file.

"""

import json

import logging

import os

import sys

import time

from collections import Counter

from configparser import ConfigParser

from binascii import hexlify, unhexlify

from resolve import Resolve

from utils import http_get, init_logger, new_redis_conn

CONF = {}

class Export(object):

"""

Export nodes into timestamp-prefixed JSON file and set consensus height

using the most common height from these nodes.

"""

def __init__(self, timestamp=None, nodes=None, redis_conn=None):

self.start_t = time.monotonic()

self.timestamp = timestamp

self.nodes = nodes

self.redis_conn = redis_conn

if redis_conn:

self.redis_pipe = redis_conn.pipeline()

else:

self.redis_pipe = None

self.heights = self.get_heights()

self.n_set = set() # ADDRESS-PORT

def export_nodes(self):

"""

Merge enumerated data for the nodes and export them into

timestamp-prefixed JSON file and then set consensus height in Redis

using the most common height from these nodes.

"""

rows = []

for node in self.nodes:

row = self.get_row(node)

if row is None:

logging.warning("Skipping duplicate %s", node)

continue

if row[-2] is None:

logging.warning("Skipping %s due to missing ASN", row[0])

continue

rows.append(row)

if self.heights:

height = Counter(self.heights.values()).most_common(1)[0][0]

logging.info("Consensus height: %d", height)

self.redis_conn.set("height", height)

self.write_json_file(rows)

logging.info("Elapsed: %.2f", time.monotonic() - self.start_t)

def get_row(self, node):

"""

Return enumerated row data from Redis for the specified node.

"""

# address, port, version, user_agent, timestamp, services

node = tuple(json.loads(node))

address = node[0]

port = node[1]

services = node[-1]

n = f"{address}-{port}"

if n in self.n_set:

return None

self.n_set.add(n)

# Height from handshake in crawl.py.

self.redis_pipe.get(f"height:{address}-{port}-{services}")

self.redis_pipe.hget(f"resolve:{address}", "hostname")

self.redis_pipe.hget(f"resolve:{address}", "geoip")

height, hostname, geoip = self.redis_pipe.execute()

if n in self.heights:

# Height from received block inv message in ping.py.

height = (self.heights[n],)

else:

height = (0,) if height is None else (int(height),)

logging.debug("Using handshake height %s: %s", node, height)

hostname = (hostname.decode(),) if hostname else (None,)

if geoip is None:

# resolve.py may not have seen this node in opendata yet when

# it last ran, so manually trigger raw geoip now.

geoip = Resolve().raw_geoip(address)

else:

geoip = tuple(json.loads(geoip))

return node + height + hostname + geoip

def get_heights(self):

"""

Return the latest heights based on received block inv messages.

"""

heights = {}

recent_blocks = []

timestamp_ms = self.timestamp * 1000

# Consensus height from previous export.

prev_height = int(self.redis_conn.get("height") or 0)

response = http_get(CONF["block_heights_url"])

if response is not None:

recent_blocks = response.json()["blocks"]

now = time.time()

logging.info("Timestamp age: %.2f", now - self.timestamp)

for block in recent_blocks:

block_height, block_time, block_hash = block

if block_height < prev_height - 3:

continue

logging.info(

"Block %d (%s) age: %.2f",

block_height,

block_hash,

now - block_time,

)

key = f"binv:{block_hash}"

# [('ADDRESS-PORT', EPOCH_MS),..]

nodes = self.redis_conn.zrangebyscore(

key, "-inf", "+inf", withscores=True, score_cast_func=int

)

for node in nodes:

n, t = node

n = n.decode()

# Reject if t is over timestamp_ms by 60000 ms.

if n not in heights and t <= timestamp_ms + 60000:

heights[n] = block_height

logging.info(

"Heights: %d (s=%.2f)",

len(heights),

time.monotonic() - self.start_t,

)

return heights

def write_json_file(self, rows):

filepath = os.path.join(CONF["export_dir"], f"{self.timestamp}.json")

with open(filepath, "w") as f:

json.dump(rows, f)

logging.info("Wrote %s (%d rows)", filepath, len(rows))

def cron():

"""

Subscribe to 'resolve' message from resolve.py to export GeoIP resolved

nodes into a JSON file.

"""

redis_conn = new_redis_conn(db=CONF["db"])

magic_number = hexlify(CONF["magic_number"]).decode()

subscribe_key = f"resolve:{magic_number}"

publish_key = f"export:{magic_number}"

pubsub = redis_conn.pubsub()

pubsub.subscribe(subscribe_key)

while True:

msg = pubsub.get_message()

if msg is None:

time.sleep(0.1) # 100 ms artificial intrinsic latency.

continue

channel = msg["channel"].decode()

# 'resolve' message is published by resolve.py after resolving hostname

# and GeoIP data for all reachable nodes.

if channel == subscribe_key and msg["type"] == "message":

timestamp = int(msg["data"]) # From ping.py's 'snapshot' message.

logging.info("Timestamp: %d", timestamp)

nodes = redis_conn.zrangebyscore("opendata", "-inf", "+inf")

logging.info("Nodes: %d", len(nodes))

export = Export(timestamp=timestamp, nodes=nodes, redis_conn=redis_conn)

export.export_nodes()

redis_conn.publish(publish_key, timestamp)

def init_conf(config):

"""

Populate CONF with key-value pairs from configuration file.

"""

conf = ConfigParser()

conf.read(config)

CONF["logfile"] = conf.get("export", "logfile")

CONF["magic_number"] = unhexlify(conf.get("export", "magic_number"))

CONF["db"] = conf.getint("export", "db")

CONF["debug"] = conf.getboolean("export", "debug")

CONF["export_dir"] = conf.get("export", "export_dir")

CONF["block_heights_url"] = conf.get("export", "block_heights_url")

if not os.path.exists(CONF["export_dir"]):

os.makedirs(CONF["export_dir"])

def main(argv):

if len(argv) < 2 or not os.path.exists(argv[1]):

print("Usage: export.py [config]")

return 1

# Initialize global conf.

init_conf(argv[1])

# Initialize logger.

init_logger(CONF["logfile"], debug=CONF["debug"])

cron()

return 0

if __name__ == "__main__":

sys.exit(main(sys.argv))

bitnodes/export.py at master · rebroad/bitnodes · GitHub

Expand file tree

Breadcrumbs

export.py

Latest commit

History

Breadcrumbs

export.py

File metadata and controls