Skip to content

Commit 27f8ff5

Browse files
docs: add architecture scaffolding and intent for issue #1380 public error mapping
1 parent cb41ebf commit 27f8ff5

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Intent & Scaffolding: Stabilize Public Error Mapping
2+
3+
Closes #1380
4+
5+
## Problem Statement
6+
Client applications need consistent decoding when contract errors evolve. Stabilizing public error mapping by versioning codes and preserving backwards compatibility for existing callers is required.
7+
8+
## Implementation Architecture
9+
1. **Stable Error Code Registry**:
10+
- Maintain stability of existing public error codes and numerical representations.
11+
- Document and allocate unique codes for newly introduced error conditions.
12+
2. **Safe Decoding for Unknown Variants**:
13+
- Provide safe fallback handling when unknown or unexpected error codes are received.
14+
3. **Golden Vector Test Suites**:
15+
- Add golden vectors covering all public entrypoints and return error variations.

0 commit comments

Comments
 (0)