Skip to content

Commit

Permalink
x/upgrade gRPC methods for VersionMap (cosmos#9073)
Browse files Browse the repository at this point in the history 
* setup version map query

* query methods

* grpc methods

* cleanup

* grpc for VersionMap

* swagger update

* swagger sync

* cleanup

* reset docs

* clean

* grpc with field

* daily

* -add grpc methods
-add optional field to get specific module from version map
-added cli test for version map query from cli

* -consolidate grpc test to one test function
-return better errors in grpc methods

* consolidate tests

* swagger update

* this breaks

* Try stringer on individual msgs

* change map to slice in proto

* cleanup

* add comments to proto fields

* cleanup

* regen proto files

* jsoncodec

* rename gRPC methods

* * add fetch method for module version slice
* add method to return version given a module name
* remove sorting functions

* lint

* Update proto/cosmos/upgrade/v1beta1/query.proto

Co-authored-by: Aaron Craelius <[email protected]>

* Update proto/cosmos/upgrade/v1beta1/upgrade.proto

Co-authored-by: Aaron Craelius <[email protected]>

* fix up comments and regen proto/swagger

* Update x/upgrade/client/cli/query.go

Co-authored-by: Amaury <[email protected]>

* conform to pr 6711

* lint

Co-authored-by: technicallyty <[email protected]>
Co-authored-by: Amaury M <[email protected]>
Co-authored-by: Aaron Craelius <[email protected]>
  • Loading branch information
@technicallyty @amaury1093 @aaronc
4 people authored May 19, 2021
1 parent 420e73c commit 53fe03e
Show file tree
Hide file tree
Showing 14 changed files with 1,422 additions and 73 deletions.
266 changes: 266 additions & 0 deletions client/docs/swagger-ui/swagger.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21407,6 +21407,237 @@ paths:
}
tags:
- Query
/cosmos/upgrade/v1beta1/module_versions:
get:
summary: ModuleVersions queries the list of module versions from state.
operationId: ModuleVersions
responses:
'200':
description: A successful response.
schema:
type: object
properties:
module_versions:
type: array
items:
type: object
properties:
name:
type: string
title: name of the app module
version:
type: string
format: uint64
title: consensus version of the app module
description: ModuleVersion specifies a module and its consensus version.
description: >-
module_versions is a list of module names with their consensus
versions.
description: >-
QueryModuleVersionsResponse is the response type for the
Query/ModuleVersions

RPC method.
default:
description: An unexpected error response
schema:
type: object
properties:
error:
type: string
code:
type: integer
format: int32
message:
type: string
details:
type: array
items:
type: object
properties:
type_url:
type: string
description: >-
A URL/resource name that uniquely identifies the type of
the serialized

protocol buffer message. This string must contain at
least

one "/" character. The last segment of the URL's path
must represent

the fully qualified name of the type (as in

`path/google.protobuf.Duration`). The name should be in
a canonical form

(e.g., leading "." is not accepted).


In practice, teams usually precompile into the binary
all types that they

expect it to use in the context of Any. However, for
URLs which use the

scheme `http`, `https`, or no scheme, one can optionally
set up a type

server that maps type URLs to message definitions as
follows:


* If no scheme is provided, `https` is assumed.

* An HTTP GET on the URL must yield a
[google.protobuf.Type][]
value in binary format, or produce an error.
* Applications are allowed to cache lookup results based
on the
URL, or have them precompiled into a binary to avoid any
lookup. Therefore, binary compatibility needs to be preserved
on changes to types. (Use versioned type names to manage
breaking changes.)

Note: this functionality is not currently available in
the official

protobuf release, and it is not used for type URLs
beginning with

type.googleapis.com.


Schemes other than `http`, `https` (or the empty scheme)
might be

used with implementation specific semantics.
value:
type: string
format: byte
description: >-
Must be a valid serialized protocol buffer of the above
specified type.
description: >-
`Any` contains an arbitrary serialized protocol buffer
message along with a

URL that describes the type of the serialized message.


Protobuf library provides support to pack/unpack Any values
in the form

of utility functions or additional generated methods of the
Any type.


Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
any.Unpack(foo)
...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := ptypes.MarshalAny(foo)
...
foo := &pb.Foo{}
if err := ptypes.UnmarshalAny(any, foo); err != nil {
...
}

The pack methods provided by protobuf library will by
default use

'type.googleapis.com/full.type.name' as the type URL and the
unpack

methods only use the fully qualified type name after the
last '/'

in the type URL, for example "foo.bar.com/x/y.z" will yield
type

name "y.z".



JSON

====

The JSON representation of an `Any` value uses the regular

representation of the deserialized, embedded message, with
an

additional field `@type` which contains the type URL.
Example:

package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}

{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}

If the embedded message type is well-known and has a custom
JSON

representation, that representation will be embedded adding
a field

`value` which holds the custom JSON in addition to the
`@type`

field. Example (for message [google.protobuf.Duration][]):

{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
parameters:
- name: module_name
description: |-
module_name is a field to query a specific module
consensus version from state. Leaving this empty will
fetch the full list of module versions from state.
in: query
required: false
type: string
tags:
- Query
'/cosmos/upgrade/v1beta1/upgraded_consensus_state/{last_height}':
get:
summary: |-
Expand Down Expand Up @@ -36870,6 +37101,17 @@ definitions:
type: boolean
format: boolean
description: 'EventAttribute is a single key-value pair, associated with an event.'
cosmos.upgrade.v1beta1.ModuleVersion:
type: object
properties:
name:
type: string
title: name of the app module
version:
type: string
format: uint64
title: consensus version of the app module
description: ModuleVersion specifies a module and its consensus version.
cosmos.upgrade.v1beta1.Plan:
type: object
properties:
Expand Down Expand Up @@ -36966,6 +37208,30 @@ definitions:
RPC

method.
cosmos.upgrade.v1beta1.QueryModuleVersionsResponse:
type: object
properties:
module_versions:
type: array
items:
type: object
properties:
name:
type: string
title: name of the app module
version:
type: string
format: uint64
title: consensus version of the app module
description: ModuleVersion specifies a module and its consensus version.
description: >-
module_versions is a list of module names with their consensus
versions.
description: >-
QueryModuleVersionsResponse is the response type for the
Query/ModuleVersions

RPC method.
cosmos.upgrade.v1beta1.QueryUpgradedConsensusStateResponse:
type: object
properties:
Expand Down
Loading

0 comments on commit 53fe03e

Please sign in to comment.