Documentation
Private vs Public
An explanation of Privacy for Markets and Tradeable Items.
How Private and Public Settings Differ
Private
Markets and Tradeable Items are created Private to the creator, who becomes an Owner. The Owner then assigns rights to other Users.
If a User tries to access a Private Market or Tradeable Item, their rights are retrieved from the database. The operation they are trying to perform will require a particular right. If the User does not have the required right, they are blocked from performing that operation.
Public
Markets and Tradeable Items that are Public are assumed to be accessible to other Users. Specific Users may be restricted by assigning them rights strings that do not include the rights required to perform an operation.
If a User tries to access a Public Market or Tradeable Item, their rights are retrieved from the database, just as with a Private resource. If there is no rights string, the User is assumed to have the required rights. If there is a rights string, the User must have the right associated with the operation they are trying to perform.
A User can be blocked from a Public Market or Tradeable Item by assigning them a rights string that is the empty string "". If a User must be prevented from, for example, trading on a Public Market, but still allowed to view Price data on that Market, they would be assigned the rights string "V".
Public Tradeable Items
Public Tradeable Items are provided as a convenience for all Users. Currencies will be very commonly used, so the major common currencies are pre-configured in the database and available to all Users.
Public Markets
A Public Market allows any User to view Price data and trade on the Market by default, while the EDIT, OWNER and FILL rights remain restricted.
The creator becomes an Owner of the Public Market. Owners can change the Market configuration, open and close the Market, delete the Market, assign rights, and access Fill data.
Public Markets are not enabled by default. A User may be allowed to set up a Public Market if there is a compelling use case. Please contact the Administrators if you wish to set up a Public Market.
Conclusion
This documentation section covered:
- Tradeable Items: Objects that represent products, goods, contracts, assets or other commodified items.
- Markets: Venues where traders meet to exchange two Tradeable Items.
- Permissions: How to control access to your Markets and Tradeable Items.
- Private vs Public: Markets and Tradeable Items are Private by default, but Public resources are also possible.