Skip to content

Commit

Permalink
feat: add grpc/CLI for channel params query
Browse files Browse the repository at this point in the history
  • Loading branch information
@crodriguezvega
crodriguezvega committed Dec 17, 2023
1 parent 1ccb724 commit af86874
Show file tree
Hide file tree
Showing 9 changed files with 947 additions and 107 deletions.
370 changes: 370 additions & 0 deletions docs/client/swagger-ui/swagger.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14295,6 +14295,268 @@ paths:
type: boolean
tags:
- Query
/ibc/core/channel/v1/params:
get:
summary: ChannelParams queries all parameters of the ibc channel submodule.
operationId: ChannelParams
responses:
'200':
description: A successful response.
schema:
type: object
properties:
params:
description: params defines the parameters of the module.
type: object
properties:
upgrade_timeout:
type: object
properties:
height:
title: >-
block height after which the packet or upgrade times
out
type: object
properties:
revision_number:
type: string
format: uint64
title: the revision that the client is currently on
revision_height:
type: string
format: uint64
title: the height within the given revision
description: >-
Normally the RevisionHeight is incremented at each
height while keeping

RevisionNumber the same. However some consensus
algorithms may choose to

reset the height in certain conditions e.g. hard
forks, state-machine

breaking changes In these cases, the RevisionNumber is
incremented so that

height continues to be monitonically increasing even
as the RevisionHeight

gets reset
timestamp:
type: string
format: uint64
title: >-
block timestamp (in nanoseconds) after which the
packet or upgrade times out
description: >-
Timeout defines an execution deadline structure for
04-channel handlers.

This includes packet lifecycle handlers as well as the
upgrade handshake handlers.

A valid Timeout contains either one or both of a timestamp
and block height (sequence).
description: >-
QueryChannelParamsResponse is the response type for the
Query/ChannelParams 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);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
foo = any.unpack(Foo.getDefaultInstance());
}

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/lightclients/wasm/v1/checksums:
get:
summary: Get all Wasm checksums
Expand Down Expand Up @@ -18864,6 +19126,57 @@ definitions:
packet commitments, acknowledgements, and receipts.
Caller is responsible for knowing the context necessary to interpret this
state as a commitment, acknowledgement, or a receipt.
ibc.core.channel.v1.Params:
type: object
properties:
upgrade_timeout:
type: object
properties:
height:
title: block height after which the packet or upgrade times out
type: object
properties:
revision_number:
type: string
format: uint64
title: the revision that the client is currently on
revision_height:
type: string
format: uint64
title: the height within the given revision
description: >-
Normally the RevisionHeight is incremented at each height while
keeping

RevisionNumber the same. However some consensus algorithms may
choose to

reset the height in certain conditions e.g. hard forks,
state-machine

breaking changes In these cases, the RevisionNumber is incremented
so that

height continues to be monitonically increasing even as the
RevisionHeight

gets reset
timestamp:
type: string
format: uint64
title: >-
block timestamp (in nanoseconds) after which the packet or upgrade
times out
description: >-
Timeout defines an execution deadline structure for 04-channel
handlers.

This includes packet lifecycle handlers as well as the upgrade
handshake handlers.

A valid Timeout contains either one or both of a timestamp and block
height (sequence).
description: Params defines the set of IBC channel parameters.
ibc.core.channel.v1.QueryChannelClientStateResponse:
type: object
properties:
Expand Down Expand Up @@ -19289,6 +19602,63 @@ definitions:
title: |-
QueryChannelClientStateResponse is the Response type for the
Query/QueryChannelClientState RPC method
ibc.core.channel.v1.QueryChannelParamsResponse:
type: object
properties:
params:
description: params defines the parameters of the module.
type: object
properties:
upgrade_timeout:
type: object
properties:
height:
title: block height after which the packet or upgrade times out
type: object
properties:
revision_number:
type: string
format: uint64
title: the revision that the client is currently on
revision_height:
type: string
format: uint64
title: the height within the given revision
description: >-
Normally the RevisionHeight is incremented at each height
while keeping

RevisionNumber the same. However some consensus algorithms may
choose to

reset the height in certain conditions e.g. hard forks,
state-machine

breaking changes In these cases, the RevisionNumber is
incremented so that

height continues to be monitonically increasing even as the
RevisionHeight

gets reset
timestamp:
type: string
format: uint64
title: >-
block timestamp (in nanoseconds) after which the packet or
upgrade times out
description: >-
Timeout defines an execution deadline structure for 04-channel
handlers.

This includes packet lifecycle handlers as well as the upgrade
handshake handlers.

A valid Timeout contains either one or both of a timestamp and
block height (sequence).
description: >-
QueryChannelParamsResponse is the response type for the
Query/ChannelParams RPC method.
ibc.core.channel.v1.QueryChannelResponse:
type: object
properties:
Expand Down
1 change: 1 addition & 0 deletions modules/core/04-channel/client/cli/cli.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ func GetQueryCmd() *cobra.Command {
GetCmdQueryNextSequenceSend(),
GetCmdQueryUpgradeError(),
GetCmdQueryUpgrade(),
GetCmdChannelParams(),
)

return queryCmd
Expand Down
Loading

0 comments on commit af86874

Please sign in to comment.