Skip to content

Commit

Permalink
feat: adding connection params grpc and cli query (#2745)
Browse files Browse the repository at this point in the history 
imp: (core/03-connection) Adding `ConnectionParams` grpc query and CLI to 03-connection.
fix: (modules/core/keeper) Fix request wiring for `UpgradedConsensusState` in core query server.
  • Loading branch information
@damiannolan
damiannolan committed Nov 17, 2022
1 parent 876b73a commit a05247c
Show file tree
Hide file tree
Showing 17 changed files with 977 additions and 238 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ Ref: https://keepachangelog.com/en/1.0.0/
* (04-channel) [\#2638](https://github.com/cosmos/ibc-go/pull/2638) Channel Keeper now expects a keeper which fulfills the expected `exported.ScopedKeeper` interface for the capability keeper.
* (core/04-channel)[\#1703](https://github.com/cosmos/ibc-go/pull/1703) Update `SendPacket` API to take in necessary arguments and construct rest of packet rather than taking in entire packet. The generated packet sequence is returned by the `SendPacket` function.
* (modules/apps/27-interchain-accounts) [\#2433](https://github.com/cosmos/ibc-go/pull/2450) Renamed icatypes.PortPrefix to icatypes.ControllerPortPrefix & icatypes.PortID to icatypes.HostPortID
* (core/02-client) [\#2573](https://github.com/cosmos/ibc-go/pull/2573) Renames `ClientParams` gRPC query method to `Params`.
* (testing) [\#2567](https://github.com/cosmos/ibc-go/pull/2567) Modify `SendPacket` API of `Endpoint` to match the API of `SendPacket` in 04-channel.
* (06-solomachine) [\#2761](https://github.com/cosmos/ibc-go/pull/2761) Removed deprecated `ClientId` field from `Misbehaviour` and `allow_update_after_proposal` field from `ClientState`.

Expand Down Expand Up @@ -105,6 +104,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
* (modules/core/keeper) [\#1728](https://github.com/cosmos/ibc-go/pull/2399) Updated channel callback errors to include portID & channelID for better identification of errors.
* [\#2434](https://github.com/cosmos/ibc-go/pull/2478) Removed all `TypeMsg` constants
* (modules/core/exported) [#1689] (https://github.com/cosmos/ibc-go/pull/2539) Removing `GetVersions` from `ConnectionI` interface.
* (core/03-connection) [\#2745](https://github.com/cosmos/ibc-go/pull/2745) Adding `ConnectionParams` grpc query and CLI to 03-connection.

### Features

Expand All @@ -117,6 +117,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
* (light-clients/07-tendermint) [\#1674](https://github.com/cosmos/ibc-go/pull/1674) Submitted ClientState is zeroed out before checking the proof in order to prevent the proposal from containing information governance is not actually voting on.
* (modules/core/02-client)[\#1676](https://github.com/cosmos/ibc-go/pull/1676) ClientState must be zeroed out for `UpgradeProposals` to pass validation. This prevents a proposal containing information governance is not actually voting on.
* (modules/core/keeper) [\#2403](https://github.com/cosmos/ibc-go/pull/2403) Added a function in keeper to cater for blank pointers.
* (modules/core/keeper) [\#2745](https://github.com/cosmos/ibc-go/pull/2745) Fix request wiring for `UpgradedConsensusState` in core query server.

## [v5.1.0](https://github.com/cosmos/ibc-go/releases/tag/v5.1.0) - 2022-11-09

Expand Down
299 changes: 281 additions & 18 deletions docs/client/swagger-ui/swagger.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5742,7 +5742,7 @@ paths:
- Query
/ibc/core/client/v1/params:
get:
summary: Params queries all parameters of the ibc client.
summary: ClientParams queries all parameters of the ibc client submodule.
operationId: ClientParams
responses:
'200':
Expand All @@ -5761,8 +5761,10 @@ paths:
description: >-
allowed_clients defines the list of allowed client state
types.
description: |-
QueryParamsResponse is the response type for the Query/Params RPC
description: >-
QueryClientParamsResponse is the response type for the
Query/ClientParams RPC

method.
default:
description: An unexpected error response.
Expand Down Expand Up @@ -8605,6 +8607,229 @@ paths:
format: uint64
tags:
- Query
/ibc/core/connection/v1/params:
get:
summary: ConnectionParams queries all parameters of the ibc connection submodule.
operationId: ConnectionParams
responses:
'200':
description: A successful response.
schema:
type: object
properties:
params:
description: params defines the parameters of the module.
type: object
properties:
max_expected_time_per_block:
type: string
format: uint64
description: >-
maximum expected time per block (in nanoseconds), used to
enforce block delay. This parameter should reflect the

largest amount of time that the chain might reasonably
take to produce the next block under normal operating

conditions. A safe choice is 3-5x the expected time per
block.
description: >-
QueryConnectionParamsResponse is the response type for the
Query/ConnectionParams 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 := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(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"
}
tags:
- Query
/ibc/core/channel/v1/channels:
get:
summary: Channels queries all the IBC channels of a chain.
Expand Down Expand Up @@ -14701,6 +14926,23 @@ definitions:
type: string
description: allowed_clients defines the list of allowed client state types.
description: Params defines the set of IBC light client parameters.
ibc.core.client.v1.QueryClientParamsResponse:
type: object
properties:
params:
description: params defines the parameters of the module.
type: object
properties:
allowed_clients:
type: array
items:
type: string
description: allowed_clients defines the list of allowed client state types.
description: >-
QueryClientParamsResponse is the response type for the Query/ClientParams
RPC

method.
ibc.core.client.v1.QueryClientStateResponse:
type: object
properties:
Expand Down Expand Up @@ -15666,21 +15908,6 @@ definitions:
title: |-
QueryConsensusStatesResponse is the response type for the
Query/ConsensusStates RPC method
ibc.core.client.v1.QueryParamsResponse:
type: object
properties:
params:
description: params defines the parameters of the module.
type: object
properties:
allowed_clients:
type: array
items:
type: string
description: allowed_clients defines the list of allowed client state types.
description: |-
QueryParamsResponse is the response type for the Query/Params RPC
method.
ibc.core.client.v1.QueryUpgradedClientStateResponse:
type: object
properties:
Expand Down Expand Up @@ -16228,6 +16455,21 @@ definitions:
description: |-
IdentifiedConnection defines a connection with additional connection
identifier field.
ibc.core.connection.v1.Params:
type: object
properties:
max_expected_time_per_block:
type: string
format: uint64
description: >-
maximum expected time per block (in nanoseconds), used to enforce
block delay. This parameter should reflect the

largest amount of time that the chain might reasonably take to produce
the next block under normal operating

conditions. A safe choice is 3-5x the expected time per block.
description: Params defines the set of Connection parameters.
ibc.core.connection.v1.QueryClientConnectionsResponse:
type: object
properties:
Expand Down Expand Up @@ -16692,6 +16934,27 @@ definitions:
title: |-
QueryConnectionConsensusStateResponse is the response type for the
Query/ConnectionConsensusState RPC method
ibc.core.connection.v1.QueryConnectionParamsResponse:
type: object
properties:
params:
description: params defines the parameters of the module.
type: object
properties:
max_expected_time_per_block:
type: string
format: uint64
description: >-
maximum expected time per block (in nanoseconds), used to enforce
block delay. This parameter should reflect the

largest amount of time that the chain might reasonably take to
produce the next block under normal operating

conditions. A safe choice is 3-5x the expected time per block.
description: >-
QueryConnectionParamsResponse is the response type for the
Query/ConnectionParams RPC method.
ibc.core.connection.v1.QueryConnectionResponse:
type: object
properties:
Expand Down
2 changes: 1 addition & 1 deletion modules/core/02-client/client/cli/cli.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ func GetQueryCmd() *cobra.Command {
GetCmdQueryConsensusState(),
GetCmdQueryHeader(),
GetCmdSelfConsensusState(),
GetCmdParams(),
GetCmdClientParams(),
)

return queryCmd
Expand Down
Loading

0 comments on commit a05247c

Please sign in to comment.