Skip to content

Commit 2981599

Browse files
authored
docs(template): update CAIP-350 namespace profile template (#154)
2 parents 9dfc61d + bc56462 commit 2981599

File tree

1 file changed

+25
-6
lines changed

1 file changed

+25
-6
lines changed

_template/caip350.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,14 +50,15 @@ ChainType binary key: `0xXXXX`
5050

5151
<!-- a description of the format of addresses intended for the text representation of ERC-7930 Interoperable Addresses -->
5252

53-
##### Text representation -> customary text address formats conversion
53+
##### Text representation -> native representation conversion
5454

55-
<!-- instructions for how to convert from the above to the address formats normally used in the ecosystem -->
55+
<!-- instructions for how to convert from the above to the native address formats normally used in the ecosystem -->
5656
<!-- MUST cover all address types used in the ecosystem -->
57+
<!-- Note: actor addresses should be addressed here natively, i.e. in the native representation format -->
5758

58-
##### customary text addresses -> text representation conversion
59+
##### Native representation -> text representation conversion
5960

60-
<!-- instructions for how to convert from text address normally used in the ecosystem to the Interoperable Address format -->
61+
<!-- instructions for how to convert from native address formats normally used in the ecosystem to the Interoperable Address text representation -->
6162
<!-- MUST cover all address types used in the ecosystem -->
6263

6364
#### Binary representation
@@ -70,10 +71,28 @@ ChainType binary key: `0xXXXX`
7071

7172
#### Binary -> text conversion
7273

73-
<!-- instructions for converting from the text representation to the binary one -->
74+
<!-- instructions for converting from the binary representation to the text one -->
7475

7576
#### Examples
7677

77-
## Extra considerations
78+
### Error handling
79+
80+
<!-- _(Optional section)_ -->
81+
82+
<!-- Document any error handling considerations specific to this namespace, such as:
83+
- Scenarios where loss of information may occur during conversions (e.g., CAIP-2 -> CAIP-350 when full chainId can't be determined)
84+
- Error types and how they should be handled -->
85+
86+
### Implementation considerations
87+
88+
<!-- _(Optional section)_ -->
89+
90+
<!-- Document any implementation considerations specific to this namespace, such as:
91+
- Account types that cannot be chain-specified
92+
- Chain-wildcard limitations
93+
- Other implementation footguns specific to this ecosystem -->
94+
95+
### Extra considerations
7896

7997
<!-- Anything that is particular to this namespace and of interest to users, such as not being able to satisfy canonicity requirements or imminent expansions/revisions to the conventions of the ecosystem -->
98+

0 commit comments

Comments
 (0)