Skip to content

Commit

Permalink
add images to README.md in tokenfactory module (#5594)
Browse files Browse the repository at this point in the history
Co-authored-by: alessandromazza <[email protected]>
Co-authored-by: niilptr <[email protected]>
  • Loading branch information
3 people authored Jun 27, 2023
1 parent d0f2c42 commit 75f982c
Show file tree
Hide file tree
Showing 6 changed files with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions x/tokenfactory/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ message MsgCreateDenom {
- Add denom to the `CreatorPrefixStore`, where a state of denoms created per
creator is kept.

![Schema](/x/tokenfactory/images/CreateDenom.png)
### Mint

Minting of a specific denom is only allowed for the current admin.
Expand All @@ -66,6 +67,7 @@ message MsgMint {
- Check that the sender of the message is the admin of the denom
- Mint designated amount of tokens for the denom via `bank` module

![Schema](/x/tokenfactory/images/Mint.png)
### Burn

Burning of a specific denom is only allowed for the current admin.
Expand All @@ -88,6 +90,7 @@ message MsgBurn {
- Check that the sender of the message is the admin of the denom
- Burn designated amount of tokens for the denom via `bank` module

![Schema](/x/tokenfactory/images/Burn.png)
### ChangeAdmin

Change the admin of a denom. Note, this is only allowed to be called by the current admin of the denom.
Expand All @@ -100,6 +103,7 @@ message MsgChangeAdmin {
}
```

![Schema](/x/tokenfactory/images/ChangeAdmin.png)
### SetDenomMetadata

Setting of metadata for a specific denom is only allowed for the admin of the denom.
Expand All @@ -117,6 +121,7 @@ message MsgChangeAdmin {
- Check that sender of the message is the admin of denom
- Modify `AuthorityMetadata` state entry to change the admin of the denom

![Schema](/x/tokenfactory/images/SetDenomMetadata.png)
## Expectations from the chain

The chain's bech32 prefix for addresses can be at most 16 characters long.
Expand Down
Binary file added x/tokenfactory/images/Burn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added x/tokenfactory/images/ChangeAdmin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added x/tokenfactory/images/CreateDenom.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added x/tokenfactory/images/Mint.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added x/tokenfactory/images/SetDenomMetadata.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 75f982c

Please sign in to comment.