-
Notifications
You must be signed in to change notification settings - Fork 7
/
deploy.py
445 lines (366 loc) · 16.3 KB
/
deploy.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
import base64
import dataclasses
import json
import logging
import re
from collections.abc import Callable, Iterable, Mapping
from enum import Enum
from algosdk import transaction
from algosdk.logic import get_application_address
from algosdk.transaction import StateSchema
from algosdk.v2client.algod import AlgodClient
from algosdk.v2client.indexer import IndexerClient
from algokit_utils.application_specification import (
ApplicationSpecification,
CallConfig,
MethodConfigDict,
OnCompleteActionName,
)
from algokit_utils.models import Account, TransactionResponse
__all__ = [
"UPDATABLE_TEMPLATE_NAME",
"DELETABLE_TEMPLATE_NAME",
"NOTE_PREFIX",
"DeploymentFailedError",
"AppReference",
"AppDeployMetaData",
"AppMetaData",
"AppLookup",
"DeployResponse",
"OnUpdate",
"OnSchemaBreak",
"OperationPerformed",
"TemplateValueDict",
"check_app_and_deploy",
"get_creator_apps",
"replace_template_variables",
]
logger = logging.getLogger(__name__)
DEFAULT_INDEXER_MAX_API_RESOURCES_PER_ACCOUNT = 1000
_UPDATABLE = "UPDATABLE"
_DELETABLE = "DELETABLE"
UPDATABLE_TEMPLATE_NAME = f"TMPL_{_UPDATABLE}"
DELETABLE_TEMPLATE_NAME = f"TMPL_{_DELETABLE}"
TemplateValue = int | str | bytes
TemplateValueDict = dict[str, TemplateValue]
TemplateValueMapping = Mapping[str, TemplateValue]
NOTE_PREFIX = "ALGOKIT_DEPLOYER:j" # this prefix also makes the note ARC-2 compliant
# when base64 encoding bytes, 3 bytes are stored in every 4 characters
# assert the NOTE_PREFIX length is a multiple of 3, so we don't need to worry about the
# padding/changing characters at the end
assert len(NOTE_PREFIX) % 3 == 0
class DeploymentFailedError(Exception):
pass
@dataclasses.dataclass
class AppReference:
app_id: int
app_address: str
@dataclasses.dataclass
class AppDeployMetaData:
name: str
version: str
deletable: bool | None
updatable: bool | None
@staticmethod
def from_json(value: str) -> "AppDeployMetaData":
json_value: dict = json.loads(value)
json_value.setdefault("deletable", None)
json_value.setdefault("updatable", None)
return AppDeployMetaData(**json_value)
@classmethod
def from_b64(cls: type["AppDeployMetaData"], b64: str) -> "AppDeployMetaData":
return cls.decode(base64.b64decode(b64))
@classmethod
def decode(cls: type["AppDeployMetaData"], value: bytes) -> "AppDeployMetaData":
note = value.decode("utf-8")
assert note.startswith(NOTE_PREFIX)
return cls.from_json(note[len(NOTE_PREFIX) :])
def encode(self) -> bytes:
json_str = json.dumps(self.__dict__)
return f"{NOTE_PREFIX}{json_str}".encode()
@dataclasses.dataclass
class AppMetaData(AppReference, AppDeployMetaData):
created_round: int
updated_round: int
created_metadata: AppDeployMetaData
deleted: bool
@dataclasses.dataclass
class AppLookup:
creator: str
apps: dict[str, AppMetaData] = dataclasses.field(default_factory=dict)
def get_creator_apps(indexer: IndexerClient, creator_account: Account | str) -> AppLookup:
apps: dict[str, AppMetaData] = {}
creator_address = creator_account if isinstance(creator_account, str) else creator_account.address
token = None
# TODO: paginated indexer call instead of N + 1 calls
while True:
response = indexer.lookup_account_application_by_creator(
creator_address, limit=DEFAULT_INDEXER_MAX_API_RESOURCES_PER_ACCOUNT, next_page=token
) # type: ignore[no-untyped-call]
if "message" in response: # an error occurred
raise Exception(f"Error querying applications for {creator_address}: {response}")
for app in response["applications"]:
app_id = app["id"]
app_created_at_round = app["created-at-round"]
app_deleted = app.get("deleted", False)
search_transactions_response = indexer.search_transactions(
min_round=app_created_at_round,
txn_type="appl",
application_id=app_id,
address=creator_address,
address_role="sender",
note_prefix=NOTE_PREFIX.encode("utf-8"),
) # type: ignore[no-untyped-call]
transactions: list[dict] = search_transactions_response["transactions"]
if not transactions:
continue
created_transaction = next(
t
for t in transactions
if t["application-transaction"]["application-id"] == 0 and t["sender"] == creator_address
)
def sort_by_round(txn: dict) -> tuple[int, int]:
confirmed = txn["confirmed-round"]
offset = txn["intra-round-offset"]
return confirmed, offset
transactions.sort(key=sort_by_round, reverse=True)
latest_transaction = transactions[0]
app_updated_at_round = latest_transaction["confirmed-round"]
def parse_note(metadata_b64: str | None) -> AppDeployMetaData | None:
if not metadata_b64:
return None
# noinspection PyBroadException
try:
return AppDeployMetaData.from_b64(metadata_b64)
except Exception:
return None
create_metadata = parse_note(created_transaction.get("note"))
update_metadata = parse_note(latest_transaction.get("note"))
if create_metadata and create_metadata.name:
apps[create_metadata.name] = AppMetaData(
app_id=app_id,
app_address=get_application_address(app_id),
created_metadata=create_metadata,
created_round=app_created_at_round,
**(update_metadata or create_metadata).__dict__,
updated_round=app_updated_at_round,
deleted=app_deleted,
)
token = response.get("next-token")
if not token:
break
return AppLookup(creator_address, apps)
def _state_schema(schema: dict[str, int]) -> StateSchema:
return StateSchema(schema.get("num-uint", 0), schema.get("num-byte-slice", 0)) # type: ignore[no-untyped-call]
def _describe_schema_breaks(prefix: str, from_schema: StateSchema, to_schema: StateSchema) -> Iterable[str]:
if to_schema.num_uints > from_schema.num_uints:
yield f"{prefix} uints increased from {from_schema.num_uints} to {to_schema.num_uints}"
if to_schema.num_byte_slices > from_schema.num_byte_slices:
yield f"{prefix} byte slices increased from {from_schema.num_byte_slices} to {to_schema.num_byte_slices}"
@dataclasses.dataclass(kw_only=True)
class AppChanges:
app_updated: bool
schema_breaking_change: bool
schema_change_description: str | None
def check_for_app_changes(
algod_client: AlgodClient,
new_approval: bytes,
new_clear: bytes,
new_global_schema: StateSchema,
new_local_schema: StateSchema,
app_id: int,
) -> AppChanges:
application_info = algod_client.application_info(app_id)
assert isinstance(application_info, dict)
application_create_params = application_info["params"]
current_approval = base64.b64decode(application_create_params["approval-program"])
current_clear = base64.b64decode(application_create_params["clear-state-program"])
current_global_schema = _state_schema(application_create_params["global-state-schema"])
current_local_schema = _state_schema(application_create_params["local-state-schema"])
app_updated = current_approval != new_approval or current_clear != new_clear
schema_changes: list[str] = []
schema_changes.extend(_describe_schema_breaks("Global", current_global_schema, new_global_schema))
schema_changes.extend(_describe_schema_breaks("Local", current_local_schema, new_local_schema))
return AppChanges(
app_updated=app_updated,
schema_breaking_change=bool(schema_changes),
schema_change_description=", ".join(schema_changes),
)
def _replace_template_variable(program_lines: list[str], template_variable: str, value: str) -> tuple[list[str], int]:
result: list[str] = []
match_count = 0
pattern = re.compile(rf"(\b)TMPL_{template_variable}(\b|$)")
def replacement(m: re.Match) -> str:
return f"{m.group(1)}{value}{m.group(2)}"
for line in program_lines:
code_comment = line.split("//", maxsplit=1)
code = code_comment[0]
new_line, matches = re.subn(pattern, replacement, code)
match_count += matches
if len(code_comment) > 1:
new_line = f"{new_line}//{code_comment[1]}"
result.append(new_line)
return result, match_count
def add_deploy_template_variables(
template_values: TemplateValueDict, allow_update: bool | None, allow_delete: bool | None
) -> None:
if allow_update is not None:
template_values[_UPDATABLE] = int(allow_update)
if allow_delete is not None:
template_values[_DELETABLE] = int(allow_delete)
def _strip_comments(program: str) -> str:
lines = [x.split("//", maxsplit=1)[0] for x in program.splitlines()]
return "\n".join(lines)
def check_template_variables(approval_program: str, template_values: TemplateValueDict) -> None:
approval_program = _strip_comments(approval_program)
if UPDATABLE_TEMPLATE_NAME in approval_program and _UPDATABLE not in template_values:
raise DeploymentFailedError(
"allow_update must be specified if deploy time configuration of update is being used"
)
if DELETABLE_TEMPLATE_NAME in approval_program and _DELETABLE not in template_values:
raise DeploymentFailedError(
"allow_delete must be specified if deploy time configuration of delete is being used"
)
for template_variable_name in template_values:
if template_variable_name not in approval_program:
if template_variable_name == _UPDATABLE:
raise DeploymentFailedError(
"allow_update must only be specified if deploy time configuration of update is being used"
)
if template_variable_name == _DELETABLE:
raise DeploymentFailedError(
"allow_delete must only be specified if deploy time configuration of delete is being used"
)
logger.warning(f"{template_variable_name} not found in approval program, but variable was provided")
def replace_template_variables(program: str, template_values: TemplateValueMapping) -> str:
program_lines = program.splitlines()
for template_variable_name, template_value in template_values.items():
match template_value:
case int():
value = str(template_value)
case str():
value = "0x" + template_value.encode("utf-8").hex()
case bytes():
value = "0x" + template_value.hex()
case _:
raise DeploymentFailedError(
f"Unexpected template value type {template_variable_name}: {template_value.__class__}"
)
program_lines, matches = _replace_template_variable(program_lines, template_variable_name, value)
return "\n".join(program_lines)
def has_template_vars(app_spec: ApplicationSpecification) -> bool:
return "TMPL_" in _strip_comments(app_spec.approval_program) or "TMPL_" in _strip_comments(app_spec.clear_program)
def get_deploy_control(
app_spec: ApplicationSpecification, template_var: str, on_complete: transaction.OnComplete
) -> bool | None:
if template_var not in _strip_comments(app_spec.approval_program):
return None
return get_call_config(app_spec.bare_call_config, on_complete) != CallConfig.NEVER or any(
h for h in app_spec.hints.values() if get_call_config(h.call_config, on_complete) != CallConfig.NEVER
)
def get_call_config(method_config: MethodConfigDict, on_complete: transaction.OnComplete) -> CallConfig:
def get(key: OnCompleteActionName) -> CallConfig:
return method_config.get(key, CallConfig.NEVER)
match on_complete:
case transaction.OnComplete.NoOpOC:
return get("no_op")
case transaction.OnComplete.UpdateApplicationOC:
return get("update_application")
case transaction.OnComplete.DeleteApplicationOC:
return get("delete_application")
case transaction.OnComplete.OptInOC:
return get("opt_in")
case transaction.OnComplete.CloseOutOC:
return get("close_out")
case transaction.OnComplete.ClearStateOC:
return get("clear_state")
class OnUpdate(Enum):
Fail = 0
UpdateApp = 1
ReplaceApp = 2
# TODO: AppendApp
class OnSchemaBreak(Enum):
Fail = 0
ReplaceApp = 2
class OperationPerformed(Enum):
Nothing = 0
Create = 1
Update = 2
Replace = 3
@dataclasses.dataclass(kw_only=True)
class DeployResponse:
app: AppMetaData
create_response: TransactionResponse | None = None
delete_response: TransactionResponse | None = None
update_response: TransactionResponse | None = None
action_taken: OperationPerformed = OperationPerformed.Nothing
def check_app_and_deploy(
app: AppMetaData,
app_changes: AppChanges,
on_schema_break: OnSchemaBreak,
on_update: OnUpdate,
update_app: Callable[[], DeployResponse],
create_and_delete_app: Callable[[], DeployResponse],
) -> DeployResponse:
if app_changes.schema_breaking_change:
logger.warning(f"Detected a breaking app schema change: {app_changes.schema_change_description}")
if on_schema_break == OnSchemaBreak.Fail:
raise DeploymentFailedError(
"Schema break detected and on_schema_break=OnSchemaBreak.Fail, stopping deployment. "
"If you want to try deleting and recreating the app then "
"re-run with on_schema_break=OnSchemaBreak.ReplaceApp"
)
if app.deletable:
logger.info(
"App is deletable and on_schema_break=ReplaceApp, will attempt to create new app and delete old app"
)
elif app.deletable is False:
logger.warning(
"App is not deletable but on_schema_break=ReplaceApp, "
"will attempt to delete app, delete will most likely fail"
)
else:
logger.warning(
"Cannot determine if App is deletable but on_schema_break=ReplaceApp, " "will attempt to delete app"
)
return create_and_delete_app()
elif app_changes.app_updated:
logger.info(f"Detected a TEAL update in app id {app.app_id}")
if on_update == OnUpdate.Fail:
raise DeploymentFailedError(
"Update detected and on_update=Fail, stopping deployment. "
"If you want to try updating the app then re-run with on_update=UpdateApp"
)
if app.updatable and on_update == OnUpdate.UpdateApp:
logger.info("App is updatable and on_update=UpdateApp, will update app")
return update_app()
elif app.updatable and on_update == OnUpdate.ReplaceApp:
logger.warning(
"App is updatable but on_update=ReplaceApp, will attempt to create new app and delete old app"
)
return create_and_delete_app()
elif on_update == OnUpdate.ReplaceApp:
if app.updatable is False:
logger.warning(
"App is not updatable and on_update=ReplaceApp, "
"will attempt to create new app and delete old app"
)
else:
logger.warning(
"Cannot determine if App is updatable and on_update=ReplaceApp, "
"will attempt to create new app and delete old app"
)
return create_and_delete_app()
else:
if app.updatable is False:
logger.warning(
"App is not updatable but on_update=UpdateApp, "
"will attempt to update app, update will most likely fail"
)
else:
logger.warning(
"Cannot determine if App is updatable and on_update=UpdateApp, " "will attempt to update app"
)
return update_app()
logger.info("No detected changes in app, nothing to do.")
return DeployResponse(app=app)