Skip to content

Commit

Permalink
doc: compilers recommendations
Browse files Browse the repository at this point in the history
  • Loading branch information
cusma committed Oct 25, 2024
1 parent 859a73f commit 22128f9
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions ARCs/arc-0065.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,18 +128,23 @@ regexp).

It is **NOT RECOMMENDED** to use on the `message` field to retrieve errors.

### AVM Compilers

AVM compilers (and related tools) **SHOULD** provide two error compiling options:

1. ARC-65 as **default**;

Check failure on line 135 in ARCs/arc-0065.md

View workflow job for this annotation

GitHub Actions / ARC Walidator

the first match of the given pattern must be a link

error[markdown-link-first]: the first match of the given pattern must be a link --> ARCs/arc-0065.md | 135 | 1. ARC-65 as **default**; | = info: the pattern in question: `(?i)ARC-[0-9]+`
1. ARC-64 as fallback, if compiled bytecode size exceeds the AVM limits.

Check failure on line 136 in ARCs/arc-0065.md

View workflow job for this annotation

GitHub Actions / ARC Walidator

the first match of the given pattern must be a link

error[markdown-link-first]: the first match of the given pattern must be a link --> ARCs/arc-0065.md | 136 | 1. ARC-64 as fallback, if compiled bytecode size exceeds the AVM limits. | = info: the pattern in question: `(?i)ARC-[0-9]+`

## Rationale

This convention for AVM run time errors presents the following PROS and CONS.

### PROS

**PROS:**
- No additional artifacts required to return informative run time errors;
- Errors are directly returned in the Algod API response, which can be filtered
with the specified error regexp.

### CONS

**CONS:**
- Errors consume program bytecode size.

## Security Considerations
Expand Down

0 comments on commit 22128f9

Please sign in to comment.