Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update src14 storage recommendation and general typos #136

Merged
merged 8 commits into from
Aug 30, 2024
Merged

docs: update src14 storage recommendation and general typos #136

merged 8 commits into from
Aug 30, 2024

Conversation

K1-R1
Copy link
Member

@K1-R1 K1-R1 commented Aug 21, 2024

Type of change

  • Documentation

Changes

The following changes have been made:

  • SRC14: as of forc > v0.61.0 storage slots now are calculated differently, SRC14 has been updated to recommend namespacing all non-standardized storage variables under the SRC14 namespace.
  • General markdown file typos have been fixed.
  • General markdown file formatting.

Related Issues

Closes #133
Closes #134

Checklist

  • I have linked to any relevant issues.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation where relevant (API docs, the reference, and the Sway book).
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added (or requested a maintainer to add) the necessary Breaking* or New Feature labels where relevant.
  • I have done my best to ensure that my PR adheres to the Fuel Labs Code Review Standards.
  • I have requested a review from the relevant team or maintainers.
  • I have updated the changelog to reflect the changes on this PR.

@K1-R1 K1-R1 added Documentation Improvements or additions to documentation SRC 14 Label used to filter for the standard issue labels Aug 21, 2024
@K1-R1 K1-R1 self-assigned this Aug 21, 2024
@K1-R1
Copy link
Member Author

K1-R1 commented Aug 21, 2024

To be merged after #135

@K1-R1 K1-R1 marked this pull request as ready for review August 21, 2024 18:11
@K1-R1 K1-R1 requested a review from a team as a code owner August 21, 2024 18:11
@K1-R1 K1-R1 added the Blocked label Aug 21, 2024
bitzoic
bitzoic reviewed Aug 22, 2024
View reviewed changes
README.md Show resolved Hide resolved
docs/src/src-10-native-bridge.md Outdated Show resolved Hide resolved
docs/src/src-14-simple-upgradeable-proxies.md Outdated Show resolved Hide resolved
docs/src/src-14-simple-upgradeable-proxies.md Outdated Show resolved Hide resolved
docs/src/src-2-inline-documentation.md Outdated Show resolved Hide resolved
docs/src/src-2-inline-documentation.md Outdated Show resolved Hide resolved
@bitzoic bitzoic self-requested a review August 30, 2024 05:47
SwayStar123
SwayStar123 previously approved these changes Aug 30, 2024
View reviewed changes
@bitzoic bitzoic requested a review from SwayStar123 August 30, 2024 05:52
@bitzoic bitzoic merged commit d264041 into master Aug 30, 2024
14 checks passed
@bitzoic bitzoic mentioned this pull request Sep 9, 2024
Merged
bitzoic added a commit that referenced this pull request Sep 10, 2024
@bitzoic @SwayStar123
@IGI-111 @sdankel @K1-R1
Release v0.6.1 (#150)
792639c 
* Hotfix: Update Cargo.toml to v0.5.1 (#115)

* Hotfix: Update Cargo.toml to v0.5.1

* Udpate CHANGELOG

* fix vault reads

* add changelog

* move changelog to new empty changelog

* add "unreleased" to changelog heads

* remove date

* add  v0.5.1

* SRC-6 example contract does not update managed assets (#122)

* Update SRC-6 example with decrementation of managed assets

* Update CHANGELOG

* Fix link on CHANGELOG.md

* Update CHANGELOG to resolve markdown error with duplicate headers

* Write to storage

* Use new namespace syntax for storage (#120)

* chore: fix compiler warnings

* remove for examples

* Update changelog

* Prepare master for v0.5.2 release (#126)

* Prepare for v0.5.2 release

* Update CHANGELOG

* Update CHANGELOG formatting

* Make the `SubId` an `Option` in SRC-3's `mint()` function  (#131)

* Update specifications to change SRC-3 mint sub_id to an Option

* Update SRC-3 standard for option in mint

* Update examples

* Udpate CHANGELOG

* Run formatter

* Fix spelling

* Add event logging to SRC-20 and SRC-7 standards (#130)

* Add event logging to SRC-20 and SRC-7 specification

* Add event logging structs to SRC-20 and SRC-7

* Update CHANGELOG

* Add inline docs to SRC-20 events

* Fix CI

* Require that logs of metadata are emitted even with contants

* Update standards with additional log and ordering

* Update examples to follow new specs

* Add custom word to spell checker

* Run formatter

* Fix markdown formatting

* Resolve warnings in examples

* Build CI with release

* Store srv7 metadata to storage

* Remove cancel in progress from CI

* Update name for TotalSupplyEvent

* Split examples into seperate workspace projects

* Prepare for v0.6.0 release

* Update CHANGELOG

* Resolve warnings in examples (#137)

* Resolve warnings

* Update CHANGELOG

* Run formatter

* Remove cancel in progress from CI

* Revert remove cancel in progress from CI

* fix max_depositable and max_withdrawable examples

---------

Co-authored-by: SwayStar123 <[email protected]>

* chore: update to forc 0.63.3 (#135)

* chore: update to forc 0.63.1

* chore: updated changelog

* Update to forc v0.63.3

---------

Co-authored-by: bitzoic <[email protected]>

* docs: update src14 storage recommendation and general typos (#136)

* chore: update to forc 0.63.1

* chore: updated changelog

* docs: update src14 and general typos

* Apply PR review comments

* Fix markdown

* Update CHANGELOG

* Improve CHANGELOG comment

---------

Co-authored-by: bitzoic <[email protected]>

* Add helper functions to SRC7 standard's `Metadata` (#144)

* Add helper functions to SRC7 standard

* Update CHANGELOG

* Remove metadata functions (#148)

* Fix Sway Standards inline docs (#142)

* Update sway standards inline docs

* Update CHANGELOG

* Fix typo

* Prepare for Sway-Standards `v0.6.1` release (#147)

* Prepare for Sway-Standards v0.6.1 release

* Update CHANGELOG

* Add helper functions to struct types and `Eq` implementations for all types (#149)

* Add helper functions to struct types and Eq implementations

* Add checks to enum types

* Update CHANGELOG

---------

Co-authored-by: SwayStar123 <[email protected]>
Co-authored-by: SwayStar123 <[email protected]>
Co-authored-by: IGI-111 <[email protected]>
Co-authored-by: Sophie <[email protected]>
Co-authored-by: K1-R1 <[email protected]>
bitzoic added a commit that referenced this pull request Jan 6, 2025
@bitzoic @SwayStar123
@IGI-111 @sdankel @K1-R1 @calldelegation
Release v0.6.2 (#164)
ba788b2 
* Hotfix: Update Cargo.toml to v0.5.1 (#115)

* Hotfix: Update Cargo.toml to v0.5.1

* Udpate CHANGELOG

* fix vault reads

* add changelog

* move changelog to new empty changelog

* add "unreleased" to changelog heads

* remove date

* add  v0.5.1

* SRC-6 example contract does not update managed assets (#122)

* Update SRC-6 example with decrementation of managed assets

* Update CHANGELOG

* Fix link on CHANGELOG.md

* Update CHANGELOG to resolve markdown error with duplicate headers

* Write to storage

* Use new namespace syntax for storage (#120)

* chore: fix compiler warnings

* remove for examples

* Update changelog

* Prepare master for v0.5.2 release (#126)

* Prepare for v0.5.2 release

* Update CHANGELOG

* Update CHANGELOG formatting

* Make the `SubId` an `Option` in SRC-3's `mint()` function  (#131)

* Update specifications to change SRC-3 mint sub_id to an Option

* Update SRC-3 standard for option in mint

* Update examples

* Udpate CHANGELOG

* Run formatter

* Fix spelling

* Add event logging to SRC-20 and SRC-7 standards (#130)

* Add event logging to SRC-20 and SRC-7 specification

* Add event logging structs to SRC-20 and SRC-7

* Update CHANGELOG

* Add inline docs to SRC-20 events

* Fix CI

* Require that logs of metadata are emitted even with contants

* Update standards with additional log and ordering

* Update examples to follow new specs

* Add custom word to spell checker

* Run formatter

* Fix markdown formatting

* Resolve warnings in examples

* Build CI with release

* Store srv7 metadata to storage

* Remove cancel in progress from CI

* Update name for TotalSupplyEvent

* Split examples into seperate workspace projects

* Prepare for v0.6.0 release

* Update CHANGELOG

* Resolve warnings in examples (#137)

* Resolve warnings

* Update CHANGELOG

* Run formatter

* Remove cancel in progress from CI

* Revert remove cancel in progress from CI

* fix max_depositable and max_withdrawable examples

---------

Co-authored-by: SwayStar123 <[email protected]>

* chore: update to forc 0.63.3 (#135)

* chore: update to forc 0.63.1

* chore: updated changelog

* Update to forc v0.63.3

---------

Co-authored-by: bitzoic <[email protected]>

* docs: update src14 storage recommendation and general typos (#136)

* chore: update to forc 0.63.1

* chore: updated changelog

* docs: update src14 and general typos

* Apply PR review comments

* Fix markdown

* Update CHANGELOG

* Improve CHANGELOG comment

---------

Co-authored-by: bitzoic <[email protected]>

* Add helper functions to SRC7 standard's `Metadata` (#144)

* Add helper functions to SRC7 standard

* Update CHANGELOG

* Remove metadata functions (#148)

* Fix Sway Standards inline docs (#142)

* Update sway standards inline docs

* Update CHANGELOG

* Fix typo

* Prepare for Sway-Standards `v0.6.1` release (#147)

* Prepare for Sway-Standards v0.6.1 release

* Update CHANGELOG

* Add helper functions to struct types and `Eq` implementations for all types (#149)

* Add helper functions to struct types and Eq implementations

* Add checks to enum types

* Update CHANGELOG

* init

* remove unused param from SetSRC20Data impl

* fix import

* fix some get calls

* fmt 2

* unwrap -> read

* remove get from sasbv

* init

* ujpdate changelog pr number

* resolve comments

* fmt

* get(asset) for maps

* add write permission

* move changelog

* add sotrage writes to set_src20_data

* add changelog

* add write to storage annotation

* Update abi names in standards docs (#154)

* Update abi names in standards docs

* Update CHANGELOG

* Rename SRC-7 to Onchain Native Asset Metadata Standard (#157)

* Update SRC-7 to Onchain Native Asset Metadata Standard

* Add onchain to spellcheck

* Update CHANGELOG

* Fix typo in SRC-7 inline docs (#160)

* Fix typo in SRC-7 inline docs

* Update CHANGELOG

* docs: Add CI link check (#162)

* add

* r

* r

* SRC-15; Offchain Metadata Standard (#159)

* Create SRC-15 specifications

* Create SRC-15 standard

* Create SRC-15 examples

* Add SRC-15 examples to CI

* Update CHANGELOG

* Run formatter

* Fix markdown

* Update custom words spellcheck

* Remove sender and add nonce to SRC15 event

* Update standards and examples with nonce

* Resolve review comments

* Add comment on restricting who may emit

* Remove nonce from SRC-15 log

* Update master from v0.6.1 to v0.6.2 (#163)

* Update from v0.6.1 to v0.6.2

* Update CHANGELOG

* Add PR #162

* Resolve merge conflicts

* Resolve merge conflicts

---------

Co-authored-by: SwayStar123 <[email protected]>
Co-authored-by: SwayStar123 <[email protected]>
Co-authored-by: IGI-111 <[email protected]>
Co-authored-by: Sophie <[email protected]>
Co-authored-by: K1-R1 <[email protected]>
Co-authored-by: Call Delegation <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bitzoic bitzoic bitzoic approved these changes

@SwayStar123 SwayStar123 SwayStar123 approved these changes

Assignees

@K1-R1 K1-R1

Labels
Blocked Documentation Improvements or additions to documentation SRC 14 Label used to filter for the standard issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

chore: fix typos src14: update namespace recommendation docs to match new slot calculation
3 participants
@K1-R1 @SwayStar123 @bitzoic