-
Notifications
You must be signed in to change notification settings - Fork 81
/
Copy pathsafe_operator.py
961 lines (835 loc) · 35.4 KB
/
safe_operator.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
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
import dataclasses
import os
from functools import cached_property, wraps
from typing import List, Optional, Sequence, Set
from ens import ENS
from eth_account import Account
from eth_account.signers.local import LocalAccount
from eth_typing import ChecksumAddress
from eth_utils import ValidationError
from hexbytes import HexBytes
from packaging import version as semantic_version
from prompt_toolkit import HTML, print_formatted_text
from web3 import Web3
from web3.exceptions import BadFunctionCallOutput
from gnosis.eth import EthereumClient, EthereumNetwork, TxSpeed
from gnosis.eth.clients import EtherscanClient, EtherscanClientConfigurationProblem
from gnosis.eth.constants import NULL_ADDRESS, SENTINEL_ADDRESS
from gnosis.eth.contracts import (
get_erc20_contract,
get_erc721_contract,
get_safe_contract,
get_safe_V1_1_1_contract,
)
from gnosis.safe import InvalidInternalTx, Safe, SafeOperation, SafeTx
from gnosis.safe.multi_send import MultiSend, MultiSendOperation, MultiSendTx
from safe_cli.api.relay_service_api import RelayServiceApi
from safe_cli.api.transaction_service_api import TransactionServiceApi
from safe_cli.ethereum_hd_wallet import get_account_from_words
from safe_cli.safe_addresses import (
get_default_fallback_handler_address,
get_safe_contract_address,
get_safe_l2_contract_address,
)
from safe_cli.utils import get_erc_20_list, yes_or_no_question
@dataclasses.dataclass
class SafeCliInfo:
address: str
nonce: int
threshold: int
owners: List[str]
master_copy: str
modules: List[str]
fallback_handler: str
guard: str
balance_ether: int
version: str
def __str__(self):
return (
f"safe-version={self.version} nonce={self.nonce} threshold={self.threshold} owners={self.owners} "
f"master-copy={self.master_copy} fallback-hander={self.fallback_handler} "
f"modules={self.modules} balance-ether={self.balance_ether:.4f}"
)
class SafeOperatorException(Exception):
pass
class ExistingOwnerException(SafeOperatorException):
pass
class NonExistingOwnerException(SafeOperatorException):
pass
class HashAlreadyApproved(SafeOperatorException):
pass
class ThresholdLimitException(SafeOperatorException):
pass
class SameFallbackHandlerException(SafeOperatorException):
pass
class InvalidFallbackHandlerException(SafeOperatorException):
pass
class FallbackHandlerNotSupportedException(SafeOperatorException):
pass
class SameGuardException(SafeOperatorException):
pass
class InvalidGuardException(SafeOperatorException):
pass
class GuardNotSupportedException(SafeOperatorException):
pass
class SameMasterCopyException(SafeOperatorException):
pass
class SafeAlreadyUpdatedException(SafeOperatorException):
pass
class UpdateAddressesNotValid(SafeOperatorException):
pass
class SenderRequiredException(SafeOperatorException):
pass
class AccountNotLoadedException(SafeOperatorException):
pass
class NotEnoughSignatures(SafeOperatorException):
pass
class InvalidMasterCopyException(SafeOperatorException):
pass
class NotEnoughEtherToSend(SafeOperatorException):
pass
class NotEnoughTokenToSend(SafeOperatorException):
pass
class SafeServiceNotAvailable(SafeOperatorException):
pass
def require_tx_service(f):
@wraps(f)
def decorated(self, *args, **kwargs):
if not self.safe_tx_service:
print_formatted_text(
HTML(
f"<ansired>No tx service available for "
f"network={self.network.name}</ansired>"
)
)
if self.etherscan:
url = f"{self.etherscan.base_url}/address/{self.address}"
print_formatted_text(HTML(f"<b>Try Etherscan instead</b> {url}"))
else:
return f(self, *args, **kwargs)
return decorated
def require_default_sender(f):
"""
Throws SenderRequiredException if not default sender configured
"""
@wraps(f)
def decorated(self, *args, **kwargs):
if not self.default_sender:
raise SenderRequiredException()
else:
return f(self, *args, **kwargs)
return decorated
class SafeOperator:
def __init__(self, address: str, node_url: str):
self.address = address
self.node_url = node_url
self.ethereum_client = EthereumClient(self.node_url)
self.ens = ENS.from_web3(self.ethereum_client.w3)
self.network: EthereumNetwork = self.ethereum_client.get_network()
try:
self.etherscan = EtherscanClient(self.network)
except EtherscanClientConfigurationProblem:
self.etherscan = None
self.safe_relay_service = RelayServiceApi.from_ethereum_client(
self.ethereum_client
)
self.safe_tx_service = TransactionServiceApi.from_ethereum_client(
self.ethereum_client
)
self.safe = Safe(address, self.ethereum_client)
self.safe_contract = self.safe.contract
self.safe_contract_1_1_0 = get_safe_V1_1_1_contract(
self.ethereum_client.w3, address=self.address
)
self.accounts: Set[LocalAccount] = set()
self.default_sender: Optional[LocalAccount] = None
self.executed_transactions: List[str] = []
self._safe_cli_info: Optional[SafeCliInfo] = None # Cache for SafeCliInfo
self.require_all_signatures = (
True # Require all signatures to be present to send a tx
)
@cached_property
def last_default_fallback_handler_address(self) -> ChecksumAddress:
"""
:return: Address for last version of default fallback handler contract
"""
return get_default_fallback_handler_address(self.ethereum_client)
@cached_property
def last_safe_contract_address(self) -> ChecksumAddress:
"""
:return: Last version of the Safe Contract. Use events version for every network but mainnet
"""
if self.network == EthereumNetwork.MAINNET:
return get_safe_contract_address(self.ethereum_client)
else:
return get_safe_l2_contract_address(self.ethereum_client)
@cached_property
def ens_domain(self) -> Optional[str]:
# FIXME After web3.py fixes the middleware copy
if self.network == EthereumNetwork.MAINNET:
return self.ens.name(self.address)
@property
def safe_cli_info(self) -> SafeCliInfo:
if not self._safe_cli_info:
self._safe_cli_info = self.refresh_safe_cli_info()
return self._safe_cli_info
def is_version_updated(self) -> bool:
"""
:return: True if Safe Master Copy is updated, False otherwise
"""
if self._safe_cli_info.master_copy == self.last_safe_contract_address:
return True
else: # Check versions, maybe safe-cli addresses were not updated
safe_contract = get_safe_contract(
self.ethereum_client.w3, self.last_safe_contract_address
)
try:
safe_contract_version = safe_contract.functions.VERSION().call()
except BadFunctionCallOutput: # Safe master copy is not deployed or errored, maybe custom network
return True # We cannot say you are not updated ¯\_(ツ)_/¯
return semantic_version.parse(
self.safe_cli_info.version
) >= semantic_version.parse(safe_contract_version)
def refresh_safe_cli_info(self) -> SafeCliInfo:
self._safe_cli_info = self.get_safe_cli_info()
return self._safe_cli_info
def load_cli_owners_from_words(self, words: List[str]):
if len(words) == 1: # Reading seed from Environment Variable
words = os.environ.get(words[0], default="").strip().split(" ")
parsed_words = " ".join(words)
try:
for index in range(100): # Try first accounts of seed phrase
account = get_account_from_words(parsed_words, index=index)
if account.address in self.safe_cli_info.owners:
self.load_cli_owners([account.key.hex()])
if not index:
print_formatted_text(
HTML(
"<ansired>Cannot generate any valid owner for this Safe</ansired>"
)
)
except ValidationError:
print_formatted_text(
HTML("<ansired>Cannot load owners from words</ansired>")
)
def load_cli_owners(self, keys: List[str]):
for key in keys:
try:
account = Account.from_key(
os.environ.get(key, default=key)
) # Try to get key from `environ`
self.accounts.add(account)
balance = self.ethereum_client.get_balance(account.address)
print_formatted_text(
HTML(
f"Loaded account <b>{account.address}</b> "
f'with balance={Web3.from_wei(balance, "ether")} ether'
)
)
if not self.default_sender and balance > 0:
print_formatted_text(
HTML(
f"Set account <b>{account.address}</b> as default sender of txs"
)
)
self.default_sender = account
except ValueError:
print_formatted_text(HTML(f"<ansired>Cannot load key={key}</ansired>"))
def unload_cli_owners(self, owners: List[str]):
accounts_to_remove: Set[Account] = set()
for owner in owners:
for account in self.accounts:
if account.address == owner:
if self.default_sender and self.default_sender.address == owner:
self.default_sender = None
accounts_to_remove.add(account)
break
self.accounts = self.accounts.difference(accounts_to_remove)
if accounts_to_remove:
print_formatted_text(
HTML("<ansigreen>Accounts have been deleted</ansigreen>")
)
else:
print_formatted_text(HTML("<ansired>No account was deleted</ansired>"))
def show_cli_owners(self):
if not self.accounts:
print_formatted_text(HTML("<ansired>No accounts loaded</ansired>"))
else:
for account in self.accounts:
print_formatted_text(
HTML(
f"<ansigreen><b>Account</b> {account.address} loaded</ansigreen>"
)
)
if self.default_sender:
print_formatted_text(
HTML(
f"<ansigreen><b>Default sender:</b> {self.default_sender.address}"
f"</ansigreen>"
)
)
else:
print_formatted_text(
HTML("<ansigreen>Not default sender set </ansigreen>")
)
def approve_hash(self, hash_to_approve: HexBytes, sender: str) -> bool:
sender_account = [
account for account in self.accounts if account.address == sender
]
if not sender_account:
raise AccountNotLoadedException(sender)
elif sender not in self.safe_cli_info.owners:
raise NonExistingOwnerException(sender)
elif self.safe.retrieve_is_hash_approved(
self.default_sender.address, hash_to_approve
):
raise HashAlreadyApproved(hash_to_approve, self.default_sender.address)
else:
sender_account = sender_account[0]
transaction_to_send = self.safe_contract.functions.approveHash(
hash_to_approve
).build_transaction(
{
"from": sender_account.address,
"nonce": self.ethereum_client.get_nonce_for_account(
sender_account.address
),
}
)
if self.ethereum_client.is_eip1559_supported():
transaction_to_send = self.ethereum_client.set_eip1559_fees(
transaction_to_send
)
call_result = self.ethereum_client.w3.eth.call(transaction_to_send)
if call_result: # There's revert message
return False
else:
signed_transaction = sender_account.sign_transaction(
transaction_to_send
)
tx_hash = self.ethereum_client.send_raw_transaction(
signed_transaction["rawTransaction"]
)
print_formatted_text(
HTML(
f"<ansigreen>Sent tx with tx-hash {tx_hash.hex()} from owner "
f"{self.default_sender.address}, waiting for receipt</ansigreen>"
)
)
if self.ethereum_client.get_transaction_receipt(tx_hash, timeout=120):
return True
else:
print_formatted_text(
HTML(
f"<ansired>Tx with tx-hash {tx_hash.hex()} still not mined</ansired>"
)
)
return False
def add_owner(self, new_owner: str, threshold: Optional[int] = None) -> bool:
threshold = threshold if threshold is not None else self.safe_cli_info.threshold
if new_owner in self.safe_cli_info.owners:
raise ExistingOwnerException(new_owner)
else:
# TODO Allow to set threshold
transaction = self.safe_contract.functions.addOwnerWithThreshold(
new_owner, threshold
).build_transaction({"from": self.address, "gas": 0, "gasPrice": 0})
if self.execute_safe_internal_transaction(transaction["data"]):
self.safe_cli_info.owners = self.safe.retrieve_owners()
self.safe_cli_info.threshold = threshold
return True
return False
def remove_owner(self, owner_to_remove: str, threshold: Optional[int] = None):
threshold = threshold if threshold is not None else self.safe_cli_info.threshold
if owner_to_remove not in self.safe_cli_info.owners:
raise NonExistingOwnerException(owner_to_remove)
elif len(self.safe_cli_info.owners) == threshold:
raise ThresholdLimitException()
else:
index_owner = self.safe_cli_info.owners.index(owner_to_remove)
prev_owner = (
self.safe_cli_info.owners[index_owner - 1]
if index_owner
else SENTINEL_ADDRESS
)
transaction = self.safe_contract.functions.removeOwner(
prev_owner, owner_to_remove, threshold
).build_transaction({"from": self.address, "gas": 0, "gasPrice": 0})
if self.execute_safe_internal_transaction(transaction["data"]):
self.safe_cli_info.owners = self.safe.retrieve_owners()
self.safe_cli_info.threshold = threshold
return True
return False
def send_custom(
self,
to: str,
value: int,
data: bytes,
safe_nonce: Optional[int] = None,
delegate_call: bool = False,
) -> bool:
if value > 0:
safe_balance = self.ethereum_client.get_balance(self.address)
if safe_balance < value:
raise NotEnoughEtherToSend(safe_balance)
operation = SafeOperation.DELEGATE_CALL if delegate_call else SafeOperation.CALL
return self.prepare_and_execute_safe_transaction(
to, value, data, operation, safe_nonce=safe_nonce
)
def send_ether(self, to: str, value: int, **kwargs) -> bool:
return self.send_custom(to, value, b"", **kwargs)
def send_erc20(self, to: str, token_address: str, amount: int, **kwargs) -> bool:
transaction = (
get_erc20_contract(self.ethereum_client.w3, token_address)
.functions.transfer(to, amount)
.build_transaction({"from": self.address, "gas": 0, "gasPrice": 0})
)
return self.send_custom(
token_address, 0, HexBytes(transaction["data"]), **kwargs
)
def send_erc721(self, to: str, token_address: str, token_id: int, **kwargs) -> bool:
transaction = (
get_erc721_contract(self.ethereum_client.w3, token_address)
.functions.transferFrom(self.address, to, token_id)
.build_transaction({"from": self.address, "gas": 0, "gasPrice": 0})
)
return self.send_custom(token_address, 0, transaction["data"], **kwargs)
def change_fallback_handler(self, new_fallback_handler: str) -> bool:
if new_fallback_handler == self.safe_cli_info.fallback_handler:
raise SameFallbackHandlerException(new_fallback_handler)
elif semantic_version.parse(
self.safe_cli_info.version
) < semantic_version.parse("1.1.0"):
raise FallbackHandlerNotSupportedException()
elif (
new_fallback_handler != NULL_ADDRESS
and not self.ethereum_client.is_contract(new_fallback_handler)
):
raise InvalidFallbackHandlerException(
f"{new_fallback_handler} address is not a contract"
)
else:
transaction = self.safe_contract.functions.setFallbackHandler(
new_fallback_handler
).build_transaction({"from": self.address, "gas": 0, "gasPrice": 0})
if self.execute_safe_internal_transaction(transaction["data"]):
self.safe_cli_info.fallback_handler = new_fallback_handler
self.safe_cli_info.version = self.safe.retrieve_version()
return True
def change_guard(self, guard: str) -> bool:
if guard == self.safe_cli_info.guard:
raise SameGuardException(guard)
elif semantic_version.parse(
self.safe_cli_info.version
) < semantic_version.parse("1.3.0"):
raise GuardNotSupportedException()
elif guard != NULL_ADDRESS and not self.ethereum_client.is_contract(guard):
raise InvalidGuardException(f"{guard} address is not a contract")
else:
transaction = self.safe_contract.functions.setGuard(
guard
).build_transaction({"from": self.address, "gas": 0, "gasPrice": 0})
if self.execute_safe_internal_transaction(transaction["data"]):
self.safe_cli_info.guard = guard
self.safe_cli_info.version = self.safe.retrieve_version()
return True
def change_master_copy(self, new_master_copy: str) -> bool:
if new_master_copy == self.safe_cli_info.master_copy:
raise SameMasterCopyException(new_master_copy)
else:
try:
Safe(new_master_copy, self.ethereum_client).retrieve_version()
except BadFunctionCallOutput:
raise InvalidMasterCopyException(new_master_copy)
transaction = self.safe_contract_1_1_0.functions.changeMasterCopy(
new_master_copy
).build_transaction({"from": self.address, "gas": 0, "gasPrice": 0})
if self.execute_safe_internal_transaction(transaction["data"]):
self.safe_cli_info.master_copy = new_master_copy
self.safe_cli_info.version = self.safe.retrieve_version()
return True
def update_version(self) -> Optional[bool]:
"""
Update Safe Master Copy and Fallback handler to the last version
:return:
"""
if self.is_version_updated():
raise SafeAlreadyUpdatedException()
addresses = (
self.last_safe_contract_address,
self.last_default_fallback_handler_address,
)
if not all(
self.ethereum_client.is_contract(contract) for contract in addresses
):
raise UpdateAddressesNotValid(
"Not valid addresses to update Safe", *addresses
)
multisend = MultiSend(ethereum_client=self.ethereum_client)
tx_params = {"from": self.address, "gas": 0, "gasPrice": 0}
multisend_txs = [
MultiSendTx(MultiSendOperation.CALL, self.address, 0, data)
for data in (
self.safe_contract_1_1_0.functions.changeMasterCopy(
self.last_safe_contract_address
).build_transaction(tx_params)["data"],
self.safe_contract_1_1_0.functions.setFallbackHandler(
self.last_default_fallback_handler_address
).build_transaction(tx_params)["data"],
)
]
multisend_data = multisend.build_tx_data(multisend_txs)
if self.prepare_and_execute_safe_transaction(
multisend.address, 0, multisend_data, operation=SafeOperation.DELEGATE_CALL
):
self.safe_cli_info.master_copy = self.last_safe_contract_address
self.safe_cli_info.fallback_handler = (
self.last_default_fallback_handler_address
)
self.safe_cli_info.version = self.safe.retrieve_version()
def change_threshold(self, threshold: int):
if threshold == self.safe_cli_info.threshold:
print_formatted_text(
HTML(f"<ansired>Threshold is already {threshold}</ansired>")
)
elif threshold > len(self.safe_cli_info.owners):
print_formatted_text(
HTML(
f"<ansired>Threshold={threshold} bigger than number "
f"of owners={len(self.safe_cli_info.owners)}</ansired>"
)
)
else:
transaction = self.safe_contract.functions.changeThreshold(
threshold
).build_transaction({"from": self.address, "gas": 0, "gasPrice": 0})
if self.execute_safe_internal_transaction(transaction["data"]):
self.safe_cli_info.threshold = threshold
def enable_module(self, module_address: str):
if module_address in self.safe_cli_info.modules:
print_formatted_text(
HTML(f"<ansired>Module {module_address} is already enabled</ansired>")
)
else:
transaction = self.safe_contract.functions.enableModule(
module_address
).build_transaction({"from": self.address, "gas": 0, "gasPrice": 0})
if self.execute_safe_internal_transaction(transaction["data"]):
self.safe_cli_info.modules = self.safe.retrieve_modules()
def disable_module(self, module_address: str):
if module_address not in self.safe_cli_info.modules:
print_formatted_text(
HTML(f"<ansired>Module {module_address} is not enabled</ansired>")
)
else:
pos = self.safe_cli_info.modules.index(module_address)
if pos == 0:
previous_address = SENTINEL_ADDRESS
else:
previous_address = self.safe_cli_info.modules[pos - 1]
transaction = self.safe_contract.functions.disableModule(
previous_address, module_address
).build_transaction({"from": self.address, "gas": 0, "gasPrice": 0})
if self.execute_safe_internal_transaction(transaction["data"]):
self.safe_cli_info.modules = self.safe.retrieve_modules()
def print_info(self):
for key, value in dataclasses.asdict(self.safe_cli_info).items():
print_formatted_text(
HTML(
f"<b><ansigreen>{key.capitalize()}</ansigreen></b>="
f"<ansiblue>{value}</ansiblue>"
)
)
if self.ens_domain:
print_formatted_text(
HTML(
f"<b><ansigreen>Ens domain</ansigreen></b>="
f"<ansiblue>{self.ens_domain}</ansiblue>"
)
)
if self.safe_tx_service:
url = f"{self.safe_tx_service.base_url}/api/v1/safes/{self.address}/transactions/"
print_formatted_text(
HTML(
f"<b><ansigreen>Safe Tx Service</ansigreen></b>="
f"<ansiblue>{url}</ansiblue>"
)
)
if self.safe_relay_service:
url = f"{self.safe_relay_service.base_url}/api/v1/safes/{self.address}/transactions/"
print_formatted_text(
HTML(
f"<b><ansigreen>Safe Relay Service</ansigreen></b>="
f"<ansiblue>{url}</ansiblue>"
)
)
if self.etherscan:
url = f"{self.etherscan.base_url}/address/{self.address}"
print_formatted_text(
HTML(
f"<b><ansigreen>Etherscan</ansigreen></b>="
f"<ansiblue>{url}</ansiblue>"
)
)
if not self.is_version_updated():
print_formatted_text(
HTML(
"<ansired>Safe is not updated! You can use <b>update</b> command to update "
"the Safe to a newest version</ansired>"
)
)
def get_safe_cli_info(self) -> SafeCliInfo:
safe = self.safe
balance_ether = Web3.from_wei(
self.ethereum_client.get_balance(self.address), "ether"
)
safe_info = safe.retrieve_all_info()
return SafeCliInfo(
self.address,
safe_info.nonce,
safe_info.threshold,
safe_info.owners,
safe_info.master_copy,
safe_info.modules,
safe_info.fallback_handler,
safe_info.guard,
balance_ether,
safe_info.version,
)
def get_threshold(self):
print_formatted_text(self.safe.retrieve_threshold())
def get_nonce(self):
print_formatted_text(self.safe.retrieve_nonce())
def get_owners(self):
print_formatted_text(self.safe.retrieve_owners())
def execute_safe_internal_transaction(self, data: bytes) -> bool:
return self.prepare_and_execute_safe_transaction(self.address, 0, data)
def prepare_safe_transaction(
self,
to: str,
value: int,
data: bytes,
operation: SafeOperation = SafeOperation.CALL,
safe_nonce: Optional[int] = None,
) -> SafeTx:
safe_tx = self.safe.build_multisig_tx(
to, value, data, operation=operation.value, safe_nonce=safe_nonce
)
self.sign_transaction(safe_tx) # Raises exception if it cannot be signed
return safe_tx
def prepare_and_execute_safe_transaction(
self,
to: str,
value: int,
data: bytes,
operation: SafeOperation = SafeOperation.CALL,
safe_nonce: Optional[int] = None,
) -> bool:
safe_tx = self.prepare_safe_transaction(
to, value, data, operation, safe_nonce=safe_nonce
)
return self.execute_safe_transaction(safe_tx)
@require_default_sender # Throws Exception if default sender not found
def execute_safe_transaction(self, safe_tx: SafeTx):
try:
call_result = safe_tx.call(self.default_sender.address)
print_formatted_text(HTML(f"Result: <ansigreen>{call_result}</ansigreen>"))
if yes_or_no_question("Do you want to execute tx " + str(safe_tx)):
tx_hash, tx = safe_tx.execute(
self.default_sender.key, eip1559_speed=TxSpeed.NORMAL
)
self.executed_transactions.append(tx_hash.hex())
print_formatted_text(
HTML(
f"<ansigreen>Sent tx with tx-hash {tx_hash.hex()} "
f"and safe-nonce {safe_tx.safe_nonce}, waiting for receipt</ansigreen>"
)
)
tx_receipt = self.ethereum_client.get_transaction_receipt(
tx_hash, timeout=120
)
if tx_receipt:
fees = self.ethereum_client.w3.from_wei(
tx_receipt["gasUsed"]
* tx_receipt.get("effectiveGasPrice", tx.get("gasPrice", 0)),
"ether",
)
print_formatted_text(
HTML(
f"<ansigreen>Tx was executed on block-number={tx_receipt['blockNumber']}, fees "
f"deducted={fees}</ansigreen>"
)
)
self.safe_cli_info.nonce += 1
return True
else:
print_formatted_text(
HTML(
f"<ansired>Tx with tx-hash {tx_hash.hex()} still not mined</ansired>"
)
)
except InvalidInternalTx as invalid_internal_tx:
print_formatted_text(
HTML(f"Result: <ansired>InvalidTx - {invalid_internal_tx}</ansired>")
)
return False
# Batch_transactions multisend
def batch_safe_txs(
self, safe_nonce: int, safe_txs: Sequence[SafeTx]
) -> Optional[SafeTx]:
"""
Submit signatures to the tx service. It's recommended to be on Safe v1.3.0 to prevent issues
with `safeTxGas` and gas estimation.
:return:
"""
try:
multisend = MultiSend(ethereum_client=self.ethereum_client)
except ValueError:
multisend = None
print_formatted_text(
HTML(
"<ansired>Multisend contract is not deployed on this network and it's required for "
"batching txs</ansired>"
)
)
multisend_txs = []
for safe_tx in safe_txs:
# Check if call is already a Multisend call
inner_txs = MultiSend.from_transaction_data(safe_tx.data)
if inner_txs:
multisend_txs.extend(inner_txs)
else:
multisend_txs.append(
MultiSendTx(
MultiSendOperation.CALL, safe_tx.to, safe_tx.value, safe_tx.data
)
)
if len(multisend_txs) == 1:
safe_tx.safe_tx_gas = 0
safe_tx.base_gas = 0
safe_tx.gas_price = 0
safe_tx.signatures = b""
safe_tx.safe_nonce = safe_nonce # Resend single transaction
elif multisend:
safe_tx = SafeTx(
self.ethereum_client,
self.address,
multisend.address,
0,
multisend.build_tx_data(multisend_txs),
SafeOperation.DELEGATE_CALL.value,
0,
0,
0,
None,
None,
safe_nonce=safe_nonce,
)
else:
# Multisend not defined
return None
safe_tx = self.sign_transaction(safe_tx)
if not safe_tx.signatures:
print_formatted_text(
HTML("<ansired>At least one owner must be loaded</ansired>")
)
return None
else:
return safe_tx
# TODO Set sender so we can save gas in that signature
def sign_transaction(self, safe_tx: SafeTx) -> SafeTx:
permitted_signers = self.get_permitted_signers()
threshold = self.safe_cli_info.threshold
selected_accounts: List[
Account
] = [] # Some accounts that are not an owner can be loaded
for account in self.accounts:
if account.address in permitted_signers:
selected_accounts.append(account)
threshold -= 1
if threshold == 0:
break
if self.require_all_signatures and threshold > 0:
raise NotEnoughSignatures(threshold)
for selected_account in selected_accounts:
safe_tx.sign(selected_account.key)
return safe_tx
@require_tx_service
def _require_tx_service_mode(self):
print_formatted_text(
HTML(
"<ansired>First enter tx-service mode using <b>tx-service</b> command</ansired>"
)
)
def get_delegates(self):
return self._require_tx_service_mode()
def add_delegate(self, delegate_address: str, label: str, signer_address: str):
return self._require_tx_service_mode()
def remove_delegate(self, delegate_address: str, signer_address: str):
return self._require_tx_service_mode()
def submit_signatures(self, safe_tx_hash: bytes) -> bool:
return self._require_tx_service_mode()
def get_balances(self):
return self._require_tx_service_mode()
def get_transaction_history(self):
return self._require_tx_service_mode()
def batch_txs(self, safe_nonce: int, safe_tx_hashes: Sequence[bytes]) -> bool:
return self._require_tx_service_mode()
def execute_tx(self, safe_tx_hash: Sequence[bytes]) -> bool:
return self._require_tx_service_mode()
def get_permitted_signers(self) -> Set[str]:
return set(self.safe_cli_info.owners)
def drain(self, to: str):
# Getting all events related with ERC20 transfers
last = self.ethereum_client.get_block("latest")["number"]
token_addresses = get_erc_20_list(self.ethereum_client, self.address, 1, last)
safe_txs = []
for token_address in token_addresses:
balance = self.ethereum_client.erc20.get_balance(
self.address, token_address
)
if balance > 0:
transaction = (
get_erc20_contract(self.ethereum_client.w3, token_address)
.functions.transfer(to, balance)
.build_transaction({"from": self.address, "gas": 0, "gasPrice": 0})
)
safe_tx = self.prepare_safe_transaction(
token_address,
0,
HexBytes(transaction["data"]),
SafeOperation.CALL,
safe_nonce=None,
)
safe_txs.append(safe_tx)
# Getting ethereum balance
balance_eth = self.ethereum_client.get_balance(self.address)
if balance_eth:
safe_tx = self.prepare_safe_transaction(
to,
balance_eth,
b"",
SafeOperation.CALL,
safe_nonce=None,
)
safe_txs.append(safe_tx)
if safe_txs:
multisend_tx = self.batch_safe_txs(self.get_nonce(), safe_txs)
if multisend_tx is not None:
if self.execute_safe_transaction(multisend_tx):
print_formatted_text(
HTML(
"<ansigreen>Transaction to drain account correctly executed</ansigreen>"
)
)
else:
print_formatted_text(
HTML("<ansigreen>Safe account is currently empty</ansigreen>")
)
def process_command(self, first_command: str, rest_command: List[str]) -> bool:
if first_command == "help":
print_formatted_text("I still cannot help you")
elif first_command == "refresh":
print_formatted_text("Reloading Safe information")
self.refresh_safe_cli_info()
return False