Skip to content
This repository has been archived by the owner on May 30, 2024. It is now read-only.

Tokens in Substrate Docs #70

Closed
juangirini opened this issue Dec 15, 2023 · 3 comments · Fixed by paritytech/polkadot-sdk#2802
Closed

Tokens in Substrate Docs #70

juangirini opened this issue Dec 15, 2023 · 3 comments · Fixed by paritytech/polkadot-sdk#2802
Assignees
@liamaharon

Comments

@juangirini
Copy link

juangirini commented Dec 15, 2023 •
edited by liamaharon

This is a spin off of the Currency ref docs issue #49 and its related PR paritytech/polkadot-sdk#2683

Tokens in Substrate Ref Doc

briefly explains

  • how Substrate follows the pattern of traits and trait implementation for tokens
  • why this approach was chosen

Fungible Traits and Pallets

list and compare fungible traits and pallets

Non-fungible Traits and Pallets

list and compare non-fungible traits and pallets

additionally

Improve and update trait and trait impl docs
@juangirini
Copy link
Author

@liamaharon do you want to add something else?

@liamaharon liamaharon self-assigned this Dec 15, 2023
@liamaharon
Copy link
Member

@liamaharon do you want to add something else?

yup will refine it. thanks!

@juangirini juangirini mentioned this issue Dec 15, 2023
Closed
@liamaharon liamaharon changed the title Ref docs for tokens Tokens in Substrate Docs Dec 21, 2023
@liamaharon
Copy link
Member

Trait and trait impl docs also need improving. updated this issue to include improving/updating those docs.

@liamaharon liamaharon mentioned this issue Dec 24, 2023
Merged
6 tasks
@liamaharon liamaharon mentioned this issue Jan 23, 2024
Closed
github-merge-queue bot pushed a commit to paritytech/polkadot-sdk that referenced this issue Mar 31, 2024
@liamaharon @laboon
@franciscoaguirre @kianenigma @skunert
Tokens in FRAME Docs (#2802)
4125706 
Closes paritytech/polkadot-sdk-docs#70

WIP PR for an overview of how to develop tokens in FRAME. 

- [x] Tokens in Substrate Ref Doc
  - High-level overview of the token-related logic in FRAME
- Improve docs with better explanation of how holds, freezes, ed, free
balance, etc, all work
- [x] Update `pallet_balances` docs
  - Clearly mark what is deprecated (currency)
- [x] Write fungible trait docs
- [x] Evaluate and if required update `pallet_assets`, `pallet_uniques`,
`pallet_nfts` docs
- [x] Absorb #2683
- [x] Audit individual trait method docs, and improve if possible

Feel free to suggest additional TODOs for this PR in the comments

---------

Co-authored-by: Bill Laboon <laboon@users.noreply.github.com>
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
pgherveou pushed a commit to paritytech/polkadot-sdk that referenced this issue Apr 2, 2024
@liamaharon @laboon
@franciscoaguirre @kianenigma @skunert @pgherveou
Tokens in FRAME Docs (#2802)
5df4d0a 
Closes paritytech/polkadot-sdk-docs#70

WIP PR for an overview of how to develop tokens in FRAME. 

- [x] Tokens in Substrate Ref Doc
  - High-level overview of the token-related logic in FRAME
- Improve docs with better explanation of how holds, freezes, ed, free
balance, etc, all work
- [x] Update `pallet_balances` docs
  - Clearly mark what is deprecated (currency)
- [x] Write fungible trait docs
- [x] Evaluate and if required update `pallet_assets`, `pallet_uniques`,
`pallet_nfts` docs
- [x] Absorb #2683
- [x] Audit individual trait method docs, and improve if possible

Feel free to suggest additional TODOs for this PR in the comments

---------

Co-authored-by: Bill Laboon <laboon@users.noreply.github.com>
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
dharjeezy pushed a commit to dharjeezy/polkadot-sdk that referenced this issue Apr 9, 2024
@liamaharon @laboon
@franciscoaguirre @kianenigma @skunert @dharjeezy
Tokens in FRAME Docs (paritytech#2802)
5d0b0d5 
Closes paritytech/polkadot-sdk-docs#70

WIP PR for an overview of how to develop tokens in FRAME. 

- [x] Tokens in Substrate Ref Doc
  - High-level overview of the token-related logic in FRAME
- Improve docs with better explanation of how holds, freezes, ed, free
balance, etc, all work
- [x] Update `pallet_balances` docs
  - Clearly mark what is deprecated (currency)
- [x] Write fungible trait docs
- [x] Evaluate and if required update `pallet_assets`, `pallet_uniques`,
`pallet_nfts` docs
- [x] Absorb paritytech#2683
- [x] Audit individual trait method docs, and improve if possible

Feel free to suggest additional TODOs for this PR in the comments

---------

Co-authored-by: Bill Laboon <laboon@users.noreply.github.com>
Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com>
Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@liamaharon liamaharon

Labels
None yet
Projects
Polkadot SDK Docs
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Tokens in FRAME Docs paritytech/polkadot-sdk
2 participants
@juangirini @liamaharon