Skip to content

Commit

Permalink
using kread docs
Browse files Browse the repository at this point in the history
  • Loading branch information
carlos-kryha committed Dec 5, 2023
1 parent 142c279 commit 8023a0b
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 3 deletions.
Binary file added docs/assets/KREAD-EQUIP.webp
Binary file not shown.
Binary file added docs/assets/KREAD-SELECT-ITEM.webp
Binary file not shown.
Binary file added docs/assets/KREAD-SELL-FLOW.webp
Binary file not shown.
Binary file added docs/assets/character-view-equip.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/kread-marketplace.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/mint-new.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/provision-wallet.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 32 additions & 3 deletions docs/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ Cosmos wallets are designed to sign transactions on any Cosmos network, so in or
Once you have access to your Agoric address using a wallet, you are ready to provision an Agoric smart wallet. This step is necessary in order to enable the full functionality of the Agoric smart contract platform.

1. Obtain 10BLD (this provision fee is meant to mitigate potential Denial-of-Service attacks). Checkout [this section](https://docs.inter.trade/user-how-to/wallet-usage/acquiring-bld-tokens) from [Inter Protocol](https://inter.trade/)'s documentation for more information on how to obtain BLD.
>💡 The KREAd website can be used to get BLD using [Kado](https://www.kado.money/)'s fiat on-ramp, navigate to https://kread.app/connect-wallet and click "Buy IST/BLD" to try it
>💡 You can get BLD using [Kado](https://www.kado.money/)'s fiat on-ramp directly from the KREAd frontend. Navigate to https://kread.app/connect-wallet, click "Buy IST/BLD" and follow the prompts to try it.
![kado-on-ramp](./assets/kado-on-ramp.jpg)

2. Navigate to https://kread.app/connect-wallet
Expand All @@ -63,7 +64,7 @@ That will take you to the mint character form, follow the prompts to mint a rand
> 💡 Although there is no mint item functionality, when a Character is minted, 3 randomly selected items will be minted and equipped to the Character before it gets sent to your wallet.
##### Buy an Item (or Character)
Besides the mint flow, there is one other way to obtain a Character: the KREAd Marketplace. It functions as a simple p2p marketplace for KREAd Characters and Items, allowing anyone to list their asset for sale at a price of their choosing. Unlike minting, when using the marketplace you are free to browse through the available entries and decide which asset to get based on its properties and price (remember: minting gets you a random Character).
Besides the mint flow, there is one other way to obtain a Character: the KREAd Marketplace. It functions as a simple p2p marketplace for KREAd Characters and Items, allowing anyone to list their asset for sale at a price of their choosing. Unlike minting, when using the marketplace you are free to browse through the available entries and decide which asset to get based on its properties and price (remember: minting gets you a random Character). To buy an Item on the marketplace:

1. Navigate to https://kread.app/shop/items
![kread-marketplace](./assets/kread-marketplace.jpg)
Expand All @@ -75,8 +76,36 @@ Besides the mint flow, there is one other way to obtain a Character: the KREAd M
6. Approve the transaction on Keplr
7. Await confirmation

Check out (TODO: link to marketplace section of glossary) for more details on KREAd's marketplace feature.
You can verify the purchase was successful by browsing the [inventory](https://kread.app/inventory). For more details check out (TODO: link to marketplace section of glossary)

##### Equip an Item

With an unequipped item in your wallet, you are ready to use the equip feature. This allows you to customize a Character by adding an Item to its inventory, to learn more about how this works checkout (TODO: link to inventory section of glossary). In this section we will focus on the how-to:

1. Navigate to the [character view](https://kread.app/character)
2. Select the Character you wish to equip the item to (use "My Characters" button in the top-right of the interface to switch characters if you need to)
3. Click on the category of Item you wish to equip (for the purposes of this tutorial lets select the category of the item bough in the previous step). This interface allows you to select any unequipped Item you own (within the selected category) so you can preview how it will look once equipped.
![equip-item](assets/KREAD-SELECT-ITEM.webp)
4. Having the item you would like to equip selected, click "Equip" to trigger an equip transaction
5. Approve the transaction using your wallet of choice and wait for the call to settle (may take up to 1 minute), you will see a change in the character once it does
![kread-equip-tx](assets/KREAD-EQUIP.webp)

> 💡 The unequip flow works in the same way, but of course in that case the item is transferred from the Character's inventory to the user's wallet. There is a third inventory action called swap, this allows an inventory item to be swapped for an item of the same category. Since Character inventories are limited to a single Item per category, when a user performs the equip flow shown above in a category that already contains an Item, a swap will be called instead of equip.
##### Sell your Character

Great, now that you know how to mint a Character, manage its inventory and get Items from the marketplace, let's go over placing a Character or Item for sale.

1. Navigate to [KREAD's Character page](https://kread.app/character)
2. Click the info button below your character's name to enter the character details view
3. Click "Sell" on the top right of the interface
4. Enter the desired price in IST
> 💡 10% artist royalties and 3% platform fees are added on top of the price you enter
5. Review the price breakdown and click "Send offer"
6. Sign the Sell transaction on your wallet
7. Navigate to https://kread.app/shop/characters to verify your character was added to the market
![kread-sell-flow](assets/KREAD-SELL-FLOW.webp)

> 💡 The sell button is present in many sections of the KREAd frontend for both Character and Item assets and will work in the same way

0 comments on commit 8023a0b

Please sign in to comment.