-
Notifications
You must be signed in to change notification settings - Fork 24
/
contract_crawler.py
493 lines (389 loc) · 17.2 KB
/
contract_crawler.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
# python contract_crawler.py --web bscscan --session-url https://bscscan.com/address/0x2D530a3b07F2a9Cc3B9043356Af293aEE09ED103#code
# python contract_crawler.py --web polygon --use-api --api-key $POLYGONSCAN_API_KEY --csv ../py-scripts/polygon.addresses.csv
import argparse
import os
import fnmatch
import json
from typing import Optional, Dict, List, Any
from bs4 import BeautifulSoup
import requests
from datetime import datetime
import time
import re
from ratelimit import limits, sleep_and_retry
import undetected_chromedriver as uc
from selenium.webdriver.support.ui import WebDriverWait
from selenium.webdriver.support import expected_conditions as EC
from selenium.webdriver.common.by import By
proxies = {} #{'http': "socks5://127.0.0.1:1080", 'https': "socks5://127.0.0.1:1080"}
REQ_HEADER = {
'user-agent': 'Mozilla/5.0 (X11; CrOS x86_64 8172.45.0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.64 Safari/537.36',
}
VERIFIED_CONTRACT_URL = 'https://etherscan.io/contractsVerified'
CONTRACT_SOURCE_URL = 'https://etherscan.io/address/{}#code'
BASE_URL_BY_NETWORK ={
'etherscan': 'https://api.etherscan.io/api',
'bscscan': 'https://api.bscscan.com/api',
'polygon': 'https://api.polygonscan.com/api'
}
INPAGE_META_TEXT = {'Contract Name:': 'contract_name',
'Compiler Version': 'version',
'Optimization Enabled': 'optimizations',
'Other Settings:': 'settings'}
def to_path_name(s, max_length=255):
s = re.sub(r'[^a-zA-Z0-9\-_\.]', '_', s)
return s[:max_length]
def starts_with_digit(s):
return bool(re.match(r'^\d', s))
session = {}
class any_of_elements_present:
def __init__(self, *locators):
self.locators = locators
def __call__(self, driver):
for locator in self.locators:
try:
element = EC.presence_of_element_located(locator)(driver)
if element:
return element
except:
pass
return False
def catch_all_exceptions(handler):
def decorator(func):
def wrapper(*args, **kwargs):
try:
return func(*args, **kwargs)
except Exception as e:
return handler(e)
return wrapper
return decorator
def exception_silent_handler(e):
# print(f"Caught an exception: {str(e)}")
return None
def get_session_from_chromedriver(url):
options = uc.ChromeOptions()
options.add_argument('--no-sandbox')
options.add_argument('--disable-gpu')
# options.add_argument('--headless=new')
# options.add_argument('--headless')
# driver = uc.Chrome(options=options)
driver = uc.Chrome(options=options, browser_executable_path='/usr/bin/brave', enable_cdp_events=True, version_main=116, force=True)
user_agent = driver.execute_script("return navigator.userAgent;")
selectors = [
'#ctl00 > div.d-md-flex.justify-content-between.my-3 > ul',
'#ContentPlaceHolder1_pageRecords > nav > ul',
'#searchFilterInvoker',
'#ContentPlaceHolder1_li_transactions'
]
selectors = [(By.CSS_SELECTOR, s) for s in selectors]
driver.get(url)
WebDriverWait(driver, 30).until(any_of_elements_present(*selectors))
cookies = driver.get_cookies()
print(cookies)
session = requests.Session()
session.headers.update({'User-Agent': user_agent})
if len(cookies) < 1:
raise Exception('Should have some cookies here')
for cookie in cookies:
session.cookies.set(cookie['name'], cookie['value'])
print(f'Cookies loaded from {url} {session.cookies}')
return session
def load_session(url):
global session
if not session:
session = get_session_from_chromedriver(url)
return session
def address_from_tr(td: Any) -> str:
a = td.select_one('a.js-clipboard')
return a.attrs.get('data-clipboard-text') if (a and a.attrs) else None
# Crawl meta info of contracts by page
def parse_page(page: Optional[int]=None, retry=3, retry_delay=5) -> Optional[List[Dict[str, str]]]:
url = VERIFIED_CONTRACT_URL if page is None else f'{VERIFIED_CONTRACT_URL}/{page}'
print(f'Crawling {url}')
resp = session.get(url, allow_redirects=False)
if resp.status_code != 200:
print(f'No results found on page: {page}, http status: {resp.status_code}')
return None
try:
soup = BeautifulSoup(resp.content, 'lxml')
trs = soup.select('tr')
table_headers = [th.text.strip() for th in trs[0].select('th')]
return [dict(zip(table_headers, [address_from_tr(td) or td.text.strip() for td in tr.select('td')])) for tr in trs[1:]]
except Exception as e:
print(f'Error {e}')
if retry > 0:
time.sleep(retry_delay)
f'Parse page failed for {url}, status {resp.status_code}, retry in {retry_delay} secs'
return parse_page(page, retry-1, retry_delay)
else:
raise e
def parse_for_balance(soup):
bsc_selector = '#ContentPlaceHolder1_divSummary > div.row.mb-4 > div.col-md-6.mb-3.mb-md-0 > div > div.card-body > div:nth-child(1) > div.col-md-8'
eth_selector= '#ContentPlaceHolder1_divSummary > div.row.g-3.mb-4 > div:nth-child(1) > div > div > div:nth-child(2) > div > div'
found = soup.select_one(eth_selector) or soup.select_one(bsc_selector)
return found.text.strip() if found else None
def parse_for_num_txs(soup):
bsc_selector = '#transactions > div.d-md-flex.align-items-center > p'
eth_selector = '#ContentPlaceHolder1_divTxDataInfo > div > p'
found = soup.select_one(eth_selector) or soup.select_one(bsc_selector)
if not found:
return None
s = found.text.strip()
match = re.search(r'a total of ([\d,]+)', s)
if match:
num_str = match.group(1)
num_str = num_str.replace(',', '')
return int(num_str)
else:
return None
# Parse meta data from source code page
def parse_for_inpage_meta(soup):
rows = [t.text.strip().split('\n', maxsplit=1) for t in soup.select('#ContentPlaceHolder1_contractCodeDiv .row div')]
# rows = [t.text.strip().split('\n+', maxsplit=1) for t in soup.select('#ContentPlaceHolder1_contractCodeDiv .row div')]
rows = [[t[0].strip(), t[1].strip()] for t in rows if len(t) == 2]
rows = [(INPAGE_META_TEXT[t[0]], t[1]) for t in rows if t[0] in INPAGE_META_TEXT]
balance = parse_for_balance(soup)
num_txs = parse_for_num_txs(soup)
data = dict(rows)
if balance:
data['balance'] = balance
if num_txs:
data['num_txs'] = num_txs
return data
def parse_for_contract_name(soup):
meta = parse_for_inpage_meta(soup)
return meta['contract_name']
def select_file_names(soup) -> list:
@catch_all_exceptions(exception_silent_handler)
def parse_for_file_name(text):
num_text, name_text = text.strip().split(':')
_, n, _, total = num_text.split()
num = f'{n:0>2}_{total:0>2}'
return f'{num}_{name_text.strip()}'
selectors = ['.d-flex > .text-secondary', '.d-flex > .text-muted', '#dividcode > div > span']
file_spans = []
files = []
for selector in selectors:
file_spans = soup.select(selector)
files = [parse_for_file_name(name.text) for name in file_spans]
files = [f for f in files if f]
if len(files) > 0:
break
return files
def select_sources(soup) -> list:
selectors = ['.js-sourcecopyarea', 'div.ace_scroller > div', 'pre.editor']
sources = []
for selector in selectors:
sources = [e.text for e in soup.select(selector) if e.text and not starts_with_digit(e.text)]
if len(sources) > 0:
break
return sources
def parse_source_soup(soup, address=None, contract_name=None):
address = address or soup.select('title')[0].text.split(r'|')[1].strip().split()[-1]
contract_name = contract_name or parse_for_contract_name(soup) or ''
safe_contract_name = to_path_name(contract_name)
if not contract_name:
print(f'ERROR: No contract name found in {address}')
parent = f'{ROOT_DIR}/{address}_{safe_contract_name}'
os.makedirs(parent, exist_ok=True)
def write_source_file(source_file_name, source_code, overwrite=False):
f = f'{parent}/{source_file_name}'
if (not overwrite) and os.path.exists(f):
return
print(f'Saving {f}')
with open(f, 'w') as f:
f.write(source_code)
files = select_file_names(soup)
sources = select_sources(soup)
if len(sources) < 1:
raise Exception(f'No source code found for {address} {contract_name}')
inpage_meta = parse_for_inpage_meta(soup)
write_source_file(f'inpage_meta.json', json.dumps(inpage_meta), True)
if len(sources) > 1 and len(files) == 0:
raise Exception(f'Multiple source with no file name? {address} {contract_name}')
if len(sources) == 1 and len(files) == 0:
write_source_file(f'{safe_contract_name}.sol', sources[0])
return
# if len(sources) != len(files): the extra source appearing in the sources might just be `settings`
# raise Exception(f'Number of files does not match number of source text: {address} {contract_name}')
for source_file_name, source_code in zip(files, sources):
write_source_file(source_file_name, source_code)
# Save metadata of a contract to a json file
def write_meta_json(contract: Dict[str, str]):
address = contract['Address']
contract_name = contract['Contract Name']
if not (address and contract_name):
raise Exception(f'Bad meta data in {contract}')
parent = f'{ROOT_DIR}/{address}_{contract_name}'
os.makedirs(parent, exist_ok=True)
f = f'{parent}/meta.json'
if not os.path.exists(f):
with open(f, 'w') as f:
f.write(json.dumps(contract, indent=2))
# Get contract source code
def download_source(contract: Dict[str, str], retry=3, retry_delay=5, throw_if_fail=False) -> None:
address = contract['Address']
contract_name = contract['Contract Name']
url = CONTRACT_SOURCE_URL.format(address)
print(f"downloading {url}")
resp = session.get(url, allow_redirects=False)
def maybe_retry(e=None):
if retry > 0:
time.sleep(retry_delay)
f'Download source failed for {address} {contract_name}, status {resp.status_code}, retry in {retry_delay} secs'
return download_source(contract, retry-1, retry_delay)
else:
if throw_if_fail:
raise e or Exception(f'Download source abort for {address} {contract_name}, status {resp.status_code}')
return
if resp.status_code != 200:
maybe_retry()
try:
soup = BeautifulSoup(resp.content, 'lxml')
parse_source_soup(soup, address, contract_name)
except Exception as e:
maybe_retry(e)
def fetch_all():
contracts = [c for p in range(1, 21) for c in parse_page(p)]
now = f"{datetime.now().strftime('%Y%m%d_%H%M%S')}"
with open(f'{ROOT_DIR}/contracts_{now}.json', 'w') as f:
f.write(json.dumps(contracts, indent=2))
for contract in contracts:
write_meta_json(contract)
download_source(contract)
def download_url_poly(url, retry=3, retry_delay=5, throw_if_fail=False):
address = url.split('/')[-1].split('#')[0]
session = get_session_from_chromedriver(url)
resp = session.get(url)
soup = BeautifulSoup(resp.content, 'lxml')
parse_source_soup(soup, address)
def download_url(url, retry=3, retry_delay=5, throw_if_fail=False):
address = url.split('/')[-1].split('#')[0]
resp = session.get(url, allow_redirects=False)
if resp.status_code != 200:
if retry > 0:
time.sleep(retry_delay)
f'Download source failed for {url}, status {resp.status_code}, retry in {retry_delay} secs'
return download_url(url, retry-1, retry_delay)
else:
if throw_if_fail:
raise Exception(f'Download source abort for {url}, status {resp.status_code}')
return
soup = BeautifulSoup(resp.content, 'lxml')
try:
parse_source_soup(soup, address)
except Exception as e:
with open('.example.html', 'wb') as f:
f.write(resp.content)
raise e
def load_addresses_from_csv(csv_path: str, csv_col_index: int = 0):
import csv
with open(csv_path, 'r') as f:
reader = csv.reader(f)
return [row[csv_col_index].lower() for row in reader]
def build_existing_contracts(root: str):
return [f.split('_')[0].lower() for f in os.listdir(root) if os.path.isdir(os.path.join(root, f))]
def is_valid_ethereum_address(address):
pattern = "^0x[a-fA-F0-9]{40}$"
return bool(re.match(pattern, address))
@sleep_and_retry
@limits(calls=5, period=1)
def throttled_get(url):
return requests.get(url)
def retrieve_standard_json_input_by_api(network, api_key, address, root):
if os.path.exists(root):
return
base_url = BASE_URL_BY_NETWORK.get(network)
url = f'{base_url}?module=contract&action=getsourcecode&address={address}&apikey={api_key}'
response = requests.get(url)
data = json.loads(response.text)
if data['status'] == '1':
result = data['result'][0]
contract_name = result.get('ContractName')
if not contract_name:
print(f'Contract name not found for {address}')
return
output = os.path.join(root, f'{address}_{to_path_name(contract_name, 20)}.json')
os.mkdir(root)
with open(output, 'w') as f:
print(output)
json.dump(result, f)
if __name__ == '__main__':
ap = argparse.ArgumentParser()
ap.add_argument("--web", default="etherscan",type=str, help="Choose website, etherscan(default) or bscscan, polygon")
ap.add_argument("--url", type=str, help="URL of contract to download")
ap.add_argument("--output-dir", type=str, help="URL of contract to download", default="./")
ap.add_argument("--session-url", type=str, help="URL to load the first session from")
ap.add_argument("--csv", type=str, help="Load address from csv file")
ap.add_argument("--csv-col-index", type=int, help="Column index of address in csv file", default=-1)
ap.add_argument("--use-api", action='store_true', help="Use API to download source code")
ap.add_argument("--address", type=str, help="Address to download (to be used with the `--use-api` flag)")
ap.add_argument("--api-key", type=str, help="API key for etherscan or bscscan or polygonscan")
args = ap.parse_args()
OUTPUT_DIR = args.output_dir
OUTPUT_DIR = OUTPUT_DIR[:-1] if OUTPUT_DIR.endswith('/') else OUTPUT_DIR
addresses = set()
if args.csv:
addresses = set(load_addresses_from_csv(args.csv, args.csv_col_index))
print(f'Found {len(addresses)} addresses in {args.csv}')
elif args.address:
addresses = set([args.address])
if args.web == 'etherscan':
VERIFIED_CONTRACT_URL = 'https://etherscan.io/contractsVerified'
CONTRACT_SOURCE_URL = 'https://etherscan.io/address/{}#code'
ROOT_DIR = f'{OUTPUT_DIR}/eth_contracts'
os.makedirs(ROOT_DIR, exist_ok=True)
fn = download_url
elif args.web == 'bscscan':
VERIFIED_CONTRACT_URL = 'https://bscscan.com/contractsVerified'
CONTRACT_SOURCE_URL = 'https://bscscan.com/address/{}#code'
ROOT_DIR = f'{OUTPUT_DIR}/bsc_contracts'
os.makedirs(ROOT_DIR, exist_ok=True)
fn = download_url
elif args.web == "polygon":
VERIFIED_CONTRACT_URL = 'https://polygonscan.com/contractsVerified'
CONTRACT_SOURCE_URL = 'https://polygonscan.com/address/{}#code'
ROOT_DIR = f'{OUTPUT_DIR}/polygon_contracts'
os.makedirs(ROOT_DIR, exist_ok=True)
fn = download_url_poly
else:
raise Exception('Invalid website, choose etherscan or bscscan')
print(VERIFIED_CONTRACT_URL)
url = args.url
if not args.use_api:
load_session(args.session_url or VERIFIED_CONTRACT_URL)
if url:
fn(url)
elif args.csv or args.address:
existing = build_existing_contracts(ROOT_DIR)
processed = set()
if os.path.exists('.processed.txt'):
with open('.processed.txt', 'r') as f:
lines = [line.lower() for line in f.read().split('\n')]
processed = set(processed)
ignored = processed.union(existing)
f_processed = open('.processed.txt', 'w')
addresses = addresses.difference(ignored)
print(f'Found {len(addresses)} addresses to process')
for address in addresses:
if not is_valid_ethereum_address(address):
print(f'Invalid address {address}')
continue
url = CONTRACT_SOURCE_URL.format(address)
print(f'Processing {url}')
try:
if args.use_api:
retrieve_standard_json_input_by_api(args.web, args.api_key, address, f'{ROOT_DIR}/{address}')
else:
fn(url)
except KeyError as e:
if 'contract_name' in str(e):
print(f'Probably no code found for {address}')
else:
raise e
finally:
f_processed.write(f'{address}\n')
f_processed.flush()
else:
fetch_all()
print("all jobs done")