Skip to content

Commit

Permalink
AIP-X Increase coin symbol limit to 32 bytes (#558)
Browse files Browse the repository at this point in the history
* Fix typos in template

* [aip] Add AIP to increase coin symbol length

* Update and rename aip-increase-coin-symbol.md to aip-114.md

---------

Co-authored-by: Frances Liu <[email protected]>
  • Loading branch information
gregnazario and thepomeranian authored Feb 21, 2025
1 parent 5b10df0 commit 6d07d61
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 4 deletions.
8 changes: 4 additions & 4 deletions TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ requires (*optional): <AIP number(s)>

## High-level Overview

> Define the strawman solution with enough details to make it clear why this is the preferred solution.
> Define the straw man solution with enough details to make it clear why this is the preferred solution.
> Please write a 2-3 paragraph high-level overview here and defer writing a more detailed description in [the specification section](#specification-and-implementation-details).
...
Expand Down Expand Up @@ -66,7 +66,7 @@ requires (*optional): <AIP number(s)>

## Testing

> - What is the testing plan? (other than load testing, all tests should be part of the implementation details and won’t need to be called out. Some examples include user stories, network health metrics, system metrics, E2E tests, unit tests, etc)
> - What is the testing plan? (other than load testing, all tests should be part of the implementation details and won’t need to be called out. Some examples include user stories, network health metrics, system metrics, E2E tests, unit tests, etc.)
> - When can we expect the results?
> - What are the test results and are they what we expected? If not, explain the gap.
Expand All @@ -75,7 +75,7 @@ requires (*optional): <AIP number(s)>
## Risks and Drawbacks

> - Express here the potential risks of taking on this proposal. What are the hazards? What can go wrong?
> - Can this proposal impact backward compabitibility?
> - Can this proposal impact backward compatibility?
> - What is the mitigation plan for each risk or drawback?
## Security Considerations
Expand Down Expand Up @@ -121,6 +121,6 @@ requires (*optional): <AIP number(s)>

## Open Questions (Optional)

> Q&A here, some of them can have answers some of those questions can be things we have not figured out but we should
> Q&A here, some of them can have answers some of those questions can be things we have not figured out, but we should
...
68 changes: 68 additions & 0 deletions aips/aip-114.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
aip: 114
title: Increase Coin Symbol Length
author: <a list of the author's or authors' name(s) and/or username(s), or name(s) and email(s). Details are below.>
discussions-to (*optional): <a url pointing to the official discussion thread>
Status: Draft
last-call-end-date (*optional): <mm/dd/yyyy the last date to leave feedbacks and reviews>
type: Standard (Framework)
created: 02/01/2024
updated (*optional): <mm/dd/yyyy>
requires (*optional): <AIP number(s)>
---

# AIP-114 - Increase Coin Symbol Byte Length

## Summary

Currently, emojis are 3 bytes, and could be longer up to 32 bytes. This AIP proposes to increase the coin and FA symbol
byte length to allow for more combinations of emojis to be used as a coin symbol. This is an increase behind a feature
flag to increase from 10 bytes to 32 bytes, and will need to adjust the indexer storage accordingly.

Goal here is to allow for more flexibility in coin symbols, and to allow for more unique coin symbols to be used.

### Out of scope

> What are we committing to not doing and why are they scoped out?
Not changing anything but the number of bytes allowed to be stored, and the Aptos default indexer.

## High-level Overview

Increases the limit to 32 bytes, adds a feature flag to enable this, and adjusts the indexer storage to allow for this.

## Impact

Indexers will now need to handle the longer symbol length. Most other applications simply read, and should not have any
issues with this change.

If this proposal doesn't happen, then we will be limited to 10 bytes for coin and FA symbols.

## Alternative Solutions

None, it's currently limited to 10 bytes, there's no other way to stick with UTF-8 and allow for more emojis.

## Specification and Implementation Details

See https://github.com/aptos-labs/aptos-core/pull/15846

## Reference Implementation

Has a feature flag associated. See https://github.com/aptos-labs/aptos-core/pull/15846

## Testing

Will have to test in devnet / testnet against existing indexers to ensure they can handle the longer symbol length.

## Risks and Drawbacks

Risk is some indexers may not be able to handle the longer symbol length, and may need to be updated. This could break
existing indexers that handle generic types, but should not effect indexers for things like centralized exchanges.

## Security Considerations

None

## Future Potential

None

0 comments on commit 6d07d61

Please sign in to comment.