-
Notifications
You must be signed in to change notification settings - Fork 36
/
Copy pathgen_add_permissions_payload.py
217 lines (195 loc) · 8.94 KB
/
gen_add_permissions_payload.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
import json
from dotmap import DotMap
from bal_addresses import AddrBook, BalPermissions, NoResultError
import pandas as pd
from datetime import date
from web3 import Web3
import os
from collections import defaultdict
today = str(date.today())
debug = False
script_dir = os.path.dirname(os.path.abspath(__file__))
# TODO: The below settings must be set before running the script
INFURA_KEY = os.getenv("WEB3_INFURA_PROJECT_ID")
BALANCER_DEPLOYMENTS_URL = (
"https://raw.githubusercontent.com/balancer/balancer-deployments/master"
)
W3_BY_CHAIN = {
"mainnet": Web3(Web3.HTTPProvider(f"https://mainnet.infura.io/v3/{INFURA_KEY}")),
"arbitrum": Web3(
Web3.HTTPProvider(f"https://arbitrum-mainnet.infura.io/v3/{INFURA_KEY}")
),
"optimism": Web3(Web3.HTTPProvider(f"https://optimism-rpc.gateway.pokt.network")),
"polygon": Web3(
Web3.HTTPProvider(f"https://polygon-mainnet.infura.io/v3/{INFURA_KEY}")
),
"zkevm": Web3(Web3.HTTPProvider(f"https://zkevm-rpc.com")),
"avalanche": Web3(
Web3.HTTPProvider(f"https://avalanche-mainnet.infura.io/v3/{INFURA_KEY}")
),
"gnosis": Web3(Web3.HTTPProvider(f"https://rpc.gnosischain.com/")),
"goerli": Web3(Web3.HTTPProvider(f"https://goerli.infura.io/v3/{INFURA_KEY}")),
"sepolia": Web3(Web3.HTTPProvider(f"https://sepolia.infura.io/v3/{INFURA_KEY}")),
}
book_by_chain = {}
perms_by_chain = {}
for chain_name in AddrBook.chain_ids_by_name.keys():
book_by_chain[chain_name] = AddrBook(chain_name)
perms_by_chain[chain_name] = BalPermissions(chain_name)
def load_input_data(input_json_file):
with open(input_json_file, "r") as f:
data = json.load(f)
return data
def build_action_ids_map(input_data):
warnings = ""
action_ids_map = {}
for chain_name in AddrBook.chain_ids_by_name.keys():
action_ids_map[chain_name] = defaultdict(set)
for change in input_data:
for chain_name, chain_id in change["chain_map"].items():
print(f"Processing {chain_name}({chain_id})")
book = book_by_chain[chain_name]
perms = perms_by_chain[chain_name]
for deployment in change["deployments"]:
for function, callers in change["function_caller_map"].items():
# Turn a string into a 1 item list
if isinstance(callers, str):
callers = [callers]
try:
result = perms.search_unique_path_by_unique_deployment(
deployment, function
)
except NoResultError as err:
warnings += f"WARNING: On chain:{chain_name}:{deployment}/{function}: found no matches, skipping\n"
continue
for caller in callers:
# TODO rethink bal addresses here, output format is different for extras/msigs and deployments
caller_lookup = book.search_unique(caller)
if isinstance(caller_lookup, str):
caller_address = caller_lookup
else:
caller_address = caller_lookup.address
action_ids_map[chain_name][result.action_id].add(caller_address)
return action_ids_map, warnings
def generate_change_list(actions_id_map):
changes = []
warnings = ""
for chain_name, action_id_infos in actions_id_map.items():
print(f"generate list: {chain_name}")
book = book_by_chain[chain_name]
perms = perms_by_chain[chain_name]
for action_id, callers in action_id_infos.items():
paths = perms.paths_by_action_id[action_id]
for path in paths:
for caller_address in callers:
(deployment, _, function) = path.split("/")
try:
authorizered_callers = perms.allowed_addresses(action_id)
except NoResultError:
authorizered_callers = []
if caller_address in authorizered_callers:
warnings += f"{deployment}/{function} already has the proper owner set, skipping.\n"
continue
caller = book.reversebook[caller_address]
changes.append(
{
"deployment": deployment,
"function": function,
"role": action_id,
"chain": chain_name,
"caller": caller,
"caller_address": caller_address,
}
)
return changes, warnings
def print_change_list(change_list, output_dir, filename_root=today):
df = pd.DataFrame(change_list)
chain_address_sorted = df.sort_values(by=["chain", "caller_address"])
chain_deployment_sorted = df.sort_values(by=["chain", "deployment", "function"])
print(df.to_markdown(index=False))
if output_dir:
with open(f"{output_dir}/{filename_root}_address_sorted.md", "w") as f:
chain_address_sorted.to_markdown(index=False, buf=f)
with open(f"{output_dir}/{filename_root}_deployment_sorted.md", "w") as f:
chain_deployment_sorted.to_markdown(index=False, buf=f)
def save_command_description_table(change_list, output_dir, filename_root=today):
referenced_calls = []
functions = []
descriptions = []
with open(f"{output_dir}/func_desc_by_name.json", "r") as f:
func_desc_by_name = json.load(f)
for change in change_list:
function = change["function"]
if function not in referenced_calls:
if function not in functions:
functions.append(function)
try:
descriptions.append(func_desc_by_name[function])
except:
descriptions.append("description not found in map")
df = pd.DataFrame({"function": functions, "description": descriptions})
with open(f"{output_dir}/{filename_root}_function_descriptions.md", "w") as f:
df.to_markdown(buf=f, index=False)
def save_txbuilder_json(change_list, output_dir, filename_root=today):
print("Dumping files")
chains = []
for change in change_list:
if change["chain"] not in chains:
chains.append(change["chain"])
for chain_name in chains:
chain_id = AddrBook.chain_ids_by_name[chain_name]
print(f"chain:{chain_name}")
book = book_by_chain[chain_name]
with open(
f"{script_dir}/tx_builder_templates/authorizor_grant_roles.json", "r"
) as f:
data = DotMap(json.load(f))
print(f"book.chain:{book.chain}")
# Set global data
print(book.search_unique("multisigs/dao").address)
data.chainId = chain_id
data.meta.createdFromSafeAddress = book.search_unique("multisigs/dao").address
# Group roles on this chain by caller address
action_ids_by_address = defaultdict(set)
for change in change_list:
if change["chain"] != chain_name:
continue
action_ids_by_address[change["caller_address"]].add(change["role"])
# Build transaction list
transactions = []
tx_template = data.transactions[0]
for address, actions in action_ids_by_address.items():
sorted_actions = list(actions)
sorted_actions.sort()
transaction = DotMap(tx_template)
transaction.to = book.flatbook["20210418-authorizer/Authorizer"]
# TX builder wants lists in a string, addresses unquoted
transaction.contractInputsValues.roles = str(sorted_actions).replace(
"'", ""
)
transaction.contractInputsValues.account = address
transactions.append(dict(transaction))
# Inject transaction list
data.transactions = transactions
# Save tx builder json
with open(f"{output_dir}/{filename_root}_{chain_name}.json", "w") as f:
json.dump(dict(data), f, indent=2)
f.write("\n")
def main(
output_dir=f"{script_dir}/../BIPs/00batched/authorizer",
input_file=f"{script_dir}/../BIPs/00batched/authorizer/{today}.json",
):
input_data = load_input_data(input_file)
(action_ids_map, warnings) = build_action_ids_map(input_data=input_data)
(change_list, w) = generate_change_list(actions_id_map=action_ids_map)
warnings += "\n" + w
if change_list:
print_change_list(change_list=change_list, output_dir=output_dir)
save_command_description_table(change_list=change_list, output_dir=output_dir)
save_txbuilder_json(change_list=change_list, output_dir=output_dir)
else:
warnings += "Doing nothing as there is no changelist, everything up to date? \n"
with open(f"{output_dir}/{today}_warnings.txt", "w") as f:
f.write(warnings)
if __name__ == "__main__":
main()