From 834f122676f79065784188f6be1a9eb5c120280c Mon Sep 17 00:00:00 2001 From: Daniel Wedul Date: Wed, 6 Sep 2023 17:35:00 -0600 Subject: [PATCH] [1658]: Add some extra explanation to the req attrs fields. --- docs/proto-docs.md | 8 ++++---- proto/provenance/exchange/v1/market.proto | 8 ++++++-- x/exchange/market.pb.go | 8 ++++++-- 3 files changed, 16 insertions(+), 8 deletions(-) diff --git a/docs/proto-docs.md b/docs/proto-docs.md index 3e3b276878..8c2c868442 100644 --- a/docs/proto-docs.md +++ b/docs/proto-docs.md @@ -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. | diff --git a/proto/provenance/exchange/v1/market.proto b/proto/provenance/exchange/v1/market.proto index 652c294493..ba6a1db3ae 100644 --- a/proto/provenance/exchange/v1/market.proto +++ b/proto/provenance/exchange/v1/market.proto @@ -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; diff --git a/x/exchange/market.pb.go b/x/exchange/market.pb.go index 33fda5366e..648a5829de 100644 --- a/x/exchange/market.pb.go +++ b/x/exchange/market.pb.go @@ -227,16 +227,20 @@ type Market struct { // access_grants is the list of addresses and permissions granted for this market. AccessGrants []AccessGrant `protobuf:"bytes,11,rep,name=access_grants,json=accessGrants,proto3" json:"access_grants"` // 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. ReqAttrCreateAsk []string `protobuf:"bytes,12,rep,name=req_attr_create_ask,json=reqAttrCreateAsk,proto3" json:"req_attr_create_ask,omitempty"` // 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. ReqAttrCreateBid []string `protobuf:"bytes,13,rep,name=req_attr_create_bid,json=reqAttrCreateBid,proto3" json:"req_attr_create_bid,omitempty"`