-
Notifications
You must be signed in to change notification settings - Fork 4
/
run_service.py
926 lines (782 loc) · 34.9 KB
/
run_service.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
# -*- coding: utf-8 -*-
# ------------------------------------------------------------------------------
#
# Copyright 2024 Valory AG
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# ------------------------------------------------------------------------------
"""Olas Modius Quickstart script."""
import warnings
warnings.filterwarnings("ignore", category=UserWarning)
import sys
import tty
import termios
import getpass
import json
import os
import sys
import time
import typing as t
import math
from dataclasses import dataclass
from pathlib import Path
from decimal import Decimal, ROUND_UP
from enum import Enum
import requests
import yaml
from aea.crypto.base import LedgerApi
from aea_ledger_ethereum import EthereumApi, EIP1559, get_base_fee_multiplier
from dotenv import load_dotenv
from eth_utils import to_wei
from halo import Halo
from termcolor import colored
from web3 import Web3
from web3.types import Wei, TxParams
from typing import Dict, Any, Optional
from operate.account.user import UserAccount
from operate.cli import OperateApp
from operate.ledger.profiles import OLAS, STAKING, CONTRACTS
from operate.resource import LocalResource, deserialize
from operate.services.manage import ServiceManager
from operate.services.service import Service
from operate.types import (
LedgerType,
ServiceTemplate,
ConfigurationTemplate,
FundRequirementsTemplate, ChainType, OnChainState,
)
load_dotenv()
SUGGESTED_TOP_UP_DEFAULT = 1_000_000_000_000_000
SUGGESTED_SAFE_TOP_UP_DEFAULT = 5_000_000_000_000_000
MASTER_WALLET_MIMIMUM_BALANCE = 6_001_000_000_000_000
COST_OF_BOND = 1
COST_OF_BOND_STAKING = 2 * 10 ** 19
STAKED_BONDING_TOKEN = "OLAS"
FALLBACK_INVESTMENT_FUNDS_REQUIREMENT = {"USDC": 18_000_000, "ETH": 7_000_000_000_000_000}
USDC_ADDRESS = "0xd988097fb8612cc24eeC14542bC03424c656005f"
WARNING_ICON = colored('\u26A0', 'yellow')
OPERATE_HOME = Path.cwd() / ".olas-modius"
DEFAULT_MIN_SWAP_AMOUNT_THRESHOLD = 15
DEFAULT_STAKING_CHAIN = "mode"
DEFAULT_FEE_HISTORY_PERCENTILE = 50
CHAIN_ID_TO_METADATA = {
34443: {
"name": "Mode",
"token": "ETH",
"operationalFundReq": SUGGESTED_TOP_UP_DEFAULT * 10,
"gasParams": {
# this means default values will be used
"FEE_HISTORY_PERCENTILE": "50",
"DEFAULT_PRIORITY_FEE": "2000000",
"MAX_PRIORITY_FEE_PER_GAS": "3000000",
"MAX_FEE_PER_GAS": "20000000",
}
},
}
COINGECKO_CHAIN_TO_PLATFORM_ID_MAPPING = {
"mode":"mode"
}
ZERO_ADDRESS = "0x0000000000000000000000000000000000000000"
DEFAULT_MAX_FEE = 20000000
use_default_max_fee = True
class Strategy(Enum):
"""Strategy type"""
MerklPoolSearchStrategy = "merkl_pools_search"
BalancerPoolSearchStrategy = "balancer_pools_search"
SturdyLendingStrategy = "asset_lending"
def estimate_priority_fee(
web3_object: Web3,
block_number: int,
fee_history_blocks: int,
fee_history_percentile: int,
priority_fee_increase_boundary: int,
) -> t.Optional[int]:
"""Estimate priority fee from base fee."""
fee_history = web3_object.eth.fee_history(
fee_history_blocks, block_number, [fee_history_percentile] # type: ignore
)
# This is going to break if more percentiles are introduced in the future,
# i.e., `fee_history_percentile` param becomes a `List[int]`.
rewards = sorted([reward[0] for reward in fee_history.get("reward", []) if reward[0] > 0])
if len(rewards) == 0:
return None
# Calculate percentage increases from between ordered list of fees
percentage_increases = [
((j - i) / i) * 100 if i != 0 else 0 for i, j in zip(rewards[:-1], rewards[1:])
]
highest_increase = max(percentage_increases)
highest_increase_index = percentage_increases.index(highest_increase)
values = rewards.copy()
# If we have big increase in value, we could be considering "outliers" in our estimate
# Skip the low elements and take a new median
if (
highest_increase > priority_fee_increase_boundary
and highest_increase_index >= len(values) // 2
):
values = values[highest_increase_index:]
return values[len(values) // 2]
def get_masked_input(prompt: str) -> str:
"""Get user input while masking it with asterisks."""
password = ""
sys.stdout.write(prompt)
sys.stdout.flush()
fd = sys.stdin.fileno()
old_settings = termios.tcgetattr(fd)
try:
tty.setraw(fd)
while True:
char = sys.stdin.read(1)
if char == '\r' or char == '\n':
break
if char == '\x7f':
if password:
password = password[:-1]
sys.stdout.write('\b \b')
else:
password += char
sys.stdout.write('*')
sys.stdout.flush()
finally:
termios.tcsetattr(fd, termios.TCSADRAIN, old_settings)
sys.stdout.write('\n')
return password
@dataclass
class OptimusConfig(LocalResource):
"""Local configuration."""
path: Path
mode_rpc: t.Optional[str] = None
tenderly_access_key: t.Optional[str] = None
tenderly_account_slug: t.Optional[str] = None
tenderly_project_slug: t.Optional[str] = None
coingecko_api_key: t.Optional[str] = None
min_swap_amount_threshold: t.Optional[int] = None
password_migrated: t.Optional[bool] = None
use_staking: t.Optional[bool] = None
allowed_chains: t.Optional[list[str]] = None
target_investment_chains: t.Optional[list[str]] = None
staking_chain: t.Optional[str] = None
principal_chain: t.Optional[str] = None
investment_funding_requirements: t.Optional[Dict[str, Any]] = None
selected_strategies: t.Optional[list[str]] = None
@classmethod
def from_json(cls, obj: t.Dict) -> "LocalResource":
"""Load LocalResource from json."""
kwargs = {}
for pname, ptype in cls.__annotations__.items():
if pname.startswith("_"):
continue
# allow for optional types
is_optional_type = t.get_origin(ptype) is t.Union and type(None) in t.get_args(ptype)
value = obj.get(pname, None)
if is_optional_type and value is None:
continue
kwargs[pname] = deserialize(obj=obj[pname], otype=ptype)
return cls(**kwargs)
def print_box(text: str, margin: int = 1, character: str = '=') -> None:
"""Print text centered within a box."""
lines = text.split('\n')
text_length = max(len(line) for line in lines)
length = text_length + 2 * margin
border = character * length
margin_str = ' ' * margin
print(border)
print(f"{margin_str}{text}{margin_str}")
print(border)
print()
def print_title(text: str) -> None:
"""Print title."""
print()
print_box(text, 4, '=')
def print_section(text: str) -> None:
"""Print section."""
print_box(text, 1, '-')
def wei_to_unit(wei: int) -> float:
"""Convert Wei to unit."""
return wei / 1e18
def wei_to_token(wei: int, token: str = "xDAI") -> str:
"""Convert Wei to token."""
return f"{wei_to_unit(wei):.6f} {token}"
def ask_confirm_password() -> str:
password = getpass.getpass("Please input your password (or press enter): ")
confirm_password = getpass.getpass("Please confirm your password: ")
if password == confirm_password:
return password
else:
print("Passwords do not match. Terminating.")
sys.exit(1)
def check_rpc(rpc_url: str) -> None:
spinner = Halo(text=f"Checking RPC...", spinner="dots")
spinner.start()
rpc_data = {
"jsonrpc": "2.0",
"method": "eth_newFilter",
"params": ["invalid"],
"id": 1
}
try:
response = requests.post(
rpc_url,
json=rpc_data,
headers={"Content-Type": "application/json"}
)
response.raise_for_status()
rpc_response = response.json()
except Exception as e:
print("Error: Failed to send RPC request:", e)
sys.exit(1)
rcp_error_message = rpc_response.get("error", {}).get("message", "Exception processing RCP response")
if rcp_error_message == "Exception processing RCP response":
print("Error: The received RCP response is malformed. Please verify the RPC address and/or RCP behavior.")
print(" Received response:")
print(" ", rpc_response)
print("")
print("Terminating script.")
sys.exit(1)
elif rcp_error_message == "Out of requests":
print("Error: The provided RCP is out of requests.")
print("Terminating script.")
sys.exit(1)
elif rcp_error_message == "The method eth_newFilter does not exist/is not available":
print("Error: The provided RPC does not support 'eth_newFilter'.")
print("Terminating script.")
sys.exit(1)
elif rcp_error_message == "invalid params":
spinner.succeed("RPC checks passed.")
else:
print("Error: Unknown RCP error.")
print(" Received response:")
print(" ", rpc_response)
print("")
print("Terminating script.")
sys.exit(1)
def load_local_config() -> OptimusConfig:
"""Load the local optimus configuration."""
path = OPERATE_HOME / "local_config.json"
if path.exists():
optimus_config = OptimusConfig.load(path)
else:
optimus_config = OptimusConfig(path)
return optimus_config
def configure_local_config() -> OptimusConfig:
"""Configure local optimus configuration."""
path = OPERATE_HOME / "local_config.json"
if path.exists():
optimus_config = OptimusConfig.load(path)
else:
optimus_config = OptimusConfig(path)
if optimus_config.tenderly_access_key is None:
print_section("Tenderly API Configuration and Price Data Source")
optimus_config.tenderly_access_key = get_masked_input(
"Please enter your Tenderly API Key. Get one at https://dashboard.tenderly.co/: "
)
if optimus_config.tenderly_account_slug is None:
optimus_config.tenderly_account_slug = get_masked_input(
"Please enter your Tenderly Account Slug: "
)
if optimus_config.tenderly_project_slug is None:
optimus_config.tenderly_project_slug = get_masked_input(
"Please enter your Tenderly Project Slug: "
)
if optimus_config.coingecko_api_key is None:
optimus_config.coingecko_api_key = get_masked_input(
"Please enter your CoinGecko API Key. Get one at https://www.coingecko.com/: "
)
print()
if optimus_config.min_swap_amount_threshold is None:
print_section("Minimum Investment")
print(f"The minimum investment amount is {DEFAULT_MIN_SWAP_AMOUNT_THRESHOLD} USD on both USDC and ETH Tokens")
update_min_swap = input("Do you want to increase the minimum investment amount? (y/n): ").lower() == 'y'
if update_min_swap:
while True:
user_input = input(
f"Please enter the minimum investment amount in USD (at least {DEFAULT_MIN_SWAP_AMOUNT_THRESHOLD} USD): "
)
min_swap_amount = user_input
if not min_swap_amount.isdigit():
print("Error: Please enter a valid integer.")
continue
if int(min_swap_amount) >= DEFAULT_MIN_SWAP_AMOUNT_THRESHOLD:
optimus_config.min_swap_amount_threshold = min_swap_amount
break
else:
print(f"Error: The minimum investment amount must be at least {DEFAULT_MIN_SWAP_AMOUNT_THRESHOLD} USD.")
else:
optimus_config.min_swap_amount_threshold = str(DEFAULT_MIN_SWAP_AMOUNT_THRESHOLD)
print()
if optimus_config.password_migrated is None:
optimus_config.password_migrated = False
if optimus_config.use_staking is None:
print_section("Staking")
optimus_config.use_staking = input("Do you want to stake your service? (y/n): ").lower() == 'y'
if optimus_config.staking_chain is None:
if optimus_config.use_staking:
optimus_config.staking_chain = DEFAULT_STAKING_CHAIN
if optimus_config.principal_chain is None:
optimus_config.principal_chain = DEFAULT_STAKING_CHAIN
if optimus_config.investment_funding_requirements is None:
optimus_config.investment_funding_requirements = {
optimus_config.principal_chain : {
"USDC": 0,
"ETH": 0
}
}
print()
if optimus_config.allowed_chains is None:
optimus_config.allowed_chains = [optimus_config.principal_chain]
if optimus_config.target_investment_chains is None:
optimus_config.target_investment_chains = [optimus_config.principal_chain]
if optimus_config.mode_rpc is None:
print_section("Chain RPC")
optimus_config.mode_rpc = get_masked_input("Please enter a Mode RPC URL: ")
print()
if optimus_config.selected_strategies is None:
optimus_config.selected_strategies = [Strategy.MerklPoolSearchStrategy.value, Strategy.BalancerPoolSearchStrategy.value, Strategy.SturdyLendingStrategy.value]
optimus_config.store()
return optimus_config
def apply_env_vars(env_vars: t.Dict[str, str]) -> None:
"""Apply environment variables."""
for key, value in env_vars.items():
if value is not None:
os.environ[key] = value
def handle_password_migration(operate: OperateApp, config: OptimusConfig) -> t.Optional[str]:
"""Handle password migration."""
if not config.password_migrated:
print("Add password...")
old_password, new_password = "12345", ask_confirm_password()
operate.user_account.update(old_password, new_password)
if operate.wallet_manager.exists(LedgerType.ETHEREUM):
operate.password = old_password
wallet = operate.wallet_manager.load(LedgerType.ETHEREUM)
wallet.crypto.dump(str(wallet.key_path), password=new_password)
wallet.password = new_password
wallet.store()
config.password_migrated = True
config.store()
return new_password
return None
def get_service_template(config: OptimusConfig) -> ServiceTemplate:
"""Get the service template"""
home_chain_id = "34443"
return ServiceTemplate({
"name": "Optimus",
"hash": "bafybeihqho73he6mirkodg4ubom6ngf2nkgebhmxr435yxpsxgsthu5nvy",
"description": "Optimus",
"image": "https://gateway.autonolas.tech/ipfs/bafybeiaakdeconw7j5z76fgghfdjmsr6tzejotxcwnvmp3nroaw3glgyve",
"service_version": 'v0.18.1',
"home_chain_id": home_chain_id,
"configurations": {
"34443": ConfigurationTemplate(
{
"staking_program_id": "optimus_alpha",
"rpc": config.mode_rpc,
"nft": "bafybeiaakdeconw7j5z76fgghfdjmsr6tzejotxcwnvmp3nroaw3glgyve",
"cost_of_bond": COST_OF_BOND_STAKING if config.staking_chain == "mode" else COST_OF_BOND,
"threshold": 1,
"use_staking": config.use_staking and config.staking_chain == "mode",
"fund_requirements": FundRequirementsTemplate(
{
"agent": SUGGESTED_TOP_UP_DEFAULT * 5,
"safe": 0,
}
),
}
),
},
})
def get_erc20_balance(ledger_api: LedgerApi, token: str, account: str) -> int:
"""Get ERC-20 token balance of an account."""
web3 = t.cast(EthereumApi, ledger_api).api
# ERC20 Token Standard Partial ABI
erc20_abi = [
{
"constant": True,
"inputs": [{"name": "_owner", "type": "address"}],
"name": "balanceOf",
"outputs": [{"name": "balance", "type": "uint256"}],
"type": "function",
}
]
# Create contract instance
contract = web3.eth.contract(address=web3.to_checksum_address(token), abi=erc20_abi)
# Get the balance of the account
balance = contract.functions.balanceOf(web3.to_checksum_address(account)).call()
return balance
FALLBACK_STAKING_PARAMS = dict(
agent_ids=[40],
service_registry="0x9338b5153AE39BB89f50468E608eD9d764B755fD", # nosec
staking_token="0xcE11e14225575945b8E6Dc0D4F2dD4C570f79d9f", # nosec
service_registry_token_utility="0xa45E64d13A30a51b91ae0eb182e88a40e9b18eD8", # nosec
min_staking_deposit=20000000000000000000,
activity_checker="0x155547857680A6D51bebC5603397488988DEb1c8" # nosec
)
def add_volumes(docker_compose_path: Path, host_path: str, container_path: str) -> None:
"""Add volumes to the docker-compose."""
with open(docker_compose_path, "r") as f:
docker_compose = yaml.safe_load(f)
abci_service_name = None
for service_name in docker_compose["services"]:
if "abci" in service_name:
abci_service_name = service_name
break
if abci_service_name is None:
raise ValueError("No service containing 'abci' found in the docker-compose file.")
docker_compose["services"][abci_service_name]["volumes"].append(f"{host_path}:{container_path}:Z")
with open(docker_compose_path, "w") as f:
yaml.dump(docker_compose, f)
def get_service(manager: ServiceManager, template: ServiceTemplate) -> Service:
if len(manager.json) > 0:
old_hash = manager.json[0]["hash"]
if old_hash == template["hash"]:
print(f'Loading service {template["hash"]}')
service = manager.load_or_create(
hash=template["hash"],
service_template=template,
)
else:
print(f"Updating service from {old_hash} to " + template["hash"])
service = manager.update_service(
old_hash=old_hash,
new_hash=template["hash"],
service_template=template,
)
else:
print(f'Creating service {template["hash"]}')
service = manager.load_or_create(
hash=template["hash"],
service_template=template,
)
return service
def fetch_token_price(url: str, headers: dict) -> t.Optional[float]:
"""Fetch the price of a token from a given URL."""
try:
response = requests.get(url, headers=headers)
if response.status_code != 200:
print(f"Error fetching info from url {url}. Failed with status code: {response.status_code}")
return None
prices = response.json()
token = next(iter(prices))
return prices[token].get('usd', None)
except Exception as e:
print(f"Error fetching token price: {e}")
return None
def fetch_investing_funding_requirements(chain_name: str) -> None:
"""Fetch initial funding requirements based on min_swap_amount_threshold."""
optimus_config = load_local_config()
headers = {
"accept": "application/json",
"x-cg-api-key": optimus_config.coingecko_api_key
}
# Fetch ETH price
eth_url = "https://api.coingecko.com/api/v3/simple/price?ids=ethereum&vs_currencies=usd"
eth_price = fetch_token_price(eth_url, headers)
if eth_price is None:
print("Error: Could not fetch price for ETH. Using fallback value")
optimus_config.investment_funding_requirements[chain_name]["ETH"] = FALLBACK_INVESTMENT_FUNDS_REQUIREMENT["ETH"]
else:
safety_margin = 500_000_000_000_000
eth_required = (int(optimus_config.min_swap_amount_threshold) / eth_price)
eth_required_rounded = float(Decimal(eth_required).quantize(Decimal('0.0001'), rounding=ROUND_UP))
eth_required_in_wei = int((eth_required_rounded * 10 ** 18) + safety_margin)
optimus_config.investment_funding_requirements[chain_name]["ETH"] = eth_required_in_wei
# Fetch USDC price
platform_id = COINGECKO_CHAIN_TO_PLATFORM_ID_MAPPING[chain_name]
usdc_url = f"https://api.coingecko.com/api/v3/simple/token_price/{platform_id}?contract_addresses={USDC_ADDRESS}&vs_currencies=usd"
usdc_price = fetch_token_price(usdc_url, headers)
if usdc_price is None:
print("Error: Could not fetch price for USDC.")
optimus_config.investment_funding_requirements[chain_name]["USDC"] = FALLBACK_INVESTMENT_FUNDS_REQUIREMENT["USDC"]
else:
safety_margin = 1_000_000
usdc_required = (int(optimus_config.min_swap_amount_threshold) / usdc_price)
usdc_required_rounded = math.ceil(usdc_required)
usdc_required_in_decimals = int((usdc_required_rounded * 10 ** 6) + safety_margin)
optimus_config.investment_funding_requirements[chain_name]["USDC"] = usdc_required_in_decimals
optimus_config.store()
def calculate_fund_requirement(
rpc: str,
fee_history_blocks: int,
gas_amount: int,
fee_history_percentile: int = 50,
safety_margin: int = 500_000_000_000_000
) -> Optional[int]:
"""
Calculate the estimated fund requirement for a transaction.
Args:
rpc (str): RPC URL of the Ethereum node.
fee_history_blocks (int): Number of recent blocks for fee history.
gas_amount (int): Gas amount required for the transaction.
fee_history_percentile (int): Percentile for priority fee (default: 50).
safety_margin (int): Safety margin in wei (default: 500,000,000,000,000).
Returns:
Optional[int]: Estimated fund requirement in wei, or None if unavailable.
"""
if not rpc:
print("RPC URL is required.")
return None
try:
web3 = Web3(Web3.HTTPProvider(rpc))
block_number = web3.eth.block_number
fee_history = web3.eth.fee_history(
fee_history_blocks, block_number, [fee_history_percentile]
)
except Exception as e:
return None
if not fee_history or 'baseFeePerGas' not in fee_history:
return None
base_fees = fee_history.get('baseFeePerGas', [])
priority_fees = [reward[0] for reward in fee_history.get('reward', []) if reward]
if not base_fees or not priority_fees:
return None
try:
# Calculate averages
average_base_fee = sum(base_fees) / len(base_fees)
average_priority_fee = sum(priority_fees) / len(priority_fees)
average_gas_price = average_base_fee + average_priority_fee
# Calculate fund requirement
fund_requirement = int((average_gas_price * gas_amount) + safety_margin)
return fund_requirement
except Exception as e:
return None
def fetch_agent_fund_requirement(chain_id, rpc, fee_history_blocks: int = 500000) -> int:
gas_amount = 50_000_000
if use_default_max_fee:
return DEFAULT_MAX_FEE * gas_amount
return calculate_fund_requirement(rpc, fee_history_blocks, gas_amount)
def fetch_operator_fund_requirement(chain_id, rpc, service_exists: bool = True, fee_history_blocks: int = 500000) -> int:
if service_exists:
gas_amount = 5_000_000
else:
gas_amount = 30_000_000
if use_default_max_fee:
return DEFAULT_MAX_FEE * gas_amount
return calculate_fund_requirement(rpc, fee_history_blocks, gas_amount)
def main() -> None:
"""Run service."""
print_title("Olas Modius Quickstart")
print("This script will assist you in setting up and running the olas modius service.")
print()
operate = OperateApp(
home=OPERATE_HOME,
)
operate.setup()
optimus_config = configure_local_config()
template = get_service_template(optimus_config)
manager = operate.service_manager()
service = get_service(manager, template)
if operate.user_account is None:
print_section("Set up local user account")
print("Creating a new local user account...")
password = ask_confirm_password()
UserAccount.new(
password=password,
path=operate._path / "user.json",
)
optimus_config.password_migrated = True
optimus_config.store()
else:
password = handle_password_migration(operate, optimus_config)
if password is None:
password = getpass.getpass("Enter local user account password: ")
if not operate.user_account.is_valid(password=password):
print("Invalid password!")
sys.exit(1)
operate.password = password
if not operate.wallet_manager.exists(ledger_type=LedgerType.ETHEREUM):
print("Creating the main wallet...")
wallet, mnemonic = operate.wallet_manager.create(ledger_type=LedgerType.ETHEREUM)
wallet.password = password
print()
print_box(f"Please save the mnemonic phrase for the main wallet:\n{', '.join(mnemonic)}", 0, '-')
input("Press enter to continue...")
else:
wallet = operate.wallet_manager.load(ledger_type=LedgerType.ETHEREUM)
manager = operate.service_manager()
fetch_investing_funding_requirements(optimus_config.principal_chain)
optimus_config = load_local_config()
for chain_id, configuration in service.chain_configs.items():
chain_metadata = CHAIN_ID_TO_METADATA[int(chain_id)]
chain_name, token = chain_metadata['name'], chain_metadata["token"]
chain_config = service.chain_configs[chain_id]
if chain_config.ledger_config.rpc is not None:
os.environ["CUSTOM_CHAIN_RPC"] = chain_config.ledger_config.rpc
os.environ["OPEN_AUTONOMY_SUBGRAPH_URL"] = "https://subgraph.autonolas.tech/subgraphs/name/autonolas-staging"
service_exists = manager._get_on_chain_state(chain_config) != OnChainState.NON_EXISTENT
chain_type = chain_config.ledger_config.chain
ledger_api = wallet.ledger_api(
chain_type=chain_type,
rpc=chain_config.ledger_config.rpc,
)
balance_str = wei_to_token(ledger_api.get_balance(wallet.crypto.address), token)
eth_investment_fund_requirement = optimus_config.investment_funding_requirements[chain_name.lower()]["ETH"]
usdc_investment_fund_requirement = optimus_config.investment_funding_requirements[chain_name.lower()]["USDC"]
print(
f"[{chain_name}] Main wallet balance: {balance_str}",
)
safe_exists = wallet.safes.get(chain_type) is not None
agent_fund_requirement = fetch_agent_fund_requirement(chain_id, chain_config.ledger_config.rpc)
if agent_fund_requirement is None:
agent_fund_requirement = chain_config.chain_data.user_params.fund_requirements.agent
operational_fund_req = fetch_operator_fund_requirement(chain_id, chain_config.ledger_config.rpc, service_exists)
if operational_fund_req is None:
operational_fund_req = chain_metadata.get("operationalFundReq")
if service_exists:
agent_balance = ledger_api.get_balance(address=service.keys[0].address)
if agent_balance < 0.3 * agent_fund_requirement:
agent_fund_requirement = agent_fund_requirement - agent_balance
else:
agent_fund_requirement = 0
operator_balance = ledger_api.get_balance(wallet.crypto.address)
if operator_balance < 0.3 * operational_fund_req:
operational_fund_req = operational_fund_req - operator_balance
else:
operational_fund_req = 0
safety_margin = 100_000_000_000_000
required_balance = operational_fund_req + agent_fund_requirement
if not safe_exists:
required_balance += eth_investment_fund_requirement
if required_balance > 0:
required_balance += safety_margin
required_balance = (required_balance // 10**12) * 10**12
print(
f"[{chain_name}] Please make sure main wallet {wallet.crypto.address} has at least {wei_to_token(required_balance, token)}",
)
spinner = Halo(
text=f"[{chain_name}] Waiting for funds...",
spinner="dots"
)
spinner.start()
while ledger_api.get_balance(wallet.crypto.address) < required_balance:
time.sleep(1)
spinner.succeed(f"[{chain_name}] Main wallet updated balance: {wei_to_token(ledger_api.get_balance(wallet.crypto.address), token)}.")
if not safe_exists:
print(f"[{chain_name}] Creating Safe")
ledger_type = LedgerType.ETHEREUM
wallet_manager = operate.wallet_manager
wallet = wallet_manager.load(ledger_type=ledger_type)
wallet.create_safe( # pylint: disable=no-member
chain_type=chain_type,
rpc=chain_config.ledger_config.rpc,
)
print_section(f"[{chain_name}] Set up the service in the Olas Protocol")
address = wallet.safes[chain_type]
if not service_exists:
top_up = eth_investment_fund_requirement + agent_fund_requirement + safety_margin
else:
top_up = agent_fund_requirement + safety_margin
if top_up > 0:
print(
f"[{chain_name}] Please make sure address {address} has at least {wei_to_token(top_up, token)}."
)
spinner = Halo(
text=f"[{chain_name}] Waiting for funds...",
spinner="dots",
)
spinner.start()
while ledger_api.get_balance(address) < top_up:
print(f"[{chain_name}] Funding Safe")
wallet.transfer(
to=t.cast(str, wallet.safes[chain_type]),
amount=int(top_up),
chain_type=chain_type,
from_safe=False,
rpc=chain_config.ledger_config.rpc,
)
time.sleep(1)
spinner.succeed(f"[{chain_name}] Safe updated balance: {wei_to_token(ledger_api.get_balance(address), token)}.")
if chain_config.chain_data.user_params.use_staking and not service_exists:
print(f"[{chain_name}] Please make sure address {address} has at least {wei_to_token(2 * COST_OF_BOND_STAKING, STAKED_BONDING_TOKEN)}")
spinner = Halo(
text=f"[{chain_name}] Waiting for {STAKED_BONDING_TOKEN}...",
spinner="dots",
)
spinner.start()
olas_address = OLAS[chain_type]
while get_erc20_balance(ledger_api, olas_address, address) < 2 * COST_OF_BOND_STAKING:
time.sleep(1)
balance = get_erc20_balance(ledger_api, olas_address, address) / 10 ** 18
spinner.succeed(f"[{chain_name}] Safe updated balance: {balance} {STAKED_BONDING_TOKEN}")
if chain_name.lower() == optimus_config.principal_chain and not service_exists:
print(f"[{chain_name}] Please make sure address {address} has at least {usdc_investment_fund_requirement / 10 ** 6} USDC")
spinner = Halo(
text=f"[{chain_name}] Waiting for USDC...",
spinner="dots",
)
spinner.start()
while get_erc20_balance(ledger_api, USDC_ADDRESS, address) < usdc_investment_fund_requirement:
time.sleep(1)
usdc_balance = get_erc20_balance(ledger_api, USDC_ADDRESS, address) / 10 ** 6
spinner.succeed(f"[{chain_name}] Safe updated balance: {usdc_balance} USDC.")
manager.deploy_service_onchain_from_safe_single_chain(
hash=service.hash,
chain_id=chain_id,
fallback_staking_params=FALLBACK_STAKING_PARAMS,
)
if eth_investment_fund_requirement and not service_exists:
safe_fund_threshold=eth_investment_fund_requirement
safe_topup = safe_fund_threshold
else:
safe_fund_threshold = None
safe_topup = None
manager.fund_service(hash=service.hash, chain_id=chain_id, safe_fund_treshold=safe_fund_threshold, safe_topup=safe_topup, agent_fund_threshold=agent_fund_requirement, agent_topup=agent_fund_requirement)
usdc_balance = get_erc20_balance(ledger_api, USDC_ADDRESS, address)
if usdc_investment_fund_requirement > 0 and not service_exists:
# transfer all the usdc balance into the service safe
manager.fund_service_erc20(
hash=service.hash,
chain_id=chain_id,
token=USDC_ADDRESS,
token_symbol="USDC",
token_decimal=6,
safe_topup=usdc_balance,
agent_topup=0,
agent_fund_threshold=0,
safe_fund_treshold=usdc_investment_fund_requirement,
)
service = get_service(manager, template)
safes = {
ChainType.from_id(int(chain)).name.lower(): config.chain_data.multisig
for chain, config in service.chain_configs.items()
}
home_chain_id = service.home_chain_id
home_chain_type = ChainType.from_id(int(home_chain_id))
target_staking_program_id = service.chain_configs[home_chain_id].chain_data.user_params.staking_program_id #### to-do
activity_checker_dict = {
"mode": "0x07bc3C23DbebEfBF866Ca7dD9fAA3b7356116164"
}
initial_assets = {optimus_config.principal_chain: {ZERO_ADDRESS: "ETH", USDC_ADDRESS: "USDC"}}
env_vars = {
"SAFE_CONTRACT_ADDRESSES": json.dumps(safes, separators=(',', ':')),
"TENDERLY_ACCESS_KEY": optimus_config.tenderly_access_key,
"TENDERLY_ACCOUNT_SLUG": optimus_config.tenderly_account_slug,
"TENDERLY_PROJECT_SLUG": optimus_config.tenderly_project_slug,
"STAKING_TOKEN_CONTRACT_ADDRESS": STAKING[home_chain_type][target_staking_program_id], #### and add params staking_token_activity_checker --> in service default values and staking_chain
"COINGECKO_API_KEY": optimus_config.coingecko_api_key,
"STAKING_CHAIN": optimus_config.staking_chain,
"STAKING_ACTIVITY_CHECKER_CONTRACT_ADDRESS": activity_checker_dict.get(home_chain_type.name.lower(), ""),
"MIN_SWAP_AMOUNT_THRESHOLD": optimus_config.min_swap_amount_threshold,
"ALLOWED_CHAINS": json.dumps(optimus_config.allowed_chains),
"TARGET_INVESTMENT_CHAINS": json.dumps(optimus_config.target_investment_chains),
"INITIAL_ASSETS": json.dumps(initial_assets),
"SELECTED_STRATEGIES": json.dumps(optimus_config.selected_strategies)
}
apply_env_vars(env_vars)
print("Skipping local deployment")
service.deployment.build(use_docker=True, force=True, chain_id=home_chain_id)
docker_compose_path = service.path / "deployment" / "docker-compose.yaml"
add_volumes(docker_compose_path, str(OPERATE_HOME), "/data")
service.deployment.start(use_docker=True)
print()
print_section("Running the service")
if __name__ == "__main__":
main()