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
|
# based on https://github.com/ludbb/secp256k1-py/blob/f5e455227bf1e833128adf80de8ee0ebcebf218c/setup.py
import errno
import logging
import os
import os.path
import platform
import shutil
import subprocess
import sys
import setuptools
from setuptools import setup
try:
# needs new setuptools: >=70.1.0
from setuptools.command.bdist_wheel import bdist_wheel, safer_name, get_platform
except ImportError as e1:
try:
# or needs old wheel: <0.44
from wheel.bdist_wheel import bdist_wheel, safer_name, get_platform
except ImportError as e2:
try:
import wheel
wheel_version = wheel.__version__
except Exception:
wheel_version = None
raise ImportError(
"Cannot import bdist_wheel from either setuptools or wheel. "
"This is likely due to having old 'setuptools' (<70.1) with new 'wheel' (>=0.44) package. "
"This combination is not supported. "
f"Found: {setuptools.__version__=}, {wheel_version=}."
) from e2
_logger = logging.getLogger("electrum_ecc")
MAKE = 'gmake' if platform.system() in ['FreeBSD', 'OpenBSD'] else 'make'
ELECTRUM_ECC_DONT_COMPILE = None
for arg in sys.argv[:]:
if arg.startswith("--electrum_ecc.dont_compile="):
value = arg.split("=", 1)[1]
sys.argv.remove(arg)
ELECTRUM_ECC_DONT_COMPILE = value
break
if ELECTRUM_ECC_DONT_COMPILE is None:
ELECTRUM_ECC_DONT_COMPILE = os.getenv("ELECTRUM_ECC_DONT_COMPILE") or ""
_logger.info(f"Checking env var: {ELECTRUM_ECC_DONT_COMPILE=!r}")
if ELECTRUM_ECC_DONT_COMPILE == "": # unset
IS_COMPILING_LIB = sys.platform != "win32"
elif ELECTRUM_ECC_DONT_COMPILE == "1": # user explicitly opted out
IS_COMPILING_LIB = False
else: # any other value
IS_COMPILING_LIB = True
def absolute(*paths):
op = os.path
return op.realpath(op.abspath(op.join(op.dirname(__file__), *paths)))
def compile_secp(build_dir: str) -> None:
_logger.info(f"Going to compile libsecp ourselves. {build_dir=}")
if not os.path.exists(absolute('libsecp256k1')):
raise Exception("missing git submodule secp256k1")
deps_msg = (
"For compiling libsecp256k1, besides a C compiler, "
"you might be missing one of: autoconf automake libtool."
"\n"
"To opt out of compiling libsecp, set ELECTRUM_ECC_DONT_COMPILE=1 (as an environment variable). "
"If you opt out, you will still need to make sure libsecp256k1 is available "
"(either system-installed or by copying a .so/.dll/.dylib into electrum_ecc/ )"
)
if not os.path.exists(absolute('libsecp256k1/configure')):
# configure script hasn't been generated yet
autogen = absolute('libsecp256k1/autogen.sh')
os.chmod(absolute(autogen), 0o755)
try:
subprocess.check_call([autogen], cwd=absolute('libsecp256k1'))
except (subprocess.CalledProcessError, OSError) as e:
raise Exception(f"autogen.sh failed. {deps_msg}") from e
for filename in [
'libsecp256k1/configure',
'libsecp256k1/build-aux/compile',
'libsecp256k1/build-aux/config.guess',
'libsecp256k1/build-aux/config.sub',
'libsecp256k1/build-aux/depcomp',
'libsecp256k1/build-aux/install-sh',
'libsecp256k1/build-aux/missing',
'libsecp256k1/build-aux/test-driver',
]:
try:
os.chmod(absolute(filename), 0o755)
except OSError as e:
# some of these files might not exist depending on autoconf version
if e.errno != errno.ENOENT:
# If the error isn't 'No such file or directory' something
# else is wrong and we want to know about it
raise
cmd = [
absolute('libsecp256k1/configure'),
'--enable-shared',
'--disable-static',
'--disable-dependency-tracking',
'--with-pic',
'--prefix',
os.path.abspath(build_dir),
'--enable-module-recovery',
'--enable-module-extrakeys',
'--enable-module-schnorrsig',
'--enable-experimental',
'--enable-module-ecdh',
'--enable-benchmark=no',
'--enable-tests=no',
'--enable-openssl-tests=no',
'--enable-exhaustive-tests=no',
]
_logger.info('Running configure: {}'.format(' '.join(cmd)))
try:
subprocess.check_call(cmd, cwd=build_dir)
subprocess.check_call([MAKE], cwd=build_dir)
subprocess.check_call([MAKE, 'install'], cwd=build_dir)
except (subprocess.CalledProcessError, OSError) as e:
raise Exception(f"error compiling libsecp. {deps_msg}") from e
class Custom_bdist_wheel(bdist_wheel):
def finalize_options(self):
if IS_COMPILING_LIB:
# Inject the platform name, e.g. "linux_x86_64".
# This will result in the final build artifact being named e.g.
# electrum_ecc-0.0.2-py3-none-linux_x86_64.whl
self.plat_name = get_platform(self.bdist_dir)
# note: we don't set the python "impl tag" or the "abi tag", as the C lib we build
# does not depend on them (it is not a "C extension" as we don't static link cpython).
bdist_wheel.finalize_options(self)
def _build_and_copy_secp_lib(self):
_build_cmd = self.get_finalized_command('build')
build_dir = os.path.join(_build_cmd.build_base, "temp_libsecp")
target_dir = os.path.join(self.bdist_dir, safer_name(self.distribution.get_name()))
for dir_ in (build_dir, target_dir):
try:
os.makedirs(dir_)
except OSError as e:
if e.errno != errno.EEXIST:
raise
compile_secp(build_dir)
build_temp_libs = os.path.join(build_dir, "lib")
for fname in os.listdir(build_temp_libs):
# note: we skip the versioned .so files (e.g. "*.so.2.2.0"), as wheels don't
# support symlinks and we would end up with ~3 copies of the same file
if fname.endswith(".so") or fname.endswith(".dll") or fname.endswith(".dylib"):
srcpath = os.path.join(build_temp_libs, fname)
_logger.info(f"copying file {srcpath!r} to {target_dir=}")
shutil.copy2(srcpath, target_dir)
def run(self):
if IS_COMPILING_LIB:
self._build_and_copy_secp_lib()
bdist_wheel.run(self)
setup(
cmdclass={
'bdist_wheel': Custom_bdist_wheel,
},
)
|
