Skip to content

Commit

Permalink
[1658]: Add some extra explanation to the req attrs fields.
Browse files Browse the repository at this point in the history
  • Loading branch information
SpicyLemon committed Sep 6, 2023
1 parent 20a1903 commit 834f122
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 8 deletions.
8 changes: 4 additions & 4 deletions docs/proto-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -1620,14 +1620,14 @@ Market contains all information about a market.
| `accepting_orders` | [bool](#bool) | | accepting_orders is whether this market is allowing orders to be created for it. |
| `allow_user_settlement` | [bool](#bool) | | allow_user_settlement is whether this market allows users to initiate their own settlements. For example, the FillBids and FillAsks endpoints are available if and only if this is true. The MarketSettle endpoint is only available to market actors regardless of the value of this field. |
| `access_grants` | [AccessGrant](#provenance.exchange.v1.AccessGrant) | repeated | access_grants is the list of addresses and permissions granted for this market. |
| `req_attr_create_ask` | [string](#string) | repeated | req_attr_create_ask is a list of attributes required on an account for it to be allowed to create an ask order.
| `req_attr_create_ask` | [string](#string) | repeated | req_attr_create_ask is a list of attributes required on an account for it to be allowed to create an ask order. An account must have all of these attributes in order to create an ask order in this market. If the list is empty, any account can create ask orders in this market.

An entry that starts with "*." will match any attributes that end with the rest of it. E.g. "*.b.a" will match all of "c.b.a", "x.b.a", and "e.d.c.b.a".
An entry that starts with "*." will match any attributes that end with the rest of it. E.g. "*.b.a" will match all of "c.b.a", "x.b.a", and "e.d.c.b.a"; but not "b.a", "xb.a", "b.x.a", or "c.b.a.x".

An entry of exactly "*" will match any attribute, which is equivalent to leaving this list empty. |
| `req_attr_create_bid` | [string](#string) | repeated | req_attr_create_ask is a list of attributes required on an account for it to be allowed to create a bid order.
| `req_attr_create_bid` | [string](#string) | repeated | req_attr_create_ask is a list of attributes required on an account for it to be allowed to create a bid order. An account must have all of these attributes in order to create a bid order in this market. If the list is empty, any account can create bid orders in this market.

An entry that starts with "*." will match any attributes that end with the rest of it. E.g. "*.b.a" will match all of "c.b.a", "x.b.a", and "e.d.c.b.a".
An entry that starts with "*." will match any attributes that end with the rest of it. E.g. "*.b.a" will match all of "c.b.a", "x.b.a", and "e.d.c.b.a"; but not "b.a", "xb.a", "c.b.x.a", or "c.b.a.x".

An entry of exactly "*" will match any attribute, which is equivalent to leaving this list empty. |

Expand Down
8 changes: 6 additions & 2 deletions proto/provenance/exchange/v1/market.proto
Original file line number Diff line number Diff line change
Expand Up @@ -78,16 +78,20 @@ message Market {
// access_grants is the list of addresses and permissions granted for this market.
repeated AccessGrant access_grants = 11 [(gogoproto.nullable) = false];
// req_attr_create_ask is a list of attributes required on an account for it to be allowed to create an ask order.
// An account must have all of these attributes in order to create an ask order in this market.
// If the list is empty, any account can create ask orders in this market.
//
// An entry that starts with "*." will match any attributes that end with the rest of it.
// E.g. "*.b.a" will match all of "c.b.a", "x.b.a", and "e.d.c.b.a".
// E.g. "*.b.a" will match all of "c.b.a", "x.b.a", and "e.d.c.b.a"; but not "b.a", "xb.a", "b.x.a", or "c.b.a.x".
//
// An entry of exactly "*" will match any attribute, which is equivalent to leaving this list empty.
repeated string req_attr_create_ask = 12;
// req_attr_create_ask is a list of attributes required on an account for it to be allowed to create a bid order.
// An account must have all of these attributes in order to create a bid order in this market.
// If the list is empty, any account can create bid orders in this market.
//
// An entry that starts with "*." will match any attributes that end with the rest of it.
// E.g. "*.b.a" will match all of "c.b.a", "x.b.a", and "e.d.c.b.a".
// E.g. "*.b.a" will match all of "c.b.a", "x.b.a", and "e.d.c.b.a"; but not "b.a", "xb.a", "c.b.x.a", or "c.b.a.x".
//
// An entry of exactly "*" will match any attribute, which is equivalent to leaving this list empty.
repeated string req_attr_create_bid = 13;
Expand Down
8 changes: 6 additions & 2 deletions x/exchange/market.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 834f122

Please sign in to comment.