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

BLOCK-2390 - Advanced Uniq actions update #213

Merged
merged 4 commits into from
Jun 20, 2024
Merged

BLOCK-2390 - Advanced Uniq actions update #213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f2da12e
BLOCK-2216 - Updated page order, split the guide into 2, added steps …
igor-sikachyna Jun 13, 2024
01d3aa3
BLOCK-2216 - Fix grammar
igor-sikachyna Jun 13, 2024
da03066
BLOCK-2216 - Fix resale share range
igor-sikachyna Jun 13, 2024
7e1bd06
BLOCK-2216 minor fixes
ammanpashasc Jun 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions descriptors/eosio.nft.ft-descriptor.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
},
"promoter_basis_point": {
"friendlyName": "Promoter Basis Points",
"description": "Promoter commission in basis points (0-1000)"
"description": "Promoter commission in basis points (200-1000)"
},
"owner": {
"friendlyName": "Owner",
Expand Down Expand Up @@ -104,7 +104,7 @@
},
"promoter_basis_point": {
"friendlyName": "Promoter Basis Points",
"description": "Promoter commission in basis points (0-1000)"
"description": "Promoter commission in basis points (200-1000)"
},
"factory_id": {
"friendlyName": "Token Factory ID",
Expand Down Expand Up @@ -747,7 +747,7 @@
},
"promoter_basis_point": {
"friendlyName": "Promoter Basis Points",
"description": "The resale promoter commission (0-1000)"
"description": "The resale promoter commission (200-1000)"
},
"memo": {
"friendlyName": "Memo",
Expand Down Expand Up @@ -898,7 +898,7 @@
},
"promoter_basis_point": {
"friendlyName": "Promoter basis point",
"description": "UOS share received by the promoter with each purchase done for this option. Specified in basis points (200-1000)"
"description": "UOS share received by the promoter with each purchase done for this option. Specified in basis points (0-1000)"
},
"purchase_option_with_uniqs": {
"friendlyName": "Purchase option with Uniqs",
Expand Down
4 changes: 2 additions & 2 deletions docs/blockchain/contracts/nft-contract/nft-actions/setprchsreq.a.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The factory manager can specify purchase options for users. Note that currently

`purchase_limit` - how much users can buy via purchase action. It has to be less than factory limit setting and greater or equal to what was already minted via the action. If value provided is below the number of tokens already purchased from this option the `purchase_limit` will be set to be equal to the number of purchased tokens from this option

`promoter_basis_point` is used to specify how much % of a sale a promoter will get. Minimum value is `200` (2%), maximum value is `1000` (10%). Value range is controlled by `min_promoter_share_bp` and `max_promoter_share_bp` stored in `saleshrlimcfg` table under the scope of `1`.
`promoter_basis_point` is used to specify how much % of a sale a promoter will get. Minimum value is `0` (0%), maximum value is `1000` (10%). Value range is controlled by `min_promoter_share_bp` and `max_promoter_share_bp` stored in `saleshrlimcfg` table under the scope of `0`.

`purchase_option_with_uniqs` - optional field used to set purchase options via uniqs. user has to have `count` tokens from listed uniq factories. They will be burned, transferred or checked as per `strategy` setting.

Expand Down Expand Up @@ -122,7 +122,7 @@ By understanding this formalization, you can ensure a clear and standardized way
| index | uint64_t | number | Index of the purchase option. Multiple purchase options can be added to a single factory |
| price | eosio::asset | string | Price of the Uniqs from this purchase option either in UOS or USD. Can also set 0 price |
| purchase_limit | optional\<uint32_t> | number / null | Maximum number of Uniqs that can be purchased from this purchase option. Must not exceed factory minting limit |
| promoter_basis_point | uint16_t | number | UOS share received by the promoter with each purchase done for this option. Specified in basis points. Must be in the range 200-1000 |
| promoter_basis_point | uint16_t | number | UOS share received by the promoter with each purchase done for this option. Specified in basis points. Must be in the range 0-1000 |
| purchase_option_with_uniqs | std::optional\<provided_user_uniqs> | Object / null | Optional feature that allows the purchase option to require user to own uniqs from specific factories or to pay with uniqs from specific factories. Refer to a link below for more details |
| sale_shares | std::vector\<sale_share> | Array | A vector of [account, share] pairs setting the share each account receives during the purchase |
| maximum_uos_payment | optional\<eosio::asset> | asset / null | Maximum amount of UOS manager allows to be take for the creation of the purchase option. Since the price is fixed in USD the equivalent UOS payment may fluctuate. Using this option will prevent the manager from paying more then he is willing to |
Expand Down
4 changes: 2 additions & 2 deletions docs/blockchain/contracts/nft-contract/nft-actions/setprchsreq.b.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The factory manager can specify purchase options for users. Note that currently

`purchase_limit` - how much users can buy via purchase action. It has to be less than factory limit setting and greater or equal to what was already minted via the action. If value provided is below the number of tokens already purchased from this option the `purchase_limit` will be set to be equal to the number of purchased tokens from this option

`promoter_basis_point` is used to specify how much % of a sale a promoter will get. Minimum value is `200` (2%), maximum value is `1000` (10%). Value range is controlled by `min_promoter_share_bp` and `max_promoter_share_bp` stored in `saleshrlimcfg` table under the scope of `1`.
`promoter_basis_point` is used to specify how much % of a sale a promoter will get. Minimum value is `0` (0%), maximum value is `1000` (10%). Value range is controlled by `min_promoter_share_bp` and `max_promoter_share_bp` stored in `saleshrlimcfg` table under the scope of `0`.

`purchase_option_with_uniqs` - optional field used to set purchase options via uniqs. user has to have `count` tokens from listed uniq factories. They will be burned, transferred or checked as per `strategy` setting.

Expand Down Expand Up @@ -118,7 +118,7 @@ By understanding this formalization, you can ensure a clear and standardized way
| index | uint64_t | number | Index of the purchase option. Multiple purchase options can be added to a single factory |
| price | eosio::asset | string | Price of the Uniqs from this purchase option either in UOS or USD. Can also set 0 price |
| purchase_limit | optional\<uint32_t> | number / null | Maximum number of Uniqs that can be purchased from this purchase option. Must not exceed factory minting limit |
| promoter_basis_point | uint16_t | number | UOS share received by the promoter with each purchase done for this option. Specified in basis points. Must be in the range 200-1000 |
| promoter_basis_point | uint16_t | number | UOS share received by the promoter with each purchase done for this option. Specified in basis points. Must be in the range 0-1000 |
| purchase_option_with_uniqs | std::optional\<provided_user_uniqs> | Object / null | Optional feature that allows the purchase option to require user to own uniqs from specific factories or to pay with uniqs from specific factories. Refer to a link below for more details |
| sale_shares | std::vector\<sale_share> | Array | A vector of [account, share] pairs setting the share each account receives during the purchase |
| maximum_uos_payment | optional\<eosio::asset> | asset / null | Maximum amount of UOS manager allows to be take for the creation of the purchase option. Since the price is fixed in USD the equivalent UOS payment may fluctuate. Using this option will prevent the manager from paying more then he is willing to |
Expand Down
15 changes: 8 additions & 7 deletions docs/tutorials/index/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,11 +167,6 @@ General tutorials to help feed your curiosity.
<td>Learn how to validate uniq metadata files using Ultra Toolkit's schema validation feature</td>
<td><a href="../uniq-factories/creating-uniq-factories/how-to-validate-uniq-metadata-using-schema-validator-toolkit">Link</a></td>
</tr>
<tr>
<td>How to perform advanced actions with Uniqs and Factories</td>
<td>Learn how to use Ultra Toolkit to add or remove a direct purchase from your Factory, transfer and burning Uniqs, add authorized minters</td>
<td><a href="../uniq-factories/factory-management/how-to-perform-advanced-actions-with-uniqs-and-factories">Link</a></td>
</tr>
<tr>
<td>How to create a Uniq Factory using Ultra Toolkit</td>
<td>Learn how to create your first uniq factory using Ultra Toolkit</td>
Expand All @@ -188,15 +183,21 @@ General tutorials to help feed your curiosity.
<td><a href="../uniq-factories/creating-uniq-factories/how-to-update-uniq-metadata-using-toolkit">Link</a></td>
</tr>
<tr>
<td>How to perform advanced actions with Uniqs and Factories</td>
<td>Learn how to use Ultra Toolkit to add or remove a direct purchase from your Factory, transfer and burning Uniqs, add authorized minters</td>
<td>How to perform advanced actions with Uniqs and Factories using Ultra Toolkit</td>
<td>Learn how to transfer Uniqs, burn Uniqs add authorized minters to your factory using Ultra Toolkit</td>
<td><a href="../uniq-factories/factory-management/how-to-perform-advanced-actions-with-uniqs-and-factories">Link</a></td>
</tr>
<tr>
<td>How to add first-hand purchase options using Toolkit</td>
<td>Learn how to use Ultra Toolkit to add or remove a direct purchase option from your Factory</td>
<td><a href="../uniq-factories/factory-management/how-to-add-first-hand-purchase-using-toolkit">Link</a></td>
</tr>
<tr>
<td>Uniq Avatars</td>
<td>Learn how to manage your uniq avatar as a user</td>
<td><a href="../uniq-factories/uniq-avatar/index">Link</a></td>
</tr>

</table>

## Others
Expand Down
4 changes: 3 additions & 1 deletion ...-factories/creating-uniq-factories/how-to-update-uniq-metadata-using-toolkit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,4 +179,6 @@ You have now successfully disabled metadata updates for the uniq factory. To ver

## What's next?

TODO
After practicing the basic metadata actions, you can move on to advanced actions with Uniqs and Factories:

- [How to perform advanced actions with Uniqs and Factories](../factory-management/how-to-perform-advanced-actions-with-uniqs-and-factories.md)
2 changes: 1 addition & 1 deletion ...rials/uniq-factories/factory-management/exchange-a-uniq-using-smart-contract.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Exchange a Uniq Using Smart Contract'

order: 3
order: 5
---

# Exchange a Uniq Using Smart Contract
Expand Down
2 changes: 1 addition & 1 deletion ...utorials/uniq-factories/factory-management/factory-purchase-options-examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Factory Purchase Options Examples'

order: 2
order: 4
---


Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/uniq-factories/factory-management/factory-purchase-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Factory Purchase Options'

order: 1
order: 3
---


Expand Down
Loading
Loading