refactor(schema)!: remove unimplemented stubs (#24441)

Author: aaronc

.github/workflows/test.yml

@@ -374,7 +374,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-go@v5
         with:
-          go-version: "1.12"
+          go-version: "1.16"
           cache: true
           cache-dependency-path: schema/go.sum
       - uses: technote-space/[email protected]

schema/field.go

@@ -17,19 +17,6 @@ type Field struct {
 
 	// ReferencedType is the referenced type name when Kind is EnumKind, StructKind or OneOfKind.
 	ReferencedType string `json:"referenced_type,omitempty"`
-
-	// ElementKind is the element type when Kind is ListKind.
-	// Support for this is currently UNIMPLEMENTED, this notice will be removed when it is added.
-	ElementKind Kind `json:"element_kind,omitempty"`
-
-	// Size specifies the size or max-size of a field.
-	// Support for this is currently UNIMPLEMENTED, this notice will be removed when it is added.
-	// Its specific meaning may vary depending on the field kind.
-	// For IntNKind and UintNKind fields, it specifies the bit width of the field.
-	// For StringKind, BytesKind, AddressKind, and JSONKind, fields it specifies the maximum length rather than a fixed length.
-	// If it is 0, such fields have no maximum length.
-	// It is invalid to have a non-zero Size for other kinds.
-	Size uint32 `json:"size,omitempty"`
 }
 
 // Validate validates the field.

schema/go.mod

@@ -4,4 +4,6 @@ module cosmossdk.io/schema
 // with all known production releases of the Cosmos SDK. This is to ensure that all historical
 // apps could be patched to support indexing if desired.
 
-go 1.12
+go 1.16
+
+retract v1.0.0

schema/indexer/config.go

@@ -14,39 +14,4 @@ type Config struct {
 
 	// Config are the indexer specific config options specified by the user.
 	Config interface{} `mapstructure:"config" toml:"config" json:"config,omitempty" comment:"Indexer specific configuration options."`
-
-	// Filter is the filter configuration for the indexer.
-	Filter *FilterConfig `mapstructure:"filter" toml:"filter" json:"filter,omitempty" comment:"Filter configuration for the indexer. Currently UNSUPPORTED!"`
-}
-
-// FilterConfig specifies the configuration for filtering the data stream
-type FilterConfig struct {
-	// ExcludeState specifies that the indexer will not receive state updates.
-	ExcludeState bool `mapstructure:"exclude_state" toml:"exclude_state" json:"exclude_state" comment:"Exclude all state updates."`
-
-	// ExcludeEvents specifies that the indexer will not receive events.
-	ExcludeEvents bool `mapstructure:"exclude_events" toml:"exclude_events" json:"exclude_events" comment:"Exclude all events."`
-
-	// ExcludeTxs specifies that the indexer will not receive transaction's.
-	ExcludeTxs bool `mapstructure:"exclude_txs" toml:"exclude_txs" json:"exclude_txs" comment:"Exclude all transactions."`
-
-	// ExcludeBlockHeaders specifies that the indexer will not receive block headers,
-	// although it will still receive StartBlock and Commit callbacks, just without
-	// the header data.
-	ExcludeBlockHeaders bool `mapstructure:"exclude_block_headers" toml:"exclude_block_headers" json:"exclude_block_headers" comment:"Exclude all block headers."`
-
-	Modules *ModuleFilterConfig `mapstructure:"modules" toml:"modules" json:"modules,omitempty" comment:"Module filter configuration."`
-}
-
-// ModuleFilterConfig specifies the configuration for filtering modules.
-type ModuleFilterConfig struct {
-	// Include specifies a list of modules whose state the indexer will
-	// receive state updates for.
-	// Only one of include or exclude modules should be specified.
-	Include []string `mapstructure:"include" toml:"include" json:"include" comment:"List of modules to include. Only one of include or exclude should be specified."`
-
-	// Exclude specifies a list of modules whose state the indexer will not
-	// receive state updates for.
-	// Only one of include or exclude modules should be specified.
-	Exclude []string `mapstructure:"exclude" toml:"exclude" json:"exclude" comment:"List of modules to exclude. Only one of include or exclude should be specified."`
 }

schema/indexer/start.go

@@ -65,10 +65,6 @@ type IndexingTarget struct {
 	// It will do all processing in the background so updates should be sent synchronously.
 	Listener appdata.Listener
 
-	// ModuleFilter returns the root module filter which an app can use to exclude modules at the storage level,
-	// if such a filter is set.
-	ModuleFilter *ModuleFilterConfig
-
 	IndexerInfos map[string]IndexerInfo
 }
 
@@ -109,10 +105,6 @@ func StartIndexing(opts IndexingOptions) (IndexingTarget, error) {
 
 		logger.Info("Starting indexer", "target_name", targetName, "type", targetCfg.Type)
 
-		if targetCfg.Filter != nil {
-			return IndexingTarget{}, fmt.Errorf("indexer filter options are not supported yet")
-		}
-
 		childLogger := logger
 		if scopeableLogger, ok := logger.(logutil.ScopeableLogger); ok {
 			childLogger = scopeableLogger.WithContext("indexer", targetName).(logutil.Logger)

schema/kind.go

@@ -9,26 +9,12 @@ import (
 )
 
 // Kind represents the basic type of a field in an object.
-// Each kind defines the following encodings:
+// Each kind defines the following encoding:
 //
 // - Go Encoding: the golang type which should be accepted by listeners and
 // generated by decoders when providing entity updates.
-// - JSON Encoding: the JSON encoding which should be used when encoding the field to JSON.
-// - Key Binary Encoding: the encoding which should be used when encoding the field
-// as a key in binary messages. Some encodings specify a terminal and non-terminal form
-// depending on whether or not the field is the last field in the key.
-// - Value Binary Encoding: the encoding which should be used when encoding the field
-// as a value in binary messages.
 //
-// When there is some non-determinism in an encoding, kinds should specify what
-// values they accept and also what is the canonical, deterministic encoding which
-// should be preferably emitted by serializers.
-//
-// Binary encodings were chosen based on what is likely to be the most convenient default binary encoding
-// for state management implementations. This encoding allows for sorted keys whenever it is possible for a kind
-// and is deterministic.
-// Modules that use the specified encoding natively will have a trivial decoder implementation because the
-// encoding is already in the correct format after any initial prefix bytes are stripped.
+// More encodings such as JSON or binary may be specified in the future.
 type Kind int
 
 const (
@@ -37,110 +23,56 @@ const (
 
 	// StringKind is a string type.
 	// Go Encoding: UTF-8 string with no null characters.
-	// JSON Encoding: string
-	// Key Binary Encoding:
-	//   non-terminal: UTF-8 string with no null characters suffixed with a null character
-	//   terminal: UTF-8 string with no null characters
-	// Value Binary Encoding: the same value binary encoding as BytesKind.
 	StringKind
 
 	// BytesKind represents a byte array.
 	// Go Encoding: []byte
-	// JSON Encoding: base64 encoded string, canonical values should be encoded with standard encoding and padding.
-	// Either standard or URL encoding with or without padding should be accepted.
-	// Key Binary Encoding:
-	//   non-terminal: length prefixed bytes where the width of the length prefix is 1, 2, 3 or 4 bytes depending on
-	//     the field's MaxLength (defaulting to 4 bytes).
-	//     Length prefixes should be big-endian encoded.
-	//     Values larger than 2^32 bytes are not supported (likely key-value stores impose a lower limit).
-	//   terminal: raw bytes with no length prefix
-	// Value Binary Encoding: two 32-bit unsigned little-endian integers, the first one representing the offset of the
-	//   value in the buffer and the second one representing the length of the value.
 	BytesKind
 
 	// Int8Kind represents an 8-bit signed integer.
 	// Go Encoding: int8
-	// JSON Encoding: number
-	// Key Binary Encoding: 1-byte two's complement encoding, with the first bit inverted for sorting.
-	// Value Binary Encoding: 1-byte two's complement encoding.
 	Int8Kind
 
 	// Uint8Kind represents an 8-bit unsigned integer.
 	// Go Encoding: uint8
-	// JSON Encoding: number
-	// Key Binary Encoding: 1-byte unsigned encoding.
-	// Value Binary Encoding: 1-byte unsigned encoding.
 	Uint8Kind
 
 	// Int16Kind represents a 16-bit signed integer.
 	// Go Encoding: int16
-	// JSON Encoding: number
-	// Key Binary Encoding: 2-byte two's complement big-endian encoding, with the first bit inverted for sorting.
-	// Value Binary Encoding: 2 byte two's complement little-endian encoding.
 	Int16Kind
 
 	// Uint16Kind represents a 16-bit unsigned integer.
 	// Go Encoding: uint16
-	// JSON Encoding: number
-	// Key Binary Encoding: 2-byte unsigned big-endian encoding.
-	// Value Binary Encoding: 2-byte unsigned little-endian encoding.
 	Uint16Kind
 
 	// Int32Kind represents a 32-bit signed integer.
 	// Go Encoding: int32
-	// JSON Encoding: number
-	// Key Binary Encoding: 4-byte two's complement big-endian encoding, with the first bit inverted for sorting.
-	// Value Binary Encoding: 4-byte two's complement little-endian encoding.
 	Int32Kind
 
 	// Uint32Kind represents a 32-bit unsigned integer.
 	// Go Encoding: uint32
-	// JSON Encoding: number
-	// Key Binary Encoding: 4-byte unsigned big-endian encoding.
-	// Value Binary Encoding: 4-byte unsigned little-endian encoding.
 	Uint32Kind
 
 	// Int64Kind represents a 64-bit signed integer.
 	// Go Encoding: int64
-	// JSON Encoding: base10 integer string which matches the IntegerFormat regex
-	// The canonical encoding should include no leading zeros.
-	// Key Binary Encoding: 8-byte two's complement big-endian encoding, with the first bit inverted for sorting.
-	// Value Binary Encoding: 8-byte two's complement little-endian encoding.
 	Int64Kind
 
 	// Uint64Kind represents a 64-bit unsigned integer.
 	// Go Encoding: uint64
-	// JSON Encoding: base10 integer string which matches the IntegerFormat regex
-	// Canonically encoded values should include no leading zeros.
-	// Key Binary Encoding: 8-byte unsigned big-endian encoding.
-	// Value Binary Encoding: 8-byte unsigned little-endian encoding.
 	Uint64Kind
 
 	// IntegerKind represents an arbitrary precision integer number.
 	// Support for expressing the maximum bit precision of values will be added in the future.
 	// Go Encoding: string which matches the IntegerFormat regex (unstable, subject to change).
-	// JSON Encoding: base10 integer string
-	// Canonically encoded values should include no leading zeros.
-	// Equality comparison with integers should be done using numerical equality rather
-	// than string equality.
 	IntegerKind
 
 	// DecimalKind represents an arbitrary precision decimal or integer number.
 	// Support for optionally limiting the precision may be added in the future.
 	// Go Encoding: string which matches the DecimalFormat regex
-	// JSON Encoding: base10 decimal string
-	// Canonically encoded values should include no leading zeros or trailing zeros,
-	// and exponential notation with a lowercase 'e' should be used for any numbers
-	// with an absolute value less than or equal to 1e-6 or greater than or equal to 1e6.
-	// Equality comparison with decimals should be done using numerical equality rather
-	// than string equality.
 	DecimalKind
 
 	// BoolKind represents a boolean true or false value.
 	// Go Encoding: bool
-	// JSON Encoding: boolean
-	// Key Binary Encoding: 1-byte encoding where 0 is false and 1 is true.
-	// Value Binary Encoding: 1-byte encoding where 0 is false and 1 is true.
 	BoolKind
 
 	// TimeKind represents a nanosecond precision UNIX time value (with zero representing January 1, 1970 UTC).
@@ -157,106 +89,32 @@ const (
 	// DurationKind represents the elapsed time between two nanosecond precision time values.
 	// Its valid range is +/- 2^63 (the range of a 64-bit signed integer).
 	// Go Encoding: time.Duration
-	// JSON Encoding: the number of seconds as a decimal string with no trailing zeros followed by
-	// a lowercase 's' character to represent seconds.
-	// Key Binary Encoding: 8-byte two's complement big-endian encoding, with the first bit inverted for sorting.
-	// Value Binary Encoding: 8-byte two's complement little-endian encoding.
 	DurationKind
 
 	// Float32Kind represents an IEEE-754 32-bit floating point number.
 	// Go Encoding: float32
-	// JSON Encoding: number
-	// Key Binary Encoding: 4-byte IEEE-754 encoding.
-	// Value Binary Encoding: 4-byte IEEE-754 encoding.
 	Float32Kind
 
 	// Float64Kind represents an IEEE-754 64-bit floating point number.
 	// Go Encoding: float64
-	// JSON Encoding: number
-	// Key Binary Encoding: 8-byte IEEE-754 encoding.
-	// Value Binary Encoding: 8-byte IEEE-754 encoding.
 	Float64Kind
 
 	// AddressKind represents an account address which is represented by a variable length array of bytes.
 	// Addresses usually have a human-readable rendering, such as bech32, and tooling should provide
 	// a way for apps to define a string encoder for friendly user-facing display. Addresses have a maximum
 	// supported length of 63 bytes.
 	// Go Encoding: []byte
-	// JSON Encoding: addresses should be encoded as strings using the human-readable address renderer
-	// provided to the JSON encoder.
-	// Key Binary Encoding:
-	//   non-terminal: bytes prefixed with 1-byte length prefix
-	//   terminal: raw bytes with no length prefix
-	// Value Binary Encoding: bytes prefixed with 1-byte length prefix.
 	AddressKind
 
 	// EnumKind represents a value of an enum type.
 	// Fields of this type are expected to set the EnumType field in the field definition to the enum
 	// definition.
 	// Go Encoding: string
-	// JSON Encoding: string
-	// Key Binary Encoding: the same binary encoding as the EnumType's numeric kind.
-	// Value Binary Encoding: the same binary encoding as the EnumType's numeric kind.
 	EnumKind
 
 	// JSONKind represents arbitrary JSON data.
 	// Go Encoding: json.RawMessage
-	// JSON Encoding: any valid JSON value
-	// Key Binary Encoding: string encoding
-	// Value Binary Encoding: string encoding
 	JSONKind
-
-	// UIntNKind represents a signed integer type with a width in bits specified by the Size field in the
-	// field definition.
-	// Support for this is currently UNIMPLEMENTED, this notice will be removed when it is added.
-	// N must be a multiple of 8, and it is invalid for N to equal 8, 16, 32, 64 as there are more specific
-	// types for these widths.
-	// Go Encoding: []byte where len([]byte) == Size / 8, little-endian encoded.
-	// JSON Encoding: base10 integer string matching the IntegerFormat regex, canonically with no leading zeros.
-	// Key Binary Encoding: N / 8 bytes big-endian encoded
-	// Value Binary Encoding: N / 8 bytes little-endian encoded
-	UIntNKind
-
-	// IntNKind represents an unsigned integer type with a width in bits specified by the Size field in the
-	// field definition. N must be a multiple of 8.
-	// Support for this is currently UNIMPLEMENTED, this notice will be removed when it is added.
-	// N must be a multiple of 8, and it is invalid for N to equal 8, 16, 32, 64 as there are more specific
-	// types for these widths.
-	// Go Encoding: []byte where len([]byte) == Size / 8, two's complement little-endian encoded.
-	// JSON Encoding: base10 integer string matching the IntegerFormat regex, canonically with no leading zeros.
-	// Key Binary Encoding: N / 8 bytes big-endian two's complement encoded with the first bit inverted for sorting.
-	// Value Binary Encoding: N / 8 bytes little-endian two's complement encoded.
-	IntNKind
-
-	// StructKind represents a struct object.
-	// Support for this is currently UNIMPLEMENTED, this notice will be removed when it is added.
-	// Go Encoding: an array of type []interface{} where each element is of the respective field's kind type.
-	// JSON Encoding: an object where each key is the field name and the value is the field value.
-	// Canonically, keys are in alphabetical order with no extra whitespace.
-	// Key Binary Encoding: not valid as a key field.
-	// Value Binary Encoding: 32-bit unsigned little-endian length prefix,
-	// followed by the value binary encoding of each field in order.
-	StructKind
-
-	// OneOfKind represents a field that can be one of a set of types.
-	// Support for this is currently UNIMPLEMENTED, this notice will be removed when it is added.
-	// Go Encoding: the anonymous struct { Case string; Value interface{} }, aliased as OneOfValue.
-	// JSON Encoding: same as the case's struct encoding with "@type" set to the case name.
-	// Key Binary Encoding: not valid as a key field.
-	// Value Binary Encoding: the oneof's discriminant numeric value encoded as its discriminant kind
-	// followed by the encoded value.
-	OneOfKind
-
-	// ListKind represents a list of elements.
-	// Support for this is currently UNIMPLEMENTED, this notice will be removed when it is added.
-	// Go Encoding: an array of type []interface{} where each element is of the respective field's kind type.
-	// JSON Encoding: an array of values where each element is the field value.
-	// Canonically, there is no extra whitespace.
-	// Key Binary Encoding: not valid as a key field.
-	// Value Binary Encoding: 32-bit unsigned little-endian size prefix indicating the size of the encoded data in bytes,
-	// followed by a 32-bit unsigned little-endian count of the number of elements in the list,
-	// followed by each element encoded with value binary encoding.
-	ListKind
 )
 
 // MAX_VALID_KIND is the maximum valid kind value.