aptos-core icon indicating copy to clipboard operation
aptos-core copied to clipboard

[Bug] Formalize and expand coin and token docs as Aptos Token Standard

Open clay-aptos opened this issue 3 years ago • 3 comments

🐛 Bug

Although we have ample documentation on Aptos tokens and coins, it needs to be expanded and highlighted on Aptos.dev. Cathy, Bo and I just met on the topic and agreed to:

  1. Move the Coin and Token index and the Coin and Token pages higher up in the site, to a proposed Start menu (along with the CLI docs and other starter materials).
  2. Rename Token as digital asset to avoid confusion from the coin being a subset of token. For example, see: https://docs.metaplex.com/programs/token-metadata/overview
  3. Augment the lists of fields with tables that contain the existing names and descriptions from lists but also reveal expected values and ranges and indicate which are mandatory vs. optional.
  4. Replace the old-style diagram depicting token data flow with one supporting both dark and light modes.
  5. Link to our Move examples for even more help: https://github.com/aptos-labs/aptos-core/tree/main/aptos-move/move-examples
  6. Note the limits to storing customized token properties on-chain, namely 1000 properties per token with field names limited to 128 characters.
  7. Explain that Aptos Name Service and other services rely upon these on-chain properties.
  8. Gather Rust examples for all of the existing tutorials where missing and expected: https://aptos.dev/tutorials/aptos-quickstarts Namely: https://aptos.dev/tutorials/your-first-nft https://aptos.dev/tutorials/your-first-coin

See related work underway in: https://github.com/aptos-labs/aptos-core/pull/5097 https://github.com/aptos-labs/aptos-core/pull/5259

Expected Behavior

Easier use of and understanding of the Aptos Token Standard.

clay-aptos avatar Oct 25 '22 22:10 clay-aptos

Adding @davidiw for guidance on navigation here.

clay-aptos avatar Oct 28 '22 19:10 clay-aptos

More work to do here.

clay-aptos avatar Nov 01 '22 21:11 clay-aptos

Now that the first phase of improvements are out, we should announce them: https://github.com/aptos-labs/aptos-core/pull/5432

clay-aptos avatar Nov 03 '22 18:11 clay-aptos

Hi team, I am seeing what else remains from this issue we can accomplish. I'm adding @movekevin for his guidance. In short, we completed: Move the Coin and Token index and the Coin and Token pages higher up in the site, to a proposed Start menu (along with the CLI docs and other starter materials). Rename Token as digital asset to avoid confusion from the coin being a subset of token. For example, see: https://docs.metaplex.com/programs/token-metadata/overview Augment the lists of fields with tables that contain the existing names and descriptions from lists but also reveal expected values and ranges and indicate which are mandatory vs. optional. Replace the old-style diagram depicting token data flow with one supporting both dark and light modes. Link to our Move examples for even more help: https://github.com/aptos-labs/aptos-core/tree/main/aptos-move/move-examples

And I could use help with: Note the limits to storing customized token properties on-chain, namely 1000 properties per token with field names limited to 128 characters. Explain that Aptos Name Service and other services rely upon these on-chain properties. Gather Rust examples for all of the existing tutorials where missing and expected: https://aptos.dev/tutorials/aptos-quickstarts Namely: https://aptos.dev/tutorials/your-first-nft https://aptos.dev/tutorials/your-first-coin

Thanks!

clay-aptos avatar Nov 22 '22 17:11 clay-aptos

This issue is stale because it has been open 45 days with no activity. Remove the stale label or comment - otherwise this will be closed in 15 days.

github-actions[bot] avatar Jan 07 '23 01:01 github-actions[bot]

Hi @areshand and @cathyaptos,

I am finishing up this work in: https://github.com/aptos-labs/aptos-core/pull/6126 Please take a look.

And noting the Rust SDK parity is out of scope here. I am asking @gregnazario and @davidiw if we should track improvements to the SDK in a distinct issue. Thanks, all.

clay-aptos avatar Jan 09 '23 19:01 clay-aptos