From 5e3977190a72912104e8aec16d64de5479cea0db Mon Sep 17 00:00:00 2001 From: Cameron Carstens Date: Wed, 30 Oct 2024 12:11:01 +0700 Subject: [PATCH] Update SRC-7 naming (#306) ## Type of change - Improvement (refactoring, restructuring repository, cleaning tech debt, ...) - Documentation ## Changes The following changes have been made: - Updates the SRC-7 naming to "Onchain Asset Metadata Standard" - Adds comments on the SRC-7 intent for stateful metadata ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. - [x] I have updated the changelog to reflect the changes on this PR. --------- Co-authored-by: K1-R1 <77465250+K1-R1@users.noreply.github.com> --- CHANGELOG.md | 1 + docs/book/spell-check-custom-words.txt | 3 ++- docs/book/src/asset/index.md | 2 +- docs/book/src/asset/metadata.md | 2 +- 4 files changed, 5 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d79e4755..fa133c77 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,7 @@ Description of the upcoming release here. ### Changed - [#305](https://github.com/FuelLabs/sway-libs/pull/305) Updates to forc `v0.66.2`, fuel-core `v0.40.0`, and fuels-rs `v0.66.9`. +- [#306](https://github.com/FuelLabs/sway-libs/pull/306) Updates the SRC-7 naming to Onchain Native Asset Metadata Standard. ### Fixed diff --git a/docs/book/spell-check-custom-words.txt b/docs/book/spell-check-custom-words.txt index d066d8e8..1044e280 100644 --- a/docs/book/spell-check-custom-words.txt +++ b/docs/book/spell-check-custom-words.txt @@ -209,4 +209,5 @@ StorageMetadata functionly verifiably upgradable -upgradability \ No newline at end of file +upgradability +Onchain \ No newline at end of file diff --git a/docs/book/src/asset/index.md b/docs/book/src/asset/index.md index c9c1f6d2..ee8fe64e 100644 --- a/docs/book/src/asset/index.md +++ b/docs/book/src/asset/index.md @@ -14,4 +14,4 @@ The [SRC-3; Mint and Burn Standard](https://docs.fuel.network/docs/sway-standard ## [SRC-7 Functionality](./metadata.md) -The [SRC-7; Arbitrary Asset Metadata Standard](https://docs.fuel.network/docs/sway-standards/src-7-asset-metadata/) prescribes an ABI for metadata associated with Native Assets on the Fuel Network. The Asset Library's [metadata](./metadata.md) section supports the [SRC-7](https://docs.fuel.network/docs/sway-standards/src-7-asset-metadata/)'s implementation. +The [SRC-7; Onchain Asset Metadata Standard](https://docs.fuel.network/docs/sway-standards/src-7-asset-metadata/) prescribes an ABI for stateful metadata associated with Native Assets on the Fuel Network. The Asset Library's [metadata](./metadata.md) section supports the [SRC-7](https://docs.fuel.network/docs/sway-standards/src-7-asset-metadata/)'s implementation. diff --git a/docs/book/src/asset/metadata.md b/docs/book/src/asset/metadata.md index d4db48c8..9b90ff6e 100644 --- a/docs/book/src/asset/metadata.md +++ b/docs/book/src/asset/metadata.md @@ -14,7 +14,7 @@ To import the Asset Library Base Functionality and [SRC-7](https://docs.fuel.net ## Integration with the SRC-7 Standard -The [SRC-7](https://docs.fuel.network/docs/sway-standards/src-7-asset-metadata/) definition states that the following abi implementation is required for any Native Asset on Fuel: +The [SRC-7](https://docs.fuel.network/docs/sway-standards/src-7-asset-metadata/) definition states that the following abi implementation is required for any Native Asset on Fuel which uses stateful metadata: ```sway {{#include ../../../../examples/asset/metadata_docs/src/main.sw:src7_abi}}