mirror of
https://github.com/0glabs/0g-chain.git
synced 2024-12-26 16:25:21 +00:00
988836dee0
* add deposits to genesis state * import/export genesis with deposits * add helper keeper method + update tests * invariants + tests * register invariants on module * fix genesis test invariant init * clean up invariants test * remove comment from test file * fix invariants test * run 'make proto-all'
77057 lines
2.5 MiB
77057 lines
2.5 MiB
swagger: '2.0'
|
|
info:
|
|
title: Kava - Legacy REST and gRPC Gateway docs
|
|
description: A REST interface for state queries
|
|
version: 1.0.0
|
|
externalDocs:
|
|
description: GitHub
|
|
url: https://github.com/Kava-Labs/kava
|
|
host: api.data.kava.io
|
|
schemes:
|
|
- https
|
|
paths:
|
|
/kava/auction/v1beta1/auctions:
|
|
get:
|
|
summary: >-
|
|
Auctions queries auctions filtered by asset denom, owner address, phase,
|
|
and auction type
|
|
operationId: AuctionAuctions
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
auctions:
|
|
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"
|
|
}
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryAuctionsResponse is the response type for the Query/Auctions
|
|
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"
|
|
}
|
|
parameters:
|
|
- name: type
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: owner
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: denom
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: phase
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
|
|
|
|
Since: cosmos-sdk 0.43
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Auction
|
|
/kava/auction/v1beta1/auctions/{auction_id}:
|
|
get:
|
|
summary: Auction queries an individual Auction by auction ID
|
|
operationId: AuctionAuction
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
auction:
|
|
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"
|
|
}
|
|
description: >-
|
|
QueryAuctionResponse is the response type for the Query/Auction
|
|
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"
|
|
}
|
|
parameters:
|
|
- name: auction_id
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
tags:
|
|
- Auction
|
|
/kava/auction/v1beta1/next-auction-id:
|
|
get:
|
|
summary: NextAuctionID queries the next auction ID
|
|
operationId: AuctionNextAuctionID
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
QueryNextAuctionIDResponse defines the response type for querying
|
|
x/auction next auction ID.
|
|
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:
|
|
- Auction
|
|
/kava/auction/v1beta1/params:
|
|
get:
|
|
summary: Params queries all parameters of the auction module.
|
|
operationId: AuctionParams
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
params:
|
|
type: object
|
|
properties:
|
|
max_auction_duration:
|
|
type: string
|
|
forward_bid_duration:
|
|
type: string
|
|
reverse_bid_duration:
|
|
type: string
|
|
increment_surplus:
|
|
type: string
|
|
format: byte
|
|
increment_debt:
|
|
type: string
|
|
format: byte
|
|
increment_collateral:
|
|
type: string
|
|
format: byte
|
|
description: Params defines the parameters for the issuance module.
|
|
description: >-
|
|
QueryParamsResponse defines the response type for querying
|
|
x/auction parameters.
|
|
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:
|
|
- Auction
|
|
/kava/bep3/v1beta1/assetsupplies:
|
|
get:
|
|
summary: AssetSupplies queries a list of asset supplies
|
|
operationId: BEP3AssetSupplies
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
asset_supplies:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
incoming_supply:
|
|
title: >-
|
|
incoming_supply represents the incoming supply of an
|
|
asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
outgoing_supply:
|
|
title: >-
|
|
outgoing_supply represents the outgoing supply of an
|
|
asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
current_supply:
|
|
title: >-
|
|
current_supply represents the current on-chain supply of
|
|
an asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
time_limited_current_supply:
|
|
title: >-
|
|
time_limited_current_supply represents the time limited
|
|
current supply of an asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
time_elapsed:
|
|
type: string
|
|
title: time_elapsed represents the time elapsed
|
|
description: >-
|
|
AssetSupplyResponse defines information about an asset's
|
|
supply.
|
|
title: asset_supplies represents the supplies of returned assets
|
|
description: >-
|
|
QueryAssetSuppliesResponse is the response type for the
|
|
Query/AssetSupplies 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
tags:
|
|
- BEP3
|
|
/kava/bep3/v1beta1/assetsupply/{denom}:
|
|
get:
|
|
summary: AssetSupply queries info about an asset's supply
|
|
operationId: BEP3AssetSupply
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
asset_supply:
|
|
type: object
|
|
properties:
|
|
incoming_supply:
|
|
title: incoming_supply represents the incoming supply of an asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
outgoing_supply:
|
|
title: outgoing_supply represents the outgoing supply of an asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
current_supply:
|
|
title: >-
|
|
current_supply represents the current on-chain supply of
|
|
an asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
time_limited_current_supply:
|
|
title: >-
|
|
time_limited_current_supply represents the time limited
|
|
current supply of an asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
time_elapsed:
|
|
type: string
|
|
title: time_elapsed represents the time elapsed
|
|
description: >-
|
|
AssetSupplyResponse defines information about an asset's
|
|
supply.
|
|
title: asset_supply represents the supply of the asset
|
|
description: >-
|
|
QueryAssetSupplyResponse is the response type for the
|
|
Query/AssetSupply 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: denom
|
|
description: denom filters the asset response for the specified denom
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- BEP3
|
|
/kava/bep3/v1beta1/atomicswap/{swap_id}:
|
|
get:
|
|
summary: AtomicSwap queries info about an atomic swap
|
|
operationId: BEP3AtomicSwap
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
atomic_swap:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: id represents the id of the atomic swap
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
title: amount represents the amount being swapped
|
|
random_number_hash:
|
|
type: string
|
|
title: >-
|
|
random_number_hash represents the hash of the random
|
|
number
|
|
expire_height:
|
|
type: string
|
|
format: uint64
|
|
title: expire_height represents the height when the swap expires
|
|
timestamp:
|
|
type: string
|
|
format: int64
|
|
title: timestamp represents the timestamp of the swap
|
|
sender:
|
|
type: string
|
|
title: sender is the kava chain sender of the swap
|
|
recipient:
|
|
type: string
|
|
title: recipient is the kava chain recipient of the swap
|
|
sender_other_chain:
|
|
type: string
|
|
title: sender_other_chain is the sender on the other chain
|
|
recipient_other_chain:
|
|
type: string
|
|
title: recipient_other_chain is the recipient on the other chain
|
|
closed_block:
|
|
type: string
|
|
format: int64
|
|
title: closed_block is the block when the swap is closed
|
|
status:
|
|
title: status represents the current status of the swap
|
|
type: string
|
|
enum:
|
|
- SWAP_STATUS_UNSPECIFIED
|
|
- SWAP_STATUS_OPEN
|
|
- SWAP_STATUS_COMPLETED
|
|
- SWAP_STATUS_EXPIRED
|
|
default: SWAP_STATUS_UNSPECIFIED
|
|
description: >-
|
|
- SWAP_STATUS_UNSPECIFIED: SWAP_STATUS_UNSPECIFIED
|
|
represents an unspecified status
|
|
- SWAP_STATUS_OPEN: SWAP_STATUS_OPEN represents an open swap
|
|
- SWAP_STATUS_COMPLETED: SWAP_STATUS_COMPLETED represents a completed swap
|
|
- SWAP_STATUS_EXPIRED: SWAP_STATUS_EXPIRED represents an expired swap
|
|
cross_chain:
|
|
type: boolean
|
|
format: boolean
|
|
title: >-
|
|
cross_chain identifies whether the atomic swap is cross
|
|
chain
|
|
direction:
|
|
title: direction identifies if the swap is incoming or outgoing
|
|
type: string
|
|
enum:
|
|
- SWAP_DIRECTION_UNSPECIFIED
|
|
- SWAP_DIRECTION_INCOMING
|
|
- SWAP_DIRECTION_OUTGOING
|
|
default: SWAP_DIRECTION_UNSPECIFIED
|
|
description: >-
|
|
- SWAP_DIRECTION_UNSPECIFIED: SWAP_DIRECTION_UNSPECIFIED
|
|
represents unspecified or invalid swap direcation
|
|
- SWAP_DIRECTION_INCOMING: SWAP_DIRECTION_INCOMING represents is incoming swap (to the kava chain)
|
|
- SWAP_DIRECTION_OUTGOING: SWAP_DIRECTION_OUTGOING represents an outgoing swap (from the kava chain)
|
|
title: >-
|
|
AtomicSwapResponse represents the returned atomic swap
|
|
properties
|
|
description: >-
|
|
QueryAtomicSwapResponse is the response type for the
|
|
Query/AtomicSwap 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: swap_id
|
|
description: swap_id represents the id of the swap to query
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- BEP3
|
|
/kava/bep3/v1beta1/atomicswaps:
|
|
get:
|
|
summary: AtomicSwaps queries a list of atomic swaps
|
|
operationId: BEP3AtomicSwaps
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
atomic_swaps:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: id represents the id of the atomic swap
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an
|
|
amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
title: amount represents the amount being swapped
|
|
random_number_hash:
|
|
type: string
|
|
title: >-
|
|
random_number_hash represents the hash of the random
|
|
number
|
|
expire_height:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
expire_height represents the height when the swap
|
|
expires
|
|
timestamp:
|
|
type: string
|
|
format: int64
|
|
title: timestamp represents the timestamp of the swap
|
|
sender:
|
|
type: string
|
|
title: sender is the kava chain sender of the swap
|
|
recipient:
|
|
type: string
|
|
title: recipient is the kava chain recipient of the swap
|
|
sender_other_chain:
|
|
type: string
|
|
title: sender_other_chain is the sender on the other chain
|
|
recipient_other_chain:
|
|
type: string
|
|
title: >-
|
|
recipient_other_chain is the recipient on the other
|
|
chain
|
|
closed_block:
|
|
type: string
|
|
format: int64
|
|
title: closed_block is the block when the swap is closed
|
|
status:
|
|
title: status represents the current status of the swap
|
|
type: string
|
|
enum:
|
|
- SWAP_STATUS_UNSPECIFIED
|
|
- SWAP_STATUS_OPEN
|
|
- SWAP_STATUS_COMPLETED
|
|
- SWAP_STATUS_EXPIRED
|
|
default: SWAP_STATUS_UNSPECIFIED
|
|
description: >-
|
|
- SWAP_STATUS_UNSPECIFIED: SWAP_STATUS_UNSPECIFIED
|
|
represents an unspecified status
|
|
- SWAP_STATUS_OPEN: SWAP_STATUS_OPEN represents an open swap
|
|
- SWAP_STATUS_COMPLETED: SWAP_STATUS_COMPLETED represents a completed swap
|
|
- SWAP_STATUS_EXPIRED: SWAP_STATUS_EXPIRED represents an expired swap
|
|
cross_chain:
|
|
type: boolean
|
|
format: boolean
|
|
title: >-
|
|
cross_chain identifies whether the atomic swap is cross
|
|
chain
|
|
direction:
|
|
title: direction identifies if the swap is incoming or outgoing
|
|
type: string
|
|
enum:
|
|
- SWAP_DIRECTION_UNSPECIFIED
|
|
- SWAP_DIRECTION_INCOMING
|
|
- SWAP_DIRECTION_OUTGOING
|
|
default: SWAP_DIRECTION_UNSPECIFIED
|
|
description: >-
|
|
- SWAP_DIRECTION_UNSPECIFIED: SWAP_DIRECTION_UNSPECIFIED
|
|
represents unspecified or invalid swap direcation
|
|
- SWAP_DIRECTION_INCOMING: SWAP_DIRECTION_INCOMING represents is incoming swap (to the kava chain)
|
|
- SWAP_DIRECTION_OUTGOING: SWAP_DIRECTION_OUTGOING represents an outgoing swap (from the kava chain)
|
|
title: >-
|
|
AtomicSwapResponse represents the returned atomic swap
|
|
properties
|
|
title: >-
|
|
atomic_swap represents the returned atomic swaps for the
|
|
request
|
|
pagination:
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
PageResponse is to be embedded in gRPC response messages where
|
|
the
|
|
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
description: >-
|
|
QueryAtomicSwapsResponse is the response type for the
|
|
Query/AtomicSwaps 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: involve
|
|
description: involve filters by address.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: expiration
|
|
description: expiration filters by expiration block height.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: status
|
|
description: |-
|
|
status filters by swap status.
|
|
|
|
- SWAP_STATUS_UNSPECIFIED: SWAP_STATUS_UNSPECIFIED represents an unspecified status
|
|
- SWAP_STATUS_OPEN: SWAP_STATUS_OPEN represents an open swap
|
|
- SWAP_STATUS_COMPLETED: SWAP_STATUS_COMPLETED represents a completed swap
|
|
- SWAP_STATUS_EXPIRED: SWAP_STATUS_EXPIRED represents an expired swap
|
|
in: query
|
|
required: false
|
|
type: string
|
|
enum:
|
|
- SWAP_STATUS_UNSPECIFIED
|
|
- SWAP_STATUS_OPEN
|
|
- SWAP_STATUS_COMPLETED
|
|
- SWAP_STATUS_EXPIRED
|
|
default: SWAP_STATUS_UNSPECIFIED
|
|
- name: direction
|
|
description: |-
|
|
direction fitlers by swap direction.
|
|
|
|
- SWAP_DIRECTION_UNSPECIFIED: SWAP_DIRECTION_UNSPECIFIED represents unspecified or invalid swap direcation
|
|
- SWAP_DIRECTION_INCOMING: SWAP_DIRECTION_INCOMING represents is incoming swap (to the kava chain)
|
|
- SWAP_DIRECTION_OUTGOING: SWAP_DIRECTION_OUTGOING represents an outgoing swap (from the kava chain)
|
|
in: query
|
|
required: false
|
|
type: string
|
|
enum:
|
|
- SWAP_DIRECTION_UNSPECIFIED
|
|
- SWAP_DIRECTION_INCOMING
|
|
- SWAP_DIRECTION_OUTGOING
|
|
default: SWAP_DIRECTION_UNSPECIFIED
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
|
|
|
|
Since: cosmos-sdk 0.43
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- BEP3
|
|
/kava/bep3/v1beta1/params:
|
|
get:
|
|
summary: Params queries module params
|
|
operationId: BEP3Params
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
params:
|
|
title: params represents the parameters of the module
|
|
type: object
|
|
properties:
|
|
asset_params:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
title: denom represents the denominatin for this asset
|
|
coin_id:
|
|
type: string
|
|
format: int64
|
|
title: >-
|
|
coin_id represents the registered coin type to use
|
|
(https://github.com/satoshilabs/slips/blob/master/slip-0044.md)
|
|
supply_limit:
|
|
title: >-
|
|
supply_limit defines the maximum supply allowed for
|
|
the asset - a total or time based rate limit
|
|
type: object
|
|
properties:
|
|
limit:
|
|
type: string
|
|
title: limit defines the total supply allowed
|
|
time_limited:
|
|
type: boolean
|
|
format: boolean
|
|
title: >-
|
|
time_limited enables or disables time based
|
|
supply limiting
|
|
time_period:
|
|
type: string
|
|
title: >-
|
|
time_period specifies the duration that
|
|
time_based_limit is evalulated
|
|
time_based_limit:
|
|
type: string
|
|
title: >-
|
|
time_based_limit defines the maximum supply that
|
|
can be swapped within time_period
|
|
description: >-
|
|
SupplyLimit define the absolute and time-based
|
|
limits for an assets's supply.
|
|
active:
|
|
type: boolean
|
|
format: boolean
|
|
title: active specifies if the asset is live or paused
|
|
deputy_address:
|
|
type: string
|
|
format: byte
|
|
title: deputy_address the kava address of the deputy
|
|
fixed_fee:
|
|
type: string
|
|
title: fixed_fee defines the fee for incoming swaps
|
|
min_swap_amount:
|
|
type: string
|
|
title: >-
|
|
min_swap_amount defines the minimum amount able to
|
|
be swapped in a single message
|
|
max_swap_amount:
|
|
type: string
|
|
title: >-
|
|
max_swap_amount defines the maximum amount able to
|
|
be swapped in a single message
|
|
min_block_lock:
|
|
type: string
|
|
format: uint64
|
|
title: min_block_lock defined the minimum blocks to lock
|
|
max_block_lock:
|
|
type: string
|
|
format: uint64
|
|
title: min_block_lock defined the maximum blocks to lock
|
|
description: AssetParam defines parameters for each bep3 asset.
|
|
title: asset_params define the parameters for each bep3 asset
|
|
description: Params defines the parameters for the bep3 module.
|
|
description: >-
|
|
QueryParamsResponse defines the response type for querying x/bep3
|
|
parameters.
|
|
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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
tags:
|
|
- BEP3
|
|
/kava/cdp/v1beta1/accounts:
|
|
get:
|
|
summary: Accounts queries the CDP module accounts.
|
|
operationId: CDPAccounts
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
accounts:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
base_account:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
pub_key:
|
|
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"
|
|
}
|
|
account_number:
|
|
type: string
|
|
format: uint64
|
|
sequence:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
BaseAccount defines a base account type. It contains all
|
|
the necessary fields
|
|
|
|
for basic account functionality. Any custom account type
|
|
should extend this
|
|
|
|
type for additional functionality (e.g. vesting).
|
|
name:
|
|
type: string
|
|
permissions:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: >-
|
|
ModuleAccount defines an account for modules that holds
|
|
coins on a pool.
|
|
description: >-
|
|
QueryAccountsResponse defines the response type for the
|
|
Query/Accounts 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:
|
|
- CDP
|
|
/kava/cdp/v1beta1/cdps:
|
|
get:
|
|
summary: Cdps queries all active CDPs.
|
|
operationId: CDPCdps
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
cdps:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uint64
|
|
owner:
|
|
type: string
|
|
type:
|
|
type: string
|
|
collateral:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
principal:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
accumulated_fees:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
fees_updated:
|
|
type: string
|
|
format: date-time
|
|
interest_factor:
|
|
type: string
|
|
collateral_value:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
collateralization_ratio:
|
|
type: string
|
|
description: >-
|
|
CDPResponse defines the state of a single collateralized
|
|
debt position.
|
|
pagination:
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
PageResponse is to be embedded in gRPC response messages where
|
|
the
|
|
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
description: >-
|
|
QueryCdpsResponse defines the response type for the Query/Cdps 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"
|
|
}
|
|
parameters:
|
|
- name: collateral_type
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: owner
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: id
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: ratio
|
|
description: sdk.Dec as a string.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
|
|
|
|
Since: cosmos-sdk 0.43
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- CDP
|
|
/kava/cdp/v1beta1/cdps/deposits/{owner}/{collateral_type}:
|
|
get:
|
|
summary: >-
|
|
Deposits queries deposits associated with the CDP owned by an address
|
|
for a collateral type.
|
|
operationId: CDPDeposits
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
deposits:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
cdp_id:
|
|
type: string
|
|
format: uint64
|
|
depositor:
|
|
type: string
|
|
amount:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
title: >-
|
|
Deposit defines an amount of coins deposited by an account
|
|
to a cdp
|
|
description: >-
|
|
QueryDepositsResponse defines the response type for the
|
|
Query/Deposits 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"
|
|
}
|
|
parameters:
|
|
- name: owner
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: collateral_type
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- CDP
|
|
/kava/cdp/v1beta1/cdps/{owner}/{collateral_type}:
|
|
get:
|
|
summary: Cdp queries a CDP with the input owner address and collateral type.
|
|
operationId: CDPCdp
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
cdp:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uint64
|
|
owner:
|
|
type: string
|
|
type:
|
|
type: string
|
|
collateral:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
principal:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
accumulated_fees:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
fees_updated:
|
|
type: string
|
|
format: date-time
|
|
interest_factor:
|
|
type: string
|
|
collateral_value:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
collateralization_ratio:
|
|
type: string
|
|
description: >-
|
|
CDPResponse defines the state of a single collateralized debt
|
|
position.
|
|
description: >-
|
|
QueryCdpResponse defines the response type for the Query/Cdp 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"
|
|
}
|
|
parameters:
|
|
- name: owner
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: collateral_type
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- CDP
|
|
/kava/cdp/v1beta1/params:
|
|
get:
|
|
summary: Params queries all parameters of the cdp module.
|
|
operationId: CDPParams
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
params:
|
|
type: object
|
|
properties:
|
|
collateral_params:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
type:
|
|
type: string
|
|
liquidation_ratio:
|
|
type: string
|
|
debt_limit:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an
|
|
amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements
|
|
the custom method
|
|
|
|
signatures required by gogoproto.
|
|
stability_fee:
|
|
type: string
|
|
auction_size:
|
|
type: string
|
|
liquidation_penalty:
|
|
type: string
|
|
spot_market_id:
|
|
type: string
|
|
liquidation_market_id:
|
|
type: string
|
|
keeper_reward_percentage:
|
|
type: string
|
|
check_collateralization_index_count:
|
|
type: string
|
|
conversion_factor:
|
|
type: string
|
|
title: >-
|
|
CollateralParam defines governance parameters for each
|
|
collateral type within the cdp module
|
|
debt_param:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
reference_asset:
|
|
type: string
|
|
conversion_factor:
|
|
type: string
|
|
debt_floor:
|
|
type: string
|
|
title: DebtParam defines governance params for debt assets
|
|
global_debt_limit:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
surplus_auction_threshold:
|
|
type: string
|
|
surplus_auction_lot:
|
|
type: string
|
|
debt_auction_threshold:
|
|
type: string
|
|
debt_auction_lot:
|
|
type: string
|
|
circuit_breaker:
|
|
type: boolean
|
|
format: boolean
|
|
description: Params defines the parameters for the cdp module.
|
|
description: >-
|
|
QueryParamsResponse defines the response type for the Query/Params
|
|
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:
|
|
- CDP
|
|
/kava/cdp/v1beta1/totalCollateral:
|
|
get:
|
|
summary: TotalCollateral queries the total collateral of a given collateral type.
|
|
operationId: CDPTotalCollateral
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
total_collateral:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
amount:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
title: >-
|
|
TotalCollateral defines the total collateral of a given
|
|
collateral type
|
|
description: >-
|
|
QueryTotalCollateralResponse defines the response type for the
|
|
Query/TotalCollateral 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"
|
|
}
|
|
parameters:
|
|
- name: collateral_type
|
|
in: query
|
|
required: false
|
|
type: string
|
|
tags:
|
|
- CDP
|
|
/kava/cdp/v1beta1/totalPrincipal:
|
|
get:
|
|
summary: TotalPrincipal queries the total principal of a given collateral type.
|
|
operationId: CDPTotalPrincipal
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
total_principal:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
amount:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
title: >-
|
|
TotalPrincipal defines the total principal of a given
|
|
collateral type
|
|
description: >-
|
|
QueryTotalPrincipalResponse defines the response type for the
|
|
Query/TotalPrincipal 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"
|
|
}
|
|
parameters:
|
|
- name: collateral_type
|
|
in: query
|
|
required: false
|
|
type: string
|
|
tags:
|
|
- CDP
|
|
/kava/committee/v1beta1/committees:
|
|
get:
|
|
summary: Committees queries all committess of the committee module.
|
|
operationId: CommitteeCommittees
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
committees:
|
|
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"
|
|
}
|
|
description: >-
|
|
QueryCommitteesResponse defines the response type for querying
|
|
x/committee committees.
|
|
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:
|
|
- Committee
|
|
/kava/committee/v1beta1/committees/{committee_id}:
|
|
get:
|
|
summary: Committee queries a committee based on committee ID.
|
|
operationId: CommitteeCommittee
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
committee:
|
|
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"
|
|
}
|
|
description: >-
|
|
QueryCommitteeResponse defines the response type for querying
|
|
x/committee committee.
|
|
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"
|
|
}
|
|
parameters:
|
|
- name: committee_id
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
tags:
|
|
- Committee
|
|
/kava/committee/v1beta1/next-proposal-id:
|
|
get:
|
|
summary: NextProposalID queries the next proposal ID of the committee module.
|
|
operationId: CommitteeNextProposalID
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
next_proposal_id:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
QueryNextProposalIDRequest defines the response type for querying
|
|
x/committee NextProposalID.
|
|
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:
|
|
- Committee
|
|
/kava/committee/v1beta1/proposals:
|
|
get:
|
|
summary: Proposals queries proposals based on committee ID.
|
|
operationId: CommitteeProposals
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
proposals:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
pub_proposal:
|
|
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"
|
|
}
|
|
id:
|
|
type: string
|
|
format: uint64
|
|
committee_id:
|
|
type: string
|
|
format: uint64
|
|
deadline:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
QueryProposalResponse defines the response type for querying
|
|
x/committee proposal.
|
|
description: >-
|
|
QueryProposalsResponse defines the response type for querying
|
|
x/committee proposals.
|
|
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"
|
|
}
|
|
parameters:
|
|
- name: committee_id
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
tags:
|
|
- Committee
|
|
/kava/committee/v1beta1/proposals/{proposal_id}:
|
|
get:
|
|
summary: Deposits queries a proposal based on proposal ID.
|
|
operationId: CommitteeProposal
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
pub_proposal:
|
|
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"
|
|
}
|
|
id:
|
|
type: string
|
|
format: uint64
|
|
committee_id:
|
|
type: string
|
|
format: uint64
|
|
deadline:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
QueryProposalResponse defines the response type for querying
|
|
x/committee proposal.
|
|
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"
|
|
}
|
|
parameters:
|
|
- name: proposal_id
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
tags:
|
|
- Committee
|
|
/kava/committee/v1beta1/proposals/{proposal_id}/tally:
|
|
get:
|
|
summary: Tally queries the tally of a single proposal ID.
|
|
operationId: CommitteeTally
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
yes_votes:
|
|
type: string
|
|
no_votes:
|
|
type: string
|
|
current_votes:
|
|
type: string
|
|
possible_votes:
|
|
type: string
|
|
vote_threshold:
|
|
type: string
|
|
quorum:
|
|
type: string
|
|
description: >-
|
|
QueryTallyResponse defines the response type for querying
|
|
x/committee tally.
|
|
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"
|
|
}
|
|
parameters:
|
|
- name: proposal_id
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
tags:
|
|
- Committee
|
|
/kava/committee/v1beta1/proposals/{proposal_id}/votes:
|
|
get:
|
|
summary: Votes queries all votes for a single proposal ID.
|
|
operationId: CommitteeVotes
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
votes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
voter:
|
|
type: string
|
|
vote_type:
|
|
type: string
|
|
enum:
|
|
- VOTE_TYPE_UNSPECIFIED
|
|
- VOTE_TYPE_YES
|
|
- VOTE_TYPE_NO
|
|
- VOTE_TYPE_ABSTAIN
|
|
default: VOTE_TYPE_UNSPECIFIED
|
|
description: |-
|
|
VoteType enumerates the valid types of a vote.
|
|
|
|
- VOTE_TYPE_UNSPECIFIED: VOTE_TYPE_UNSPECIFIED defines a no-op vote option.
|
|
- VOTE_TYPE_YES: VOTE_TYPE_YES defines a yes vote option.
|
|
- VOTE_TYPE_NO: VOTE_TYPE_NO defines a no vote option.
|
|
- VOTE_TYPE_ABSTAIN: VOTE_TYPE_ABSTAIN defines an abstain vote option.
|
|
description: >-
|
|
QueryVoteResponse defines the response type for querying
|
|
x/committee vote.
|
|
description: votes defined the queried votes.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryVotesResponse defines the response type for querying
|
|
x/committee votes.
|
|
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"
|
|
}
|
|
parameters:
|
|
- name: proposal_id
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
|
|
|
|
Since: cosmos-sdk 0.43
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Committee
|
|
/kava/committee/v1beta1/proposals/{proposal_id}/votes/{voter}:
|
|
get:
|
|
summary: Vote queries the vote of a single voter for a single proposal ID.
|
|
operationId: CommitteeVote
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
voter:
|
|
type: string
|
|
vote_type:
|
|
type: string
|
|
enum:
|
|
- VOTE_TYPE_UNSPECIFIED
|
|
- VOTE_TYPE_YES
|
|
- VOTE_TYPE_NO
|
|
- VOTE_TYPE_ABSTAIN
|
|
default: VOTE_TYPE_UNSPECIFIED
|
|
description: |-
|
|
VoteType enumerates the valid types of a vote.
|
|
|
|
- VOTE_TYPE_UNSPECIFIED: VOTE_TYPE_UNSPECIFIED defines a no-op vote option.
|
|
- VOTE_TYPE_YES: VOTE_TYPE_YES defines a yes vote option.
|
|
- VOTE_TYPE_NO: VOTE_TYPE_NO defines a no vote option.
|
|
- VOTE_TYPE_ABSTAIN: VOTE_TYPE_ABSTAIN defines an abstain vote option.
|
|
description: >-
|
|
QueryVoteResponse defines the response type for querying
|
|
x/committee vote.
|
|
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"
|
|
}
|
|
parameters:
|
|
- name: proposal_id
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
- name: voter
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Committee
|
|
/kava/committee/v1beta1/raw-params:
|
|
get:
|
|
summary: RawParams queries the raw params data of any subspace and key.
|
|
operationId: CommitteeRawParams
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
raw_data:
|
|
type: string
|
|
description: >-
|
|
QueryRawParamsResponse defines the response type for querying
|
|
x/committee raw params.
|
|
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"
|
|
}
|
|
parameters:
|
|
- name: subspace
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: key
|
|
in: query
|
|
required: false
|
|
type: string
|
|
tags:
|
|
- Committee
|
|
/kava/hard/v1beta1/accounts:
|
|
get:
|
|
summary: Accounts queries module accounts.
|
|
operationId: HardAccounts
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
accounts:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
base_account:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
pub_key:
|
|
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"
|
|
}
|
|
account_number:
|
|
type: string
|
|
format: uint64
|
|
sequence:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
BaseAccount defines a base account type. It contains all
|
|
the necessary fields
|
|
|
|
for basic account functionality. Any custom account type
|
|
should extend this
|
|
|
|
type for additional functionality (e.g. vesting).
|
|
name:
|
|
type: string
|
|
permissions:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: >-
|
|
ModuleAccount defines an account for modules that holds
|
|
coins on a pool.
|
|
description: >-
|
|
QueryAccountsResponse is the response type for the Query/Accounts
|
|
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:
|
|
- Hard
|
|
/kava/hard/v1beta1/borrows:
|
|
get:
|
|
summary: Borrows queries hard borrows.
|
|
operationId: HardBorrows
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
borrows:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
borrower:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an
|
|
amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
index:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
value:
|
|
type: string
|
|
title: sdk.Dec as string
|
|
description: >-
|
|
BorrowInterestFactorResponse defines an individual
|
|
borrow interest factor.
|
|
description: >-
|
|
BorrowResponse defines an amount of coins borrowed from a
|
|
hard module account.
|
|
pagination:
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
PageResponse is to be embedded in gRPC response messages where
|
|
the
|
|
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
description: >-
|
|
QueryBorrowsResponse is the response type for the Query/Borrows
|
|
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"
|
|
}
|
|
parameters:
|
|
- name: denom
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: owner
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
|
|
|
|
Since: cosmos-sdk 0.43
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Hard
|
|
/kava/hard/v1beta1/deposits:
|
|
get:
|
|
summary: Deposits queries hard deposits.
|
|
operationId: HardDeposits
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
deposits:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
depositor:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an
|
|
amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
index:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
value:
|
|
type: string
|
|
title: sdk.Dec as string
|
|
description: >-
|
|
SupplyInterestFactorResponse defines an individual
|
|
borrow interest factor.
|
|
description: >-
|
|
DepositResponse defines an amount of coins deposited into a
|
|
hard module account.
|
|
pagination:
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
PageResponse is to be embedded in gRPC response messages where
|
|
the
|
|
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
description: >-
|
|
QueryDepositsResponse is the response type for the Query/Deposits
|
|
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"
|
|
}
|
|
parameters:
|
|
- name: denom
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: owner
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
|
|
|
|
Since: cosmos-sdk 0.43
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Hard
|
|
/kava/hard/v1beta1/interest-factors/{denom}:
|
|
get:
|
|
summary: InterestFactors queries hard module interest factors.
|
|
operationId: HardInterestFactors
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
interest_factors:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
borrow_interest_factor:
|
|
type: string
|
|
title: sdk.Dec as String
|
|
supply_interest_factor:
|
|
type: string
|
|
title: sdk.Dec as String
|
|
title: >-
|
|
InterestFactor is a unique type returned by interest factor
|
|
queries
|
|
description: >-
|
|
QueryInterestFactorsResponse is the response type for the
|
|
Query/InterestFactors 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"
|
|
}
|
|
parameters:
|
|
- name: denom
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Hard
|
|
/kava/hard/v1beta1/interest-rate/{denom}:
|
|
get:
|
|
summary: InterestRate queries the hard module interest rates.
|
|
operationId: HardInterestRate
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
interest_rates:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
supply_interest_rate:
|
|
type: string
|
|
title: sdk.Dec as String
|
|
borrow_interest_rate:
|
|
type: string
|
|
title: sdk.Dec as String
|
|
title: >-
|
|
MoneyMarketInterestRate is a unique type returned by
|
|
interest rate queries
|
|
description: >-
|
|
QueryInterestRateResponse is the response type for the
|
|
Query/InterestRate 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"
|
|
}
|
|
parameters:
|
|
- name: denom
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Hard
|
|
/kava/hard/v1beta1/params:
|
|
get:
|
|
summary: Params queries module params.
|
|
operationId: HardParams
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
params:
|
|
type: object
|
|
properties:
|
|
money_markets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
borrow_limit:
|
|
type: object
|
|
properties:
|
|
has_max_limit:
|
|
type: boolean
|
|
format: boolean
|
|
maximum_limit:
|
|
type: string
|
|
loan_to_value:
|
|
type: string
|
|
description: BorrowLimit enforces restrictions on a money market.
|
|
spot_market_id:
|
|
type: string
|
|
conversion_factor:
|
|
type: string
|
|
interest_rate_model:
|
|
type: object
|
|
properties:
|
|
base_rate_apy:
|
|
type: string
|
|
base_multiplier:
|
|
type: string
|
|
kink:
|
|
type: string
|
|
jump_multiplier:
|
|
type: string
|
|
description: >-
|
|
InterestRateModel contains information about an
|
|
asset's interest rate.
|
|
reserve_factor:
|
|
type: string
|
|
keeper_reward_percentage:
|
|
type: string
|
|
description: MoneyMarket is a money market for an individual asset.
|
|
minimum_borrow_usd_value:
|
|
type: string
|
|
description: Params defines the parameters for the hard module.
|
|
description: >-
|
|
QueryParamsResponse is the response type for the Query/Params 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:
|
|
- Hard
|
|
/kava/hard/v1beta1/reserves/{denom}:
|
|
get:
|
|
summary: Reserves queries total hard reserve coins.
|
|
operationId: HardReserves
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
QueryReservesResponse is the response type for the Query/Reserves
|
|
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"
|
|
}
|
|
parameters:
|
|
- name: denom
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Hard
|
|
/kava/hard/v1beta1/total-borrowed/{denom}:
|
|
get:
|
|
summary: TotalBorrowed queries total coins borrowed from hard liquidity pools.
|
|
operationId: HardTotalBorrowed
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
borrowed_coins:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
QueryTotalBorrowedResponse is the response type for the
|
|
Query/TotalBorrowed 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"
|
|
}
|
|
parameters:
|
|
- name: denom
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Hard
|
|
/kava/hard/v1beta1/total-deposited/{denom}:
|
|
get:
|
|
summary: TotalDeposited queries total coins deposited to hard liquidity pools.
|
|
operationId: HardTotalDeposited
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
supplied_coins:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
QueryTotalDepositedResponse is the response type for the
|
|
Query/TotalDeposited 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"
|
|
}
|
|
parameters:
|
|
- name: denom
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Hard
|
|
/kava/hard/v1beta1/unsynced-borrows:
|
|
get:
|
|
summary: UnsyncedBorrows queries unsynced borrows.
|
|
operationId: HardUnsyncedBorrows
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
borrows:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
borrower:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an
|
|
amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
index:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
value:
|
|
type: string
|
|
title: sdk.Dec as string
|
|
description: >-
|
|
BorrowInterestFactorResponse defines an individual
|
|
borrow interest factor.
|
|
description: >-
|
|
BorrowResponse defines an amount of coins borrowed from a
|
|
hard module account.
|
|
pagination:
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
PageResponse is to be embedded in gRPC response messages where
|
|
the
|
|
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
description: >-
|
|
QueryUnsyncedBorrowsResponse is the response type for the
|
|
Query/UnsyncedBorrows 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"
|
|
}
|
|
parameters:
|
|
- name: denom
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: owner
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
|
|
|
|
Since: cosmos-sdk 0.43
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Hard
|
|
/kava/hard/v1beta1/unsynced-deposits:
|
|
get:
|
|
summary: UnsyncedDeposits queries unsynced deposits.
|
|
operationId: HardUnsyncedDeposits
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
deposits:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
depositor:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an
|
|
amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
index:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
value:
|
|
type: string
|
|
title: sdk.Dec as string
|
|
description: >-
|
|
SupplyInterestFactorResponse defines an individual
|
|
borrow interest factor.
|
|
description: >-
|
|
DepositResponse defines an amount of coins deposited into a
|
|
hard module account.
|
|
pagination:
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
PageResponse is to be embedded in gRPC response messages where
|
|
the
|
|
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
description: >-
|
|
QueryUnsyncedDepositsResponse is the response type for the
|
|
Query/UnsyncedDeposits 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"
|
|
}
|
|
parameters:
|
|
- name: denom
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: owner
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
|
|
|
|
Since: cosmos-sdk 0.43
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Hard
|
|
/kava/issuance/v1beta1/params:
|
|
get:
|
|
summary: Params queries all parameters of the issuance module.
|
|
operationId: IssuanceParams
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
params:
|
|
type: object
|
|
properties:
|
|
assets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
owner:
|
|
type: string
|
|
denom:
|
|
type: string
|
|
blocked_addresses:
|
|
type: array
|
|
items:
|
|
type: string
|
|
paused:
|
|
type: boolean
|
|
format: boolean
|
|
blockable:
|
|
type: boolean
|
|
format: boolean
|
|
rate_limit:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
format: boolean
|
|
limit:
|
|
type: string
|
|
format: byte
|
|
time_period:
|
|
type: string
|
|
title: >-
|
|
RateLimit parameters for rate-limiting the supply of
|
|
an issued asset
|
|
title: Asset type for assets in the issuance module
|
|
description: Params defines the parameters for the issuance module.
|
|
description: >-
|
|
QueryParamsResponse defines the response type for querying
|
|
x/issuance parameters.
|
|
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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
tags:
|
|
- Issuance
|
|
/kava/kavadist/v1beta1/balance:
|
|
get:
|
|
summary: Balance queries the balance of all coins of x/kavadist module.
|
|
operationId: KavadistBalance
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
coins:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
QueryBalanceResponse defines the response type for querying
|
|
x/kavadist balance.
|
|
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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
tags:
|
|
- Kavadist
|
|
/kava/kavadist/v1beta1/parameters:
|
|
get:
|
|
summary: Params queries the parameters of x/kavadist module.
|
|
operationId: KavadistParams
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
params:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
format: boolean
|
|
periods:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
start:
|
|
type: string
|
|
format: date-time
|
|
title: example "2020-03-01T15:20:00Z"
|
|
end:
|
|
type: string
|
|
format: date-time
|
|
title: example "2020-06-01T15:20:00Z"
|
|
inflation:
|
|
type: string
|
|
format: byte
|
|
title: example "1.000000003022265980" - 10% inflation
|
|
title: >-
|
|
Period stores the specified start and end dates, and the
|
|
inflation, expressed as a decimal
|
|
|
|
representing the yearly APR of KAVA tokens that will be
|
|
minted during that period
|
|
title: Params governance parameters for kavadist module
|
|
description: >-
|
|
QueryParamsResponse defines the response type for querying
|
|
x/kavadist parameters.
|
|
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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
tags:
|
|
- Kavadist
|
|
/kava/pricefeed/v1beta1/markets:
|
|
get:
|
|
summary: Markets queries all markets
|
|
operationId: PricefeedMarkets
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
markets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
base_asset:
|
|
type: string
|
|
quote_asset:
|
|
type: string
|
|
oracles:
|
|
type: array
|
|
items:
|
|
type: string
|
|
active:
|
|
type: boolean
|
|
format: boolean
|
|
description: MarketResponse defines an asset in the pricefeed.
|
|
title: List of markets
|
|
description: >-
|
|
QueryMarketsResponse is the response type for the Query/Markets
|
|
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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
tags:
|
|
- Pricefeed
|
|
/kava/pricefeed/v1beta1/oracles/{market_id}:
|
|
get:
|
|
summary: Oracles queries all oracles based on a market
|
|
operationId: PricefeedOracles
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
oracles:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: List of oracle addresses
|
|
description: >-
|
|
QueryOraclesResponse is the response type for the Query/Oracles
|
|
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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: market_id
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Pricefeed
|
|
/kava/pricefeed/v1beta1/params:
|
|
get:
|
|
summary: Params queries all parameters of the pricefeed module.
|
|
operationId: PricefeedParams
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
params:
|
|
type: object
|
|
properties:
|
|
markets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
base_asset:
|
|
type: string
|
|
quote_asset:
|
|
type: string
|
|
oracles:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: byte
|
|
active:
|
|
type: boolean
|
|
format: boolean
|
|
description: Market defines an asset in the pricefeed.
|
|
description: Params defines the parameters for the pricefeed module.
|
|
description: >-
|
|
QueryParamsResponse defines the response type for querying
|
|
x/pricefeed
|
|
|
|
parameters.
|
|
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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
tags:
|
|
- Pricefeed
|
|
/kava/pricefeed/v1beta1/prices:
|
|
get:
|
|
summary: Prices queries all prices
|
|
operationId: PricefeedPrices
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
prices:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
price:
|
|
type: string
|
|
description: >-
|
|
CurrentPriceResponse defines a current price for a
|
|
particular market in the pricefeed
|
|
|
|
module.
|
|
description: >-
|
|
QueryPricesResponse is the response type for the Query/Prices 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
tags:
|
|
- Pricefeed
|
|
/kava/pricefeed/v1beta1/prices/{market_id}:
|
|
get:
|
|
summary: Price queries price details based on a market
|
|
operationId: PricefeedPrice
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
price:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
price:
|
|
type: string
|
|
description: >-
|
|
CurrentPriceResponse defines a current price for a particular
|
|
market in the pricefeed
|
|
|
|
module.
|
|
description: >-
|
|
QueryPriceResponse is the response type for the Query/Prices 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: market_id
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Pricefeed
|
|
/kava/pricefeed/v1beta1/rawprices/{market_id}:
|
|
get:
|
|
summary: RawPrices queries all raw prices based on a market
|
|
operationId: PricefeedRawPrices
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
raw_prices:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
oracle_address:
|
|
type: string
|
|
price:
|
|
type: string
|
|
expiry:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
PostedPriceResponse defines a price for market posted by a
|
|
specific oracle.
|
|
description: >-
|
|
QueryRawPricesResponse is the response type for the
|
|
Query/RawPrices 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: market_id
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Pricefeed
|
|
/kava/swap/v1beta1/deposits:
|
|
get:
|
|
summary: Deposits queries deposit details based on owner address and pool
|
|
operationId: SwapDeposits
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
deposits:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
depositor:
|
|
type: string
|
|
title: depositor represents the owner of the deposit
|
|
pool_id:
|
|
type: string
|
|
title: pool_id represents the pool the deposit is for
|
|
shares_owned:
|
|
type: string
|
|
title: >-
|
|
shares_owned presents the shares owned by the depositor
|
|
for the pool
|
|
shares_value:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an
|
|
amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
title: >-
|
|
shares_value represents the coin value of the
|
|
shares_owned
|
|
description: >-
|
|
DepositResponse defines a single deposit query response
|
|
type.
|
|
title: >-
|
|
deposits returns the deposits matching the requested
|
|
parameters
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryDepositsResponse is the response type for the Query/Deposits
|
|
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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: owner
|
|
description: owner optionally filters deposits by owner.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: pool_id
|
|
description: pool_id optionally fitlers deposits by pool id.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
|
|
|
|
Since: cosmos-sdk 0.43
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Swap
|
|
/kava/swap/v1beta1/params:
|
|
get:
|
|
summary: Params queries all parameters of the swap module.
|
|
operationId: SwapParams
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
params:
|
|
title: params represents the swap module parameters
|
|
type: object
|
|
properties:
|
|
allowed_pools:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
token_a:
|
|
type: string
|
|
title: token_a represents the a token allowed
|
|
token_b:
|
|
type: string
|
|
title: token_b represents the b token allowed
|
|
title: AllowedPool defines a pool that is allowed to be created
|
|
title: >-
|
|
allowed_pools defines that pools that are allowed to be
|
|
created
|
|
swap_fee:
|
|
type: string
|
|
title: swap_fee defines the swap fee for all pools
|
|
description: Params defines the parameters for the swap module.
|
|
description: >-
|
|
QueryParamsResponse defines the response type for querying x/swap
|
|
parameters.
|
|
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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
tags:
|
|
- Swap
|
|
/kava/swap/v1beta1/pools:
|
|
get:
|
|
summary: Pools queries pools based on pool ID
|
|
operationId: SwapPools
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
pools:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
title: name represents the name of the pool
|
|
coins:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an
|
|
amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
title: coins represents the total reserves of the pool
|
|
total_shares:
|
|
type: string
|
|
title: total_shares represents the total shares of the pool
|
|
title: Pool represents the state of a single pool
|
|
title: pools represents returned pools
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryPoolsResponse is the response type for the Query/Pools 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: pool_id
|
|
description: pool_id filters pools by id.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
|
|
|
|
Since: cosmos-sdk 0.43
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Swap
|
|
/node_info:
|
|
get:
|
|
description: Information about the connected node
|
|
summary: The properties of the connected node
|
|
tags:
|
|
- KAVA Rest
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: Node status
|
|
schema:
|
|
type: object
|
|
properties:
|
|
application_version:
|
|
properties:
|
|
build_tags:
|
|
type: string
|
|
client_name:
|
|
type: string
|
|
commit:
|
|
type: string
|
|
go:
|
|
type: string
|
|
name:
|
|
type: string
|
|
server_name:
|
|
type: string
|
|
version:
|
|
type: string
|
|
node_info:
|
|
properties:
|
|
id:
|
|
type: string
|
|
moniker:
|
|
type: string
|
|
example: validator-name
|
|
protocol_version:
|
|
properties:
|
|
p2p:
|
|
type: string
|
|
example: 7
|
|
block:
|
|
type: string
|
|
example: 10
|
|
app:
|
|
type: string
|
|
example: 0
|
|
network:
|
|
type: string
|
|
example: gaia-2
|
|
channels:
|
|
type: string
|
|
listen_addr:
|
|
type: string
|
|
example: 192.168.56.1:26656
|
|
version:
|
|
description: Tendermint version
|
|
type: string
|
|
example: 0.15.0
|
|
other:
|
|
description: more information on versions
|
|
type: object
|
|
properties:
|
|
tx_index:
|
|
type: string
|
|
example: 'on'
|
|
rpc_address:
|
|
type: string
|
|
example: tcp://0.0.0.0:26657
|
|
'500':
|
|
description: Failed to query node status
|
|
/syncing:
|
|
get:
|
|
summary: Syncing state of node
|
|
tags:
|
|
- Tendermint RPC
|
|
description: Get if the node is currently syning with other nodes
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: Node syncing status
|
|
schema:
|
|
type: object
|
|
properties:
|
|
syncing:
|
|
type: boolean
|
|
'500':
|
|
description: Server internal error
|
|
/blocks/latest:
|
|
get:
|
|
summary: Get the latest block
|
|
tags:
|
|
- Tendermint RPC
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: The latest block
|
|
schema:
|
|
type: object
|
|
properties:
|
|
block_meta:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
chain_id:
|
|
type: string
|
|
example: cosmoshub-2
|
|
height:
|
|
type: number
|
|
example: 1
|
|
time:
|
|
type: string
|
|
example: '2017-12-30T05:53:09.287+01:00'
|
|
num_txs:
|
|
type: number
|
|
example: 0
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
total_txs:
|
|
type: number
|
|
example: 35
|
|
last_commit_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
data_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
validators_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
next_validators_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
consensus_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
app_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
last_results_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
evidence_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
proposer_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
version:
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
example: 10
|
|
app:
|
|
type: string
|
|
example: 0
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
block:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
chain_id:
|
|
type: string
|
|
example: cosmoshub-2
|
|
height:
|
|
type: number
|
|
example: 1
|
|
time:
|
|
type: string
|
|
example: '2017-12-30T05:53:09.287+01:00'
|
|
num_txs:
|
|
type: number
|
|
example: 0
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
total_txs:
|
|
type: number
|
|
example: 35
|
|
last_commit_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
data_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
validators_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
next_validators_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
consensus_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
app_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
last_results_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
evidence_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
proposer_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
version:
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
example: 10
|
|
app:
|
|
type: string
|
|
example: 0
|
|
txs:
|
|
type: array
|
|
items:
|
|
type: string
|
|
evidence:
|
|
type: array
|
|
items:
|
|
type: string
|
|
last_commit:
|
|
type: object
|
|
properties:
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
precommits:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
validator_address:
|
|
type: string
|
|
validator_index:
|
|
type: string
|
|
example: '0'
|
|
height:
|
|
type: string
|
|
example: '0'
|
|
round:
|
|
type: string
|
|
example: '0'
|
|
timestamp:
|
|
type: string
|
|
example: '2017-12-30T05:53:09.287+01:00'
|
|
type:
|
|
type: number
|
|
example: 2
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
7uTC74QlknqYWEwg7Vn6M8Om7FuZ0EO4bjvuj6rwH1mTUJrRuMMZvAAqT9VjNgP0RA/TDp6u/92AqrZfXJSpBQ==
|
|
'500':
|
|
description: Server internal error
|
|
/blocks/{height}:
|
|
get:
|
|
summary: Get a block at a certain height
|
|
tags:
|
|
- Tendermint RPC
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: height
|
|
description: Block height
|
|
required: true
|
|
type: number
|
|
x-example: 1
|
|
responses:
|
|
'200':
|
|
description: The block at a specific height
|
|
schema:
|
|
type: object
|
|
properties:
|
|
block_meta:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
chain_id:
|
|
type: string
|
|
example: cosmoshub-2
|
|
height:
|
|
type: number
|
|
example: 1
|
|
time:
|
|
type: string
|
|
example: '2017-12-30T05:53:09.287+01:00'
|
|
num_txs:
|
|
type: number
|
|
example: 0
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
total_txs:
|
|
type: number
|
|
example: 35
|
|
last_commit_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
data_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
validators_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
next_validators_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
consensus_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
app_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
last_results_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
evidence_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
proposer_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
version:
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
example: 10
|
|
app:
|
|
type: string
|
|
example: 0
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
block:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
chain_id:
|
|
type: string
|
|
example: cosmoshub-2
|
|
height:
|
|
type: number
|
|
example: 1
|
|
time:
|
|
type: string
|
|
example: '2017-12-30T05:53:09.287+01:00'
|
|
num_txs:
|
|
type: number
|
|
example: 0
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
total_txs:
|
|
type: number
|
|
example: 35
|
|
last_commit_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
data_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
validators_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
next_validators_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
consensus_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
app_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
last_results_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
evidence_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
proposer_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
version:
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
example: 10
|
|
app:
|
|
type: string
|
|
example: 0
|
|
txs:
|
|
type: array
|
|
items:
|
|
type: string
|
|
evidence:
|
|
type: array
|
|
items:
|
|
type: string
|
|
last_commit:
|
|
type: object
|
|
properties:
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
precommits:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
validator_address:
|
|
type: string
|
|
validator_index:
|
|
type: string
|
|
example: '0'
|
|
height:
|
|
type: string
|
|
example: '0'
|
|
round:
|
|
type: string
|
|
example: '0'
|
|
timestamp:
|
|
type: string
|
|
example: '2017-12-30T05:53:09.287+01:00'
|
|
type:
|
|
type: number
|
|
example: 2
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
7uTC74QlknqYWEwg7Vn6M8Om7FuZ0EO4bjvuj6rwH1mTUJrRuMMZvAAqT9VjNgP0RA/TDp6u/92AqrZfXJSpBQ==
|
|
'400':
|
|
description: Invalid height
|
|
'404':
|
|
description: Request block height doesn't
|
|
'500':
|
|
description: Server internal error
|
|
/validatorsets/latest:
|
|
get:
|
|
summary: Get the latest validator set
|
|
tags:
|
|
- Tendermint RPC
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: The validator set at the latest block height
|
|
schema:
|
|
type: object
|
|
properties:
|
|
block_height:
|
|
type: string
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
pub_key:
|
|
type: string
|
|
example: >-
|
|
cosmosvalconspub1zcjduepq0vu2zgkgk49efa0nqwzndanq5m4c7pa3u4apz4g2r9gspqg6g9cs3k9cuf
|
|
voting_power:
|
|
type: string
|
|
example: '1000'
|
|
proposer_priority:
|
|
type: string
|
|
example: '1000'
|
|
'500':
|
|
description: Server internal error
|
|
/validatorsets/{height}:
|
|
get:
|
|
summary: Get a validator set a certain height
|
|
tags:
|
|
- Tendermint RPC
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: height
|
|
description: Block height
|
|
required: true
|
|
type: number
|
|
x-example: 1
|
|
responses:
|
|
'200':
|
|
description: The validator set at a specific block height
|
|
schema:
|
|
type: object
|
|
properties:
|
|
block_height:
|
|
type: string
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
pub_key:
|
|
type: string
|
|
example: >-
|
|
cosmosvalconspub1zcjduepq0vu2zgkgk49efa0nqwzndanq5m4c7pa3u4apz4g2r9gspqg6g9cs3k9cuf
|
|
voting_power:
|
|
type: string
|
|
example: '1000'
|
|
proposer_priority:
|
|
type: string
|
|
example: '1000'
|
|
'400':
|
|
description: Invalid height
|
|
'404':
|
|
description: Block at height not available
|
|
'500':
|
|
description: Server internal error
|
|
/txs/{hash}:
|
|
get:
|
|
deprecated: true
|
|
summary: Get a Tx by hash
|
|
tags:
|
|
- Transactions
|
|
description: Retrieve a transaction using its hash.
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: hash
|
|
description: Tx hash
|
|
required: true
|
|
type: string
|
|
x-example: BCBE20E8D46758B96AE5883B792858296AC06E51435490FBDCAE25A72B3CC76B
|
|
responses:
|
|
'200':
|
|
description: Tx with the provided hash
|
|
schema:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: >-
|
|
D085138D913993919295FF4B0A9107F1F2CDE0D37A87CE0644E217CBF3B49656
|
|
height:
|
|
type: number
|
|
example: 368
|
|
tx:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
result:
|
|
type: object
|
|
properties:
|
|
log:
|
|
type: string
|
|
gas_wanted:
|
|
type: string
|
|
example: '200000'
|
|
gas_used:
|
|
type: string
|
|
example: '26354'
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
'500':
|
|
description: Internal Server Error
|
|
/txs:
|
|
get:
|
|
deprecated: true
|
|
tags:
|
|
- Transactions
|
|
summary: Search transactions
|
|
description: Search transactions by events.
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: query
|
|
name: message.action
|
|
type: string
|
|
description: >-
|
|
transaction events such as 'message.action=send' which results in
|
|
the following endpoint: 'GET /txs?message.action=send'. note that
|
|
each module documents its own events. look for xx_events.md in the
|
|
corresponding cosmos-sdk/docs/spec directory
|
|
x-example: send
|
|
- in: query
|
|
name: message.sender
|
|
type: string
|
|
description: >-
|
|
transaction tags with sender: 'GET
|
|
/txs?message.action=send&message.sender=cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv'
|
|
x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
|
|
- in: query
|
|
name: page
|
|
description: Page number
|
|
type: integer
|
|
x-example: 1
|
|
- in: query
|
|
name: limit
|
|
description: Maximum number of items per page
|
|
type: integer
|
|
x-example: 1
|
|
- in: query
|
|
name: tx.minheight
|
|
type: integer
|
|
description: transactions on blocks with height greater or equal this value
|
|
x-example: 25
|
|
- in: query
|
|
name: tx.maxheight
|
|
type: integer
|
|
description: transactions on blocks with height less than or equal this value
|
|
x-example: 800000
|
|
responses:
|
|
'200':
|
|
description: All txs matching the provided events
|
|
schema:
|
|
type: object
|
|
properties:
|
|
total_count:
|
|
type: number
|
|
example: 1
|
|
count:
|
|
type: number
|
|
example: 1
|
|
page_number:
|
|
type: number
|
|
example: 1
|
|
page_total:
|
|
type: number
|
|
example: 1
|
|
limit:
|
|
type: number
|
|
example: 30
|
|
txs:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: >-
|
|
D085138D913993919295FF4B0A9107F1F2CDE0D37A87CE0644E217CBF3B49656
|
|
height:
|
|
type: number
|
|
example: 368
|
|
tx:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
result:
|
|
type: object
|
|
properties:
|
|
log:
|
|
type: string
|
|
gas_wanted:
|
|
type: string
|
|
example: '200000'
|
|
gas_used:
|
|
type: string
|
|
example: '26354'
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
'400':
|
|
description: Invalid search events
|
|
'500':
|
|
description: Internal Server Error
|
|
post:
|
|
tags:
|
|
- Transactions
|
|
summary: Broadcast a signed tx
|
|
description: Broadcast a signed tx to a full node
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: txBroadcast
|
|
description: >-
|
|
The tx must be a signed StdTx. The supported broadcast modes include
|
|
`"block"`(return after tx commit), `"sync"`(return afer CheckTx) and
|
|
`"async"`(return right away).
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
tx:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
mode:
|
|
type: string
|
|
example: block
|
|
responses:
|
|
'200':
|
|
description: Tx broadcasting result
|
|
schema:
|
|
type: object
|
|
properties:
|
|
check_tx:
|
|
type: object
|
|
properties:
|
|
code:
|
|
type: integer
|
|
data:
|
|
type: string
|
|
gas_used:
|
|
type: integer
|
|
gas_wanted:
|
|
type: integer
|
|
info:
|
|
type: string
|
|
log:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
example:
|
|
code: 0
|
|
data: data
|
|
log: log
|
|
gas_used: 5000
|
|
gas_wanted: 10000
|
|
info: info
|
|
tags:
|
|
- ''
|
|
- ''
|
|
deliver_tx:
|
|
type: object
|
|
properties:
|
|
code:
|
|
type: integer
|
|
data:
|
|
type: string
|
|
gas_used:
|
|
type: integer
|
|
gas_wanted:
|
|
type: integer
|
|
info:
|
|
type: string
|
|
log:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
example:
|
|
code: 5
|
|
data: data
|
|
log: log
|
|
gas_used: 5000
|
|
gas_wanted: 10000
|
|
info: info
|
|
tags:
|
|
- ''
|
|
- ''
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
height:
|
|
type: integer
|
|
'500':
|
|
description: Internal Server Error
|
|
/txs/encode:
|
|
post:
|
|
deprecated: true
|
|
tags:
|
|
- Transactions
|
|
summary: Encode a transaction to the Amino wire format
|
|
description: >-
|
|
Encode a transaction (signed or not) from JSON to base64-encoded Amino
|
|
serialized bytes
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: tx
|
|
description: The tx to encode
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
tx:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
responses:
|
|
'200':
|
|
description: The tx was successfully decoded and re-encoded
|
|
schema:
|
|
type: object
|
|
properties:
|
|
tx:
|
|
type: string
|
|
example: The base64-encoded Amino-serialized bytes for the tx
|
|
'400':
|
|
description: The tx was malformated
|
|
'500':
|
|
description: Server internal error
|
|
/txs/decode:
|
|
post:
|
|
deprecated: true
|
|
tags:
|
|
- Transactions
|
|
summary: Decode a transaction from the Amino wire format
|
|
description: >-
|
|
Decode a transaction (signed or not) from base64-encoded Amino
|
|
serialized bytes to JSON
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: tx
|
|
description: The tx to decode
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
tx:
|
|
type: string
|
|
example: >-
|
|
SvBiXe4KPqijYZoKFFHEzJ8c2HPAfv2EFUcIhx0yPagwEhTy0vPA+GGhCEslKXa4Af0uB+mfShoMCgVzdGFrZRIDMTAwEgQQwJoM
|
|
responses:
|
|
'200':
|
|
description: The tx was successfully decoded
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
'400':
|
|
description: The tx was malformated
|
|
'500':
|
|
description: Server internal error
|
|
/bank/balances/{address}:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the account balances
|
|
tags:
|
|
- Bank
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: address
|
|
description: Account address in bech32 format
|
|
required: true
|
|
type: string
|
|
x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
|
|
responses:
|
|
'200':
|
|
description: Account balances
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
'500':
|
|
description: Server internal error
|
|
/bank/accounts/{address}/transfers:
|
|
post:
|
|
deprecated: true
|
|
summary: Send coins from one account to another
|
|
tags:
|
|
- Bank
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: address
|
|
description: Account address in bech32 format
|
|
required: true
|
|
type: string
|
|
x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
|
|
- in: body
|
|
name: account
|
|
description: The sender and tx information
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: cosmos1g9ahr6xhht5rmqven628nklxluzyv8z9jqjcmc
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: Sent via Cosmos Voyager 🚀
|
|
chain_id:
|
|
type: string
|
|
example: Cosmos-Hub
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '1'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.2'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
responses:
|
|
'202':
|
|
description: Tx was succesfully generated
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Server internal error
|
|
/bank/total:
|
|
get:
|
|
deprecated: true
|
|
summary: Total supply of coins in the chain
|
|
tags:
|
|
- Bank
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
'500':
|
|
description: Internal Server Error
|
|
/bank/total/{denomination}:
|
|
parameters:
|
|
- in: path
|
|
name: denomination
|
|
description: Coin denomination
|
|
required: true
|
|
type: string
|
|
x-example: uatom
|
|
get:
|
|
deprecated: true
|
|
summary: Total supply of a single coin denomination
|
|
tags:
|
|
- Bank
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: string
|
|
'400':
|
|
description: Invalid coin denomination
|
|
'500':
|
|
description: Internal Server Error
|
|
/auth/accounts/{address}:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the account information on blockchain
|
|
tags:
|
|
- Auth
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: address
|
|
description: Account address
|
|
required: true
|
|
type: string
|
|
x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
|
|
responses:
|
|
'200':
|
|
description: Account information on the blockchain
|
|
schema:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
value:
|
|
type: object
|
|
properties:
|
|
account_number:
|
|
type: string
|
|
address:
|
|
type: string
|
|
coins:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
public_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
value:
|
|
type: string
|
|
sequence:
|
|
type: string
|
|
'500':
|
|
description: Server internel error
|
|
/staking/delegators/{delegatorAddr}/delegations:
|
|
parameters:
|
|
- in: path
|
|
name: delegatorAddr
|
|
description: Bech32 AccAddress of Delegator
|
|
required: true
|
|
type: string
|
|
x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
|
|
get:
|
|
deprecated: true
|
|
summary: Get all delegations from a delegator
|
|
tags:
|
|
- Staking
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
validator_address:
|
|
type: string
|
|
shares:
|
|
type: string
|
|
balance:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
'400':
|
|
description: Invalid delegator address
|
|
'500':
|
|
description: Internal Server Error
|
|
post:
|
|
summary: Submit delegation
|
|
parameters:
|
|
- in: body
|
|
name: delegation
|
|
description: Delegate an amount of liquid coins to a validator
|
|
schema:
|
|
type: object
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: cosmos1g9ahr6xhht5rmqven628nklxluzyv8z9jqjcmc
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: Sent via Cosmos Voyager 🚀
|
|
chain_id:
|
|
type: string
|
|
example: Cosmos-Hub
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '1'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.2'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
delegator_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
validator_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
amount:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
tags:
|
|
- Staking
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
'400':
|
|
description: Invalid delegator address or delegation request body
|
|
'401':
|
|
description: Key password is wrong
|
|
'500':
|
|
description: Internal Server Error
|
|
/staking/delegators/{delegatorAddr}/delegations/{validatorAddr}:
|
|
parameters:
|
|
- in: path
|
|
name: delegatorAddr
|
|
description: Bech32 AccAddress of Delegator
|
|
required: true
|
|
type: string
|
|
x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
|
|
- in: path
|
|
name: validatorAddr
|
|
description: Bech32 OperatorAddress of validator
|
|
required: true
|
|
type: string
|
|
x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
get:
|
|
deprecated: true
|
|
summary: Query the current delegation between a delegator and a validator
|
|
tags:
|
|
- Staking
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
validator_address:
|
|
type: string
|
|
shares:
|
|
type: string
|
|
balance:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
'400':
|
|
description: Invalid delegator address or validator address
|
|
'500':
|
|
description: Internal Server Error
|
|
/staking/delegators/{delegatorAddr}/unbonding_delegations:
|
|
parameters:
|
|
- in: path
|
|
name: delegatorAddr
|
|
description: Bech32 AccAddress of Delegator
|
|
required: true
|
|
type: string
|
|
x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
|
|
get:
|
|
deprecated: true
|
|
summary: Get all unbonding delegations from a delegator
|
|
tags:
|
|
- Staking
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
validator_address:
|
|
type: string
|
|
initial_balance:
|
|
type: string
|
|
balance:
|
|
type: string
|
|
creation_height:
|
|
type: integer
|
|
min_time:
|
|
type: integer
|
|
'400':
|
|
description: Invalid delegator address
|
|
'500':
|
|
description: Internal Server Error
|
|
post:
|
|
summary: Submit an unbonding delegation
|
|
parameters:
|
|
- in: body
|
|
name: delegation
|
|
description: Unbond an amount of bonded shares from a validator
|
|
schema:
|
|
type: object
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: cosmos1g9ahr6xhht5rmqven628nklxluzyv8z9jqjcmc
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: Sent via Cosmos Voyager 🚀
|
|
chain_id:
|
|
type: string
|
|
example: Cosmos-Hub
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '1'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.2'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
delegator_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
validator_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
amount:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
tags:
|
|
- Staking
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
'400':
|
|
description: Invalid delegator address or unbonding delegation request body
|
|
'401':
|
|
description: Key password is wrong
|
|
'500':
|
|
description: Internal Server Error
|
|
/staking/delegators/{delegatorAddr}/unbonding_delegations/{validatorAddr}:
|
|
parameters:
|
|
- in: path
|
|
name: delegatorAddr
|
|
description: Bech32 AccAddress of Delegator
|
|
required: true
|
|
type: string
|
|
x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
|
|
- in: path
|
|
name: validatorAddr
|
|
description: Bech32 OperatorAddress of validator
|
|
required: true
|
|
type: string
|
|
x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
get:
|
|
deprecated: true
|
|
summary: Query all unbonding delegations between a delegator and a validator
|
|
tags:
|
|
- Staking
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
validator_address:
|
|
type: string
|
|
entries:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
initial_balance:
|
|
type: string
|
|
balance:
|
|
type: string
|
|
creation_height:
|
|
type: string
|
|
min_time:
|
|
type: string
|
|
'400':
|
|
description: Invalid delegator address or validator address
|
|
'500':
|
|
description: Internal Server Error
|
|
/staking/redelegations:
|
|
parameters:
|
|
- in: query
|
|
name: delegator
|
|
description: Bech32 AccAddress of Delegator
|
|
required: false
|
|
type: string
|
|
- in: query
|
|
name: validator_from
|
|
description: Bech32 ValAddress of SrcValidator
|
|
required: false
|
|
type: string
|
|
- in: query
|
|
name: validator_to
|
|
description: Bech32 ValAddress of DstValidator
|
|
required: false
|
|
type: string
|
|
get:
|
|
deprecated: true
|
|
summary: Get all redelegations (filter by query params)
|
|
tags:
|
|
- Staking
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: '#/definitions/Redelegation'
|
|
'500':
|
|
description: Internal Server Error
|
|
/staking/delegators/{delegatorAddr}/redelegations:
|
|
parameters:
|
|
- in: path
|
|
name: delegatorAddr
|
|
description: Bech32 AccAddress of Delegator
|
|
required: true
|
|
type: string
|
|
x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
|
|
post:
|
|
deprecated: true
|
|
summary: Submit a redelegation
|
|
parameters:
|
|
- in: body
|
|
name: delegation
|
|
description: The sender and tx information
|
|
schema:
|
|
type: object
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: cosmos1g9ahr6xhht5rmqven628nklxluzyv8z9jqjcmc
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: Sent via Cosmos Voyager 🚀
|
|
chain_id:
|
|
type: string
|
|
example: Cosmos-Hub
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '1'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.2'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
delegator_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
validator_src_addressess:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
validator_dst_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
shares:
|
|
type: string
|
|
example: '100'
|
|
tags:
|
|
- Staking
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: Tx was succesfully generated
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
'400':
|
|
description: Invalid delegator address or redelegation request body
|
|
'500':
|
|
description: Internal Server Error
|
|
/staking/delegators/{delegatorAddr}/validators:
|
|
parameters:
|
|
- in: path
|
|
name: delegatorAddr
|
|
description: Bech32 AccAddress of Delegator
|
|
required: true
|
|
type: string
|
|
x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
|
|
get:
|
|
deprecated: true
|
|
summary: Query all validators that a delegator is bonded to
|
|
tags:
|
|
- Staking
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
operator_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
consensus_pubkey:
|
|
type: string
|
|
example: >-
|
|
cosmosvalconspub1zcjduepq0vu2zgkgk49efa0nqwzndanq5m4c7pa3u4apz4g2r9gspqg6g9cs3k9cuf
|
|
jailed:
|
|
type: boolean
|
|
status:
|
|
type: integer
|
|
tokens:
|
|
type: string
|
|
delegator_shares:
|
|
type: string
|
|
description:
|
|
type: object
|
|
properties:
|
|
moniker:
|
|
type: string
|
|
identity:
|
|
type: string
|
|
website:
|
|
type: string
|
|
security_contact:
|
|
type: string
|
|
details:
|
|
type: string
|
|
bond_height:
|
|
type: string
|
|
example: '0'
|
|
bond_intra_tx_counter:
|
|
type: integer
|
|
example: 0
|
|
unbonding_height:
|
|
type: string
|
|
example: '0'
|
|
unbonding_time:
|
|
type: string
|
|
example: '1970-01-01T00:00:00Z'
|
|
commission:
|
|
type: object
|
|
properties:
|
|
rate:
|
|
type: string
|
|
example: '0'
|
|
max_rate:
|
|
type: string
|
|
example: '0'
|
|
max_change_rate:
|
|
type: string
|
|
example: '0'
|
|
update_time:
|
|
type: string
|
|
example: '1970-01-01T00:00:00Z'
|
|
'400':
|
|
description: Invalid delegator address
|
|
'500':
|
|
description: Internal Server Error
|
|
/staking/delegators/{delegatorAddr}/validators/{validatorAddr}:
|
|
parameters:
|
|
- in: path
|
|
name: delegatorAddr
|
|
description: Bech32 AccAddress of Delegator
|
|
required: true
|
|
type: string
|
|
x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
|
|
- in: path
|
|
name: validatorAddr
|
|
description: Bech32 ValAddress of Delegator
|
|
required: true
|
|
type: string
|
|
x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
get:
|
|
deprecated: true
|
|
summary: Query a validator that a delegator is bonded to
|
|
tags:
|
|
- Staking
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
operator_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
consensus_pubkey:
|
|
type: string
|
|
example: >-
|
|
cosmosvalconspub1zcjduepq0vu2zgkgk49efa0nqwzndanq5m4c7pa3u4apz4g2r9gspqg6g9cs3k9cuf
|
|
jailed:
|
|
type: boolean
|
|
status:
|
|
type: integer
|
|
tokens:
|
|
type: string
|
|
delegator_shares:
|
|
type: string
|
|
description:
|
|
type: object
|
|
properties:
|
|
moniker:
|
|
type: string
|
|
identity:
|
|
type: string
|
|
website:
|
|
type: string
|
|
security_contact:
|
|
type: string
|
|
details:
|
|
type: string
|
|
bond_height:
|
|
type: string
|
|
example: '0'
|
|
bond_intra_tx_counter:
|
|
type: integer
|
|
example: 0
|
|
unbonding_height:
|
|
type: string
|
|
example: '0'
|
|
unbonding_time:
|
|
type: string
|
|
example: '1970-01-01T00:00:00Z'
|
|
commission:
|
|
type: object
|
|
properties:
|
|
rate:
|
|
type: string
|
|
example: '0'
|
|
max_rate:
|
|
type: string
|
|
example: '0'
|
|
max_change_rate:
|
|
type: string
|
|
example: '0'
|
|
update_time:
|
|
type: string
|
|
example: '1970-01-01T00:00:00Z'
|
|
'400':
|
|
description: Invalid delegator address or validator address
|
|
'500':
|
|
description: Internal Server Error
|
|
/staking/validators:
|
|
get:
|
|
deprecated: true
|
|
summary: >-
|
|
Get all validator candidates. By default it returns only the bonded
|
|
validators.
|
|
parameters:
|
|
- in: query
|
|
name: status
|
|
type: string
|
|
description: >-
|
|
The validator bond status. Must be either 'bonded', 'unbonded', or
|
|
'unbonding'.
|
|
x-example: bonded
|
|
- in: query
|
|
name: page
|
|
description: The page number.
|
|
type: integer
|
|
x-example: 1
|
|
- in: query
|
|
name: limit
|
|
description: The maximum number of items per page.
|
|
type: integer
|
|
x-example: 1
|
|
tags:
|
|
- Staking
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
operator_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
consensus_pubkey:
|
|
type: string
|
|
example: >-
|
|
cosmosvalconspub1zcjduepq0vu2zgkgk49efa0nqwzndanq5m4c7pa3u4apz4g2r9gspqg6g9cs3k9cuf
|
|
jailed:
|
|
type: boolean
|
|
status:
|
|
type: integer
|
|
tokens:
|
|
type: string
|
|
delegator_shares:
|
|
type: string
|
|
description:
|
|
type: object
|
|
properties:
|
|
moniker:
|
|
type: string
|
|
identity:
|
|
type: string
|
|
website:
|
|
type: string
|
|
security_contact:
|
|
type: string
|
|
details:
|
|
type: string
|
|
bond_height:
|
|
type: string
|
|
example: '0'
|
|
bond_intra_tx_counter:
|
|
type: integer
|
|
example: 0
|
|
unbonding_height:
|
|
type: string
|
|
example: '0'
|
|
unbonding_time:
|
|
type: string
|
|
example: '1970-01-01T00:00:00Z'
|
|
commission:
|
|
type: object
|
|
properties:
|
|
rate:
|
|
type: string
|
|
example: '0'
|
|
max_rate:
|
|
type: string
|
|
example: '0'
|
|
max_change_rate:
|
|
type: string
|
|
example: '0'
|
|
update_time:
|
|
type: string
|
|
example: '1970-01-01T00:00:00Z'
|
|
'500':
|
|
description: Internal Server Error
|
|
/staking/validators/{validatorAddr}:
|
|
parameters:
|
|
- in: path
|
|
name: validatorAddr
|
|
description: Bech32 OperatorAddress of validator
|
|
required: true
|
|
type: string
|
|
x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
get:
|
|
deprecated: true
|
|
summary: Query the information from a single validator
|
|
tags:
|
|
- Staking
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
operator_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
consensus_pubkey:
|
|
type: string
|
|
example: >-
|
|
cosmosvalconspub1zcjduepq0vu2zgkgk49efa0nqwzndanq5m4c7pa3u4apz4g2r9gspqg6g9cs3k9cuf
|
|
jailed:
|
|
type: boolean
|
|
status:
|
|
type: integer
|
|
tokens:
|
|
type: string
|
|
delegator_shares:
|
|
type: string
|
|
description:
|
|
type: object
|
|
properties:
|
|
moniker:
|
|
type: string
|
|
identity:
|
|
type: string
|
|
website:
|
|
type: string
|
|
security_contact:
|
|
type: string
|
|
details:
|
|
type: string
|
|
bond_height:
|
|
type: string
|
|
example: '0'
|
|
bond_intra_tx_counter:
|
|
type: integer
|
|
example: 0
|
|
unbonding_height:
|
|
type: string
|
|
example: '0'
|
|
unbonding_time:
|
|
type: string
|
|
example: '1970-01-01T00:00:00Z'
|
|
commission:
|
|
type: object
|
|
properties:
|
|
rate:
|
|
type: string
|
|
example: '0'
|
|
max_rate:
|
|
type: string
|
|
example: '0'
|
|
max_change_rate:
|
|
type: string
|
|
example: '0'
|
|
update_time:
|
|
type: string
|
|
example: '1970-01-01T00:00:00Z'
|
|
'400':
|
|
description: Invalid validator address
|
|
'500':
|
|
description: Internal Server Error
|
|
/staking/validators/{validatorAddr}/delegations:
|
|
parameters:
|
|
- in: path
|
|
name: validatorAddr
|
|
description: Bech32 OperatorAddress of validator
|
|
required: true
|
|
type: string
|
|
x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
get:
|
|
deprecated: true
|
|
summary: Get all delegations from a validator
|
|
tags:
|
|
- Staking
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
validator_address:
|
|
type: string
|
|
shares:
|
|
type: string
|
|
balance:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
'400':
|
|
description: Invalid validator address
|
|
'500':
|
|
description: Internal Server Error
|
|
/staking/validators/{validatorAddr}/unbonding_delegations:
|
|
parameters:
|
|
- in: path
|
|
name: validatorAddr
|
|
description: Bech32 OperatorAddress of validator
|
|
required: true
|
|
type: string
|
|
x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
get:
|
|
deprecated: true
|
|
summary: Get all unbonding delegations from a validator
|
|
tags:
|
|
- Staking
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
validator_address:
|
|
type: string
|
|
initial_balance:
|
|
type: string
|
|
balance:
|
|
type: string
|
|
creation_height:
|
|
type: integer
|
|
min_time:
|
|
type: integer
|
|
'400':
|
|
description: Invalid validator address
|
|
'500':
|
|
description: Internal Server Error
|
|
/staking/pool:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the current state of the staking pool
|
|
tags:
|
|
- Staking
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
loose_tokens:
|
|
type: string
|
|
bonded_tokens:
|
|
type: string
|
|
inflation_last_time:
|
|
type: string
|
|
inflation:
|
|
type: string
|
|
date_last_commission_reset:
|
|
type: string
|
|
prev_bonded_shares:
|
|
type: string
|
|
'500':
|
|
description: Internal Server Error
|
|
/staking/parameters:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the current staking parameter values
|
|
tags:
|
|
- Staking
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
inflation_rate_change:
|
|
type: string
|
|
inflation_max:
|
|
type: string
|
|
inflation_min:
|
|
type: string
|
|
goal_bonded:
|
|
type: string
|
|
unbonding_time:
|
|
type: string
|
|
max_validators:
|
|
type: integer
|
|
bond_denom:
|
|
type: string
|
|
'500':
|
|
description: Internal Server Error
|
|
/slashing/signing_infos:
|
|
get:
|
|
deprecated: true
|
|
summary: Get sign info of given all validators
|
|
description: Get sign info of all validators
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Slashing
|
|
parameters:
|
|
- in: query
|
|
name: page
|
|
description: Page number
|
|
type: integer
|
|
required: true
|
|
x-example: 1
|
|
- in: query
|
|
name: limit
|
|
description: Maximum number of items per page
|
|
type: integer
|
|
required: true
|
|
x-example: 5
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
start_height:
|
|
type: string
|
|
index_offset:
|
|
type: string
|
|
jailed_until:
|
|
type: string
|
|
missed_blocks_counter:
|
|
type: string
|
|
'400':
|
|
description: Invalid validator public key for one of the validators
|
|
'500':
|
|
description: Internal Server Error
|
|
/slashing/validators/{validatorAddr}/unjail:
|
|
post:
|
|
deprecated: true
|
|
summary: Unjail a jailed validator
|
|
description: Send transaction to unjail a jailed validator
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Slashing
|
|
parameters:
|
|
- type: string
|
|
description: Bech32 validator address
|
|
name: validatorAddr
|
|
required: true
|
|
in: path
|
|
x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
- description: ''
|
|
name: UnjailBody
|
|
in: body
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
responses:
|
|
'200':
|
|
description: Tx was succesfully generated
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
'400':
|
|
description: Invalid validator address or base_req
|
|
'500':
|
|
description: Internal Server Error
|
|
/slashing/parameters:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the current slashing parameters
|
|
tags:
|
|
- Slashing
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
max_evidence_age:
|
|
type: string
|
|
signed_blocks_window:
|
|
type: string
|
|
min_signed_per_window:
|
|
type: string
|
|
double_sign_unbond_duration:
|
|
type: string
|
|
downtime_unbond_duration:
|
|
type: string
|
|
slash_fraction_double_sign:
|
|
type: string
|
|
slash_fraction_downtime:
|
|
type: string
|
|
'500':
|
|
description: Internal Server Error
|
|
/gov/proposals:
|
|
post:
|
|
deprecated: true
|
|
summary: Submit a proposal
|
|
description: Send transaction to submit a proposal
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Governance
|
|
parameters:
|
|
- description: >-
|
|
valid value of `"proposal_type"` can be `"text"`,
|
|
`"parameter_change"`, `"software_upgrade"`
|
|
name: post_proposal_body
|
|
in: body
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: cosmos1g9ahr6xhht5rmqven628nklxluzyv8z9jqjcmc
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: Sent via Cosmos Voyager 🚀
|
|
chain_id:
|
|
type: string
|
|
example: Cosmos-Hub
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '1'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.2'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
title:
|
|
type: string
|
|
description:
|
|
type: string
|
|
proposal_type:
|
|
type: string
|
|
example: text
|
|
proposer:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
initial_deposit:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
responses:
|
|
'200':
|
|
description: Tx was succesfully generated
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
'400':
|
|
description: Invalid proposal body
|
|
'500':
|
|
description: Internal Server Error
|
|
get:
|
|
deprecated: true
|
|
summary: Query proposals
|
|
description: Query proposals information with parameters
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Governance
|
|
parameters:
|
|
- in: query
|
|
name: voter
|
|
description: voter address
|
|
required: false
|
|
type: string
|
|
- in: query
|
|
name: depositor
|
|
description: depositor address
|
|
required: false
|
|
type: string
|
|
- in: query
|
|
name: status
|
|
description: >-
|
|
proposal status, valid values can be `"deposit_period"`,
|
|
`"voting_period"`, `"passed"`, `"rejected"`
|
|
required: false
|
|
type: string
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: integer
|
|
title:
|
|
type: string
|
|
description:
|
|
type: string
|
|
proposal_type:
|
|
type: string
|
|
proposal_status:
|
|
type: string
|
|
final_tally_result:
|
|
type: object
|
|
properties:
|
|
'yes':
|
|
type: string
|
|
example: '0.0000000000'
|
|
abstain:
|
|
type: string
|
|
example: '0.0000000000'
|
|
'no':
|
|
type: string
|
|
example: '0.0000000000'
|
|
no_with_veto:
|
|
type: string
|
|
example: '0.0000000000'
|
|
submit_time:
|
|
type: string
|
|
total_deposit:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
voting_start_time:
|
|
type: string
|
|
'400':
|
|
description: Invalid query parameters
|
|
'500':
|
|
description: Internal Server Error
|
|
/gov/proposals/param_change:
|
|
post:
|
|
deprecated: true
|
|
summary: Generate a parameter change proposal transaction
|
|
description: Generate a parameter change proposal transaction
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Governance
|
|
parameters:
|
|
- description: >-
|
|
The parameter change proposal body that contains all parameter
|
|
changes
|
|
name: post_proposal_body
|
|
in: body
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: cosmos1g9ahr6xhht5rmqven628nklxluzyv8z9jqjcmc
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: Sent via Cosmos Voyager 🚀
|
|
chain_id:
|
|
type: string
|
|
example: Cosmos-Hub
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '1'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.2'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
title:
|
|
type: string
|
|
x-example: Param Change
|
|
description:
|
|
type: string
|
|
x-example: Update max validators
|
|
proposer:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
deposit:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
changes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
subspace:
|
|
type: string
|
|
example: staking
|
|
key:
|
|
type: string
|
|
example: MaxValidators
|
|
subkey:
|
|
type: string
|
|
example: ''
|
|
value:
|
|
type: object
|
|
responses:
|
|
'200':
|
|
description: The transaction was succesfully generated
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
'400':
|
|
description: Invalid proposal body
|
|
'500':
|
|
description: Internal Server Error
|
|
/gov/proposals/{proposalId}:
|
|
get:
|
|
deprecated: true
|
|
summary: Query a proposal
|
|
description: Query a proposal by id
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Governance
|
|
parameters:
|
|
- type: string
|
|
name: proposalId
|
|
required: true
|
|
in: path
|
|
x-example: '2'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: integer
|
|
title:
|
|
type: string
|
|
description:
|
|
type: string
|
|
proposal_type:
|
|
type: string
|
|
proposal_status:
|
|
type: string
|
|
final_tally_result:
|
|
type: object
|
|
properties:
|
|
'yes':
|
|
type: string
|
|
example: '0.0000000000'
|
|
abstain:
|
|
type: string
|
|
example: '0.0000000000'
|
|
'no':
|
|
type: string
|
|
example: '0.0000000000'
|
|
no_with_veto:
|
|
type: string
|
|
example: '0.0000000000'
|
|
submit_time:
|
|
type: string
|
|
total_deposit:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
voting_start_time:
|
|
type: string
|
|
'400':
|
|
description: Invalid proposal id
|
|
'500':
|
|
description: Internal Server Error
|
|
/gov/proposals/{proposalId}/proposer:
|
|
get:
|
|
deprecated: true
|
|
summary: Query proposer
|
|
description: Query for the proposer for a proposal
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Governance
|
|
parameters:
|
|
- type: string
|
|
name: proposalId
|
|
required: true
|
|
in: path
|
|
x-example: '2'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
proposer:
|
|
type: string
|
|
'400':
|
|
description: Invalid proposal ID
|
|
'500':
|
|
description: Internal Server Error
|
|
/gov/proposals/{proposalId}/deposits:
|
|
get:
|
|
deprecated: true
|
|
summary: Query deposits
|
|
description: Query deposits by proposalId
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Governance
|
|
parameters:
|
|
- type: string
|
|
name: proposalId
|
|
required: true
|
|
in: path
|
|
x-example: '2'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
proposal_id:
|
|
type: string
|
|
depositor:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
'400':
|
|
description: Invalid proposal id
|
|
'500':
|
|
description: Internal Server Error
|
|
post:
|
|
deprecated: true
|
|
summary: Deposit tokens to a proposal
|
|
description: Send transaction to deposit tokens to a proposal
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Governance
|
|
parameters:
|
|
- type: string
|
|
description: proposal id
|
|
name: proposalId
|
|
required: true
|
|
in: path
|
|
x-example: '2'
|
|
- description: ''
|
|
name: post_deposit_body
|
|
in: body
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: cosmos1g9ahr6xhht5rmqven628nklxluzyv8z9jqjcmc
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: Sent via Cosmos Voyager 🚀
|
|
chain_id:
|
|
type: string
|
|
example: Cosmos-Hub
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '1'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.2'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
depositor:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
'400':
|
|
description: Invalid proposal id or deposit body
|
|
'401':
|
|
description: Key password is wrong
|
|
'500':
|
|
description: Internal Server Error
|
|
/gov/proposals/{proposalId}/deposits/{depositor}:
|
|
get:
|
|
deprecated: true
|
|
summary: Query deposit
|
|
description: Query deposit by proposalId and depositor address
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Governance
|
|
parameters:
|
|
- type: string
|
|
description: proposal id
|
|
name: proposalId
|
|
required: true
|
|
in: path
|
|
x-example: '2'
|
|
- type: string
|
|
description: Bech32 depositor address
|
|
name: depositor
|
|
required: true
|
|
in: path
|
|
x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
proposal_id:
|
|
type: string
|
|
depositor:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
'400':
|
|
description: Invalid proposal id or depositor address
|
|
'404':
|
|
description: Found no deposit
|
|
'500':
|
|
description: Internal Server Error
|
|
/gov/proposals/{proposalId}/votes:
|
|
get:
|
|
deprecated: true
|
|
summary: Query voters
|
|
description: Query voters information by proposalId
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Governance
|
|
parameters:
|
|
- type: string
|
|
description: proposal id
|
|
name: proposalId
|
|
required: true
|
|
in: path
|
|
x-example: '2'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
voter:
|
|
type: string
|
|
proposal_id:
|
|
type: string
|
|
option:
|
|
type: string
|
|
'400':
|
|
description: Invalid proposal id
|
|
'500':
|
|
description: Internal Server Error
|
|
post:
|
|
deprecated: true
|
|
summary: Vote a proposal
|
|
description: Send transaction to vote a proposal
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Governance
|
|
parameters:
|
|
- type: string
|
|
description: proposal id
|
|
name: proposalId
|
|
required: true
|
|
in: path
|
|
x-example: '2'
|
|
- description: >-
|
|
valid value of `"option"` field can be `"yes"`, `"no"`,
|
|
`"no_with_veto"` and `"abstain"`
|
|
name: post_vote_body
|
|
in: body
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: cosmos1g9ahr6xhht5rmqven628nklxluzyv8z9jqjcmc
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: Sent via Cosmos Voyager 🚀
|
|
chain_id:
|
|
type: string
|
|
example: Cosmos-Hub
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '1'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.2'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
voter:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
option:
|
|
type: string
|
|
example: 'yes'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
'400':
|
|
description: Invalid proposal id or vote body
|
|
'401':
|
|
description: Key password is wrong
|
|
'500':
|
|
description: Internal Server Error
|
|
/gov/proposals/{proposalId}/votes/{voter}:
|
|
get:
|
|
deprecated: true
|
|
summary: Query vote
|
|
description: Query vote information by proposal Id and voter address
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Governance
|
|
parameters:
|
|
- type: string
|
|
description: proposal id
|
|
name: proposalId
|
|
required: true
|
|
in: path
|
|
x-example: '2'
|
|
- type: string
|
|
description: Bech32 voter address
|
|
name: voter
|
|
required: true
|
|
in: path
|
|
x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
voter:
|
|
type: string
|
|
proposal_id:
|
|
type: string
|
|
option:
|
|
type: string
|
|
'400':
|
|
description: Invalid proposal id or voter address
|
|
'404':
|
|
description: Found no vote
|
|
'500':
|
|
description: Internal Server Error
|
|
/gov/proposals/{proposalId}/tally:
|
|
get:
|
|
deprecated: true
|
|
summary: Get a proposal's tally result at the current time
|
|
description: >-
|
|
Gets a proposal's tally result at the current time. If the proposal is
|
|
pending deposits (i.e status 'DepositPeriod') it returns an empty tally
|
|
result.
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Governance
|
|
parameters:
|
|
- type: string
|
|
description: proposal id
|
|
name: proposalId
|
|
required: true
|
|
in: path
|
|
x-example: '2'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
'yes':
|
|
type: string
|
|
example: '0.0000000000'
|
|
abstain:
|
|
type: string
|
|
example: '0.0000000000'
|
|
'no':
|
|
type: string
|
|
example: '0.0000000000'
|
|
no_with_veto:
|
|
type: string
|
|
example: '0.0000000000'
|
|
'400':
|
|
description: Invalid proposal id
|
|
'500':
|
|
description: Internal Server Error
|
|
/gov/parameters/deposit:
|
|
get:
|
|
deprecated: true
|
|
summary: Query governance deposit parameters
|
|
description: >-
|
|
Query governance deposit parameters. The max_deposit_period units are in
|
|
nanoseconds.
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Governance
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
min_deposit:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
max_deposit_period:
|
|
type: string
|
|
example: '86400000000000'
|
|
'400':
|
|
description: <other_path> is not a valid query request path
|
|
'404':
|
|
description: Found no deposit parameters
|
|
'500':
|
|
description: Internal Server Error
|
|
/gov/parameters/tallying:
|
|
get:
|
|
deprecated: true
|
|
summary: Query governance tally parameters
|
|
description: Query governance tally parameters
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Governance
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
properties:
|
|
threshold:
|
|
type: string
|
|
example: '0.5000000000'
|
|
veto:
|
|
type: string
|
|
example: '0.3340000000'
|
|
governance_penalty:
|
|
type: string
|
|
example: '0.0100000000'
|
|
'400':
|
|
description: <other_path> is not a valid query request path
|
|
'404':
|
|
description: Found no tally parameters
|
|
'500':
|
|
description: Internal Server Error
|
|
/gov/parameters/voting:
|
|
get:
|
|
deprecated: true
|
|
summary: Query governance voting parameters
|
|
description: >-
|
|
Query governance voting parameters. The voting_period units are in
|
|
nanoseconds.
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Governance
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
properties:
|
|
voting_period:
|
|
type: string
|
|
example: '86400000000000'
|
|
'400':
|
|
description: <other_path> is not a valid query request path
|
|
'404':
|
|
description: Found no voting parameters
|
|
'500':
|
|
description: Internal Server Error
|
|
/distribution/delegators/{delegatorAddr}/rewards:
|
|
parameters:
|
|
- in: path
|
|
name: delegatorAddr
|
|
description: Bech32 AccAddress of Delegator
|
|
required: true
|
|
type: string
|
|
x-example: cosmos167w96tdvmazakdwkw2u57227eduula2cy572lf
|
|
get:
|
|
deprecated: true
|
|
summary: Get the total rewards balance from all delegations
|
|
description: >-
|
|
Get the sum of all the rewards earned by delegations by a single
|
|
delegator
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Distribution
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
rewards:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
validator_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
reward:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
total:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
'400':
|
|
description: Invalid delegator address
|
|
'500':
|
|
description: Internal Server Error
|
|
post:
|
|
deprecated: true
|
|
summary: Withdraw all the delegator's delegation rewards
|
|
description: Withdraw all the delegator's delegation rewards
|
|
tags:
|
|
- Distribution
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: Withdraw request body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: cosmos1g9ahr6xhht5rmqven628nklxluzyv8z9jqjcmc
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: Sent via Cosmos Voyager 🚀
|
|
chain_id:
|
|
type: string
|
|
example: Cosmos-Hub
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '1'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.2'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
'400':
|
|
description: Invalid delegator address
|
|
'401':
|
|
description: Key password is wrong
|
|
'500':
|
|
description: Internal Server Error
|
|
/distribution/delegators/{delegatorAddr}/rewards/{validatorAddr}:
|
|
parameters:
|
|
- in: path
|
|
name: delegatorAddr
|
|
description: Bech32 AccAddress of Delegator
|
|
required: true
|
|
type: string
|
|
x-example: cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv
|
|
- in: path
|
|
name: validatorAddr
|
|
description: Bech32 OperatorAddress of validator
|
|
required: true
|
|
type: string
|
|
x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
get:
|
|
deprecated: true
|
|
summary: Query a delegation reward
|
|
description: Query a single delegation reward by a delegator
|
|
tags:
|
|
- Distribution
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
'400':
|
|
description: Invalid delegator address
|
|
'500':
|
|
description: Internal Server Error
|
|
post:
|
|
deprecated: true
|
|
summary: Withdraw a delegation reward
|
|
description: Withdraw a delegator's delegation reward from a single validator
|
|
tags:
|
|
- Distribution
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: Withdraw request body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: cosmos1g9ahr6xhht5rmqven628nklxluzyv8z9jqjcmc
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: Sent via Cosmos Voyager 🚀
|
|
chain_id:
|
|
type: string
|
|
example: Cosmos-Hub
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '1'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.2'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
'400':
|
|
description: Invalid delegator address or delegation body
|
|
'401':
|
|
description: Key password is wrong
|
|
'500':
|
|
description: Internal Server Error
|
|
/distribution/delegators/{delegatorAddr}/withdraw_address:
|
|
parameters:
|
|
- in: path
|
|
name: delegatorAddr
|
|
description: Bech32 AccAddress of Delegator
|
|
required: true
|
|
type: string
|
|
x-example: cosmos167w96tdvmazakdwkw2u57227eduula2cy572lf
|
|
get:
|
|
deprecated: true
|
|
summary: Get the rewards withdrawal address
|
|
description: >-
|
|
Get the delegations' rewards withdrawal address. This is the address in
|
|
which the user will receive the reward funds
|
|
tags:
|
|
- Distribution
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
'400':
|
|
description: Invalid delegator address
|
|
'500':
|
|
description: Internal Server Error
|
|
post:
|
|
deprecated: true
|
|
summary: Replace the rewards withdrawal address
|
|
description: Replace the delegations' rewards withdrawal address for a new one.
|
|
tags:
|
|
- Distribution
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: Withdraw request body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: cosmos1g9ahr6xhht5rmqven628nklxluzyv8z9jqjcmc
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: Sent via Cosmos Voyager 🚀
|
|
chain_id:
|
|
type: string
|
|
example: Cosmos-Hub
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '1'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.2'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
withdraw_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
'400':
|
|
description: Invalid delegator or withdraw address
|
|
'401':
|
|
description: Key password is wrong
|
|
'500':
|
|
description: Internal Server Error
|
|
/distribution/validators/{validatorAddr}:
|
|
parameters:
|
|
- in: path
|
|
name: validatorAddr
|
|
description: Bech32 OperatorAddress of validator
|
|
required: true
|
|
type: string
|
|
x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
get:
|
|
deprecated: true
|
|
summary: Validator distribution information
|
|
description: Query the distribution information of a single validator
|
|
tags:
|
|
- Distribution
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
operator_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
self_bond_rewards:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
val_commission:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
'400':
|
|
description: Invalid validator address
|
|
'500':
|
|
description: Internal Server Error
|
|
/distribution/validators/{validatorAddr}/outstanding_rewards:
|
|
parameters:
|
|
- in: path
|
|
name: validatorAddr
|
|
description: Bech32 OperatorAddress of validator
|
|
required: true
|
|
type: string
|
|
x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
get:
|
|
deprecated: true
|
|
summary: Fee distribution outstanding rewards of a single validator
|
|
tags:
|
|
- Distribution
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
'500':
|
|
description: Internal Server Error
|
|
/distribution/validators/{validatorAddr}/rewards:
|
|
parameters:
|
|
- in: path
|
|
name: validatorAddr
|
|
description: Bech32 OperatorAddress of validator
|
|
required: true
|
|
type: string
|
|
x-example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
get:
|
|
deprecated: true
|
|
summary: Commission and self-delegation rewards of a single validator
|
|
description: Query the commission and self-delegation rewards of validator.
|
|
tags:
|
|
- Distribution
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
'400':
|
|
description: Invalid validator address
|
|
'500':
|
|
description: Internal Server Error
|
|
post:
|
|
deprecated: true
|
|
summary: Withdraw the validator's rewards
|
|
description: Withdraw the validator's self-delegation and commissions rewards
|
|
tags:
|
|
- Distribution
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: Withdraw request body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: cosmos1g9ahr6xhht5rmqven628nklxluzyv8z9jqjcmc
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: Sent via Cosmos Voyager 🚀
|
|
chain_id:
|
|
type: string
|
|
example: Cosmos-Hub
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '1'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.2'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
'400':
|
|
description: Invalid validator address
|
|
'401':
|
|
description: Key password is wrong
|
|
'500':
|
|
description: Internal Server Error
|
|
/distribution/community_pool:
|
|
get:
|
|
deprecated: true
|
|
summary: Community pool parameters
|
|
tags:
|
|
- Distribution
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
'500':
|
|
description: Internal Server Error
|
|
/distribution/parameters:
|
|
get:
|
|
deprecated: true
|
|
summary: Fee distribution parameters
|
|
tags:
|
|
- Distribution
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
properties:
|
|
base_proposer_reward:
|
|
type: string
|
|
bonus_proposer_reward:
|
|
type: string
|
|
community_tax:
|
|
type: string
|
|
'500':
|
|
description: Internal Server Error
|
|
/minting/parameters:
|
|
get:
|
|
deprecated: true
|
|
summary: Minting module parameters
|
|
tags:
|
|
- Mint
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
properties:
|
|
mint_denom:
|
|
type: string
|
|
inflation_rate_change:
|
|
type: string
|
|
inflation_max:
|
|
type: string
|
|
inflation_min:
|
|
type: string
|
|
goal_bonded:
|
|
type: string
|
|
blocks_per_year:
|
|
type: string
|
|
'500':
|
|
description: Internal Server Error
|
|
/minting/inflation:
|
|
get:
|
|
deprecated: true
|
|
summary: Current minting inflation value
|
|
tags:
|
|
- Mint
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: string
|
|
'500':
|
|
description: Internal Server Error
|
|
/minting/annual-provisions:
|
|
get:
|
|
deprecated: true
|
|
summary: Current minting annual provisions value
|
|
tags:
|
|
- Mint
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: string
|
|
'500':
|
|
description: Internal Server Error
|
|
/cosmos/auth/v1beta1/accounts:
|
|
get:
|
|
summary: Accounts returns all the existing accounts
|
|
operationId: Accounts
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
accounts:
|
|
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"
|
|
}
|
|
title: accounts are the existing accounts
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryAccountsResponse is the response type for the Query/Accounts
|
|
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: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/auth/v1beta1/accounts/{address}:
|
|
get:
|
|
summary: Account returns account details based on address.
|
|
operationId: Account
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
account:
|
|
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"
|
|
}
|
|
description: >-
|
|
QueryAccountResponse is the response type for the Query/Account
|
|
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: address
|
|
description: address defines the address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/auth/v1beta1/params:
|
|
get:
|
|
summary: Params queries all parameters.
|
|
operationId: AuthParams
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
params:
|
|
description: params defines the parameters of the module.
|
|
type: object
|
|
properties:
|
|
max_memo_characters:
|
|
type: string
|
|
format: uint64
|
|
tx_sig_limit:
|
|
type: string
|
|
format: uint64
|
|
tx_size_cost_per_byte:
|
|
type: string
|
|
format: uint64
|
|
sig_verify_cost_ed25519:
|
|
type: string
|
|
format: uint64
|
|
sig_verify_cost_secp256k1:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
QueryParamsResponse is the response type for the Query/Params 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"
|
|
}
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/bank/v1beta1/balances/{address}:
|
|
get:
|
|
summary: AllBalances queries the balance of all coins for a single account.
|
|
operationId: AllBalances
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
balances:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
description: balances is the balances of all the coins.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryAllBalancesResponse is the response type for the
|
|
Query/AllBalances 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: address
|
|
description: address is the address to query balances for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/bank/v1beta1/balances/{address}/{denom}:
|
|
get:
|
|
summary: Balance queries the balance of a single coin for a single account.
|
|
operationId: Balance
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
balance:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
QueryBalanceResponse is the response type for the Query/Balance
|
|
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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: address
|
|
description: address is the address to query balances for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: denom
|
|
description: denom is the coin denom to query balances for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/bank/v1beta1/denom_owners/{denom}:
|
|
get:
|
|
summary: >-
|
|
DenomOwners queries for all account addresses that own a particular
|
|
token
|
|
|
|
denomination.
|
|
operationId: DenomOwners
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
denom_owners:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
description: >-
|
|
address defines the address that owns a particular
|
|
denomination.
|
|
balance:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
DenomOwner defines structure representing an account that
|
|
owns or holds a
|
|
|
|
particular denominated token. It contains the account
|
|
address and account
|
|
|
|
balance of the denominated token.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryDenomOwnersResponse defines the RPC response of a DenomOwners
|
|
RPC query.
|
|
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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: denom
|
|
description: >-
|
|
denom defines the coin denomination to query all account holders
|
|
for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/bank/v1beta1/denoms_metadata:
|
|
get:
|
|
summary: |-
|
|
DenomsMetadata queries the client metadata for all registered coin
|
|
denominations.
|
|
operationId: DenomsMetadata
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
metadatas:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
description:
|
|
type: string
|
|
denom_units:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
description: >-
|
|
denom represents the string name of the given
|
|
denom unit (e.g uatom).
|
|
exponent:
|
|
type: integer
|
|
format: int64
|
|
description: >-
|
|
exponent represents power of 10 exponent that one
|
|
must
|
|
|
|
raise the base_denom to in order to equal the
|
|
given DenomUnit's denom
|
|
|
|
1 denom = 1^exponent base_denom
|
|
|
|
(e.g. with a base_denom of uatom, one can create a
|
|
DenomUnit of 'atom' with
|
|
|
|
exponent = 6, thus: 1 atom = 10^6 uatom).
|
|
aliases:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: >-
|
|
aliases is a list of string aliases for the given
|
|
denom
|
|
description: |-
|
|
DenomUnit represents a struct that describes a given
|
|
denomination unit of the basic token.
|
|
title: >-
|
|
denom_units represents the list of DenomUnit's for a
|
|
given coin
|
|
base:
|
|
type: string
|
|
description: >-
|
|
base represents the base denom (should be the DenomUnit
|
|
with exponent = 0).
|
|
display:
|
|
type: string
|
|
description: |-
|
|
display indicates the suggested denom that should be
|
|
displayed in clients.
|
|
name:
|
|
type: string
|
|
title: 'name defines the name of the token (eg: Cosmos Atom)'
|
|
symbol:
|
|
type: string
|
|
description: >-
|
|
symbol is the token symbol usually shown on exchanges
|
|
(eg: ATOM). This can
|
|
|
|
be the same as the display.
|
|
uri:
|
|
type: string
|
|
description: >-
|
|
URI to a document (on or off-chain) that contains
|
|
additional information. Optional.
|
|
uri_hash:
|
|
type: string
|
|
description: >-
|
|
URIHash is a sha256 hash of a document pointed by URI.
|
|
It's used to verify that
|
|
|
|
the document didn't change. Optional.
|
|
description: |-
|
|
Metadata represents a struct that describes
|
|
a basic token.
|
|
description: >-
|
|
metadata provides the client information for all the
|
|
registered tokens.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryDenomsMetadataResponse is the response type for the
|
|
Query/DenomsMetadata 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/bank/v1beta1/denoms_metadata/{denom}:
|
|
get:
|
|
summary: DenomsMetadata queries the client metadata of a given coin denomination.
|
|
operationId: DenomMetadata
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
metadata:
|
|
type: object
|
|
properties:
|
|
description:
|
|
type: string
|
|
denom_units:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
description: >-
|
|
denom represents the string name of the given denom
|
|
unit (e.g uatom).
|
|
exponent:
|
|
type: integer
|
|
format: int64
|
|
description: >-
|
|
exponent represents power of 10 exponent that one
|
|
must
|
|
|
|
raise the base_denom to in order to equal the given
|
|
DenomUnit's denom
|
|
|
|
1 denom = 1^exponent base_denom
|
|
|
|
(e.g. with a base_denom of uatom, one can create a
|
|
DenomUnit of 'atom' with
|
|
|
|
exponent = 6, thus: 1 atom = 10^6 uatom).
|
|
aliases:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: >-
|
|
aliases is a list of string aliases for the given
|
|
denom
|
|
description: |-
|
|
DenomUnit represents a struct that describes a given
|
|
denomination unit of the basic token.
|
|
title: >-
|
|
denom_units represents the list of DenomUnit's for a given
|
|
coin
|
|
base:
|
|
type: string
|
|
description: >-
|
|
base represents the base denom (should be the DenomUnit
|
|
with exponent = 0).
|
|
display:
|
|
type: string
|
|
description: |-
|
|
display indicates the suggested denom that should be
|
|
displayed in clients.
|
|
name:
|
|
type: string
|
|
title: 'name defines the name of the token (eg: Cosmos Atom)'
|
|
symbol:
|
|
type: string
|
|
description: >-
|
|
symbol is the token symbol usually shown on exchanges (eg:
|
|
ATOM). This can
|
|
|
|
be the same as the display.
|
|
uri:
|
|
type: string
|
|
description: >-
|
|
URI to a document (on or off-chain) that contains
|
|
additional information. Optional.
|
|
uri_hash:
|
|
type: string
|
|
description: >-
|
|
URIHash is a sha256 hash of a document pointed by URI.
|
|
It's used to verify that
|
|
|
|
the document didn't change. Optional.
|
|
description: |-
|
|
Metadata represents a struct that describes
|
|
a basic token.
|
|
description: >-
|
|
QueryDenomMetadataResponse is the response type for the
|
|
Query/DenomMetadata 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: denom
|
|
description: denom is the coin denom to query the metadata for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/bank/v1beta1/params:
|
|
get:
|
|
summary: Params queries the parameters of x/bank module.
|
|
operationId: BankParams
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
params:
|
|
type: object
|
|
properties:
|
|
send_enabled:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
enabled:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
SendEnabled maps coin denom to a send_enabled status
|
|
(whether a denom is
|
|
|
|
sendable).
|
|
default_send_enabled:
|
|
type: boolean
|
|
format: boolean
|
|
description: Params defines the parameters for the bank module.
|
|
description: >-
|
|
QueryParamsResponse defines the response type for querying x/bank
|
|
parameters.
|
|
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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/bank/v1beta1/supply:
|
|
get:
|
|
summary: TotalSupply queries the total supply of all coins.
|
|
operationId: TotalSupply
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
supply:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
title: supply is the supply of the coins
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
title: >-
|
|
QueryTotalSupplyResponse is the response type for the
|
|
Query/TotalSupply 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/bank/v1beta1/supply/{denom}:
|
|
get:
|
|
summary: SupplyOf queries the supply of a single coin.
|
|
operationId: SupplyOf
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
amount:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
QuerySupplyOfResponse is the response type for the Query/SupplyOf
|
|
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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: denom
|
|
description: denom is the coin denom to query balances for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/base/tendermint/v1beta1/blocks/latest:
|
|
get:
|
|
summary: GetLatestBlock returns the latest block.
|
|
operationId: GetLatestBlock
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
block:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
version:
|
|
title: basic block info
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules for processing
|
|
a block in the blockchain,
|
|
|
|
including all blockchain data structures and the rules
|
|
of the application's
|
|
|
|
state transition machine.
|
|
chain_id:
|
|
type: string
|
|
height:
|
|
type: string
|
|
format: int64
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
last_commit_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes of block data
|
|
data_hash:
|
|
type: string
|
|
format: byte
|
|
validators_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes from the app output from the prev block
|
|
next_validators_hash:
|
|
type: string
|
|
format: byte
|
|
consensus_hash:
|
|
type: string
|
|
format: byte
|
|
app_hash:
|
|
type: string
|
|
format: byte
|
|
last_results_hash:
|
|
type: string
|
|
format: byte
|
|
evidence_hash:
|
|
type: string
|
|
format: byte
|
|
title: consensus info
|
|
proposer_address:
|
|
type: string
|
|
format: byte
|
|
description: Header defines the structure of a Tendermint block header.
|
|
data:
|
|
type: object
|
|
properties:
|
|
txs:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Txs that will be applied by state @ block.Height+1.
|
|
|
|
NOTE: not all txs here are valid. We're just agreeing
|
|
on the order first.
|
|
|
|
This means that block.AppHash does not include these
|
|
txs.
|
|
title: >-
|
|
Data contains the set of transactions included in the
|
|
block
|
|
evidence:
|
|
type: object
|
|
properties:
|
|
evidence:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
duplicate_vote_evidence:
|
|
type: object
|
|
properties:
|
|
vote_a:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SIGNED_MSG_TYPE_UNKNOWN
|
|
- SIGNED_MSG_TYPE_PREVOTE
|
|
- SIGNED_MSG_TYPE_PRECOMMIT
|
|
- SIGNED_MSG_TYPE_PROPOSAL
|
|
default: SIGNED_MSG_TYPE_UNKNOWN
|
|
description: >-
|
|
SignedMsgType is a type of signed
|
|
message in the consensus.
|
|
|
|
- SIGNED_MSG_TYPE_PREVOTE: Votes
|
|
- SIGNED_MSG_TYPE_PROPOSAL: Proposals
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
validator_index:
|
|
type: integer
|
|
format: int32
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Vote represents a prevote, precommit, or
|
|
commit vote from validators for
|
|
|
|
consensus.
|
|
vote_b:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SIGNED_MSG_TYPE_UNKNOWN
|
|
- SIGNED_MSG_TYPE_PREVOTE
|
|
- SIGNED_MSG_TYPE_PRECOMMIT
|
|
- SIGNED_MSG_TYPE_PROPOSAL
|
|
default: SIGNED_MSG_TYPE_UNKNOWN
|
|
description: >-
|
|
SignedMsgType is a type of signed
|
|
message in the consensus.
|
|
|
|
- SIGNED_MSG_TYPE_PREVOTE: Votes
|
|
- SIGNED_MSG_TYPE_PROPOSAL: Proposals
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
validator_index:
|
|
type: integer
|
|
format: int32
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Vote represents a prevote, precommit, or
|
|
commit vote from validators for
|
|
|
|
consensus.
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
validator_power:
|
|
type: string
|
|
format: int64
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
DuplicateVoteEvidence contains evidence of a
|
|
validator signed two conflicting votes.
|
|
light_client_attack_evidence:
|
|
type: object
|
|
properties:
|
|
conflicting_block:
|
|
type: object
|
|
properties:
|
|
signed_header:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
version:
|
|
title: basic block info
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules
|
|
for processing a block in the
|
|
blockchain,
|
|
|
|
including all blockchain data structures
|
|
and the rules of the application's
|
|
|
|
state transition machine.
|
|
chain_id:
|
|
type: string
|
|
height:
|
|
type: string
|
|
format: int64
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
last_commit_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes of block data
|
|
data_hash:
|
|
type: string
|
|
format: byte
|
|
validators_hash:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
hashes from the app output from the prev
|
|
block
|
|
next_validators_hash:
|
|
type: string
|
|
format: byte
|
|
consensus_hash:
|
|
type: string
|
|
format: byte
|
|
app_hash:
|
|
type: string
|
|
format: byte
|
|
last_results_hash:
|
|
type: string
|
|
format: byte
|
|
evidence_hash:
|
|
type: string
|
|
format: byte
|
|
title: consensus info
|
|
proposer_address:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Header defines the structure of a
|
|
Tendermint block header.
|
|
commit:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
block_id_flag:
|
|
type: string
|
|
enum:
|
|
- BLOCK_ID_FLAG_UNKNOWN
|
|
- BLOCK_ID_FLAG_ABSENT
|
|
- BLOCK_ID_FLAG_COMMIT
|
|
- BLOCK_ID_FLAG_NIL
|
|
default: BLOCK_ID_FLAG_UNKNOWN
|
|
title: >-
|
|
BlockIdFlag indicates which BlcokID the
|
|
signature is for
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
CommitSig is a part of the Vote included
|
|
in a Commit.
|
|
description: >-
|
|
Commit contains the evidence that a
|
|
block was committed by a set of
|
|
validators.
|
|
validator_set:
|
|
type: object
|
|
properties:
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for
|
|
use with Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
proposer:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for
|
|
use with Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
common_height:
|
|
type: string
|
|
format: int64
|
|
byzantine_validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for
|
|
use with Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
LightClientAttackEvidence contains evidence of a
|
|
set of validators attempting to mislead a light
|
|
client.
|
|
last_commit:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
block_id_flag:
|
|
type: string
|
|
enum:
|
|
- BLOCK_ID_FLAG_UNKNOWN
|
|
- BLOCK_ID_FLAG_ABSENT
|
|
- BLOCK_ID_FLAG_COMMIT
|
|
- BLOCK_ID_FLAG_NIL
|
|
default: BLOCK_ID_FLAG_UNKNOWN
|
|
title: >-
|
|
BlockIdFlag indicates which BlcokID the
|
|
signature is for
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
CommitSig is a part of the Vote included in a
|
|
Commit.
|
|
description: >-
|
|
Commit contains the evidence that a block was committed by
|
|
a set of validators.
|
|
description: >-
|
|
GetLatestBlockResponse is the response type for the
|
|
Query/GetLatestBlock 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"
|
|
}
|
|
tags:
|
|
- Service
|
|
/cosmos/base/tendermint/v1beta1/blocks/{height}:
|
|
get:
|
|
summary: GetBlockByHeight queries block for given height.
|
|
operationId: GetBlockByHeight
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
block:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
version:
|
|
title: basic block info
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules for processing
|
|
a block in the blockchain,
|
|
|
|
including all blockchain data structures and the rules
|
|
of the application's
|
|
|
|
state transition machine.
|
|
chain_id:
|
|
type: string
|
|
height:
|
|
type: string
|
|
format: int64
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
last_commit_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes of block data
|
|
data_hash:
|
|
type: string
|
|
format: byte
|
|
validators_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes from the app output from the prev block
|
|
next_validators_hash:
|
|
type: string
|
|
format: byte
|
|
consensus_hash:
|
|
type: string
|
|
format: byte
|
|
app_hash:
|
|
type: string
|
|
format: byte
|
|
last_results_hash:
|
|
type: string
|
|
format: byte
|
|
evidence_hash:
|
|
type: string
|
|
format: byte
|
|
title: consensus info
|
|
proposer_address:
|
|
type: string
|
|
format: byte
|
|
description: Header defines the structure of a Tendermint block header.
|
|
data:
|
|
type: object
|
|
properties:
|
|
txs:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Txs that will be applied by state @ block.Height+1.
|
|
|
|
NOTE: not all txs here are valid. We're just agreeing
|
|
on the order first.
|
|
|
|
This means that block.AppHash does not include these
|
|
txs.
|
|
title: >-
|
|
Data contains the set of transactions included in the
|
|
block
|
|
evidence:
|
|
type: object
|
|
properties:
|
|
evidence:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
duplicate_vote_evidence:
|
|
type: object
|
|
properties:
|
|
vote_a:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SIGNED_MSG_TYPE_UNKNOWN
|
|
- SIGNED_MSG_TYPE_PREVOTE
|
|
- SIGNED_MSG_TYPE_PRECOMMIT
|
|
- SIGNED_MSG_TYPE_PROPOSAL
|
|
default: SIGNED_MSG_TYPE_UNKNOWN
|
|
description: >-
|
|
SignedMsgType is a type of signed
|
|
message in the consensus.
|
|
|
|
- SIGNED_MSG_TYPE_PREVOTE: Votes
|
|
- SIGNED_MSG_TYPE_PROPOSAL: Proposals
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
validator_index:
|
|
type: integer
|
|
format: int32
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Vote represents a prevote, precommit, or
|
|
commit vote from validators for
|
|
|
|
consensus.
|
|
vote_b:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SIGNED_MSG_TYPE_UNKNOWN
|
|
- SIGNED_MSG_TYPE_PREVOTE
|
|
- SIGNED_MSG_TYPE_PRECOMMIT
|
|
- SIGNED_MSG_TYPE_PROPOSAL
|
|
default: SIGNED_MSG_TYPE_UNKNOWN
|
|
description: >-
|
|
SignedMsgType is a type of signed
|
|
message in the consensus.
|
|
|
|
- SIGNED_MSG_TYPE_PREVOTE: Votes
|
|
- SIGNED_MSG_TYPE_PROPOSAL: Proposals
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
validator_index:
|
|
type: integer
|
|
format: int32
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Vote represents a prevote, precommit, or
|
|
commit vote from validators for
|
|
|
|
consensus.
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
validator_power:
|
|
type: string
|
|
format: int64
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
DuplicateVoteEvidence contains evidence of a
|
|
validator signed two conflicting votes.
|
|
light_client_attack_evidence:
|
|
type: object
|
|
properties:
|
|
conflicting_block:
|
|
type: object
|
|
properties:
|
|
signed_header:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
version:
|
|
title: basic block info
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules
|
|
for processing a block in the
|
|
blockchain,
|
|
|
|
including all blockchain data structures
|
|
and the rules of the application's
|
|
|
|
state transition machine.
|
|
chain_id:
|
|
type: string
|
|
height:
|
|
type: string
|
|
format: int64
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
last_commit_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes of block data
|
|
data_hash:
|
|
type: string
|
|
format: byte
|
|
validators_hash:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
hashes from the app output from the prev
|
|
block
|
|
next_validators_hash:
|
|
type: string
|
|
format: byte
|
|
consensus_hash:
|
|
type: string
|
|
format: byte
|
|
app_hash:
|
|
type: string
|
|
format: byte
|
|
last_results_hash:
|
|
type: string
|
|
format: byte
|
|
evidence_hash:
|
|
type: string
|
|
format: byte
|
|
title: consensus info
|
|
proposer_address:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Header defines the structure of a
|
|
Tendermint block header.
|
|
commit:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
block_id_flag:
|
|
type: string
|
|
enum:
|
|
- BLOCK_ID_FLAG_UNKNOWN
|
|
- BLOCK_ID_FLAG_ABSENT
|
|
- BLOCK_ID_FLAG_COMMIT
|
|
- BLOCK_ID_FLAG_NIL
|
|
default: BLOCK_ID_FLAG_UNKNOWN
|
|
title: >-
|
|
BlockIdFlag indicates which BlcokID the
|
|
signature is for
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
CommitSig is a part of the Vote included
|
|
in a Commit.
|
|
description: >-
|
|
Commit contains the evidence that a
|
|
block was committed by a set of
|
|
validators.
|
|
validator_set:
|
|
type: object
|
|
properties:
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for
|
|
use with Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
proposer:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for
|
|
use with Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
common_height:
|
|
type: string
|
|
format: int64
|
|
byzantine_validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for
|
|
use with Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
LightClientAttackEvidence contains evidence of a
|
|
set of validators attempting to mislead a light
|
|
client.
|
|
last_commit:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
block_id_flag:
|
|
type: string
|
|
enum:
|
|
- BLOCK_ID_FLAG_UNKNOWN
|
|
- BLOCK_ID_FLAG_ABSENT
|
|
- BLOCK_ID_FLAG_COMMIT
|
|
- BLOCK_ID_FLAG_NIL
|
|
default: BLOCK_ID_FLAG_UNKNOWN
|
|
title: >-
|
|
BlockIdFlag indicates which BlcokID the
|
|
signature is for
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
CommitSig is a part of the Vote included in a
|
|
Commit.
|
|
description: >-
|
|
Commit contains the evidence that a block was committed by
|
|
a set of validators.
|
|
description: >-
|
|
GetBlockByHeightResponse is the response type for the
|
|
Query/GetBlockByHeight 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: height
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: int64
|
|
tags:
|
|
- Service
|
|
/cosmos/base/tendermint/v1beta1/node_info:
|
|
get:
|
|
summary: GetNodeInfo queries the current node info.
|
|
operationId: GetNodeInfo
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
default_node_info:
|
|
type: object
|
|
properties:
|
|
protocol_version:
|
|
type: object
|
|
properties:
|
|
p2p:
|
|
type: string
|
|
format: uint64
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
default_node_id:
|
|
type: string
|
|
listen_addr:
|
|
type: string
|
|
network:
|
|
type: string
|
|
version:
|
|
type: string
|
|
channels:
|
|
type: string
|
|
format: byte
|
|
moniker:
|
|
type: string
|
|
other:
|
|
type: object
|
|
properties:
|
|
tx_index:
|
|
type: string
|
|
rpc_address:
|
|
type: string
|
|
application_version:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
app_name:
|
|
type: string
|
|
version:
|
|
type: string
|
|
git_commit:
|
|
type: string
|
|
build_tags:
|
|
type: string
|
|
go_version:
|
|
type: string
|
|
build_deps:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
title: module path
|
|
version:
|
|
type: string
|
|
title: module version
|
|
sum:
|
|
type: string
|
|
title: checksum
|
|
title: Module is the type for VersionInfo
|
|
cosmos_sdk_version:
|
|
type: string
|
|
description: VersionInfo is the type for the GetNodeInfoResponse message.
|
|
description: >-
|
|
GetNodeInfoResponse is the request type for the Query/GetNodeInfo
|
|
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"
|
|
}
|
|
tags:
|
|
- Service
|
|
/cosmos/base/tendermint/v1beta1/syncing:
|
|
get:
|
|
summary: GetSyncing queries node syncing.
|
|
operationId: GetSyncing
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
syncing:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
GetSyncingResponse is the response type for the Query/GetSyncing
|
|
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"
|
|
}
|
|
tags:
|
|
- Service
|
|
/cosmos/base/tendermint/v1beta1/validatorsets/latest:
|
|
get:
|
|
summary: GetLatestValidatorSet queries latest validator-set.
|
|
operationId: GetLatestValidatorSet
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
block_height:
|
|
type: string
|
|
format: int64
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
pub_key:
|
|
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"
|
|
}
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
description: Validator is the type for the validator-set.
|
|
pagination:
|
|
description: pagination defines an pagination for the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
GetLatestValidatorSetResponse is the response type for the
|
|
Query/GetValidatorSetByHeight 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: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Service
|
|
/cosmos/base/tendermint/v1beta1/validatorsets/{height}:
|
|
get:
|
|
summary: GetValidatorSetByHeight queries validator-set at a given height.
|
|
operationId: GetValidatorSetByHeight
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
block_height:
|
|
type: string
|
|
format: int64
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
pub_key:
|
|
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"
|
|
}
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
description: Validator is the type for the validator-set.
|
|
pagination:
|
|
description: pagination defines an pagination for the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
GetValidatorSetByHeightResponse is the response type for the
|
|
Query/GetValidatorSetByHeight 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: height
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: int64
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Service
|
|
/cosmos/distribution/v1beta1/community_pool:
|
|
get:
|
|
summary: CommunityPool queries the community pool coins.
|
|
operationId: CommunityPool
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
pool:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
DecCoin defines a token with a denomination and a decimal
|
|
amount.
|
|
|
|
|
|
NOTE: The amount field is an Dec which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
description: pool defines community pool's coins.
|
|
description: >-
|
|
QueryCommunityPoolResponse is the response type for the
|
|
Query/CommunityPool
|
|
|
|
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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/distribution/v1beta1/delegators/{delegator_address}/rewards:
|
|
get:
|
|
summary: |-
|
|
DelegationTotalRewards queries the total rewards accrued by a each
|
|
validator.
|
|
operationId: DelegationTotalRewards
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
rewards:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
validator_address:
|
|
type: string
|
|
reward:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
DecCoin defines a token with a denomination and a
|
|
decimal amount.
|
|
|
|
|
|
NOTE: The amount field is an Dec which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
description: |-
|
|
DelegationDelegatorReward represents the properties
|
|
of a delegator's delegation reward.
|
|
description: rewards defines all the rewards accrued by a delegator.
|
|
total:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
DecCoin defines a token with a denomination and a decimal
|
|
amount.
|
|
|
|
|
|
NOTE: The amount field is an Dec which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
description: total defines the sum of all the rewards.
|
|
description: |-
|
|
QueryDelegationTotalRewardsResponse is the response type for the
|
|
Query/DelegationTotalRewards 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: delegator_address
|
|
description: delegator_address defines the delegator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/distribution/v1beta1/delegators/{delegator_address}/rewards/{validator_address}:
|
|
get:
|
|
summary: DelegationRewards queries the total rewards accrued by a delegation.
|
|
operationId: DelegationRewards
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
rewards:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
DecCoin defines a token with a denomination and a decimal
|
|
amount.
|
|
|
|
|
|
NOTE: The amount field is an Dec which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
description: rewards defines the rewards accrued by a delegation.
|
|
description: |-
|
|
QueryDelegationRewardsResponse is the response type for the
|
|
Query/DelegationRewards 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: delegator_address
|
|
description: delegator_address defines the delegator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: validator_address
|
|
description: validator_address defines the validator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/distribution/v1beta1/delegators/{delegator_address}/validators:
|
|
get:
|
|
summary: DelegatorValidators queries the validators of a delegator.
|
|
operationId: DelegatorValidators
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: >-
|
|
validators defines the validators a delegator is delegating
|
|
for.
|
|
description: |-
|
|
QueryDelegatorValidatorsResponse is the response type for the
|
|
Query/DelegatorValidators 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: delegator_address
|
|
description: delegator_address defines the delegator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/distribution/v1beta1/delegators/{delegator_address}/withdraw_address:
|
|
get:
|
|
summary: DelegatorWithdrawAddress queries withdraw address of a delegator.
|
|
operationId: DelegatorWithdrawAddress
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
withdraw_address:
|
|
type: string
|
|
description: withdraw_address defines the delegator address to query for.
|
|
description: |-
|
|
QueryDelegatorWithdrawAddressResponse is the response type for the
|
|
Query/DelegatorWithdrawAddress 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: delegator_address
|
|
description: delegator_address defines the delegator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/distribution/v1beta1/params:
|
|
get:
|
|
summary: Params queries params of the distribution module.
|
|
operationId: DistributionParams
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
params:
|
|
description: params defines the parameters of the module.
|
|
type: object
|
|
properties:
|
|
community_tax:
|
|
type: string
|
|
base_proposer_reward:
|
|
type: string
|
|
bonus_proposer_reward:
|
|
type: string
|
|
withdraw_addr_enabled:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
QueryParamsResponse is the response type for the Query/Params 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/distribution/v1beta1/validators/{validator_address}/commission:
|
|
get:
|
|
summary: ValidatorCommission queries accumulated commission for a validator.
|
|
operationId: ValidatorCommission
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
commission:
|
|
description: commission defines the commision the validator received.
|
|
type: object
|
|
properties:
|
|
commission:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
DecCoin defines a token with a denomination and a
|
|
decimal amount.
|
|
|
|
|
|
NOTE: The amount field is an Dec which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
title: |-
|
|
QueryValidatorCommissionResponse is the response type for the
|
|
Query/ValidatorCommission 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: validator_address
|
|
description: validator_address defines the validator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/distribution/v1beta1/validators/{validator_address}/outstanding_rewards:
|
|
get:
|
|
summary: ValidatorOutstandingRewards queries rewards of a validator address.
|
|
operationId: ValidatorOutstandingRewards
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
rewards:
|
|
type: object
|
|
properties:
|
|
rewards:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
DecCoin defines a token with a denomination and a
|
|
decimal amount.
|
|
|
|
|
|
NOTE: The amount field is an Dec which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
ValidatorOutstandingRewards represents outstanding
|
|
(un-withdrawn) rewards
|
|
|
|
for a validator inexpensive to track, allows simple sanity
|
|
checks.
|
|
description: >-
|
|
QueryValidatorOutstandingRewardsResponse is the response type for
|
|
the
|
|
|
|
Query/ValidatorOutstandingRewards 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: validator_address
|
|
description: validator_address defines the validator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/distribution/v1beta1/validators/{validator_address}/slashes:
|
|
get:
|
|
summary: ValidatorSlashes queries slash events of a validator.
|
|
operationId: ValidatorSlashes
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
slashes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
validator_period:
|
|
type: string
|
|
format: uint64
|
|
fraction:
|
|
type: string
|
|
description: >-
|
|
ValidatorSlashEvent represents a validator slash event.
|
|
|
|
Height is implicit within the store key.
|
|
|
|
This is needed to calculate appropriate amount of staking
|
|
tokens
|
|
|
|
for delegations which are withdrawn after a slash has
|
|
occurred.
|
|
description: slashes defines the slashes the validator received.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
QueryValidatorSlashesResponse is the response type for the
|
|
Query/ValidatorSlashes 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: validator_address
|
|
description: validator_address defines the validator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: starting_height
|
|
description: >-
|
|
starting_height defines the optional starting height to query the
|
|
slashes.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: ending_height
|
|
description: >-
|
|
starting_height defines the optional ending height to query the
|
|
slashes.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/evidence/v1beta1/evidence:
|
|
get:
|
|
summary: AllEvidence queries all evidence.
|
|
operationId: AllEvidence
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
evidence:
|
|
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"
|
|
}
|
|
description: evidence returns all evidences.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryAllEvidenceResponse is the response type for the
|
|
Query/AllEvidence 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: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/evidence/v1beta1/evidence/{evidence_hash}:
|
|
get:
|
|
summary: Evidence queries evidence based on evidence hash.
|
|
operationId: Evidence
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
evidence:
|
|
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"
|
|
}
|
|
description: >-
|
|
QueryEvidenceResponse is the response type for the Query/Evidence
|
|
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: evidence_hash
|
|
description: evidence_hash defines the hash of the requested evidence.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: byte
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/gov/v1beta1/params/{params_type}:
|
|
get:
|
|
summary: Params queries all parameters of the gov module.
|
|
operationId: GovParams
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
voting_params:
|
|
description: voting_params defines the parameters related to voting.
|
|
type: object
|
|
properties:
|
|
voting_period:
|
|
type: string
|
|
description: Length of the voting period.
|
|
deposit_params:
|
|
description: deposit_params defines the parameters related to deposit.
|
|
type: object
|
|
properties:
|
|
min_deposit:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
description: Minimum deposit for a proposal to enter voting period.
|
|
max_deposit_period:
|
|
type: string
|
|
description: >-
|
|
Maximum period for Atom holders to deposit on a proposal.
|
|
Initial value: 2
|
|
months.
|
|
tally_params:
|
|
description: tally_params defines the parameters related to tally.
|
|
type: object
|
|
properties:
|
|
quorum:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Minimum percentage of total stake needed to vote for a
|
|
result to be
|
|
considered valid.
|
|
threshold:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Minimum proportion of Yes votes for proposal to pass.
|
|
Default value: 0.5.
|
|
veto_threshold:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Minimum value of Veto votes to Total votes ratio for
|
|
proposal to be
|
|
vetoed. Default value: 1/3.
|
|
description: >-
|
|
QueryParamsResponse is the response type for the Query/Params 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: params_type
|
|
description: >-
|
|
params_type defines which parameters to query for, can be one of
|
|
"voting",
|
|
|
|
"tallying" or "deposit".
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/gov/v1beta1/proposals:
|
|
get:
|
|
summary: Proposals queries all proposals based on given status.
|
|
operationId: Proposals
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
proposals:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
content:
|
|
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"
|
|
}
|
|
status:
|
|
type: string
|
|
enum:
|
|
- PROPOSAL_STATUS_UNSPECIFIED
|
|
- PROPOSAL_STATUS_DEPOSIT_PERIOD
|
|
- PROPOSAL_STATUS_VOTING_PERIOD
|
|
- PROPOSAL_STATUS_PASSED
|
|
- PROPOSAL_STATUS_REJECTED
|
|
- PROPOSAL_STATUS_FAILED
|
|
default: PROPOSAL_STATUS_UNSPECIFIED
|
|
description: >-
|
|
ProposalStatus enumerates the valid statuses of a
|
|
proposal.
|
|
|
|
- PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default propopsal status.
|
|
- PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit
|
|
period.
|
|
- PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting
|
|
period.
|
|
- PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has
|
|
passed.
|
|
- PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has
|
|
been rejected.
|
|
- PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has
|
|
failed.
|
|
final_tally_result:
|
|
type: object
|
|
properties:
|
|
'yes':
|
|
type: string
|
|
abstain:
|
|
type: string
|
|
'no':
|
|
type: string
|
|
no_with_veto:
|
|
type: string
|
|
description: >-
|
|
TallyResult defines a standard tally for a governance
|
|
proposal.
|
|
submit_time:
|
|
type: string
|
|
format: date-time
|
|
deposit_end_time:
|
|
type: string
|
|
format: date-time
|
|
total_deposit:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an
|
|
amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
voting_start_time:
|
|
type: string
|
|
format: date-time
|
|
voting_end_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
Proposal defines the core field members of a governance
|
|
proposal.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryProposalsResponse is the response type for the
|
|
Query/Proposals 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: proposal_status
|
|
description: |-
|
|
proposal_status defines the status of the proposals.
|
|
|
|
- PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default propopsal status.
|
|
- PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit
|
|
period.
|
|
- PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting
|
|
period.
|
|
- PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has
|
|
passed.
|
|
- PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has
|
|
been rejected.
|
|
- PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has
|
|
failed.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
enum:
|
|
- PROPOSAL_STATUS_UNSPECIFIED
|
|
- PROPOSAL_STATUS_DEPOSIT_PERIOD
|
|
- PROPOSAL_STATUS_VOTING_PERIOD
|
|
- PROPOSAL_STATUS_PASSED
|
|
- PROPOSAL_STATUS_REJECTED
|
|
- PROPOSAL_STATUS_FAILED
|
|
default: PROPOSAL_STATUS_UNSPECIFIED
|
|
- name: voter
|
|
description: voter defines the voter address for the proposals.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: depositor
|
|
description: depositor defines the deposit addresses from the proposals.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/gov/v1beta1/proposals/{proposal_id}:
|
|
get:
|
|
summary: Proposal queries proposal details based on ProposalID.
|
|
operationId: Proposal
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
proposal:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
content:
|
|
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"
|
|
}
|
|
status:
|
|
type: string
|
|
enum:
|
|
- PROPOSAL_STATUS_UNSPECIFIED
|
|
- PROPOSAL_STATUS_DEPOSIT_PERIOD
|
|
- PROPOSAL_STATUS_VOTING_PERIOD
|
|
- PROPOSAL_STATUS_PASSED
|
|
- PROPOSAL_STATUS_REJECTED
|
|
- PROPOSAL_STATUS_FAILED
|
|
default: PROPOSAL_STATUS_UNSPECIFIED
|
|
description: >-
|
|
ProposalStatus enumerates the valid statuses of a
|
|
proposal.
|
|
|
|
- PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default propopsal status.
|
|
- PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit
|
|
period.
|
|
- PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting
|
|
period.
|
|
- PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has
|
|
passed.
|
|
- PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has
|
|
been rejected.
|
|
- PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has
|
|
failed.
|
|
final_tally_result:
|
|
type: object
|
|
properties:
|
|
'yes':
|
|
type: string
|
|
abstain:
|
|
type: string
|
|
'no':
|
|
type: string
|
|
no_with_veto:
|
|
type: string
|
|
description: >-
|
|
TallyResult defines a standard tally for a governance
|
|
proposal.
|
|
submit_time:
|
|
type: string
|
|
format: date-time
|
|
deposit_end_time:
|
|
type: string
|
|
format: date-time
|
|
total_deposit:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
voting_start_time:
|
|
type: string
|
|
format: date-time
|
|
voting_end_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
Proposal defines the core field members of a governance
|
|
proposal.
|
|
description: >-
|
|
QueryProposalResponse is the response type for the Query/Proposal
|
|
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: proposal_id
|
|
description: proposal_id defines the unique id of the proposal.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/gov/v1beta1/proposals/{proposal_id}/deposits:
|
|
get:
|
|
summary: Deposits queries all deposits of a single proposal.
|
|
operationId: Deposits
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
deposits:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
depositor:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an
|
|
amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
Deposit defines an amount deposited by an account address to
|
|
an active
|
|
|
|
proposal.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryDepositsResponse is the response type for the Query/Deposits
|
|
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: proposal_id
|
|
description: proposal_id defines the unique id of the proposal.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/gov/v1beta1/proposals/{proposal_id}/deposits/{depositor}:
|
|
get:
|
|
summary: >-
|
|
Deposit queries single deposit information based proposalID,
|
|
depositAddr.
|
|
operationId: Deposit
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
deposit:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
depositor:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
Deposit defines an amount deposited by an account address to
|
|
an active
|
|
|
|
proposal.
|
|
description: >-
|
|
QueryDepositResponse is the response type for the Query/Deposit
|
|
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: proposal_id
|
|
description: proposal_id defines the unique id of the proposal.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
- name: depositor
|
|
description: depositor defines the deposit addresses from the proposals.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/gov/v1beta1/proposals/{proposal_id}/tally:
|
|
get:
|
|
summary: TallyResult queries the tally of a proposal vote.
|
|
operationId: TallyResult
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
tally:
|
|
type: object
|
|
properties:
|
|
'yes':
|
|
type: string
|
|
abstain:
|
|
type: string
|
|
'no':
|
|
type: string
|
|
no_with_veto:
|
|
type: string
|
|
description: >-
|
|
TallyResult defines a standard tally for a governance
|
|
proposal.
|
|
description: >-
|
|
QueryTallyResultResponse is the response type for the Query/Tally
|
|
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: proposal_id
|
|
description: proposal_id defines the unique id of the proposal.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/gov/v1beta1/proposals/{proposal_id}/votes:
|
|
get:
|
|
summary: Votes queries votes of a given proposal.
|
|
operationId: Votes
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
votes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
voter:
|
|
type: string
|
|
option:
|
|
description: >-
|
|
Deprecated: Prefer to use `options` instead. This field
|
|
is set in queries
|
|
|
|
if and only if `len(options) == 1` and that option has
|
|
weight 1. In all
|
|
|
|
other cases, this field will default to
|
|
VOTE_OPTION_UNSPECIFIED.
|
|
type: string
|
|
enum:
|
|
- VOTE_OPTION_UNSPECIFIED
|
|
- VOTE_OPTION_YES
|
|
- VOTE_OPTION_ABSTAIN
|
|
- VOTE_OPTION_NO
|
|
- VOTE_OPTION_NO_WITH_VETO
|
|
default: VOTE_OPTION_UNSPECIFIED
|
|
options:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
option:
|
|
type: string
|
|
enum:
|
|
- VOTE_OPTION_UNSPECIFIED
|
|
- VOTE_OPTION_YES
|
|
- VOTE_OPTION_ABSTAIN
|
|
- VOTE_OPTION_NO
|
|
- VOTE_OPTION_NO_WITH_VETO
|
|
default: VOTE_OPTION_UNSPECIFIED
|
|
description: >-
|
|
VoteOption enumerates the valid vote options for a
|
|
given governance proposal.
|
|
|
|
- VOTE_OPTION_UNSPECIFIED: VOTE_OPTION_UNSPECIFIED defines a no-op vote option.
|
|
- VOTE_OPTION_YES: VOTE_OPTION_YES defines a yes vote option.
|
|
- VOTE_OPTION_ABSTAIN: VOTE_OPTION_ABSTAIN defines an abstain vote option.
|
|
- VOTE_OPTION_NO: VOTE_OPTION_NO defines a no vote option.
|
|
- VOTE_OPTION_NO_WITH_VETO: VOTE_OPTION_NO_WITH_VETO defines a no with veto vote option.
|
|
weight:
|
|
type: string
|
|
description: >-
|
|
WeightedVoteOption defines a unit of vote for vote
|
|
split.
|
|
description: >-
|
|
Vote defines a vote on a governance proposal.
|
|
|
|
A Vote consists of a proposal ID, the voter, and the vote
|
|
option.
|
|
description: votes defined the queried votes.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryVotesResponse is the response type for the Query/Votes 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: proposal_id
|
|
description: proposal_id defines the unique id of the proposal.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/gov/v1beta1/proposals/{proposal_id}/votes/{voter}:
|
|
get:
|
|
summary: Vote queries voted information based on proposalID, voterAddr.
|
|
operationId: Vote
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
vote:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
voter:
|
|
type: string
|
|
option:
|
|
description: >-
|
|
Deprecated: Prefer to use `options` instead. This field is
|
|
set in queries
|
|
|
|
if and only if `len(options) == 1` and that option has
|
|
weight 1. In all
|
|
|
|
other cases, this field will default to
|
|
VOTE_OPTION_UNSPECIFIED.
|
|
type: string
|
|
enum:
|
|
- VOTE_OPTION_UNSPECIFIED
|
|
- VOTE_OPTION_YES
|
|
- VOTE_OPTION_ABSTAIN
|
|
- VOTE_OPTION_NO
|
|
- VOTE_OPTION_NO_WITH_VETO
|
|
default: VOTE_OPTION_UNSPECIFIED
|
|
options:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
option:
|
|
type: string
|
|
enum:
|
|
- VOTE_OPTION_UNSPECIFIED
|
|
- VOTE_OPTION_YES
|
|
- VOTE_OPTION_ABSTAIN
|
|
- VOTE_OPTION_NO
|
|
- VOTE_OPTION_NO_WITH_VETO
|
|
default: VOTE_OPTION_UNSPECIFIED
|
|
description: >-
|
|
VoteOption enumerates the valid vote options for a
|
|
given governance proposal.
|
|
|
|
- VOTE_OPTION_UNSPECIFIED: VOTE_OPTION_UNSPECIFIED defines a no-op vote option.
|
|
- VOTE_OPTION_YES: VOTE_OPTION_YES defines a yes vote option.
|
|
- VOTE_OPTION_ABSTAIN: VOTE_OPTION_ABSTAIN defines an abstain vote option.
|
|
- VOTE_OPTION_NO: VOTE_OPTION_NO defines a no vote option.
|
|
- VOTE_OPTION_NO_WITH_VETO: VOTE_OPTION_NO_WITH_VETO defines a no with veto vote option.
|
|
weight:
|
|
type: string
|
|
description: >-
|
|
WeightedVoteOption defines a unit of vote for vote
|
|
split.
|
|
description: >-
|
|
Vote defines a vote on a governance proposal.
|
|
|
|
A Vote consists of a proposal ID, the voter, and the vote
|
|
option.
|
|
description: >-
|
|
QueryVoteResponse is the response type for the Query/Vote 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: proposal_id
|
|
description: proposal_id defines the unique id of the proposal.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
- name: voter
|
|
description: voter defines the oter address for the proposals.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/mint/v1beta1/annual_provisions:
|
|
get:
|
|
summary: AnnualProvisions current minting annual provisions value.
|
|
operationId: AnnualProvisions
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
annual_provisions:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
annual_provisions is the current minting annual provisions
|
|
value.
|
|
description: |-
|
|
QueryAnnualProvisionsResponse is the response type for the
|
|
Query/AnnualProvisions 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/mint/v1beta1/inflation:
|
|
get:
|
|
summary: Inflation returns the current minting inflation value.
|
|
operationId: Inflation
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
inflation:
|
|
type: string
|
|
format: byte
|
|
description: inflation is the current minting inflation value.
|
|
description: >-
|
|
QueryInflationResponse is the response type for the
|
|
Query/Inflation 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/mint/v1beta1/params:
|
|
get:
|
|
summary: Params returns the total set of minting parameters.
|
|
operationId: MintParams
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
params:
|
|
description: params defines the parameters of the module.
|
|
type: object
|
|
properties:
|
|
mint_denom:
|
|
type: string
|
|
title: type of coin to mint
|
|
inflation_rate_change:
|
|
type: string
|
|
title: maximum annual change in inflation rate
|
|
inflation_max:
|
|
type: string
|
|
title: maximum inflation rate
|
|
inflation_min:
|
|
type: string
|
|
title: minimum inflation rate
|
|
goal_bonded:
|
|
type: string
|
|
title: goal of percent bonded atoms
|
|
blocks_per_year:
|
|
type: string
|
|
format: uint64
|
|
title: expected blocks per year
|
|
description: >-
|
|
QueryParamsResponse is the response type for the Query/Params 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/params/v1beta1/params:
|
|
get:
|
|
summary: |-
|
|
Params queries a specific parameter of a module, given its subspace and
|
|
key.
|
|
operationId: Params
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
param:
|
|
description: param defines the queried parameter.
|
|
type: object
|
|
properties:
|
|
subspace:
|
|
type: string
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
description: >-
|
|
QueryParamsResponse is response type for the Query/Params 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: subspace
|
|
description: subspace defines the module to query the parameter for.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: key
|
|
description: key defines the key of the parameter in the subspace.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/slashing/v1beta1/params:
|
|
get:
|
|
summary: Params queries the parameters of slashing module
|
|
operationId: SlashingParams
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
params:
|
|
type: object
|
|
properties:
|
|
signed_blocks_window:
|
|
type: string
|
|
format: int64
|
|
min_signed_per_window:
|
|
type: string
|
|
format: byte
|
|
downtime_jail_duration:
|
|
type: string
|
|
slash_fraction_double_sign:
|
|
type: string
|
|
format: byte
|
|
slash_fraction_downtime:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Params represents the parameters used for by the slashing
|
|
module.
|
|
title: >-
|
|
QueryParamsResponse is the response type for the Query/Params 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/slashing/v1beta1/signing_infos:
|
|
get:
|
|
summary: SigningInfos queries signing info of all validators
|
|
operationId: SigningInfos
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
info:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
start_height:
|
|
type: string
|
|
format: int64
|
|
title: >-
|
|
Height at which validator was first a candidate OR was
|
|
unjailed
|
|
index_offset:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
Index which is incremented each time the validator was a
|
|
bonded
|
|
|
|
in a block and may have signed a precommit or not. This
|
|
in conjunction with the
|
|
|
|
`SignedBlocksWindow` param determines the index in the
|
|
`MissedBlocksBitArray`.
|
|
jailed_until:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
Timestamp until which the validator is jailed due to
|
|
liveness downtime.
|
|
tombstoned:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
Whether or not a validator has been tombstoned (killed
|
|
out of validator set). It is set
|
|
|
|
once the validator commits an equivocation or for any
|
|
other configured misbehiavor.
|
|
missed_blocks_counter:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
A counter kept to avoid unnecessary array reads.
|
|
|
|
Note that `Sum(MissedBlocksBitArray)` always equals
|
|
`MissedBlocksCounter`.
|
|
description: >-
|
|
ValidatorSigningInfo defines a validator's signing info for
|
|
monitoring their
|
|
|
|
liveness activity.
|
|
title: info is the signing info of all validators
|
|
pagination:
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
PageResponse is to be embedded in gRPC response messages where
|
|
the
|
|
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
title: >-
|
|
QuerySigningInfosResponse is the response type for the
|
|
Query/SigningInfos 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/slashing/v1beta1/signing_infos/{cons_address}:
|
|
get:
|
|
summary: SigningInfo queries the signing info of given cons address
|
|
operationId: SigningInfo
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
val_signing_info:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
start_height:
|
|
type: string
|
|
format: int64
|
|
title: >-
|
|
Height at which validator was first a candidate OR was
|
|
unjailed
|
|
index_offset:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
Index which is incremented each time the validator was a
|
|
bonded
|
|
|
|
in a block and may have signed a precommit or not. This in
|
|
conjunction with the
|
|
|
|
`SignedBlocksWindow` param determines the index in the
|
|
`MissedBlocksBitArray`.
|
|
jailed_until:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
Timestamp until which the validator is jailed due to
|
|
liveness downtime.
|
|
tombstoned:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
Whether or not a validator has been tombstoned (killed out
|
|
of validator set). It is set
|
|
|
|
once the validator commits an equivocation or for any
|
|
other configured misbehiavor.
|
|
missed_blocks_counter:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
A counter kept to avoid unnecessary array reads.
|
|
|
|
Note that `Sum(MissedBlocksBitArray)` always equals
|
|
`MissedBlocksCounter`.
|
|
description: >-
|
|
ValidatorSigningInfo defines a validator's signing info for
|
|
monitoring their
|
|
|
|
liveness activity.
|
|
title: >-
|
|
val_signing_info is the signing info of requested val cons
|
|
address
|
|
title: >-
|
|
QuerySigningInfoResponse is the response type for the
|
|
Query/SigningInfo 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: cons_address
|
|
description: cons_address is the address to query signing info of
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/staking/v1beta1/delegations/{delegator_addr}:
|
|
get:
|
|
summary: >-
|
|
DelegatorDelegations queries all delegations of a given delegator
|
|
address.
|
|
operationId: DelegatorDelegations
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
delegation_responses:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
delegation:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
description: >-
|
|
delegator_address is the bech32-encoded address of
|
|
the delegator.
|
|
validator_address:
|
|
type: string
|
|
description: >-
|
|
validator_address is the bech32-encoded address of
|
|
the validator.
|
|
shares:
|
|
type: string
|
|
description: shares define the delegation shares received.
|
|
description: >-
|
|
Delegation represents the bond with tokens held by an
|
|
account. It is
|
|
|
|
owned by one delegator, and is associated with the
|
|
voting power of one
|
|
|
|
validator.
|
|
balance:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
DelegationResponse is equivalent to Delegation except that
|
|
it contains a
|
|
|
|
balance in addition to shares which is more suitable for
|
|
client responses.
|
|
description: >-
|
|
delegation_responses defines all the delegations' info of a
|
|
delegator.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
QueryDelegatorDelegationsResponse is response type for the
|
|
Query/DelegatorDelegations 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: delegator_addr
|
|
description: delegator_addr defines the delegator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/staking/v1beta1/delegators/{delegator_addr}/redelegations:
|
|
get:
|
|
summary: Redelegations queries redelegations of given address.
|
|
operationId: Redelegations
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
redelegation_responses:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
redelegation:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
description: >-
|
|
delegator_address is the bech32-encoded address of
|
|
the delegator.
|
|
validator_src_address:
|
|
type: string
|
|
description: >-
|
|
validator_src_address is the validator redelegation
|
|
source operator address.
|
|
validator_dst_address:
|
|
type: string
|
|
description: >-
|
|
validator_dst_address is the validator redelegation
|
|
destination operator address.
|
|
entries:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
creation_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
creation_height defines the height which the
|
|
redelegation took place.
|
|
completion_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
completion_time defines the unix time for
|
|
redelegation completion.
|
|
initial_balance:
|
|
type: string
|
|
description: >-
|
|
initial_balance defines the initial balance
|
|
when redelegation started.
|
|
shares_dst:
|
|
type: string
|
|
description: >-
|
|
shares_dst is the amount of
|
|
destination-validator shares created by
|
|
redelegation.
|
|
description: >-
|
|
RedelegationEntry defines a redelegation object
|
|
with relevant metadata.
|
|
description: entries are the redelegation entries.
|
|
description: >-
|
|
Redelegation contains the list of a particular
|
|
delegator's redelegating bonds
|
|
|
|
from a particular source validator to a particular
|
|
destination validator.
|
|
entries:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
redelegation_entry:
|
|
type: object
|
|
properties:
|
|
creation_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
creation_height defines the height which the
|
|
redelegation took place.
|
|
completion_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
completion_time defines the unix time for
|
|
redelegation completion.
|
|
initial_balance:
|
|
type: string
|
|
description: >-
|
|
initial_balance defines the initial balance
|
|
when redelegation started.
|
|
shares_dst:
|
|
type: string
|
|
description: >-
|
|
shares_dst is the amount of
|
|
destination-validator shares created by
|
|
redelegation.
|
|
description: >-
|
|
RedelegationEntry defines a redelegation object
|
|
with relevant metadata.
|
|
balance:
|
|
type: string
|
|
description: >-
|
|
RedelegationEntryResponse is equivalent to a
|
|
RedelegationEntry except that it
|
|
|
|
contains a balance in addition to shares which is more
|
|
suitable for client
|
|
|
|
responses.
|
|
description: >-
|
|
RedelegationResponse is equivalent to a Redelegation except
|
|
that its entries
|
|
|
|
contain a balance in addition to shares which is more
|
|
suitable for client
|
|
|
|
responses.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryRedelegationsResponse is response type for the
|
|
Query/Redelegations 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: delegator_addr
|
|
description: delegator_addr defines the delegator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: src_validator_addr
|
|
description: src_validator_addr defines the validator address to redelegate from.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: dst_validator_addr
|
|
description: dst_validator_addr defines the validator address to redelegate to.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/staking/v1beta1/delegators/{delegator_addr}/unbonding_delegations:
|
|
get:
|
|
summary: >-
|
|
DelegatorUnbondingDelegations queries all unbonding delegations of a
|
|
given
|
|
|
|
delegator address.
|
|
operationId: DelegatorUnbondingDelegations
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
unbonding_responses:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
description: >-
|
|
delegator_address is the bech32-encoded address of the
|
|
delegator.
|
|
validator_address:
|
|
type: string
|
|
description: >-
|
|
validator_address is the bech32-encoded address of the
|
|
validator.
|
|
entries:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
creation_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
creation_height is the height which the unbonding
|
|
took place.
|
|
completion_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
completion_time is the unix time for unbonding
|
|
completion.
|
|
initial_balance:
|
|
type: string
|
|
description: >-
|
|
initial_balance defines the tokens initially
|
|
scheduled to receive at completion.
|
|
balance:
|
|
type: string
|
|
description: >-
|
|
balance defines the tokens to receive at
|
|
completion.
|
|
description: >-
|
|
UnbondingDelegationEntry defines an unbonding object
|
|
with relevant metadata.
|
|
description: entries are the unbonding delegation entries.
|
|
description: >-
|
|
UnbondingDelegation stores all of a single delegator's
|
|
unbonding bonds
|
|
|
|
for a single validator in an time-ordered list.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryUnbondingDelegatorDelegationsResponse is response type for
|
|
the
|
|
|
|
Query/UnbondingDelegatorDelegations 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: delegator_addr
|
|
description: delegator_addr defines the delegator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/staking/v1beta1/delegators/{delegator_addr}/validators:
|
|
get:
|
|
summary: |-
|
|
DelegatorValidators queries all validators info for given delegator
|
|
address.
|
|
operationId: StakingDelegatorValidators
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
operator_address:
|
|
type: string
|
|
description: >-
|
|
operator_address defines the address of the validator's
|
|
operator; bech encoded in JSON.
|
|
consensus_pubkey:
|
|
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"
|
|
}
|
|
jailed:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
jailed defined whether the validator has been jailed
|
|
from bonded status or not.
|
|
status:
|
|
description: >-
|
|
status is the validator status
|
|
(bonded/unbonding/unbonded).
|
|
type: string
|
|
enum:
|
|
- BOND_STATUS_UNSPECIFIED
|
|
- BOND_STATUS_UNBONDED
|
|
- BOND_STATUS_UNBONDING
|
|
- BOND_STATUS_BONDED
|
|
default: BOND_STATUS_UNSPECIFIED
|
|
tokens:
|
|
type: string
|
|
description: >-
|
|
tokens define the delegated tokens (incl.
|
|
self-delegation).
|
|
delegator_shares:
|
|
type: string
|
|
description: >-
|
|
delegator_shares defines total shares issued to a
|
|
validator's delegators.
|
|
description:
|
|
description: >-
|
|
description defines the description terms for the
|
|
validator.
|
|
type: object
|
|
properties:
|
|
moniker:
|
|
type: string
|
|
description: >-
|
|
moniker defines a human-readable name for the
|
|
validator.
|
|
identity:
|
|
type: string
|
|
description: >-
|
|
identity defines an optional identity signature (ex.
|
|
UPort or Keybase).
|
|
website:
|
|
type: string
|
|
description: website defines an optional website link.
|
|
security_contact:
|
|
type: string
|
|
description: >-
|
|
security_contact defines an optional email for
|
|
security contact.
|
|
details:
|
|
type: string
|
|
description: details define other optional details.
|
|
unbonding_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
unbonding_height defines, if unbonding, the height at
|
|
which this validator has begun unbonding.
|
|
unbonding_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
unbonding_time defines, if unbonding, the min time for
|
|
the validator to complete unbonding.
|
|
commission:
|
|
description: commission defines the commission parameters.
|
|
type: object
|
|
properties:
|
|
commission_rates:
|
|
description: >-
|
|
commission_rates defines the initial commission
|
|
rates to be used for creating a validator.
|
|
type: object
|
|
properties:
|
|
rate:
|
|
type: string
|
|
description: >-
|
|
rate is the commission rate charged to
|
|
delegators, as a fraction.
|
|
max_rate:
|
|
type: string
|
|
description: >-
|
|
max_rate defines the maximum commission rate
|
|
which validator can ever charge, as a fraction.
|
|
max_change_rate:
|
|
type: string
|
|
description: >-
|
|
max_change_rate defines the maximum daily
|
|
increase of the validator commission, as a
|
|
fraction.
|
|
update_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
update_time is the last time the commission rate was
|
|
changed.
|
|
min_self_delegation:
|
|
type: string
|
|
description: >-
|
|
min_self_delegation is the validator's self declared
|
|
minimum self delegation.
|
|
description: >-
|
|
Validator defines a validator, together with the total
|
|
amount of the
|
|
|
|
Validator's bond shares and their exchange rate to coins.
|
|
Slashing results in
|
|
|
|
a decrease in the exchange rate, allowing correct
|
|
calculation of future
|
|
|
|
undelegations without iterating over delegators. When coins
|
|
are delegated to
|
|
|
|
this validator, the validator is credited with a delegation
|
|
whose number of
|
|
|
|
bond shares is based on the amount of coins delegated
|
|
divided by the current
|
|
|
|
exchange rate. Voting power can be calculated as total
|
|
bonded shares
|
|
|
|
multiplied by exchange rate.
|
|
description: validators defines the the validators' info of a delegator.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
QueryDelegatorValidatorsResponse is response type for the
|
|
Query/DelegatorValidators 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: delegator_addr
|
|
description: delegator_addr defines the delegator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/staking/v1beta1/delegators/{delegator_addr}/validators/{validator_addr}:
|
|
get:
|
|
summary: |-
|
|
DelegatorValidator queries validator info for given delegator validator
|
|
pair.
|
|
operationId: DelegatorValidator
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
validator:
|
|
type: object
|
|
properties:
|
|
operator_address:
|
|
type: string
|
|
description: >-
|
|
operator_address defines the address of the validator's
|
|
operator; bech encoded in JSON.
|
|
consensus_pubkey:
|
|
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"
|
|
}
|
|
jailed:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
jailed defined whether the validator has been jailed from
|
|
bonded status or not.
|
|
status:
|
|
description: >-
|
|
status is the validator status
|
|
(bonded/unbonding/unbonded).
|
|
type: string
|
|
enum:
|
|
- BOND_STATUS_UNSPECIFIED
|
|
- BOND_STATUS_UNBONDED
|
|
- BOND_STATUS_UNBONDING
|
|
- BOND_STATUS_BONDED
|
|
default: BOND_STATUS_UNSPECIFIED
|
|
tokens:
|
|
type: string
|
|
description: >-
|
|
tokens define the delegated tokens (incl.
|
|
self-delegation).
|
|
delegator_shares:
|
|
type: string
|
|
description: >-
|
|
delegator_shares defines total shares issued to a
|
|
validator's delegators.
|
|
description:
|
|
description: >-
|
|
description defines the description terms for the
|
|
validator.
|
|
type: object
|
|
properties:
|
|
moniker:
|
|
type: string
|
|
description: >-
|
|
moniker defines a human-readable name for the
|
|
validator.
|
|
identity:
|
|
type: string
|
|
description: >-
|
|
identity defines an optional identity signature (ex.
|
|
UPort or Keybase).
|
|
website:
|
|
type: string
|
|
description: website defines an optional website link.
|
|
security_contact:
|
|
type: string
|
|
description: >-
|
|
security_contact defines an optional email for
|
|
security contact.
|
|
details:
|
|
type: string
|
|
description: details define other optional details.
|
|
unbonding_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
unbonding_height defines, if unbonding, the height at
|
|
which this validator has begun unbonding.
|
|
unbonding_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
unbonding_time defines, if unbonding, the min time for the
|
|
validator to complete unbonding.
|
|
commission:
|
|
description: commission defines the commission parameters.
|
|
type: object
|
|
properties:
|
|
commission_rates:
|
|
description: >-
|
|
commission_rates defines the initial commission rates
|
|
to be used for creating a validator.
|
|
type: object
|
|
properties:
|
|
rate:
|
|
type: string
|
|
description: >-
|
|
rate is the commission rate charged to delegators,
|
|
as a fraction.
|
|
max_rate:
|
|
type: string
|
|
description: >-
|
|
max_rate defines the maximum commission rate which
|
|
validator can ever charge, as a fraction.
|
|
max_change_rate:
|
|
type: string
|
|
description: >-
|
|
max_change_rate defines the maximum daily increase
|
|
of the validator commission, as a fraction.
|
|
update_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
update_time is the last time the commission rate was
|
|
changed.
|
|
min_self_delegation:
|
|
type: string
|
|
description: >-
|
|
min_self_delegation is the validator's self declared
|
|
minimum self delegation.
|
|
description: >-
|
|
Validator defines a validator, together with the total amount
|
|
of the
|
|
|
|
Validator's bond shares and their exchange rate to coins.
|
|
Slashing results in
|
|
|
|
a decrease in the exchange rate, allowing correct calculation
|
|
of future
|
|
|
|
undelegations without iterating over delegators. When coins
|
|
are delegated to
|
|
|
|
this validator, the validator is credited with a delegation
|
|
whose number of
|
|
|
|
bond shares is based on the amount of coins delegated divided
|
|
by the current
|
|
|
|
exchange rate. Voting power can be calculated as total bonded
|
|
shares
|
|
|
|
multiplied by exchange rate.
|
|
description: |-
|
|
QueryDelegatorValidatorResponse response type for the
|
|
Query/DelegatorValidator 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: delegator_addr
|
|
description: delegator_addr defines the delegator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: validator_addr
|
|
description: validator_addr defines the validator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/staking/v1beta1/historical_info/{height}:
|
|
get:
|
|
summary: HistoricalInfo queries the historical info for given height.
|
|
operationId: HistoricalInfo
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
hist:
|
|
description: hist defines the historical info at the given height.
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
version:
|
|
title: basic block info
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules for processing
|
|
a block in the blockchain,
|
|
|
|
including all blockchain data structures and the rules
|
|
of the application's
|
|
|
|
state transition machine.
|
|
chain_id:
|
|
type: string
|
|
height:
|
|
type: string
|
|
format: int64
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
last_block_id:
|
|
title: prev block info
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
last_commit_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes of block data
|
|
data_hash:
|
|
type: string
|
|
format: byte
|
|
validators_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes from the app output from the prev block
|
|
next_validators_hash:
|
|
type: string
|
|
format: byte
|
|
consensus_hash:
|
|
type: string
|
|
format: byte
|
|
app_hash:
|
|
type: string
|
|
format: byte
|
|
last_results_hash:
|
|
type: string
|
|
format: byte
|
|
evidence_hash:
|
|
type: string
|
|
format: byte
|
|
title: consensus info
|
|
proposer_address:
|
|
type: string
|
|
format: byte
|
|
description: Header defines the structure of a Tendermint block header.
|
|
valset:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
operator_address:
|
|
type: string
|
|
description: >-
|
|
operator_address defines the address of the
|
|
validator's operator; bech encoded in JSON.
|
|
consensus_pubkey:
|
|
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"
|
|
}
|
|
jailed:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
jailed defined whether the validator has been jailed
|
|
from bonded status or not.
|
|
status:
|
|
description: >-
|
|
status is the validator status
|
|
(bonded/unbonding/unbonded).
|
|
type: string
|
|
enum:
|
|
- BOND_STATUS_UNSPECIFIED
|
|
- BOND_STATUS_UNBONDED
|
|
- BOND_STATUS_UNBONDING
|
|
- BOND_STATUS_BONDED
|
|
default: BOND_STATUS_UNSPECIFIED
|
|
tokens:
|
|
type: string
|
|
description: >-
|
|
tokens define the delegated tokens (incl.
|
|
self-delegation).
|
|
delegator_shares:
|
|
type: string
|
|
description: >-
|
|
delegator_shares defines total shares issued to a
|
|
validator's delegators.
|
|
description:
|
|
description: >-
|
|
description defines the description terms for the
|
|
validator.
|
|
type: object
|
|
properties:
|
|
moniker:
|
|
type: string
|
|
description: >-
|
|
moniker defines a human-readable name for the
|
|
validator.
|
|
identity:
|
|
type: string
|
|
description: >-
|
|
identity defines an optional identity signature
|
|
(ex. UPort or Keybase).
|
|
website:
|
|
type: string
|
|
description: website defines an optional website link.
|
|
security_contact:
|
|
type: string
|
|
description: >-
|
|
security_contact defines an optional email for
|
|
security contact.
|
|
details:
|
|
type: string
|
|
description: details define other optional details.
|
|
unbonding_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
unbonding_height defines, if unbonding, the height
|
|
at which this validator has begun unbonding.
|
|
unbonding_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
unbonding_time defines, if unbonding, the min time
|
|
for the validator to complete unbonding.
|
|
commission:
|
|
description: commission defines the commission parameters.
|
|
type: object
|
|
properties:
|
|
commission_rates:
|
|
description: >-
|
|
commission_rates defines the initial commission
|
|
rates to be used for creating a validator.
|
|
type: object
|
|
properties:
|
|
rate:
|
|
type: string
|
|
description: >-
|
|
rate is the commission rate charged to
|
|
delegators, as a fraction.
|
|
max_rate:
|
|
type: string
|
|
description: >-
|
|
max_rate defines the maximum commission rate
|
|
which validator can ever charge, as a
|
|
fraction.
|
|
max_change_rate:
|
|
type: string
|
|
description: >-
|
|
max_change_rate defines the maximum daily
|
|
increase of the validator commission, as a
|
|
fraction.
|
|
update_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
update_time is the last time the commission rate
|
|
was changed.
|
|
min_self_delegation:
|
|
type: string
|
|
description: >-
|
|
min_self_delegation is the validator's self declared
|
|
minimum self delegation.
|
|
description: >-
|
|
Validator defines a validator, together with the total
|
|
amount of the
|
|
|
|
Validator's bond shares and their exchange rate to
|
|
coins. Slashing results in
|
|
|
|
a decrease in the exchange rate, allowing correct
|
|
calculation of future
|
|
|
|
undelegations without iterating over delegators. When
|
|
coins are delegated to
|
|
|
|
this validator, the validator is credited with a
|
|
delegation whose number of
|
|
|
|
bond shares is based on the amount of coins delegated
|
|
divided by the current
|
|
|
|
exchange rate. Voting power can be calculated as total
|
|
bonded shares
|
|
|
|
multiplied by exchange rate.
|
|
description: >-
|
|
QueryHistoricalInfoResponse is response type for the
|
|
Query/HistoricalInfo 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: height
|
|
description: height defines at which height to query the historical info.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: int64
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/staking/v1beta1/params:
|
|
get:
|
|
summary: Parameters queries the staking parameters.
|
|
operationId: StakingParams
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
params:
|
|
description: params holds all the parameters of this module.
|
|
type: object
|
|
properties:
|
|
unbonding_time:
|
|
type: string
|
|
description: unbonding_time is the time duration of unbonding.
|
|
max_validators:
|
|
type: integer
|
|
format: int64
|
|
description: max_validators is the maximum number of validators.
|
|
max_entries:
|
|
type: integer
|
|
format: int64
|
|
description: >-
|
|
max_entries is the max entries for either unbonding
|
|
delegation or redelegation (per pair/trio).
|
|
historical_entries:
|
|
type: integer
|
|
format: int64
|
|
description: >-
|
|
historical_entries is the number of historical entries to
|
|
persist.
|
|
bond_denom:
|
|
type: string
|
|
description: bond_denom defines the bondable coin denomination.
|
|
description: >-
|
|
QueryParamsResponse is response type for the Query/Params 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"
|
|
}
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/staking/v1beta1/pool:
|
|
get:
|
|
summary: Pool queries the pool info.
|
|
operationId: Pool
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
pool:
|
|
description: pool defines the pool info.
|
|
type: object
|
|
properties:
|
|
not_bonded_tokens:
|
|
type: string
|
|
bonded_tokens:
|
|
type: string
|
|
description: QueryPoolResponse is response type for the Query/Pool 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"
|
|
}
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/staking/v1beta1/validators:
|
|
get:
|
|
summary: Validators queries all validators that match the given status.
|
|
operationId: Validators
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
operator_address:
|
|
type: string
|
|
description: >-
|
|
operator_address defines the address of the validator's
|
|
operator; bech encoded in JSON.
|
|
consensus_pubkey:
|
|
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"
|
|
}
|
|
jailed:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
jailed defined whether the validator has been jailed
|
|
from bonded status or not.
|
|
status:
|
|
description: >-
|
|
status is the validator status
|
|
(bonded/unbonding/unbonded).
|
|
type: string
|
|
enum:
|
|
- BOND_STATUS_UNSPECIFIED
|
|
- BOND_STATUS_UNBONDED
|
|
- BOND_STATUS_UNBONDING
|
|
- BOND_STATUS_BONDED
|
|
default: BOND_STATUS_UNSPECIFIED
|
|
tokens:
|
|
type: string
|
|
description: >-
|
|
tokens define the delegated tokens (incl.
|
|
self-delegation).
|
|
delegator_shares:
|
|
type: string
|
|
description: >-
|
|
delegator_shares defines total shares issued to a
|
|
validator's delegators.
|
|
description:
|
|
description: >-
|
|
description defines the description terms for the
|
|
validator.
|
|
type: object
|
|
properties:
|
|
moniker:
|
|
type: string
|
|
description: >-
|
|
moniker defines a human-readable name for the
|
|
validator.
|
|
identity:
|
|
type: string
|
|
description: >-
|
|
identity defines an optional identity signature (ex.
|
|
UPort or Keybase).
|
|
website:
|
|
type: string
|
|
description: website defines an optional website link.
|
|
security_contact:
|
|
type: string
|
|
description: >-
|
|
security_contact defines an optional email for
|
|
security contact.
|
|
details:
|
|
type: string
|
|
description: details define other optional details.
|
|
unbonding_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
unbonding_height defines, if unbonding, the height at
|
|
which this validator has begun unbonding.
|
|
unbonding_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
unbonding_time defines, if unbonding, the min time for
|
|
the validator to complete unbonding.
|
|
commission:
|
|
description: commission defines the commission parameters.
|
|
type: object
|
|
properties:
|
|
commission_rates:
|
|
description: >-
|
|
commission_rates defines the initial commission
|
|
rates to be used for creating a validator.
|
|
type: object
|
|
properties:
|
|
rate:
|
|
type: string
|
|
description: >-
|
|
rate is the commission rate charged to
|
|
delegators, as a fraction.
|
|
max_rate:
|
|
type: string
|
|
description: >-
|
|
max_rate defines the maximum commission rate
|
|
which validator can ever charge, as a fraction.
|
|
max_change_rate:
|
|
type: string
|
|
description: >-
|
|
max_change_rate defines the maximum daily
|
|
increase of the validator commission, as a
|
|
fraction.
|
|
update_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
update_time is the last time the commission rate was
|
|
changed.
|
|
min_self_delegation:
|
|
type: string
|
|
description: >-
|
|
min_self_delegation is the validator's self declared
|
|
minimum self delegation.
|
|
description: >-
|
|
Validator defines a validator, together with the total
|
|
amount of the
|
|
|
|
Validator's bond shares and their exchange rate to coins.
|
|
Slashing results in
|
|
|
|
a decrease in the exchange rate, allowing correct
|
|
calculation of future
|
|
|
|
undelegations without iterating over delegators. When coins
|
|
are delegated to
|
|
|
|
this validator, the validator is credited with a delegation
|
|
whose number of
|
|
|
|
bond shares is based on the amount of coins delegated
|
|
divided by the current
|
|
|
|
exchange rate. Voting power can be calculated as total
|
|
bonded shares
|
|
|
|
multiplied by exchange rate.
|
|
description: validators contains all the queried validators.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
title: >-
|
|
QueryValidatorsResponse is response type for the Query/Validators
|
|
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: status
|
|
description: status enables to query for validators matching a given status.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/staking/v1beta1/validators/{validator_addr}:
|
|
get:
|
|
summary: Validator queries validator info for given validator address.
|
|
operationId: Validator
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
validator:
|
|
type: object
|
|
properties:
|
|
operator_address:
|
|
type: string
|
|
description: >-
|
|
operator_address defines the address of the validator's
|
|
operator; bech encoded in JSON.
|
|
consensus_pubkey:
|
|
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"
|
|
}
|
|
jailed:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
jailed defined whether the validator has been jailed from
|
|
bonded status or not.
|
|
status:
|
|
description: >-
|
|
status is the validator status
|
|
(bonded/unbonding/unbonded).
|
|
type: string
|
|
enum:
|
|
- BOND_STATUS_UNSPECIFIED
|
|
- BOND_STATUS_UNBONDED
|
|
- BOND_STATUS_UNBONDING
|
|
- BOND_STATUS_BONDED
|
|
default: BOND_STATUS_UNSPECIFIED
|
|
tokens:
|
|
type: string
|
|
description: >-
|
|
tokens define the delegated tokens (incl.
|
|
self-delegation).
|
|
delegator_shares:
|
|
type: string
|
|
description: >-
|
|
delegator_shares defines total shares issued to a
|
|
validator's delegators.
|
|
description:
|
|
description: >-
|
|
description defines the description terms for the
|
|
validator.
|
|
type: object
|
|
properties:
|
|
moniker:
|
|
type: string
|
|
description: >-
|
|
moniker defines a human-readable name for the
|
|
validator.
|
|
identity:
|
|
type: string
|
|
description: >-
|
|
identity defines an optional identity signature (ex.
|
|
UPort or Keybase).
|
|
website:
|
|
type: string
|
|
description: website defines an optional website link.
|
|
security_contact:
|
|
type: string
|
|
description: >-
|
|
security_contact defines an optional email for
|
|
security contact.
|
|
details:
|
|
type: string
|
|
description: details define other optional details.
|
|
unbonding_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
unbonding_height defines, if unbonding, the height at
|
|
which this validator has begun unbonding.
|
|
unbonding_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
unbonding_time defines, if unbonding, the min time for the
|
|
validator to complete unbonding.
|
|
commission:
|
|
description: commission defines the commission parameters.
|
|
type: object
|
|
properties:
|
|
commission_rates:
|
|
description: >-
|
|
commission_rates defines the initial commission rates
|
|
to be used for creating a validator.
|
|
type: object
|
|
properties:
|
|
rate:
|
|
type: string
|
|
description: >-
|
|
rate is the commission rate charged to delegators,
|
|
as a fraction.
|
|
max_rate:
|
|
type: string
|
|
description: >-
|
|
max_rate defines the maximum commission rate which
|
|
validator can ever charge, as a fraction.
|
|
max_change_rate:
|
|
type: string
|
|
description: >-
|
|
max_change_rate defines the maximum daily increase
|
|
of the validator commission, as a fraction.
|
|
update_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
update_time is the last time the commission rate was
|
|
changed.
|
|
min_self_delegation:
|
|
type: string
|
|
description: >-
|
|
min_self_delegation is the validator's self declared
|
|
minimum self delegation.
|
|
description: >-
|
|
Validator defines a validator, together with the total amount
|
|
of the
|
|
|
|
Validator's bond shares and their exchange rate to coins.
|
|
Slashing results in
|
|
|
|
a decrease in the exchange rate, allowing correct calculation
|
|
of future
|
|
|
|
undelegations without iterating over delegators. When coins
|
|
are delegated to
|
|
|
|
this validator, the validator is credited with a delegation
|
|
whose number of
|
|
|
|
bond shares is based on the amount of coins delegated divided
|
|
by the current
|
|
|
|
exchange rate. Voting power can be calculated as total bonded
|
|
shares
|
|
|
|
multiplied by exchange rate.
|
|
title: >-
|
|
QueryValidatorResponse is response type for the Query/Validator
|
|
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: validator_addr
|
|
description: validator_addr defines the validator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/staking/v1beta1/validators/{validator_addr}/delegations:
|
|
get:
|
|
summary: ValidatorDelegations queries delegate info for given validator.
|
|
operationId: ValidatorDelegations
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
delegation_responses:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
delegation:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
description: >-
|
|
delegator_address is the bech32-encoded address of
|
|
the delegator.
|
|
validator_address:
|
|
type: string
|
|
description: >-
|
|
validator_address is the bech32-encoded address of
|
|
the validator.
|
|
shares:
|
|
type: string
|
|
description: shares define the delegation shares received.
|
|
description: >-
|
|
Delegation represents the bond with tokens held by an
|
|
account. It is
|
|
|
|
owned by one delegator, and is associated with the
|
|
voting power of one
|
|
|
|
validator.
|
|
balance:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
DelegationResponse is equivalent to Delegation except that
|
|
it contains a
|
|
|
|
balance in addition to shares which is more suitable for
|
|
client responses.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
title: |-
|
|
QueryValidatorDelegationsResponse is response type for the
|
|
Query/ValidatorDelegations 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: validator_addr
|
|
description: validator_addr defines the validator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/staking/v1beta1/validators/{validator_addr}/delegations/{delegator_addr}:
|
|
get:
|
|
summary: Delegation queries delegate info for given validator delegator pair.
|
|
operationId: Delegation
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
delegation_response:
|
|
type: object
|
|
properties:
|
|
delegation:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
description: >-
|
|
delegator_address is the bech32-encoded address of the
|
|
delegator.
|
|
validator_address:
|
|
type: string
|
|
description: >-
|
|
validator_address is the bech32-encoded address of the
|
|
validator.
|
|
shares:
|
|
type: string
|
|
description: shares define the delegation shares received.
|
|
description: >-
|
|
Delegation represents the bond with tokens held by an
|
|
account. It is
|
|
|
|
owned by one delegator, and is associated with the voting
|
|
power of one
|
|
|
|
validator.
|
|
balance:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the
|
|
custom method
|
|
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
DelegationResponse is equivalent to Delegation except that it
|
|
contains a
|
|
|
|
balance in addition to shares which is more suitable for
|
|
client responses.
|
|
description: >-
|
|
QueryDelegationResponse is response type for the Query/Delegation
|
|
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: validator_addr
|
|
description: validator_addr defines the validator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: delegator_addr
|
|
description: delegator_addr defines the delegator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/staking/v1beta1/validators/{validator_addr}/delegations/{delegator_addr}/unbonding_delegation:
|
|
get:
|
|
summary: |-
|
|
UnbondingDelegation queries unbonding info for given validator delegator
|
|
pair.
|
|
operationId: UnbondingDelegation
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
unbond:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
description: >-
|
|
delegator_address is the bech32-encoded address of the
|
|
delegator.
|
|
validator_address:
|
|
type: string
|
|
description: >-
|
|
validator_address is the bech32-encoded address of the
|
|
validator.
|
|
entries:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
creation_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
creation_height is the height which the unbonding
|
|
took place.
|
|
completion_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
completion_time is the unix time for unbonding
|
|
completion.
|
|
initial_balance:
|
|
type: string
|
|
description: >-
|
|
initial_balance defines the tokens initially
|
|
scheduled to receive at completion.
|
|
balance:
|
|
type: string
|
|
description: balance defines the tokens to receive at completion.
|
|
description: >-
|
|
UnbondingDelegationEntry defines an unbonding object
|
|
with relevant metadata.
|
|
description: entries are the unbonding delegation entries.
|
|
description: >-
|
|
UnbondingDelegation stores all of a single delegator's
|
|
unbonding bonds
|
|
|
|
for a single validator in an time-ordered list.
|
|
description: >-
|
|
QueryDelegationResponse is response type for the
|
|
Query/UnbondingDelegation
|
|
|
|
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: validator_addr
|
|
description: validator_addr defines the validator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: delegator_addr
|
|
description: delegator_addr defines the delegator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/staking/v1beta1/validators/{validator_addr}/unbonding_delegations:
|
|
get:
|
|
summary: >-
|
|
ValidatorUnbondingDelegations queries unbonding delegations of a
|
|
validator.
|
|
operationId: ValidatorUnbondingDelegations
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
unbonding_responses:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
description: >-
|
|
delegator_address is the bech32-encoded address of the
|
|
delegator.
|
|
validator_address:
|
|
type: string
|
|
description: >-
|
|
validator_address is the bech32-encoded address of the
|
|
validator.
|
|
entries:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
creation_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
creation_height is the height which the unbonding
|
|
took place.
|
|
completion_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
completion_time is the unix time for unbonding
|
|
completion.
|
|
initial_balance:
|
|
type: string
|
|
description: >-
|
|
initial_balance defines the tokens initially
|
|
scheduled to receive at completion.
|
|
balance:
|
|
type: string
|
|
description: >-
|
|
balance defines the tokens to receive at
|
|
completion.
|
|
description: >-
|
|
UnbondingDelegationEntry defines an unbonding object
|
|
with relevant metadata.
|
|
description: entries are the unbonding delegation entries.
|
|
description: >-
|
|
UnbondingDelegation stores all of a single delegator's
|
|
unbonding bonds
|
|
|
|
for a single validator in an time-ordered list.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryValidatorUnbondingDelegationsResponse is response type for
|
|
the
|
|
|
|
Query/ValidatorUnbondingDelegations 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: validator_addr
|
|
description: validator_addr defines the validator address to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/tx/v1beta1/simulate:
|
|
post:
|
|
summary: Simulate simulates executing a transaction for estimating gas usage.
|
|
operationId: Simulate
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
gas_info:
|
|
description: gas_info is the information about gas used in the simulation.
|
|
type: object
|
|
properties:
|
|
gas_wanted:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
GasWanted is the maximum units of work we allow this tx to
|
|
perform.
|
|
gas_used:
|
|
type: string
|
|
format: uint64
|
|
description: GasUsed is the amount of gas actually consumed.
|
|
result:
|
|
description: result is the result of the simulation.
|
|
type: object
|
|
properties:
|
|
data:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Data is any data returned from message or handler
|
|
execution. It MUST be
|
|
|
|
length prefixed in order to separate data from multiple
|
|
message executions.
|
|
log:
|
|
type: string
|
|
description: >-
|
|
Log contains the log information from message or handler
|
|
execution.
|
|
events:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
format: byte
|
|
value:
|
|
type: string
|
|
format: byte
|
|
index:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
EventAttribute is a single key-value pair,
|
|
associated with an event.
|
|
description: >-
|
|
Event allows application developers to attach additional
|
|
information to
|
|
|
|
ResponseBeginBlock, ResponseEndBlock, ResponseCheckTx
|
|
and ResponseDeliverTx.
|
|
|
|
Later, transactions may be queried using these events.
|
|
description: >-
|
|
Events contains a slice of Event objects that were emitted
|
|
during message
|
|
|
|
or handler execution.
|
|
description: |-
|
|
SimulateResponse is the response type for the
|
|
Service.SimulateRPC 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: body
|
|
in: body
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/cosmos.tx.v1beta1.SimulateRequest'
|
|
tags:
|
|
- Service
|
|
/cosmos/tx/v1beta1/txs:
|
|
get:
|
|
summary: GetTxsEvent fetches txs by event.
|
|
operationId: GetTxsEvent
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
$ref: '#/definitions/cosmos.tx.v1beta1.GetTxsEventResponse'
|
|
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: events
|
|
description: events is the list of transaction event type.
|
|
in: query
|
|
required: false
|
|
type: array
|
|
items:
|
|
type: string
|
|
collectionFormat: multi
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: pagination.reverse
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the
|
|
descending order.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
- name: order_by
|
|
description: |2-
|
|
- ORDER_BY_UNSPECIFIED: ORDER_BY_UNSPECIFIED specifies an unknown sorting order. OrderBy defaults to ASC in this case.
|
|
- ORDER_BY_ASC: ORDER_BY_ASC defines ascending order
|
|
- ORDER_BY_DESC: ORDER_BY_DESC defines descending order
|
|
in: query
|
|
required: false
|
|
type: string
|
|
enum:
|
|
- ORDER_BY_UNSPECIFIED
|
|
- ORDER_BY_ASC
|
|
- ORDER_BY_DESC
|
|
default: ORDER_BY_UNSPECIFIED
|
|
tags:
|
|
- Service
|
|
post:
|
|
summary: BroadcastTx broadcast transaction.
|
|
operationId: BroadcastTx
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
tx_response:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
title: The block height
|
|
txhash:
|
|
type: string
|
|
description: The transaction hash.
|
|
codespace:
|
|
type: string
|
|
title: Namespace for the Code
|
|
code:
|
|
type: integer
|
|
format: int64
|
|
description: Response code.
|
|
data:
|
|
type: string
|
|
description: Result bytes, if any.
|
|
raw_log:
|
|
type: string
|
|
description: >-
|
|
The output of the application's logger (raw string). May
|
|
be
|
|
|
|
non-deterministic.
|
|
logs:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
msg_index:
|
|
type: integer
|
|
format: int64
|
|
log:
|
|
type: string
|
|
events:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
description: >-
|
|
Attribute defines an attribute wrapper where
|
|
the key and value are
|
|
|
|
strings instead of raw bytes.
|
|
description: >-
|
|
StringEvent defines en Event object wrapper where
|
|
all the attributes
|
|
|
|
contain key/value pairs that are strings instead
|
|
of raw bytes.
|
|
description: >-
|
|
Events contains a slice of Event objects that were
|
|
emitted during some
|
|
|
|
execution.
|
|
description: >-
|
|
ABCIMessageLog defines a structure containing an indexed
|
|
tx ABCI message log.
|
|
description: >-
|
|
The output of the application's logger (typed). May be
|
|
non-deterministic.
|
|
info:
|
|
type: string
|
|
description: Additional information. May be non-deterministic.
|
|
gas_wanted:
|
|
type: string
|
|
format: int64
|
|
description: Amount of gas requested for transaction.
|
|
gas_used:
|
|
type: string
|
|
format: int64
|
|
description: Amount of gas consumed by transaction.
|
|
tx:
|
|
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"
|
|
}
|
|
timestamp:
|
|
type: string
|
|
description: >-
|
|
Time of the previous block. For heights > 1, it's the
|
|
weighted median of
|
|
|
|
the timestamps of the valid votes in the block.LastCommit.
|
|
For height == 1,
|
|
|
|
it's genesis time.
|
|
description: >-
|
|
TxResponse defines a structure containing relevant tx data and
|
|
metadata. The
|
|
|
|
tags are stringified and the log is JSON decoded.
|
|
description: |-
|
|
BroadcastTxResponse is the response type for the
|
|
Service.BroadcastTx 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: body
|
|
in: body
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
tx_bytes:
|
|
type: string
|
|
format: byte
|
|
description: tx_bytes is the raw transaction.
|
|
mode:
|
|
type: string
|
|
enum:
|
|
- BROADCAST_MODE_UNSPECIFIED
|
|
- BROADCAST_MODE_BLOCK
|
|
- BROADCAST_MODE_SYNC
|
|
- BROADCAST_MODE_ASYNC
|
|
default: BROADCAST_MODE_UNSPECIFIED
|
|
description: >-
|
|
BroadcastMode specifies the broadcast mode for the
|
|
TxService.Broadcast RPC method.
|
|
|
|
- BROADCAST_MODE_UNSPECIFIED: zero-value for mode ordering
|
|
- BROADCAST_MODE_BLOCK: BROADCAST_MODE_BLOCK defines a tx broadcasting mode where the client waits for
|
|
the tx to be committed in a block.
|
|
- BROADCAST_MODE_SYNC: BROADCAST_MODE_SYNC defines a tx broadcasting mode where the client waits for
|
|
a CheckTx execution response only.
|
|
- BROADCAST_MODE_ASYNC: BROADCAST_MODE_ASYNC defines a tx broadcasting mode where the client returns
|
|
immediately.
|
|
description: >-
|
|
BroadcastTxRequest is the request type for the
|
|
Service.BroadcastTxRequest
|
|
|
|
RPC method.
|
|
tags:
|
|
- Service
|
|
/cosmos/tx/v1beta1/txs/{hash}:
|
|
get:
|
|
summary: GetTx fetches a tx by hash.
|
|
operationId: GetTx
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
$ref: '#/definitions/cosmos.tx.v1beta1.GetTxResponse'
|
|
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: hash
|
|
description: hash is the tx hash to query, encoded as a hex string.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Service
|
|
/cosmos/upgrade/v1beta1/applied_plan/{name}:
|
|
get:
|
|
summary: AppliedPlan queries a previously applied upgrade plan by its name.
|
|
operationId: AppliedPlan
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
description: height is the block height at which the plan was applied.
|
|
description: >-
|
|
QueryAppliedPlanResponse is the response type for the
|
|
Query/AppliedPlan 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: name
|
|
description: name is the name of the applied plan to query for.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- Cosmos SDK
|
|
/cosmos/upgrade/v1beta1/current_plan:
|
|
get:
|
|
summary: CurrentPlan queries the current upgrade plan.
|
|
operationId: CurrentPlan
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
plan:
|
|
description: plan is the current upgrade plan.
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: >-
|
|
Sets the name for the upgrade. This name will be used by
|
|
the upgraded
|
|
|
|
version of the software to apply any special "on-upgrade"
|
|
commands during
|
|
|
|
the first BeginBlock method after the upgrade is applied.
|
|
It is also used
|
|
|
|
to detect whether a software version can handle a given
|
|
upgrade. If no
|
|
|
|
upgrade handler with this name has been set in the
|
|
software, it will be
|
|
|
|
assumed that the software is out-of-date when the upgrade
|
|
Time or Height is
|
|
|
|
reached and the software will exit.
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
Deprecated: Time based upgrades have been deprecated. Time
|
|
based upgrade logic
|
|
|
|
has been removed from the SDK.
|
|
|
|
If this field is not empty, an error will be thrown.
|
|
height:
|
|
type: string
|
|
format: int64
|
|
description: |-
|
|
The height at which the upgrade must be performed.
|
|
Only used if Time is not set.
|
|
info:
|
|
type: string
|
|
title: >-
|
|
Any application specific upgrade info to be included
|
|
on-chain
|
|
|
|
such as a git commit that validators could automatically
|
|
upgrade to
|
|
upgraded_client_state:
|
|
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"
|
|
}
|
|
description: >-
|
|
QueryCurrentPlanResponse is the response type for the
|
|
Query/CurrentPlan 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"
|
|
}
|
|
tags:
|
|
- Cosmos SDK
|
|
/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:
|
|
- Cosmos SDK
|
|
/cosmos/upgrade/v1beta1/upgraded_consensus_state/{last_height}:
|
|
get:
|
|
summary: |-
|
|
UpgradedConsensusState queries the consensus state that will serve
|
|
as a trusted kernel for the next version of this chain. It will only be
|
|
stored at the last height of this chain.
|
|
UpgradedConsensusState RPC not supported with legacy querier
|
|
operationId: UpgradedConsensusState
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
upgraded_consensus_state:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
QueryUpgradedConsensusStateResponse is the response type for the
|
|
Query/UpgradedConsensusState
|
|
|
|
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: last_height
|
|
description: |-
|
|
last height of the current chain must be sent in request
|
|
as this is the height under which next consensus state is stored
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: int64
|
|
tags:
|
|
- Cosmos SDK
|
|
/ibc/apps/transfer/v1/denom_traces:
|
|
get:
|
|
summary: DenomTraces queries all denomination traces.
|
|
operationId: IbcDenomTraces
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
denom_traces:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
description: >-
|
|
path defines the chain of port/channel identifiers used
|
|
for tracing the
|
|
|
|
source of the fungible token.
|
|
base_denom:
|
|
type: string
|
|
description: base denomination of the relayed fungible token.
|
|
description: >-
|
|
DenomTrace contains the base denomination for ICS20 fungible
|
|
tokens and the
|
|
|
|
source tracing information path.
|
|
description: denom_traces returns all denominations trace information.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryConnectionsResponse is the response type for the
|
|
Query/DenomTraces 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- IBC
|
|
/ibc/apps/transfer/v1/denom_traces/{hash}:
|
|
get:
|
|
summary: DenomTrace queries a denomination trace information.
|
|
operationId: IbcDenomTrace
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
denom_trace:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
description: >-
|
|
path defines the chain of port/channel identifiers used
|
|
for tracing the
|
|
|
|
source of the fungible token.
|
|
base_denom:
|
|
type: string
|
|
description: base denomination of the relayed fungible token.
|
|
description: >-
|
|
DenomTrace contains the base denomination for ICS20 fungible
|
|
tokens and the
|
|
|
|
source tracing information path.
|
|
description: >-
|
|
QueryDenomTraceResponse is the response type for the
|
|
Query/DenomTrace 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
parameters:
|
|
- name: hash
|
|
description: hash (in hex format) of the denomination trace information.
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- IBC
|
|
/ibc/apps/transfer/v1/params:
|
|
get:
|
|
summary: Params queries all parameters of the ibc-transfer module.
|
|
operationId: IbcTransferParams
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
params:
|
|
description: params defines the parameters of the module.
|
|
type: object
|
|
properties:
|
|
send_enabled:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
send_enabled enables or disables all cross-chain token
|
|
transfers from this
|
|
|
|
chain.
|
|
receive_enabled:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
receive_enabled enables or disables all cross-chain token
|
|
transfers to this
|
|
|
|
chain.
|
|
description: >-
|
|
QueryParamsResponse is the response type for the Query/Params 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
|
|
value:
|
|
type: string
|
|
format: byte
|
|
tags:
|
|
- IBC
|
|
/ibc/client/v1/params:
|
|
get:
|
|
summary: ClientParams queries all parameters of the ibc client.
|
|
operationId: IbcClientParams
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
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.
|
|
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"
|
|
}
|
|
tags:
|
|
- IBC
|
|
/ibc/core/client/v1/client_states:
|
|
get:
|
|
summary: ClientStates queries all the IBC light clients of a chain.
|
|
operationId: IbcClientStates
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
client_states:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
client_id:
|
|
type: string
|
|
title: client identifier
|
|
client_state:
|
|
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"
|
|
}
|
|
title: client state
|
|
description: >-
|
|
IdentifiedClientState defines a client state with an
|
|
additional client
|
|
|
|
identifier field.
|
|
description: list of stored ClientStates of the chain.
|
|
pagination:
|
|
title: pagination response
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
PageResponse is to be embedded in gRPC response messages where
|
|
the
|
|
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
description: >-
|
|
QueryClientStatesResponse is the response type for the
|
|
Query/ClientStates 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: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- IBC
|
|
/ibc/core/client/v1/client_states/{client_id}:
|
|
get:
|
|
summary: ClientState queries an IBC light client.
|
|
operationId: IbcClientState
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
client_state:
|
|
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"
|
|
}
|
|
title: client state associated with the request identifier
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
description: >-
|
|
QueryClientStateResponse is the response type for the
|
|
Query/ClientState RPC
|
|
|
|
method. Besides the client state, it includes a proof and the
|
|
height from
|
|
|
|
which the proof was retrieved.
|
|
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: client_id
|
|
description: client state unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- IBC
|
|
/ibc/core/client/v1/client_status/{client_id}:
|
|
get:
|
|
summary: Status queries the status of an IBC client.
|
|
operationId: IbcClientStatus
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
status:
|
|
type: string
|
|
description: >-
|
|
QueryClientStatusResponse is the response type for the
|
|
Query/ClientStatus RPC
|
|
|
|
method. It returns the current status of the IBC client.
|
|
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: client_id
|
|
description: client unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- IBC
|
|
/ibc/core/client/v1/consensus_states/{client_id}:
|
|
get:
|
|
summary: |-
|
|
ConsensusStates queries all the consensus state associated with a given
|
|
client.
|
|
operationId: IbcConsensusStates
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
consensus_states:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
height:
|
|
title: consensus state height
|
|
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
|
|
consensus_state:
|
|
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"
|
|
}
|
|
title: consensus state
|
|
description: >-
|
|
ConsensusStateWithHeight defines a consensus state with an
|
|
additional height
|
|
|
|
field.
|
|
title: consensus states associated with the identifier
|
|
pagination:
|
|
title: pagination response
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
PageResponse is to be embedded in gRPC response messages where
|
|
the
|
|
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
title: |-
|
|
QueryConsensusStatesResponse is the response type for the
|
|
Query/ConsensusStates 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: client_id
|
|
description: client identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- IBC
|
|
/ibc/core/client/v1/consensus_states/{client_id}/revision/{revision_number}/height/{revision_height}:
|
|
get:
|
|
summary: >-
|
|
ConsensusState queries a consensus state associated with a client state
|
|
at
|
|
|
|
a given height.
|
|
operationId: IbcConsensusState
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
consensus_state:
|
|
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"
|
|
}
|
|
title: >-
|
|
consensus state associated with the client identifier at the
|
|
given height
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
title: >-
|
|
QueryConsensusStateResponse is the response type for the
|
|
Query/ConsensusState
|
|
|
|
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: client_id
|
|
description: client identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: revision_number
|
|
description: consensus state revision number
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
- name: revision_height
|
|
description: consensus state revision height
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
- name: latest_height
|
|
description: >-
|
|
latest_height overrrides the height field and queries the latest
|
|
stored
|
|
|
|
ConsensusState.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- IBC
|
|
/ibc/core/client/v1/upgraded_client_states:
|
|
get:
|
|
summary: UpgradedClientState queries an Upgraded IBC light client.
|
|
operationId: IbcUpgradedClientState
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
upgraded_client_state:
|
|
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"
|
|
}
|
|
title: client state associated with the request identifier
|
|
description: |-
|
|
QueryUpgradedClientStateResponse is the response type for the
|
|
Query/UpgradedClientState 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"
|
|
}
|
|
tags:
|
|
- IBC
|
|
/ibc/core/client/v1/upgraded_consensus_states:
|
|
get:
|
|
summary: UpgradedConsensusState queries an Upgraded IBC consensus state.
|
|
operationId: IbcUpgradedConsensusState
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
upgraded_consensus_state:
|
|
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"
|
|
}
|
|
title: Consensus state associated with the request identifier
|
|
description: |-
|
|
QueryUpgradedConsensusStateResponse is the response type for the
|
|
Query/UpgradedConsensusState 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"
|
|
}
|
|
tags:
|
|
- IBC
|
|
/ibc/core/connection/v1/client_connections/{client_id}:
|
|
get:
|
|
summary: |-
|
|
ClientConnections queries the connection paths associated with a client
|
|
state.
|
|
operationId: IbcClientConnections
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
connection_paths:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: slice of all the connection paths associated with a client.
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was generated
|
|
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
|
|
title: |-
|
|
QueryClientConnectionsResponse is the response type for the
|
|
Query/ClientConnections 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: client_id
|
|
description: client identifier associated with a connection
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- IBC
|
|
/ibc/core/connection/v1/connections:
|
|
get:
|
|
summary: Connections queries all the IBC connections of a chain.
|
|
operationId: IbcConnections
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
connections:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: connection identifier.
|
|
client_id:
|
|
type: string
|
|
description: client associated with this connection.
|
|
versions:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
identifier:
|
|
type: string
|
|
title: unique version identifier
|
|
features:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: >-
|
|
list of features compatible with the specified
|
|
identifier
|
|
description: >-
|
|
Version defines the versioning scheme used to
|
|
negotiate the IBC verison in
|
|
|
|
the connection handshake.
|
|
title: >-
|
|
IBC version which can be utilised to determine encodings
|
|
or protocols for
|
|
|
|
channels or packets utilising this connection
|
|
state:
|
|
description: current state of the connection end.
|
|
type: string
|
|
enum:
|
|
- STATE_UNINITIALIZED_UNSPECIFIED
|
|
- STATE_INIT
|
|
- STATE_TRYOPEN
|
|
- STATE_OPEN
|
|
default: STATE_UNINITIALIZED_UNSPECIFIED
|
|
counterparty:
|
|
description: counterparty chain associated with this connection.
|
|
type: object
|
|
properties:
|
|
client_id:
|
|
type: string
|
|
description: >-
|
|
identifies the client on the counterparty chain
|
|
associated with a given
|
|
|
|
connection.
|
|
connection_id:
|
|
type: string
|
|
description: >-
|
|
identifies the connection end on the counterparty
|
|
chain associated with a
|
|
|
|
given connection.
|
|
prefix:
|
|
description: commitment merkle prefix of the counterparty chain.
|
|
type: object
|
|
properties:
|
|
key_prefix:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
MerklePrefix is merkle path prefixed to the key.
|
|
|
|
The constructed key from the Path and the key will
|
|
be append(Path.KeyPath,
|
|
|
|
append(Path.KeyPrefix, key...))
|
|
delay_period:
|
|
type: string
|
|
format: uint64
|
|
description: delay period associated with this connection.
|
|
description: >-
|
|
IdentifiedConnection defines a connection with additional
|
|
connection
|
|
|
|
identifier field.
|
|
description: list of stored connections of the chain.
|
|
pagination:
|
|
title: pagination response
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
PageResponse is to be embedded in gRPC response messages where
|
|
the
|
|
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
height:
|
|
title: query block height
|
|
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
|
|
description: >-
|
|
QueryConnectionsResponse is the response type for the
|
|
Query/Connections 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: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- IBC
|
|
/ibc/core/connection/v1/connections/{connection_id}:
|
|
get:
|
|
summary: Connection queries an IBC connection end.
|
|
operationId: IbcConnection
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
connection:
|
|
title: connection associated with the request identifier
|
|
type: object
|
|
properties:
|
|
client_id:
|
|
type: string
|
|
description: client associated with this connection.
|
|
versions:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
identifier:
|
|
type: string
|
|
title: unique version identifier
|
|
features:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: >-
|
|
list of features compatible with the specified
|
|
identifier
|
|
description: >-
|
|
Version defines the versioning scheme used to negotiate
|
|
the IBC verison in
|
|
|
|
the connection handshake.
|
|
description: >-
|
|
IBC version which can be utilised to determine encodings
|
|
or protocols for
|
|
|
|
channels or packets utilising this connection.
|
|
state:
|
|
description: current state of the connection end.
|
|
type: string
|
|
enum:
|
|
- STATE_UNINITIALIZED_UNSPECIFIED
|
|
- STATE_INIT
|
|
- STATE_TRYOPEN
|
|
- STATE_OPEN
|
|
default: STATE_UNINITIALIZED_UNSPECIFIED
|
|
counterparty:
|
|
description: counterparty chain associated with this connection.
|
|
type: object
|
|
properties:
|
|
client_id:
|
|
type: string
|
|
description: >-
|
|
identifies the client on the counterparty chain
|
|
associated with a given
|
|
|
|
connection.
|
|
connection_id:
|
|
type: string
|
|
description: >-
|
|
identifies the connection end on the counterparty
|
|
chain associated with a
|
|
|
|
given connection.
|
|
prefix:
|
|
description: commitment merkle prefix of the counterparty chain.
|
|
type: object
|
|
properties:
|
|
key_prefix:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
MerklePrefix is merkle path prefixed to the key.
|
|
|
|
The constructed key from the Path and the key will be
|
|
append(Path.KeyPath,
|
|
|
|
append(Path.KeyPrefix, key...))
|
|
delay_period:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
delay period that must pass before a consensus state can
|
|
be used for
|
|
|
|
packet-verification NOTE: delay period logic is only
|
|
implemented by some
|
|
|
|
clients.
|
|
description: >-
|
|
ConnectionEnd defines a stateful object on a chain connected
|
|
to another
|
|
|
|
separate one.
|
|
|
|
NOTE: there must only be 2 defined ConnectionEnds to establish
|
|
|
|
a connection between two chains.
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
description: >-
|
|
QueryConnectionResponse is the response type for the
|
|
Query/Connection RPC
|
|
|
|
method. Besides the connection end, it includes a proof and the
|
|
height from
|
|
|
|
which the proof was retrieved.
|
|
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: connection_id
|
|
description: connection unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- IBC
|
|
/ibc/core/connection/v1/connections/{connection_id}/client_state:
|
|
get:
|
|
summary: |-
|
|
ConnectionClientState queries the client state associated with the
|
|
connection.
|
|
operationId: IbcConnectionClientState
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
identified_client_state:
|
|
title: client state associated with the channel
|
|
type: object
|
|
properties:
|
|
client_id:
|
|
type: string
|
|
title: client identifier
|
|
client_state:
|
|
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"
|
|
}
|
|
title: client state
|
|
description: >-
|
|
IdentifiedClientState defines a client state with an
|
|
additional client
|
|
|
|
identifier field.
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
title: |-
|
|
QueryConnectionClientStateResponse is the response type for the
|
|
Query/ConnectionClientState 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: connection_id
|
|
description: connection identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- IBC
|
|
/ibc/core/connection/v1/connections/{connection_id}/consensus_state/revision/{revision_number}/height/{revision_height}:
|
|
get:
|
|
summary: |-
|
|
ConnectionConsensusState queries the consensus state associated with the
|
|
connection.
|
|
operationId: IbcConnectionConsensusState
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
consensus_state:
|
|
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"
|
|
}
|
|
title: consensus state associated with the channel
|
|
client_id:
|
|
type: string
|
|
title: client ID associated with the consensus state
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
title: |-
|
|
QueryConnectionConsensusStateResponse is the response type for the
|
|
Query/ConnectionConsensusState 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: connection_id
|
|
description: connection identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: revision_number
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
- name: revision_height
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
tags:
|
|
- IBC
|
|
/ibc/core/channel/v1/channels:
|
|
get:
|
|
summary: Channels queries all the IBC channels of a chain.
|
|
operationId: IbcChannels
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
channels:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
state:
|
|
title: current state of the channel end
|
|
type: string
|
|
enum:
|
|
- STATE_UNINITIALIZED_UNSPECIFIED
|
|
- STATE_INIT
|
|
- STATE_TRYOPEN
|
|
- STATE_OPEN
|
|
- STATE_CLOSED
|
|
default: STATE_UNINITIALIZED_UNSPECIFIED
|
|
description: >-
|
|
State defines if a channel is in one of the following
|
|
states:
|
|
|
|
CLOSED, INIT, TRYOPEN, OPEN or UNINITIALIZED.
|
|
|
|
- STATE_UNINITIALIZED_UNSPECIFIED: Default State
|
|
- STATE_INIT: A channel has just started the opening handshake.
|
|
- STATE_TRYOPEN: A channel has acknowledged the handshake step on the counterparty chain.
|
|
- STATE_OPEN: A channel has completed the handshake. Open channels are
|
|
ready to send and receive packets.
|
|
- STATE_CLOSED: A channel has been closed and can no longer be used to send or receive
|
|
packets.
|
|
ordering:
|
|
title: whether the channel is ordered or unordered
|
|
type: string
|
|
enum:
|
|
- ORDER_NONE_UNSPECIFIED
|
|
- ORDER_UNORDERED
|
|
- ORDER_ORDERED
|
|
default: ORDER_NONE_UNSPECIFIED
|
|
description: >-
|
|
- ORDER_NONE_UNSPECIFIED: zero-value for channel
|
|
ordering
|
|
- ORDER_UNORDERED: packets can be delivered in any order, which may differ from the order in
|
|
which they were sent.
|
|
- ORDER_ORDERED: packets are delivered exactly in the order which they were sent
|
|
counterparty:
|
|
title: counterparty channel end
|
|
type: object
|
|
properties:
|
|
port_id:
|
|
type: string
|
|
description: >-
|
|
port on the counterparty chain which owns the other
|
|
end of the channel.
|
|
channel_id:
|
|
type: string
|
|
title: channel end on the counterparty chain
|
|
connection_hops:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: >-
|
|
list of connection identifiers, in order, along which
|
|
packets sent on
|
|
|
|
this channel will travel
|
|
version:
|
|
type: string
|
|
title: >-
|
|
opaque channel version, which is agreed upon during the
|
|
handshake
|
|
port_id:
|
|
type: string
|
|
title: port identifier
|
|
channel_id:
|
|
type: string
|
|
title: channel identifier
|
|
description: >-
|
|
IdentifiedChannel defines a channel with additional port and
|
|
channel
|
|
|
|
identifier fields.
|
|
description: list of stored channels of the chain.
|
|
pagination:
|
|
title: pagination response
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
PageResponse is to be embedded in gRPC response messages where
|
|
the
|
|
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
height:
|
|
title: query block height
|
|
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
|
|
description: >-
|
|
QueryChannelsResponse is the response type for the Query/Channels
|
|
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: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- IBC
|
|
/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}:
|
|
get:
|
|
summary: Channel queries an IBC Channel.
|
|
operationId: IbcChannel
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
channel:
|
|
title: channel associated with the request identifiers
|
|
type: object
|
|
properties:
|
|
state:
|
|
title: current state of the channel end
|
|
type: string
|
|
enum:
|
|
- STATE_UNINITIALIZED_UNSPECIFIED
|
|
- STATE_INIT
|
|
- STATE_TRYOPEN
|
|
- STATE_OPEN
|
|
- STATE_CLOSED
|
|
default: STATE_UNINITIALIZED_UNSPECIFIED
|
|
description: >-
|
|
State defines if a channel is in one of the following
|
|
states:
|
|
|
|
CLOSED, INIT, TRYOPEN, OPEN or UNINITIALIZED.
|
|
|
|
- STATE_UNINITIALIZED_UNSPECIFIED: Default State
|
|
- STATE_INIT: A channel has just started the opening handshake.
|
|
- STATE_TRYOPEN: A channel has acknowledged the handshake step on the counterparty chain.
|
|
- STATE_OPEN: A channel has completed the handshake. Open channels are
|
|
ready to send and receive packets.
|
|
- STATE_CLOSED: A channel has been closed and can no longer be used to send or receive
|
|
packets.
|
|
ordering:
|
|
title: whether the channel is ordered or unordered
|
|
type: string
|
|
enum:
|
|
- ORDER_NONE_UNSPECIFIED
|
|
- ORDER_UNORDERED
|
|
- ORDER_ORDERED
|
|
default: ORDER_NONE_UNSPECIFIED
|
|
description: |-
|
|
- ORDER_NONE_UNSPECIFIED: zero-value for channel ordering
|
|
- ORDER_UNORDERED: packets can be delivered in any order, which may differ from the order in
|
|
which they were sent.
|
|
- ORDER_ORDERED: packets are delivered exactly in the order which they were sent
|
|
counterparty:
|
|
title: counterparty channel end
|
|
type: object
|
|
properties:
|
|
port_id:
|
|
type: string
|
|
description: >-
|
|
port on the counterparty chain which owns the other
|
|
end of the channel.
|
|
channel_id:
|
|
type: string
|
|
title: channel end on the counterparty chain
|
|
connection_hops:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: >-
|
|
list of connection identifiers, in order, along which
|
|
packets sent on
|
|
|
|
this channel will travel
|
|
version:
|
|
type: string
|
|
title: >-
|
|
opaque channel version, which is agreed upon during the
|
|
handshake
|
|
description: >-
|
|
Channel defines pipeline for exactly-once packet delivery
|
|
between specific
|
|
|
|
modules on separate blockchains, which has at least one end
|
|
capable of
|
|
|
|
sending packets and one end capable of receiving packets.
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
description: >-
|
|
QueryChannelResponse is the response type for the Query/Channel
|
|
RPC method.
|
|
|
|
Besides the Channel end, it includes a proof and the height from
|
|
which the
|
|
|
|
proof was retrieved.
|
|
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: channel_id
|
|
description: channel unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: port_id
|
|
description: port unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- IBC
|
|
/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/client_state:
|
|
get:
|
|
summary: >-
|
|
ChannelClientState queries for the client state for the channel
|
|
associated
|
|
|
|
with the provided channel identifiers.
|
|
operationId: IbcChannelClientState
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
identified_client_state:
|
|
title: client state associated with the channel
|
|
type: object
|
|
properties:
|
|
client_id:
|
|
type: string
|
|
title: client identifier
|
|
client_state:
|
|
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"
|
|
}
|
|
title: client state
|
|
description: >-
|
|
IdentifiedClientState defines a client state with an
|
|
additional client
|
|
|
|
identifier field.
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
title: |-
|
|
QueryChannelClientStateResponse is the Response type for the
|
|
Query/QueryChannelClientState 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: channel_id
|
|
description: channel unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: port_id
|
|
description: port unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- IBC
|
|
/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/consensus_state/revision/{revision_number}/height/{revision_height}:
|
|
get:
|
|
summary: |-
|
|
ChannelConsensusState queries for the consensus state for the channel
|
|
associated with the provided channel identifiers.
|
|
operationId: IbcChannelConsensusState
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
consensus_state:
|
|
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"
|
|
}
|
|
title: consensus state associated with the channel
|
|
client_id:
|
|
type: string
|
|
title: client ID associated with the consensus state
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
title: |-
|
|
QueryChannelClientStateResponse is the Response type for the
|
|
Query/QueryChannelClientState 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: channel_id
|
|
description: channel unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: port_id
|
|
description: port unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: revision_number
|
|
description: revision number of the consensus state
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
- name: revision_height
|
|
description: revision height of the consensus state
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
tags:
|
|
- IBC
|
|
/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/next_sequence:
|
|
get:
|
|
summary: >-
|
|
NextSequenceReceive returns the next receive sequence for a given
|
|
channel.
|
|
operationId: IbcNextSequenceReceive
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
next_sequence_receive:
|
|
type: string
|
|
format: uint64
|
|
title: next sequence receive number
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
title: |-
|
|
QuerySequenceResponse is the request type for the
|
|
Query/QueryNextSequenceReceiveResponse 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: channel_id
|
|
description: channel unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: port_id
|
|
description: port unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
tags:
|
|
- IBC
|
|
/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/packet_acknowledgements:
|
|
get:
|
|
summary: >-
|
|
PacketAcknowledgements returns all the packet acknowledgements
|
|
associated
|
|
|
|
with a channel.
|
|
operationId: IbcPacketAcknowledgements
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
acknowledgements:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
port_id:
|
|
type: string
|
|
description: channel port identifier.
|
|
channel_id:
|
|
type: string
|
|
description: channel unique identifier.
|
|
sequence:
|
|
type: string
|
|
format: uint64
|
|
description: packet sequence.
|
|
data:
|
|
type: string
|
|
format: byte
|
|
description: embedded data that represents packet state.
|
|
description: >-
|
|
PacketState defines the generic type necessary to retrieve
|
|
and store
|
|
|
|
packet commitments, acknowledgements, and receipts.
|
|
|
|
Caller is responsible for knowing the context necessary to
|
|
interpret this
|
|
|
|
state as a commitment, acknowledgement, or a receipt.
|
|
pagination:
|
|
title: pagination response
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
PageResponse is to be embedded in gRPC response messages where
|
|
the
|
|
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
height:
|
|
title: query block height
|
|
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
|
|
title: |-
|
|
QueryPacketAcknowledgemetsResponse is the request type for the
|
|
Query/QueryPacketAcknowledgements 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: channel_id
|
|
description: channel unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: port_id
|
|
description: port unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- IBC
|
|
/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/packet_acks/{sequence}:
|
|
get:
|
|
summary: PacketAcknowledgement queries a stored packet acknowledgement hash.
|
|
operationId: IbcPacketAcknowledgement
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
acknowledgement:
|
|
type: string
|
|
format: byte
|
|
title: packet associated with the request fields
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
title: >-
|
|
QueryPacketAcknowledgementResponse defines the client query
|
|
response for a
|
|
|
|
packet which also includes a proof and the height from which the
|
|
|
|
proof was retrieved
|
|
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: channel_id
|
|
description: channel unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: port_id
|
|
description: port unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: sequence
|
|
description: packet sequence
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
tags:
|
|
- IBC
|
|
/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/packet_commitments:
|
|
get:
|
|
summary: |-
|
|
PacketCommitments returns all the packet commitments hashes associated
|
|
with a channel.
|
|
operationId: IbcPacketCommitments
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
commitments:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
port_id:
|
|
type: string
|
|
description: channel port identifier.
|
|
channel_id:
|
|
type: string
|
|
description: channel unique identifier.
|
|
sequence:
|
|
type: string
|
|
format: uint64
|
|
description: packet sequence.
|
|
data:
|
|
type: string
|
|
format: byte
|
|
description: embedded data that represents packet state.
|
|
description: >-
|
|
PacketState defines the generic type necessary to retrieve
|
|
and store
|
|
|
|
packet commitments, acknowledgements, and receipts.
|
|
|
|
Caller is responsible for knowing the context necessary to
|
|
interpret this
|
|
|
|
state as a commitment, acknowledgement, or a receipt.
|
|
pagination:
|
|
title: pagination response
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
PageResponse is to be embedded in gRPC response messages where
|
|
the
|
|
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
height:
|
|
title: query block height
|
|
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
|
|
title: |-
|
|
QueryPacketCommitmentsResponse is the request type for the
|
|
Query/QueryPacketCommitments 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: channel_id
|
|
description: channel unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: port_id
|
|
description: port unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- IBC
|
|
/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/packet_commitments/{packet_ack_sequences}/unreceived_acks:
|
|
get:
|
|
summary: >-
|
|
UnreceivedAcks returns all the unreceived IBC acknowledgements
|
|
associated
|
|
|
|
with a channel and sequences.
|
|
operationId: IbcUnreceivedAcks
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
sequences:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uint64
|
|
title: list of unreceived acknowledgement sequences
|
|
height:
|
|
title: query block height
|
|
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
|
|
title: |-
|
|
QueryUnreceivedAcksResponse is the response type for the
|
|
Query/UnreceivedAcks 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: channel_id
|
|
description: channel unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: port_id
|
|
description: port unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: packet_ack_sequences
|
|
description: list of acknowledgement sequences
|
|
in: path
|
|
required: true
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uint64
|
|
collectionFormat: csv
|
|
minItems: 1
|
|
tags:
|
|
- IBC
|
|
/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/packet_commitments/{packet_commitment_sequences}/unreceived_packets:
|
|
get:
|
|
summary: >-
|
|
UnreceivedPackets returns all the unreceived IBC packets associated with
|
|
a
|
|
|
|
channel and sequences.
|
|
operationId: IbcUnreceivedPackets
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
sequences:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uint64
|
|
title: list of unreceived packet sequences
|
|
height:
|
|
title: query block height
|
|
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
|
|
title: |-
|
|
QueryUnreceivedPacketsResponse is the response type for the
|
|
Query/UnreceivedPacketCommitments 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: channel_id
|
|
description: channel unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: port_id
|
|
description: port unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: packet_commitment_sequences
|
|
description: list of packet sequences
|
|
in: path
|
|
required: true
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uint64
|
|
collectionFormat: csv
|
|
minItems: 1
|
|
tags:
|
|
- IBC
|
|
/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/packet_commitments/{sequence}:
|
|
get:
|
|
summary: PacketCommitment queries a stored packet commitment hash.
|
|
operationId: IbcPacketCommitment
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
commitment:
|
|
type: string
|
|
format: byte
|
|
title: packet associated with the request fields
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
title: >-
|
|
QueryPacketCommitmentResponse defines the client query response
|
|
for a packet
|
|
|
|
which also includes a proof and the height from which the proof
|
|
was
|
|
|
|
retrieved
|
|
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: channel_id
|
|
description: channel unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: port_id
|
|
description: port unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: sequence
|
|
description: packet sequence
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
tags:
|
|
- IBC
|
|
/ibc/core/channel/v1/channels/{channel_id}/ports/{port_id}/packet_receipts/{sequence}:
|
|
get:
|
|
summary: >-
|
|
PacketReceipt queries if a given packet sequence has been received on
|
|
the
|
|
|
|
queried chain
|
|
operationId: IbcPacketReceipt
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
received:
|
|
type: boolean
|
|
format: boolean
|
|
title: success flag for if receipt exists
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
title: >-
|
|
QueryPacketReceiptResponse defines the client query response for a
|
|
packet
|
|
|
|
receipt which also includes a proof, and the height from which the
|
|
proof was
|
|
|
|
retrieved
|
|
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: channel_id
|
|
description: channel unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: port_id
|
|
description: port unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: sequence
|
|
description: packet sequence
|
|
in: path
|
|
required: true
|
|
type: string
|
|
format: uint64
|
|
tags:
|
|
- IBC
|
|
/ibc/core/channel/v1/connections/{connection}/channels:
|
|
get:
|
|
summary: |-
|
|
ConnectionChannels queries all the channels associated with a connection
|
|
end.
|
|
operationId: IbcConnectionChannels
|
|
responses:
|
|
'200':
|
|
description: A successful response.
|
|
schema:
|
|
type: object
|
|
properties:
|
|
channels:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
state:
|
|
title: current state of the channel end
|
|
type: string
|
|
enum:
|
|
- STATE_UNINITIALIZED_UNSPECIFIED
|
|
- STATE_INIT
|
|
- STATE_TRYOPEN
|
|
- STATE_OPEN
|
|
- STATE_CLOSED
|
|
default: STATE_UNINITIALIZED_UNSPECIFIED
|
|
description: >-
|
|
State defines if a channel is in one of the following
|
|
states:
|
|
|
|
CLOSED, INIT, TRYOPEN, OPEN or UNINITIALIZED.
|
|
|
|
- STATE_UNINITIALIZED_UNSPECIFIED: Default State
|
|
- STATE_INIT: A channel has just started the opening handshake.
|
|
- STATE_TRYOPEN: A channel has acknowledged the handshake step on the counterparty chain.
|
|
- STATE_OPEN: A channel has completed the handshake. Open channels are
|
|
ready to send and receive packets.
|
|
- STATE_CLOSED: A channel has been closed and can no longer be used to send or receive
|
|
packets.
|
|
ordering:
|
|
title: whether the channel is ordered or unordered
|
|
type: string
|
|
enum:
|
|
- ORDER_NONE_UNSPECIFIED
|
|
- ORDER_UNORDERED
|
|
- ORDER_ORDERED
|
|
default: ORDER_NONE_UNSPECIFIED
|
|
description: >-
|
|
- ORDER_NONE_UNSPECIFIED: zero-value for channel
|
|
ordering
|
|
- ORDER_UNORDERED: packets can be delivered in any order, which may differ from the order in
|
|
which they were sent.
|
|
- ORDER_ORDERED: packets are delivered exactly in the order which they were sent
|
|
counterparty:
|
|
title: counterparty channel end
|
|
type: object
|
|
properties:
|
|
port_id:
|
|
type: string
|
|
description: >-
|
|
port on the counterparty chain which owns the other
|
|
end of the channel.
|
|
channel_id:
|
|
type: string
|
|
title: channel end on the counterparty chain
|
|
connection_hops:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: >-
|
|
list of connection identifiers, in order, along which
|
|
packets sent on
|
|
|
|
this channel will travel
|
|
version:
|
|
type: string
|
|
title: >-
|
|
opaque channel version, which is agreed upon during the
|
|
handshake
|
|
port_id:
|
|
type: string
|
|
title: port identifier
|
|
channel_id:
|
|
type: string
|
|
title: channel identifier
|
|
description: >-
|
|
IdentifiedChannel defines a channel with additional port and
|
|
channel
|
|
|
|
identifier fields.
|
|
description: list of channels associated with a connection.
|
|
pagination:
|
|
title: pagination response
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
PageResponse is to be embedded in gRPC response messages where
|
|
the
|
|
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
height:
|
|
title: query block height
|
|
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
|
|
title: |-
|
|
QueryConnectionChannelsResponse is the Response type for the
|
|
Query/QueryConnectionChannels 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: connection
|
|
description: connection unique identifier
|
|
in: path
|
|
required: true
|
|
type: string
|
|
- name: pagination.key
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: byte
|
|
- name: pagination.offset
|
|
description: >-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
|
|
It is less efficient than using key. Only one of offset or key
|
|
should
|
|
|
|
be set.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.limit
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
in: query
|
|
required: false
|
|
type: string
|
|
format: uint64
|
|
- name: pagination.count_total
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in
|
|
UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored
|
|
when key
|
|
|
|
is set.
|
|
in: query
|
|
required: false
|
|
type: boolean
|
|
format: boolean
|
|
tags:
|
|
- IBC
|
|
/cdp:
|
|
post:
|
|
deprecated: true
|
|
summary: Create a cdp transaction
|
|
tags:
|
|
- CDP
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- description: create cdp post parameters
|
|
name: post_cdp_req
|
|
in: body
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
owner:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
collateral:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: xrp
|
|
amount:
|
|
type: string
|
|
example: '10000000000'
|
|
principal:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
collateral_type:
|
|
type: string
|
|
example: xrpb-a
|
|
responses:
|
|
'200':
|
|
description: Tx was successfully generated
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Server internal error
|
|
/cdp/{owner}/{collateral_type}/deposits:
|
|
post:
|
|
deprecated: true
|
|
summary: Create a deposit to cdp transaction
|
|
tags:
|
|
- CDP
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: owner
|
|
description: Owner address in bech32 format
|
|
required: true
|
|
type: string
|
|
x-example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
- in: path
|
|
name: collateral_type
|
|
description: Collateral type
|
|
required: true
|
|
type: string
|
|
x-example: xrpb-a
|
|
- description: deposit cdp post parameters
|
|
name: post_deposit_req
|
|
in: body
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
owner:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
depositor:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
collateral:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: xrp
|
|
amount:
|
|
type: string
|
|
example: '10000000000'
|
|
collateral_type:
|
|
type: string
|
|
example: xrpb-a
|
|
responses:
|
|
'200':
|
|
description: Tx was successfully generated
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Server internal error
|
|
/cdp/{owner}/{collateral_type}/withdraw:
|
|
post:
|
|
deprecated: true
|
|
summary: create a withdraw collateral transaction
|
|
tags:
|
|
- CDP
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: owner
|
|
description: Owner address in bech32 format
|
|
required: true
|
|
type: string
|
|
x-example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
- in: path
|
|
name: collateral_type
|
|
description: Collateral type
|
|
required: true
|
|
type: string
|
|
x-example: xrpb-a
|
|
- description: withdraw cdp post parameters
|
|
name: post_withdraw_req
|
|
in: body
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
owner:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
depositor:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
collateral:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: xrp
|
|
amount:
|
|
type: string
|
|
example: '10000000000'
|
|
collateral_type:
|
|
type: string
|
|
example: xrpb-a
|
|
responses:
|
|
'200':
|
|
description: Tx was successfully generated
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Server internal error
|
|
/cdp/{owner}/{collateral_type}/draw:
|
|
post:
|
|
deprecated: true
|
|
summary: Create a draw debt transaction
|
|
tags:
|
|
- CDP
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: owner
|
|
description: Owner address in bech32 format
|
|
required: true
|
|
type: string
|
|
x-example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
- in: path
|
|
name: collateral_type
|
|
description: Collateral type
|
|
required: true
|
|
type: string
|
|
x-example: xrpb-a
|
|
- description: draw cdp post parameters
|
|
name: post_draw_req
|
|
in: body
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
owner:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
principal:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
collateral_type:
|
|
type: string
|
|
example: xrpb-a
|
|
responses:
|
|
'200':
|
|
description: Tx was successfully generated
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Server internal error
|
|
/cdp/{owner}/{collateral_type}/repay:
|
|
post:
|
|
deprecated: true
|
|
summary: Repay debt from a CDP
|
|
tags:
|
|
- CDP
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: owner
|
|
description: Owner address in bech32 format
|
|
required: true
|
|
type: string
|
|
x-example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
- in: path
|
|
name: collateral_type
|
|
description: Collateral type
|
|
required: true
|
|
type: string
|
|
x-example: xrpb-a
|
|
- description: repay cdp post parameters
|
|
name: post_repay_req
|
|
in: body
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
owner:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
payment:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
collateral_type:
|
|
type: string
|
|
example: xrpb-a
|
|
responses:
|
|
'200':
|
|
description: Tx was successfully generated
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Server internal error
|
|
/cdp/{owner}/{collateral_type}/liquidate:
|
|
post:
|
|
deprecated: true
|
|
summary: >-
|
|
Attempt to liquidate a CDP whose collateralization ratio is under its
|
|
liquidaiton ratio
|
|
tags:
|
|
- CDP
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: owner
|
|
description: Owner address in bech32 format
|
|
required: true
|
|
type: string
|
|
x-example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
- in: path
|
|
name: collateral_type
|
|
description: Collateral type
|
|
required: true
|
|
type: string
|
|
x-example: xrpb-a
|
|
- description: liquidate cdp post parameters
|
|
name: post_liquidate_req
|
|
in: body
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
owner:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
collateral_type:
|
|
type: string
|
|
example: xrpb-a
|
|
responses:
|
|
'200':
|
|
description: Tx was successfully generated
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Server internal error
|
|
/cdp/accounts:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the cdp module accounts
|
|
tags:
|
|
- CDP
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: The cdp module accounts
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
account_number:
|
|
type: number
|
|
address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
coins:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
name:
|
|
type: string
|
|
permissions:
|
|
type: array
|
|
items:
|
|
type: string
|
|
public_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
value:
|
|
type: string
|
|
sequence:
|
|
type: number
|
|
'500':
|
|
description: Server internal error
|
|
/cdp/parameters:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the parameters of the cdp module
|
|
tags:
|
|
- CDP
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: The parameters of the cdp module
|
|
schema:
|
|
type: object
|
|
properties:
|
|
collateral_params:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: xrp
|
|
type:
|
|
type: string
|
|
example: xrp-a
|
|
liquidation_ratio:
|
|
type: string
|
|
example: '2.000000000000000000'
|
|
debt_limit:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
stability_fee:
|
|
type: string
|
|
example: '1.000000001547126000'
|
|
auction_size:
|
|
type: string
|
|
example: '5000000000'
|
|
liquidation_penalty:
|
|
type: string
|
|
example: '0.050000000000000000'
|
|
prefix:
|
|
type: integer
|
|
example: 0
|
|
spot_market_id:
|
|
type: string
|
|
example: xrp:usd
|
|
liquidation_market_id:
|
|
type: string
|
|
example: xrp:usd:30
|
|
keeper_reward_percentage:
|
|
type: string
|
|
example: '0.05'
|
|
check_collateralization_index_count:
|
|
type: string
|
|
example: '10'
|
|
conversion_factor:
|
|
type: string
|
|
example: '6'
|
|
debt_params:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
reference_asset:
|
|
type: string
|
|
example: usd
|
|
conversion_factor:
|
|
type: string
|
|
example: '6'
|
|
debt_floor:
|
|
type: string
|
|
example: '10000000'
|
|
global_debt_limit:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: xrp
|
|
amount:
|
|
type: string
|
|
example: '10000000000'
|
|
surplus_auction_threshold:
|
|
type: string
|
|
example: '1000000000'
|
|
surplus_auction_lot:
|
|
type: string
|
|
example: '10000000'
|
|
debt_auction_threshold:
|
|
type: string
|
|
example: '1000000000'
|
|
savings_distribution_frequency:
|
|
type: string
|
|
example: '60000000'
|
|
circuit_breaker:
|
|
type: boolean
|
|
example: false
|
|
'500':
|
|
description: Server internal error
|
|
/cdp/cdps/cdp/{owner}/{collateral_type}:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the cdp associated with the input owner address and collateral type
|
|
tags:
|
|
- CDP
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: owner
|
|
description: Owner address in bech32 format
|
|
required: true
|
|
type: string
|
|
x-example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
- in: path
|
|
name: collateral_type
|
|
description: Collateral type
|
|
required: true
|
|
type: string
|
|
x-example: xrpb-a
|
|
responses:
|
|
'200':
|
|
description: CDP associated with owner
|
|
schema:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
example: '1'
|
|
owner:
|
|
type: string
|
|
example: kava1q53rwutgpzx7szcrgzqguxyccjpzt9j4cyctn9
|
|
collateral:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: xrp
|
|
amount:
|
|
type: string
|
|
example: '10000000000'
|
|
type:
|
|
type: string
|
|
example: xrpb-a
|
|
principal:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
accumulated_fees:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
fees_updated:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
collateral_value:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
collateralization_ratio:
|
|
type: string
|
|
example: '2.721734157907653857'
|
|
'500':
|
|
description: Server internal error
|
|
/cdp/cdps/collateralType/{collateral_type}:
|
|
get:
|
|
deprecated: true
|
|
summary: Get all cdps with collateral type equal to the input collateral type
|
|
tags:
|
|
- CDP
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: collateral_type
|
|
description: Collateral Type
|
|
required: true
|
|
type: string
|
|
x-example: xrpb-a
|
|
responses:
|
|
'200':
|
|
description: All CDPs with the input collateral type
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
example: '1'
|
|
owner:
|
|
type: string
|
|
example: kava1q53rwutgpzx7szcrgzqguxyccjpzt9j4cyctn9
|
|
collateral:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: xrp
|
|
amount:
|
|
type: string
|
|
example: '10000000000'
|
|
type:
|
|
type: string
|
|
example: xrpb-a
|
|
principal:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
accumulated_fees:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
fees_updated:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
collateral_value:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
collateralization_ratio:
|
|
type: string
|
|
example: '2.721734157907653857'
|
|
'500':
|
|
description: Server internal error
|
|
/cdp/cdps/ratio/{collateral_type}/{ratio}:
|
|
get:
|
|
deprecated: true
|
|
summary: >-
|
|
Get all cdps with collateral type equal to the input collateral type and
|
|
collateralization ratio strictly less than the input ratio
|
|
tags:
|
|
- CDP
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: collateral_type
|
|
description: Collateral type
|
|
required: true
|
|
type: string
|
|
x-example: xrpb-a
|
|
- in: path
|
|
name: ratio
|
|
description: Collateralization ratio
|
|
required: true
|
|
type: string
|
|
x-example: '2.0'
|
|
responses:
|
|
'200':
|
|
description: >-
|
|
All CDPs with the input collateral type and collateralization ratio
|
|
less than the input ratio
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
example: '1'
|
|
owner:
|
|
type: string
|
|
example: kava1q53rwutgpzx7szcrgzqguxyccjpzt9j4cyctn9
|
|
collateral:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: xrp
|
|
amount:
|
|
type: string
|
|
example: '10000000000'
|
|
type:
|
|
type: string
|
|
example: xrpb-a
|
|
principal:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
accumulated_fees:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
fees_updated:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
collateral_value:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
collateralization_ratio:
|
|
type: string
|
|
example: '2.721734157907653857'
|
|
'500':
|
|
description: Server internal error
|
|
/cdp/cdps/cdp/deposits/{owner}/{collateral_type}:
|
|
get:
|
|
deprecated: true
|
|
summary: >-
|
|
Get the deposits associated with the cdp owned by an address for a
|
|
collateral type
|
|
tags:
|
|
- CDP
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: owner
|
|
description: Owner address in bech32 format
|
|
required: true
|
|
type: string
|
|
x-example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
- in: path
|
|
name: collateral_type
|
|
description: Collateral type
|
|
required: true
|
|
type: string
|
|
x-example: xrpb-a
|
|
responses:
|
|
'200':
|
|
description: Deposits associated with the cdp
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
cdp_id:
|
|
type: string
|
|
example: '1'
|
|
depositor:
|
|
type: string
|
|
example: kava1q53rwutgpzx7szcrgzqguxyccjpzt9j4cyctn9
|
|
amount:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: xrp
|
|
amount:
|
|
type: string
|
|
example: '10000000000'
|
|
'500':
|
|
description: Server internal error
|
|
/cdp/cdps:
|
|
get:
|
|
deprecated: true
|
|
summary: Query all active cdps
|
|
tags:
|
|
- CDP
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: query
|
|
name: owner
|
|
description: Owner address in bech32 format
|
|
required: false
|
|
type: string
|
|
x-example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
- in: query
|
|
name: collateral_type
|
|
description: Collateral type
|
|
required: false
|
|
type: string
|
|
x-example: xrpb-a
|
|
- in: query
|
|
name: id
|
|
description: CDP ID
|
|
required: false
|
|
type: string
|
|
x-example: '4'
|
|
- in: query
|
|
name: ratio
|
|
description: Collateralization ratio
|
|
required: false
|
|
type: string
|
|
x-example: '2.75'
|
|
responses:
|
|
'200':
|
|
description: Query cdps
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
example: '1'
|
|
owner:
|
|
type: string
|
|
example: kava1q53rwutgpzx7szcrgzqguxyccjpzt9j4cyctn9
|
|
collateral:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: xrp
|
|
amount:
|
|
type: string
|
|
example: '10000000000'
|
|
type:
|
|
type: string
|
|
example: xrpb-a
|
|
principal:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
accumulated_fees:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
fees_updated:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
collateral_value:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
collateralization_ratio:
|
|
type: string
|
|
example: '2.721734157907653857'
|
|
'500':
|
|
description: Internal Server Error
|
|
/bep3/swap/create:
|
|
post:
|
|
deprecated: true
|
|
summary: Generate a create atomic swap transaction
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- BEP3
|
|
parameters:
|
|
- in: body
|
|
name: Create atomic swap request body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
from:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
recipient_other_chain:
|
|
type: string
|
|
description: address on another chain (binance)
|
|
example: bnb1uky3me9ggqypmrsvxk7ur6hqkzq7zmv4ed4ng7
|
|
sender_other_chain:
|
|
type: string
|
|
description: address on another chain (binance)
|
|
example: bnb10uypsspvl6jlxcx5xse02pag39l8xpe7a3468h
|
|
random_number_hash:
|
|
type: string
|
|
description: hex-encoded sha256 hash of a 64bit random number
|
|
example: >-
|
|
c0544b7f4b890a673ea3f61bdb4650fbfe2f3e56bda1b397d6d592fca7163c8c
|
|
timestamp:
|
|
type: string
|
|
description: unix timestamp
|
|
example: '1585252531'
|
|
height_span:
|
|
type: string
|
|
description: span of blocks for which an atomic swap is valid
|
|
example: '3600'
|
|
cross_chain:
|
|
type: boolean
|
|
example: true
|
|
responses:
|
|
'200':
|
|
description: The transaction was successfully generated
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/bep3/swap/claim:
|
|
post:
|
|
deprecated: true
|
|
summary: Generate a claim atomic swap transaction
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- BEP3
|
|
parameters:
|
|
- in: body
|
|
name: Create atomic swap request body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
from:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
swap_id:
|
|
type: string
|
|
example: >-
|
|
3ca20f0152f03b0aabe73e7aa1ddf78b9048ede5a9a73846e1ef53bebbfa4185
|
|
random_number:
|
|
type: string
|
|
example: >-
|
|
e3d0a98b459f72231da69c3bd771c1e721fef4be83c14b80dc805ba71019eebe
|
|
responses:
|
|
'200':
|
|
description: The transaction was successfully generated
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/bep3/swap/refund:
|
|
post:
|
|
deprecated: true
|
|
summary: Generate a refund atomic swap transaction
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- BEP3
|
|
parameters:
|
|
- in: body
|
|
name: Create atomic swap request body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
from:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
swap_id:
|
|
type: string
|
|
example: >-
|
|
1b00244021ec239867e5b8c44bcd98e40f3148806a8c0a8fd3418872986becba
|
|
responses:
|
|
'200':
|
|
description: The transaction was successfully generated
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/bep3/swap/{swap-id}:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the atomic swap object associated with the input swap ID
|
|
tags:
|
|
- BEP3
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
required: true
|
|
name: swap-id
|
|
description: the swap ID
|
|
type: string
|
|
x-example: 1b00244021ec239867e5b8c44bcd98e40f3148806a8c0a8fd3418872986becba
|
|
responses:
|
|
'200':
|
|
description: Atomic swap
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '548883'
|
|
result:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
example: >-
|
|
FFEA80A3D9A42427CC12DB957866C6D428C16AA5EA6D9A4A756EF04BF9F2FF06
|
|
status:
|
|
type: string
|
|
example: Completed
|
|
amount:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
amount:
|
|
type: string
|
|
example: '555555'
|
|
random_number_hash:
|
|
type: string
|
|
example: >-
|
|
0b1e35e991bf052be230ae8dd3ff90b69a610160d28a9eb3c0701395f9d2b291
|
|
expire_hieght:
|
|
type: string
|
|
example: '532463'
|
|
timestamp:
|
|
type: string
|
|
example: '1589020884'
|
|
sender:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
recipient:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1atsrkjac6ulgmwhudfc36lnjfgv340vlvm757z
|
|
sender_other_chain:
|
|
type: string
|
|
description: address on another chain (binance)
|
|
example: bnb1uky3me9ggqypmrsvxk7ur6hqkzq7zmv4ed4ng7
|
|
recipient_other_chain:
|
|
type: string
|
|
description: address on another chain (binance)
|
|
example: bnb10uypsspvl6jlxcx5xse02pag39l8xpe7a3468h
|
|
closed_block:
|
|
type: string
|
|
example: '532105'
|
|
cross_chain:
|
|
type: boolean
|
|
example: true
|
|
direction:
|
|
type: string
|
|
example: Incoming
|
|
'500':
|
|
description: Server internal error
|
|
/bep3/swaps:
|
|
get:
|
|
deprecated: true
|
|
summary: Get all atomic swaps
|
|
tags:
|
|
- BEP3
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: All atomic swaps
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
example: >-
|
|
FFEA80A3D9A42427CC12DB957866C6D428C16AA5EA6D9A4A756EF04BF9F2FF06
|
|
status:
|
|
type: string
|
|
example: Completed
|
|
amount:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
amount:
|
|
type: string
|
|
example: '555555'
|
|
random_number_hash:
|
|
type: string
|
|
example: >-
|
|
0b1e35e991bf052be230ae8dd3ff90b69a610160d28a9eb3c0701395f9d2b291
|
|
expire_hieght:
|
|
type: string
|
|
example: '532463'
|
|
timestamp:
|
|
type: string
|
|
example: '1589020884'
|
|
sender:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
recipient:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1atsrkjac6ulgmwhudfc36lnjfgv340vlvm757z
|
|
sender_other_chain:
|
|
type: string
|
|
description: address on another chain (binance)
|
|
example: bnb1uky3me9ggqypmrsvxk7ur6hqkzq7zmv4ed4ng7
|
|
recipient_other_chain:
|
|
type: string
|
|
description: address on another chain (binance)
|
|
example: bnb10uypsspvl6jlxcx5xse02pag39l8xpe7a3468h
|
|
closed_block:
|
|
type: string
|
|
example: '532105'
|
|
cross_chain:
|
|
type: boolean
|
|
example: true
|
|
direction:
|
|
type: string
|
|
example: Incoming
|
|
'500':
|
|
description: Server internal error
|
|
/bep3/supply/{denom}:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the asset supply for the input denom
|
|
tags:
|
|
- BEP3
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
type: string
|
|
required: true
|
|
name: denom
|
|
x-example: bnb
|
|
responses:
|
|
'200':
|
|
description: Asset supply
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
incoming_supply:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
amount:
|
|
type: string
|
|
example: '555555'
|
|
outgoing_supply:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
amount:
|
|
type: string
|
|
example: '555555'
|
|
current_supply:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
amount:
|
|
type: string
|
|
example: '555555'
|
|
limit:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
amount:
|
|
type: string
|
|
example: '555555'
|
|
'500':
|
|
description: Server internal error
|
|
/bep3/parameters:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the current parameters of the BEP3 module
|
|
tags:
|
|
- BEP3
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: BEP3 module parameters
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '548883'
|
|
result:
|
|
type: object
|
|
properties:
|
|
bnb_deputy_address:
|
|
type: string
|
|
example: kava1aphsdnz5hu2t5ty2au6znprug5kx3zpy6zwq29
|
|
min_block_lock:
|
|
type: string
|
|
example: '80'
|
|
max_block_lock:
|
|
type: string
|
|
example: '3600'
|
|
supported_assets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
coin_id:
|
|
type: string
|
|
example: '714'
|
|
limit:
|
|
type: string
|
|
example: '100'
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
'500':
|
|
description: Server internal error
|
|
/auction/auctions/{id}/bids:
|
|
post:
|
|
deprecated: true
|
|
summary: Generate a place bid transaction
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Auction
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: Auction id
|
|
required: true
|
|
type: string
|
|
x-example: '1'
|
|
- in: body
|
|
name: Auction bid request body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
amount:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '100000000'
|
|
responses:
|
|
'200':
|
|
description: The transaction was successfully generated
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/auction/parameters:
|
|
get:
|
|
deprecated: true
|
|
summary: Query auction parameters
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Auction
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
max_auction_duration:
|
|
type: string
|
|
example: '172800000000000'
|
|
bid_duration:
|
|
type: string
|
|
example: '600000000000'
|
|
increment_surplus:
|
|
type: string
|
|
example: '0.05'
|
|
increment_debt:
|
|
type: string
|
|
example: '0.05'
|
|
increment_collateral:
|
|
type: string
|
|
example: '0.05'
|
|
'500':
|
|
description: Internal Server Error
|
|
/auction/auctions:
|
|
get:
|
|
deprecated: true
|
|
summary: Query auctions
|
|
description: Query all ongoing auctions
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Auction
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
example: '1'
|
|
initiator:
|
|
type: string
|
|
example: liquidator
|
|
lot:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: xrp
|
|
amount:
|
|
type: string
|
|
example: '10000000000'
|
|
bidder:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
bid:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
has_received_bids:
|
|
type: boolean
|
|
example: false
|
|
end_time:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
max_end_time:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
type:
|
|
type: string
|
|
example: collateral
|
|
phase:
|
|
type: string
|
|
example: forward
|
|
'500':
|
|
description: Internal Server Error
|
|
/auction/auctions/{id}:
|
|
get:
|
|
deprecated: true
|
|
summary: Query auction
|
|
description: Query auction by id
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Auction
|
|
parameters:
|
|
- in: path
|
|
name: id
|
|
description: Auction id
|
|
required: true
|
|
type: string
|
|
x-example: '1'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
example: '1'
|
|
initiator:
|
|
type: string
|
|
example: liquidator
|
|
lot:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: xrp
|
|
amount:
|
|
type: string
|
|
example: '10000000000'
|
|
bidder:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
bid:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
has_received_bids:
|
|
type: boolean
|
|
example: false
|
|
end_time:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
max_end_time:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
type:
|
|
type: string
|
|
example: collateral
|
|
phase:
|
|
type: string
|
|
example: forward
|
|
'400':
|
|
description: invalid auction id
|
|
'500':
|
|
description: Internal Server Error
|
|
/pricefeed/postprice:
|
|
post:
|
|
deprecated: true
|
|
summary: Generate post price transaction
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Pricefeed
|
|
parameters:
|
|
- description: post price request
|
|
name: post_price_req
|
|
in: body
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
market_id:
|
|
type: string
|
|
example: xrp:usd
|
|
price:
|
|
type: string
|
|
example: '0.298464000000000007'
|
|
expiry:
|
|
type: string
|
|
example: '158551630291'
|
|
responses:
|
|
'200':
|
|
description: The transaction was successfully generated
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/pricefeed/parameters:
|
|
get:
|
|
deprecated: true
|
|
summary: Query pricefeed parameters
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Pricefeed
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
markets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
example: xrp:usd
|
|
base_asset:
|
|
type: string
|
|
example: xrp
|
|
quote_asset:
|
|
type: string
|
|
example: usd
|
|
oracles:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
'500':
|
|
description: Internal Server Error
|
|
/pricefeed/markets:
|
|
get:
|
|
deprecated: true
|
|
summary: Query markets in the pricefeed
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Pricefeed
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
example: xrp:usd
|
|
base_asset:
|
|
type: string
|
|
example: xrp
|
|
quote_asset:
|
|
type: string
|
|
example: usd
|
|
oracles:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
'500':
|
|
description: Internal Server Error
|
|
/pricefeed/oracles/{market_id}:
|
|
get:
|
|
deprecated: true
|
|
summary: Query markets in the pricefeed
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Pricefeed
|
|
parameters:
|
|
- in: path
|
|
name: market_id
|
|
description: the market id of the market
|
|
required: true
|
|
type: string
|
|
x-example: xrp:usd
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
'500':
|
|
description: Internal Server Error
|
|
/pricefeed/rawprices/{market_id}:
|
|
get:
|
|
deprecated: true
|
|
summary: Query markets in the pricefeed
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Pricefeed
|
|
parameters:
|
|
- in: path
|
|
name: market_id
|
|
description: the market id of the market
|
|
required: true
|
|
type: string
|
|
x-example: xrp:usd
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
example: xrp:usd
|
|
oracle_address:
|
|
type: string
|
|
example: kava10cw2m04528dwlc44k0myd7strj3eq5jr6s8pxs
|
|
price:
|
|
type: string
|
|
example: '0.298758999999999997'
|
|
expiry:
|
|
type: string
|
|
example: '2021-02-12T23:10:00Z'
|
|
'500':
|
|
description: Internal Server Error
|
|
/pricefeed/price/{market_id}:
|
|
get:
|
|
deprecated: true
|
|
summary: Query markets in the pricefeed
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Pricefeed
|
|
parameters:
|
|
- in: path
|
|
name: market_id
|
|
description: the market id of the market
|
|
required: true
|
|
type: string
|
|
x-example: xrp:usd
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
example: xrp:usd
|
|
price:
|
|
type: string
|
|
example: '0.298758999999999997'
|
|
'500':
|
|
description: Internal Server Error
|
|
/incentive/claim-cdp:
|
|
post:
|
|
deprecated: true
|
|
summary: Claim USDX incentive rewards from earned from CDPs
|
|
tags:
|
|
- Incentive
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: Incentive claim CDP body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
sender:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
multiplier_name:
|
|
type: string
|
|
example: small
|
|
denoms_to_claim:
|
|
type: array
|
|
items:
|
|
type: string
|
|
example: ukava
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/incentive/claim-hard:
|
|
post:
|
|
deprecated: true
|
|
summary: Claim Hard supply/borrow rewards
|
|
tags:
|
|
- Incentive
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: Incentive claim Hard body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
sender:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
multiplier_name:
|
|
type: string
|
|
example: small
|
|
denoms_to_claim:
|
|
type: array
|
|
items:
|
|
type: string
|
|
example: ukava
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/incentive/claim-delegator:
|
|
post:
|
|
deprecated: true
|
|
summary: Claim Kava delegation rewards
|
|
tags:
|
|
- Incentive
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: Incentive claim delegator body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
sender:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
multiplier_name:
|
|
type: string
|
|
example: small
|
|
denoms_to_claim:
|
|
type: array
|
|
items:
|
|
type: string
|
|
example: ukava
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/incentive/claim-swap:
|
|
post:
|
|
deprecated: true
|
|
summary: Claim Swap liquidity provider rewards
|
|
tags:
|
|
- Incentive
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: Incentive claim swap body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
sender:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
multiplier_name:
|
|
type: string
|
|
example: small
|
|
denoms_to_claim:
|
|
type: array
|
|
items:
|
|
type: string
|
|
example: ukava
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/incentive/rewards:
|
|
get:
|
|
deprecated: true
|
|
summary: Get earned Incentive rewards
|
|
tags:
|
|
- Incentive
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: Incentive rewards
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
hard_claims:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
base_claim:
|
|
type: object
|
|
properties:
|
|
owner:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
reward:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
supply_reward_indexes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_indexes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_factor:
|
|
type: string
|
|
example: '1.2581'
|
|
borrow_reward_indexes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_indexes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_factor:
|
|
type: string
|
|
example: '1.2581'
|
|
delegator_reward_indexes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_factor:
|
|
type: string
|
|
example: '1.2581'
|
|
usdx_minting_claims:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
base_claim:
|
|
type: object
|
|
properties:
|
|
owner:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
reward:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
reward_indexes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_factor:
|
|
type: string
|
|
example: '1.2581'
|
|
'500':
|
|
description: Server internal error
|
|
/incentive/parameters:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the current parameters of the incentive module
|
|
tags:
|
|
- Incentive
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: USDX Incentive Claims
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
usdx_minting_reward_periods:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
start:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
end:
|
|
type: string
|
|
example: '2024-02-05T23:45:55.761435272Z'
|
|
rewards_per_second:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
hard_supply_reward_periods:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
start:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
end:
|
|
type: string
|
|
example: '2024-02-05T23:45:55.761435272Z'
|
|
rewards_per_second:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
hard_borrow_reward_periods:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
start:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
end:
|
|
type: string
|
|
example: '2024-02-05T23:45:55.761435272Z'
|
|
rewards_per_second:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
hard_delegator_reward_periods:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
start:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
end:
|
|
type: string
|
|
example: '2024-02-05T23:45:55.761435272Z'
|
|
rewards_per_second:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
claim_multipliers:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
example: small
|
|
months_lockup:
|
|
type: string
|
|
example: '12'
|
|
factor:
|
|
type: string
|
|
example: '0.33'
|
|
claim_end:
|
|
type: string
|
|
example: '2022-02-05T23:45:55.761435272Z'
|
|
'500':
|
|
description: Server internal error
|
|
/vesting/circulatingsupply:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the current circulating supply of KAVA
|
|
tags:
|
|
- Vesting
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: KAVA circulating supply
|
|
schema:
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: string
|
|
example: '81443180'
|
|
'500':
|
|
description: Server internal error
|
|
/vesting/totalsupply:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the total supply of KAVA
|
|
tags:
|
|
- Vesting
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: KAVA total supply
|
|
schema:
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: string
|
|
example: '120000000'
|
|
'500':
|
|
description: Server internal error
|
|
/vesting/circulatingsupplyhard:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the current circulating supply of HARD
|
|
tags:
|
|
- Vesting
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: HARD circulating supply
|
|
schema:
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: string
|
|
example: '63750000'
|
|
'500':
|
|
description: Server internal error
|
|
/vesting/totalsupplyhard:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the total supply of HARD
|
|
tags:
|
|
- Vesting
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: HARD total supply
|
|
schema:
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: string
|
|
example: '200000000'
|
|
'500':
|
|
description: Server internal error
|
|
/vesting/circulatingsupplyswp:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the current circulating supply of SWP
|
|
tags:
|
|
- Vesting
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: SWP circulating supply
|
|
schema:
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: string
|
|
example: '63750000'
|
|
'500':
|
|
description: Server internal error
|
|
/vesting/circulatingsupplyusdx:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the current circulating supply of USDX
|
|
tags:
|
|
- Vesting
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: USDX circulating supply
|
|
schema:
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: string
|
|
example: '63750000'
|
|
'500':
|
|
description: Server internal error
|
|
/vesting/totalsupplyusdx:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the total supply of USDX
|
|
tags:
|
|
- Vesting
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: USDX total supply
|
|
schema:
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: string
|
|
example: '200000000'
|
|
'500':
|
|
description: Server internal error
|
|
/committee/committees/{committee-id}/proposals:
|
|
post:
|
|
deprecated: true
|
|
summary: Create a new proposal for a committee
|
|
tags:
|
|
- Committee
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: committee-id
|
|
required: true
|
|
type: string
|
|
x-example: 1
|
|
- in: body
|
|
name: proposal request body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
pub_proposal:
|
|
type: object
|
|
properties:
|
|
title:
|
|
type: string
|
|
example: the title of the proposal
|
|
description:
|
|
type: string
|
|
example: the description of the proposal
|
|
proposer:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
responses:
|
|
'200':
|
|
description: The transaction was successfully generated
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
get:
|
|
deprecated: true
|
|
summary: Query proposals
|
|
description: Query all proposals for a committee
|
|
produces:
|
|
- application/json
|
|
tags:
|
|
- Committee
|
|
parameters:
|
|
- in: path
|
|
name: committee-id
|
|
required: true
|
|
type: string
|
|
x-example: 1
|
|
responses:
|
|
'200':
|
|
description: Committee governance proposals
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
pub_proposal:
|
|
type: object
|
|
properties:
|
|
title:
|
|
type: string
|
|
example: the title of the proposal
|
|
description:
|
|
type: string
|
|
example: the description of the proposal
|
|
id:
|
|
type: string
|
|
example: '1'
|
|
committee_id:
|
|
type: string
|
|
example: '1'
|
|
deadline:
|
|
type: string
|
|
example: '2020-05-10T16:18:43.752522893Z'
|
|
'400':
|
|
description: Invalid query parameters
|
|
'500':
|
|
description: Internal Server Error
|
|
/committee/proposals/{proposal-id}/votes:
|
|
post:
|
|
deprecated: true
|
|
summary: Create a new vote for a proposal
|
|
tags:
|
|
- Committee
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: proposal-id
|
|
required: true
|
|
type: string
|
|
x-example: 1
|
|
- in: body
|
|
name: proposal request body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
voter:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
vote_type:
|
|
type: string
|
|
example: 'yes'
|
|
responses:
|
|
'200':
|
|
description: The transaction was successfully generated
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
get:
|
|
deprecated: true
|
|
summary: Query proposal votes
|
|
description: Query proposal votes by proposal ID
|
|
tags:
|
|
- Committee
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: proposal-id
|
|
required: true
|
|
type: string
|
|
x-example: 1
|
|
responses:
|
|
'200':
|
|
description: Votes
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
voter:
|
|
type: string
|
|
proposal_id:
|
|
type: string
|
|
vote_type:
|
|
type: string
|
|
'400':
|
|
description: Invalid query parameters
|
|
'500':
|
|
description: Internal Server Error
|
|
/committee/committees:
|
|
get:
|
|
deprecated: true
|
|
summary: Query committees
|
|
description: Query all committees
|
|
tags:
|
|
- Committee
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: Committees
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
example: '1'
|
|
description:
|
|
type: string
|
|
example: description of committee
|
|
members:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
permissions:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: param_change_permission
|
|
allowed_params:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
subspace:
|
|
type: string
|
|
example: cdp
|
|
key:
|
|
type: string
|
|
example: collateral_params
|
|
vote_threshold:
|
|
type: string
|
|
example: '0.5'
|
|
proposal_duration:
|
|
type: string
|
|
example: '3600000000000'
|
|
'400':
|
|
description: Invalid query parameters
|
|
'500':
|
|
description: Internal Server Error
|
|
/committee/committees/{committee-id}:
|
|
get:
|
|
deprecated: true
|
|
summary: Query committee
|
|
description: Query committee by ID
|
|
tags:
|
|
- Committee
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: committee-id
|
|
required: true
|
|
type: string
|
|
x-example: 1
|
|
responses:
|
|
'200':
|
|
description: Committee
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
example: '1'
|
|
description:
|
|
type: string
|
|
example: description of committee
|
|
members:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
permissions:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: param_change_permission
|
|
allowed_params:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
subspace:
|
|
type: string
|
|
example: cdp
|
|
key:
|
|
type: string
|
|
example: collateral_params
|
|
vote_threshold:
|
|
type: string
|
|
example: '0.5'
|
|
proposal_duration:
|
|
type: string
|
|
example: '3600000000000'
|
|
'400':
|
|
description: Invalid query parameters
|
|
'500':
|
|
description: Internal Server Error
|
|
/committee/proposals/{proposal-id}:
|
|
get:
|
|
deprecated: true
|
|
summary: Query proposal
|
|
description: Query proposal by ID
|
|
tags:
|
|
- Committee
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: proposal-id
|
|
required: true
|
|
type: string
|
|
x-example: 1
|
|
responses:
|
|
'200':
|
|
description: Proposal
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: object
|
|
properties:
|
|
pub_proposal:
|
|
type: object
|
|
properties:
|
|
title:
|
|
type: string
|
|
example: the title of the proposal
|
|
description:
|
|
type: string
|
|
example: the description of the proposal
|
|
id:
|
|
type: string
|
|
example: '1'
|
|
committee_id:
|
|
type: string
|
|
example: '1'
|
|
deadline:
|
|
type: string
|
|
example: '2020-05-10T16:18:43.752522893Z'
|
|
'400':
|
|
description: Invalid query parameters
|
|
'500':
|
|
description: Internal Server Error
|
|
/committee/proposals/{proposal-id}/propser:
|
|
get:
|
|
deprecated: true
|
|
summary: Query proposer
|
|
description: Query proposer by proposal ID
|
|
tags:
|
|
- Committee
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: proposal-id
|
|
required: true
|
|
type: string
|
|
x-example: 1
|
|
responses:
|
|
'200':
|
|
description: Proposer
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
example: '1'
|
|
proposer:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
'400':
|
|
description: Invalid query parameters
|
|
'500':
|
|
description: Internal Server Error
|
|
/committee/proposals/{proposal-id}/tally:
|
|
get:
|
|
deprecated: true
|
|
summary: Query proposal tally
|
|
description: Query proposal tally by proposal ID
|
|
tags:
|
|
- Committee
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: path
|
|
name: proposal-id
|
|
required: true
|
|
type: string
|
|
x-example: 1
|
|
responses:
|
|
'200':
|
|
description: Vote tally
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: string
|
|
example: '3'
|
|
'400':
|
|
description: Invalid query parameters
|
|
'500':
|
|
description: Internal Server Error
|
|
/hard/deposit:
|
|
post:
|
|
deprecated: true
|
|
summary: Deposit funds to hard liquidity pool
|
|
tags:
|
|
- Hard
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: hard deposit body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
depositor:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
amount:
|
|
$ref: '#/definitions/LegacyCoins'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/hard/withdraw:
|
|
post:
|
|
deprecated: true
|
|
summary: Withdraw funds from hard liquidity pool
|
|
tags:
|
|
- Hard
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: hard withdraw body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
depositor:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
amount:
|
|
$ref: '#/definitions/LegacyCoins'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/hard/borrow:
|
|
post:
|
|
deprecated: true
|
|
summary: Borrow funds from hard liquidity pool
|
|
tags:
|
|
- Hard
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: hard borrow body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
depositor:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
amount:
|
|
$ref: '#/definitions/LegacyCoins'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/hard/repay:
|
|
post:
|
|
deprecated: true
|
|
summary: Repay funds borrowed from hard liquidity pool
|
|
tags:
|
|
- Hard
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: hard repay body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
owner:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
amount:
|
|
$ref: '#/definitions/LegacyCoins'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/hard/liquidate:
|
|
post:
|
|
deprecated: true
|
|
summary: Attempt to liquidate a borrower that is over their loan-to-value
|
|
tags:
|
|
- Hard
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: hard liquidate body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
borrower:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/hard/parameters:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the current parameters of the hard module
|
|
tags:
|
|
- Hard
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: Hard module parameters
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
money_markets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
borrow_limit:
|
|
type: object
|
|
properties:
|
|
has_max_limit:
|
|
type: boolean
|
|
example: true
|
|
maximum_limit:
|
|
type: string
|
|
example: '100000000000000'
|
|
loan_to_value:
|
|
type: string
|
|
example: '0.8'
|
|
spot_market_id:
|
|
type: string
|
|
example: bnb:usd
|
|
conversion_factor:
|
|
type: string
|
|
example: '100000000'
|
|
interest_rate_model:
|
|
type: object
|
|
properties:
|
|
base_rate_apy:
|
|
type: string
|
|
example: '0'
|
|
base_multiplier:
|
|
type: string
|
|
example: '0.1'
|
|
kink:
|
|
type: string
|
|
example: '0.8'
|
|
jump_multiplier:
|
|
type: string
|
|
example: '0.5'
|
|
reserve_factor:
|
|
type: string
|
|
example: '0.05'
|
|
keeper_reward_percentage:
|
|
type: string
|
|
example: '0.05'
|
|
minimum_borrow_usd_value:
|
|
type: string
|
|
example: '10'
|
|
'500':
|
|
description: Server internal error
|
|
/hard/total-deposited:
|
|
get:
|
|
deprecated: true
|
|
summary: Get total coins deposited to hard liquidity pools
|
|
tags:
|
|
- Hard
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: query
|
|
name: denom
|
|
description: Coin denom
|
|
required: false
|
|
type: string
|
|
x-example: btc
|
|
responses:
|
|
'200':
|
|
description: total coins deposited
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
'500':
|
|
description: Server internal error
|
|
/hard/total-borrowed:
|
|
get:
|
|
deprecated: true
|
|
summary: Get total coins borrowed from hard liquidity pools
|
|
tags:
|
|
- Hard
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: query
|
|
name: denom
|
|
description: Coin denom
|
|
required: false
|
|
type: string
|
|
x-example: btc
|
|
responses:
|
|
'200':
|
|
description: total coins borrowed
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
'500':
|
|
description: Server internal error
|
|
/hard/reserves:
|
|
get:
|
|
deprecated: true
|
|
summary: Get total hard reserve coins
|
|
tags:
|
|
- Hard
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: query
|
|
name: denom
|
|
description: Coin denom
|
|
required: false
|
|
type: string
|
|
x-example: btc
|
|
responses:
|
|
'200':
|
|
description: reserve coins
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
'500':
|
|
description: Server internal error
|
|
/hard/interest-rate:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the hard module interest rates
|
|
tags:
|
|
- Hard
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: query
|
|
name: denom
|
|
description: Money market denom
|
|
required: false
|
|
type: string
|
|
x-example: bnb
|
|
responses:
|
|
'200':
|
|
description: money market interest rates
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
supply_interest_rate:
|
|
type: string
|
|
example: '5.25'
|
|
borrow_interest_rate:
|
|
type: string
|
|
example: '5.25'
|
|
'500':
|
|
description: Server internal error
|
|
/hard/accounts:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the hard module accounts
|
|
tags:
|
|
- Hard
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: The hard module accounts
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
account_number:
|
|
type: number
|
|
address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
coins:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
name:
|
|
type: string
|
|
permissions:
|
|
type: array
|
|
items:
|
|
type: string
|
|
public_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
value:
|
|
type: string
|
|
sequence:
|
|
type: number
|
|
'500':
|
|
description: Server internal error
|
|
/hard/deposits:
|
|
get:
|
|
deprecated: true
|
|
summary: Get hard deposits
|
|
tags:
|
|
- Hard
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: query
|
|
name: denom
|
|
description: Deposit coin denom
|
|
required: false
|
|
type: string
|
|
x-example: btc
|
|
- in: query
|
|
name: owner
|
|
description: Owner address in bech32 format
|
|
required: false
|
|
type: string
|
|
x-example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
- in: query
|
|
name: page
|
|
description: The page number.
|
|
type: integer
|
|
x-example: 1
|
|
- in: query
|
|
name: limit
|
|
description: The maximum number of items per page.
|
|
type: integer
|
|
x-example: 100
|
|
responses:
|
|
'200':
|
|
description: hard deposits
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
depositor:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
index:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
value:
|
|
type: string
|
|
example: '0.1258'
|
|
'500':
|
|
description: Server internal error
|
|
/hard/borrows:
|
|
get:
|
|
deprecated: true
|
|
summary: Get hard borrows
|
|
tags:
|
|
- Hard
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: query
|
|
name: denom
|
|
description: Borrow coin denom
|
|
required: false
|
|
type: string
|
|
x-example: btc
|
|
- in: query
|
|
name: owner
|
|
description: Owner address in bech32 format
|
|
required: false
|
|
type: string
|
|
x-example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
- in: query
|
|
name: page
|
|
description: The page number.
|
|
type: integer
|
|
x-example: 1
|
|
- in: query
|
|
name: limit
|
|
description: The maximum number of items per page.
|
|
type: integer
|
|
x-example: 100
|
|
responses:
|
|
'200':
|
|
description: hard borrows
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
borrower:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
index:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
value:
|
|
type: string
|
|
example: '0.1258'
|
|
'500':
|
|
description: Server internal error
|
|
/issuance/issue:
|
|
post:
|
|
deprecated: true
|
|
summary: Issue tokens
|
|
tags:
|
|
- Issuance
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: Issue tokens body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
sender:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
tokens:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
receiver:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/issuance/redeem:
|
|
post:
|
|
deprecated: true
|
|
summary: Redeem tokens
|
|
tags:
|
|
- Issuance
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: Redeem tokens body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
sender:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
tokens:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/issuance/block:
|
|
post:
|
|
deprecated: true
|
|
summary: Block an address from using an issued token
|
|
tags:
|
|
- Issuance
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: Block address body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
sender:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
denom:
|
|
type: string
|
|
example: usdt
|
|
blocked_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/issuance/unblock:
|
|
post:
|
|
deprecated: true
|
|
summary: Unblock an address from using an issued token
|
|
tags:
|
|
- Issuance
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: Unblock address body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
sender:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
denom:
|
|
type: string
|
|
example: usdt
|
|
address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/issuance/pause:
|
|
post:
|
|
deprecated: true
|
|
summary: Set an issued token's pause status
|
|
tags:
|
|
- Issuance
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: Set pause status body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
sender:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
denom:
|
|
type: string
|
|
example: usdt
|
|
status:
|
|
type: boolean
|
|
example: true
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/issuance/parameters:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the current parameters of the Issuance module
|
|
tags:
|
|
- Issuance
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: Issuance parameters
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
assets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
owner:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
denom:
|
|
type: string
|
|
example: btc
|
|
blocked_addresses:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
paused:
|
|
type: boolean
|
|
example: false
|
|
blockable:
|
|
type: boolean
|
|
example: true
|
|
rate_limit:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
limit:
|
|
type: string
|
|
example: '500000000'
|
|
time_period:
|
|
type: string
|
|
example: '518400000000000'
|
|
'500':
|
|
description: Server internal error
|
|
/swap/deposit:
|
|
post:
|
|
deprecated: true
|
|
summary: Deposit funds to swap liquidity pool
|
|
tags:
|
|
- Swap
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: swap deposit body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
depositor:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
token_a:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
token_b:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
slippage:
|
|
type: string
|
|
example: '0.05'
|
|
deadline:
|
|
type: string
|
|
example: '1628073801'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/swap/withdraw:
|
|
post:
|
|
deprecated: true
|
|
summary: Withdraw funds from a swap liquidity pool
|
|
tags:
|
|
- Swap
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: swap withdraw body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
from:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
shares:
|
|
type: string
|
|
example: '5000'
|
|
min_token_a:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
min_token_b:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
deadline:
|
|
type: string
|
|
example: '1628073801'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/swap/swapExactForTokens:
|
|
post:
|
|
deprecated: true
|
|
summary: >-
|
|
Swap exact amount of input tokens for approximate amount of output
|
|
tokens
|
|
tags:
|
|
- Swap
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: swap exact for tokens body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
requester:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
exact_token_a:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
token_b:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
slippage:
|
|
type: string
|
|
example: '0.05'
|
|
deadline:
|
|
type: string
|
|
example: '1628073801'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/swap/swapForExactTokens:
|
|
post:
|
|
deprecated: true
|
|
summary: >-
|
|
Swap approximate amount of input tokens for exact amount of output
|
|
tokens
|
|
tags:
|
|
- Swap
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: body
|
|
name: swap for exact tokens body
|
|
schema:
|
|
properties:
|
|
base_req:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in
|
|
conjunction with generate_only)
|
|
requester:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
token_a:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
exact_token_b:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
slippage:
|
|
type: string
|
|
example: '0.05'
|
|
deadline:
|
|
type: string
|
|
example: '1628073801'
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
'400':
|
|
description: Invalid request
|
|
'500':
|
|
description: Internal server error
|
|
/swap/parameters:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the current parameters of the swap module
|
|
tags:
|
|
- Swap
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: Swap module parameters
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
type: object
|
|
properties:
|
|
allowed_pools:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
token_a:
|
|
type: string
|
|
example: ukava
|
|
token_b:
|
|
type: string
|
|
example: usdx
|
|
swap_fee:
|
|
type: string
|
|
example: '0.03'
|
|
'500':
|
|
description: Server internal error
|
|
/swap/deposits:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the current deposits of a liquidity pool
|
|
tags:
|
|
- Swap
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: query
|
|
name: owner
|
|
description: Owner address in bech32 format
|
|
required: false
|
|
type: string
|
|
x-example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
- in: query
|
|
name: pool
|
|
description: Pool ID
|
|
required: false
|
|
type: string
|
|
x-example: abc:xyz
|
|
responses:
|
|
'200':
|
|
description: Liquidity pool deposits
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
$ref: '#/definitions/LegacySwapDepositsQueryResult'
|
|
'500':
|
|
description: Server internal error
|
|
/swap/pool:
|
|
get:
|
|
deprecated: true
|
|
summary: Get information about a liquidity pool by ID
|
|
tags:
|
|
- Swap
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- in: query
|
|
name: pool
|
|
description: Pool ID
|
|
required: true
|
|
type: string
|
|
x-example: abc:xyz
|
|
responses:
|
|
'200':
|
|
description: Liquidity pool statistics
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
items:
|
|
$ref: '#/definitions/LegacySwapPoolStatsQueryResult'
|
|
'500':
|
|
description: Server internal error
|
|
/swap/pools:
|
|
get:
|
|
deprecated: true
|
|
summary: Get information about all liquidity pools
|
|
tags:
|
|
- Swap
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: Statistics for all liquidity pools
|
|
schema:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
example: '100'
|
|
result:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
$ref: '#/definitions/LegacySwapPoolStatsQueryResult'
|
|
'500':
|
|
description: Server internal error
|
|
/kavadist/parameters:
|
|
get:
|
|
deprecated: true
|
|
summary: Get the current kavadist parameter values
|
|
tags:
|
|
- Kavadist
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
schema:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: string
|
|
periods:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
start:
|
|
type: string
|
|
example: 2020-06-01:14:00:00Z
|
|
end:
|
|
type: string
|
|
example: 2020-06-01:14:00:00Z
|
|
inflation:
|
|
type: string
|
|
example: '1.000000001167363430'
|
|
'500':
|
|
description: Internal Server Error
|
|
definitions:
|
|
cosmos.base.query.v1beta1.PageRequest:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
format: byte
|
|
description: |-
|
|
key is a value returned in PageResponse.next_key to begin
|
|
querying the next page most efficiently. Only one of offset or key
|
|
should be set.
|
|
offset:
|
|
type: string
|
|
format: uint64
|
|
description: |-
|
|
offset is a numeric offset that can be used when key is unavailable.
|
|
It is less efficient than using key. Only one of offset or key should
|
|
be set.
|
|
limit:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
limit is the total number of results to be returned in the result
|
|
page.
|
|
|
|
If left empty it will default to a value to be set by each app.
|
|
count_total:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
count_total is set to true to indicate that the result set should
|
|
include
|
|
|
|
a count of the total number of items available for pagination in UIs.
|
|
|
|
count_total is only respected when offset is used. It is ignored when
|
|
key
|
|
|
|
is set.
|
|
reverse:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
reverse is set to true if results are to be returned in the descending
|
|
order.
|
|
|
|
|
|
Since: cosmos-sdk 0.43
|
|
description: |-
|
|
message SomeRequest {
|
|
Foo some_parameter = 1;
|
|
PageRequest pagination = 2;
|
|
}
|
|
title: |-
|
|
PageRequest is to be embedded in gRPC request messages for efficient
|
|
pagination. Ex:
|
|
cosmos.base.query.v1beta1.PageResponse:
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: |-
|
|
total is total number of results available if PageRequest.count_total
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
PageResponse is to be embedded in gRPC response messages where the
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
google.protobuf.Any:
|
|
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"
|
|
}
|
|
grpc.gateway.runtime.Error:
|
|
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"
|
|
}
|
|
kava.auction.v1beta1.Params:
|
|
type: object
|
|
properties:
|
|
max_auction_duration:
|
|
type: string
|
|
forward_bid_duration:
|
|
type: string
|
|
reverse_bid_duration:
|
|
type: string
|
|
increment_surplus:
|
|
type: string
|
|
format: byte
|
|
increment_debt:
|
|
type: string
|
|
format: byte
|
|
increment_collateral:
|
|
type: string
|
|
format: byte
|
|
description: Params defines the parameters for the issuance module.
|
|
kava.auction.v1beta1.QueryAuctionResponse:
|
|
type: object
|
|
properties:
|
|
auction:
|
|
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"
|
|
}
|
|
description: >-
|
|
QueryAuctionResponse is the response type for the Query/Auction RPC
|
|
method.
|
|
kava.auction.v1beta1.QueryAuctionsResponse:
|
|
type: object
|
|
properties:
|
|
auctions:
|
|
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"
|
|
}
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryAuctionsResponse is the response type for the Query/Auctions RPC
|
|
method.
|
|
kava.auction.v1beta1.QueryNextAuctionIDResponse:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
QueryNextAuctionIDResponse defines the response type for querying
|
|
x/auction next auction ID.
|
|
kava.auction.v1beta1.QueryParamsResponse:
|
|
type: object
|
|
properties:
|
|
params:
|
|
type: object
|
|
properties:
|
|
max_auction_duration:
|
|
type: string
|
|
forward_bid_duration:
|
|
type: string
|
|
reverse_bid_duration:
|
|
type: string
|
|
increment_surplus:
|
|
type: string
|
|
format: byte
|
|
increment_debt:
|
|
type: string
|
|
format: byte
|
|
increment_collateral:
|
|
type: string
|
|
format: byte
|
|
description: Params defines the parameters for the issuance module.
|
|
description: >-
|
|
QueryParamsResponse defines the response type for querying x/auction
|
|
parameters.
|
|
cosmos.base.v1beta1.Coin:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
kava.bep3.v1beta1.AssetParam:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
title: denom represents the denominatin for this asset
|
|
coin_id:
|
|
type: string
|
|
format: int64
|
|
title: >-
|
|
coin_id represents the registered coin type to use
|
|
(https://github.com/satoshilabs/slips/blob/master/slip-0044.md)
|
|
supply_limit:
|
|
title: >-
|
|
supply_limit defines the maximum supply allowed for the asset - a
|
|
total or time based rate limit
|
|
type: object
|
|
properties:
|
|
limit:
|
|
type: string
|
|
title: limit defines the total supply allowed
|
|
time_limited:
|
|
type: boolean
|
|
format: boolean
|
|
title: time_limited enables or disables time based supply limiting
|
|
time_period:
|
|
type: string
|
|
title: >-
|
|
time_period specifies the duration that time_based_limit is
|
|
evalulated
|
|
time_based_limit:
|
|
type: string
|
|
title: >-
|
|
time_based_limit defines the maximum supply that can be swapped
|
|
within time_period
|
|
description: >-
|
|
SupplyLimit define the absolute and time-based limits for an assets's
|
|
supply.
|
|
active:
|
|
type: boolean
|
|
format: boolean
|
|
title: active specifies if the asset is live or paused
|
|
deputy_address:
|
|
type: string
|
|
format: byte
|
|
title: deputy_address the kava address of the deputy
|
|
fixed_fee:
|
|
type: string
|
|
title: fixed_fee defines the fee for incoming swaps
|
|
min_swap_amount:
|
|
type: string
|
|
title: >-
|
|
min_swap_amount defines the minimum amount able to be swapped in a
|
|
single message
|
|
max_swap_amount:
|
|
type: string
|
|
title: >-
|
|
max_swap_amount defines the maximum amount able to be swapped in a
|
|
single message
|
|
min_block_lock:
|
|
type: string
|
|
format: uint64
|
|
title: min_block_lock defined the minimum blocks to lock
|
|
max_block_lock:
|
|
type: string
|
|
format: uint64
|
|
title: min_block_lock defined the maximum blocks to lock
|
|
description: AssetParam defines parameters for each bep3 asset.
|
|
kava.bep3.v1beta1.AssetSupplyResponse:
|
|
type: object
|
|
properties:
|
|
incoming_supply:
|
|
title: incoming_supply represents the incoming supply of an asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
outgoing_supply:
|
|
title: outgoing_supply represents the outgoing supply of an asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
current_supply:
|
|
title: current_supply represents the current on-chain supply of an asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
time_limited_current_supply:
|
|
title: >-
|
|
time_limited_current_supply represents the time limited current supply
|
|
of an asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
time_elapsed:
|
|
type: string
|
|
title: time_elapsed represents the time elapsed
|
|
description: AssetSupplyResponse defines information about an asset's supply.
|
|
kava.bep3.v1beta1.AtomicSwapResponse:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: id represents the id of the atomic swap
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
title: amount represents the amount being swapped
|
|
random_number_hash:
|
|
type: string
|
|
title: random_number_hash represents the hash of the random number
|
|
expire_height:
|
|
type: string
|
|
format: uint64
|
|
title: expire_height represents the height when the swap expires
|
|
timestamp:
|
|
type: string
|
|
format: int64
|
|
title: timestamp represents the timestamp of the swap
|
|
sender:
|
|
type: string
|
|
title: sender is the kava chain sender of the swap
|
|
recipient:
|
|
type: string
|
|
title: recipient is the kava chain recipient of the swap
|
|
sender_other_chain:
|
|
type: string
|
|
title: sender_other_chain is the sender on the other chain
|
|
recipient_other_chain:
|
|
type: string
|
|
title: recipient_other_chain is the recipient on the other chain
|
|
closed_block:
|
|
type: string
|
|
format: int64
|
|
title: closed_block is the block when the swap is closed
|
|
status:
|
|
title: status represents the current status of the swap
|
|
type: string
|
|
enum:
|
|
- SWAP_STATUS_UNSPECIFIED
|
|
- SWAP_STATUS_OPEN
|
|
- SWAP_STATUS_COMPLETED
|
|
- SWAP_STATUS_EXPIRED
|
|
default: SWAP_STATUS_UNSPECIFIED
|
|
description: >-
|
|
- SWAP_STATUS_UNSPECIFIED: SWAP_STATUS_UNSPECIFIED represents an
|
|
unspecified status
|
|
- SWAP_STATUS_OPEN: SWAP_STATUS_OPEN represents an open swap
|
|
- SWAP_STATUS_COMPLETED: SWAP_STATUS_COMPLETED represents a completed swap
|
|
- SWAP_STATUS_EXPIRED: SWAP_STATUS_EXPIRED represents an expired swap
|
|
cross_chain:
|
|
type: boolean
|
|
format: boolean
|
|
title: cross_chain identifies whether the atomic swap is cross chain
|
|
direction:
|
|
title: direction identifies if the swap is incoming or outgoing
|
|
type: string
|
|
enum:
|
|
- SWAP_DIRECTION_UNSPECIFIED
|
|
- SWAP_DIRECTION_INCOMING
|
|
- SWAP_DIRECTION_OUTGOING
|
|
default: SWAP_DIRECTION_UNSPECIFIED
|
|
description: >-
|
|
- SWAP_DIRECTION_UNSPECIFIED: SWAP_DIRECTION_UNSPECIFIED represents
|
|
unspecified or invalid swap direcation
|
|
- SWAP_DIRECTION_INCOMING: SWAP_DIRECTION_INCOMING represents is incoming swap (to the kava chain)
|
|
- SWAP_DIRECTION_OUTGOING: SWAP_DIRECTION_OUTGOING represents an outgoing swap (from the kava chain)
|
|
title: AtomicSwapResponse represents the returned atomic swap properties
|
|
kava.bep3.v1beta1.Params:
|
|
type: object
|
|
properties:
|
|
asset_params:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
title: denom represents the denominatin for this asset
|
|
coin_id:
|
|
type: string
|
|
format: int64
|
|
title: >-
|
|
coin_id represents the registered coin type to use
|
|
(https://github.com/satoshilabs/slips/blob/master/slip-0044.md)
|
|
supply_limit:
|
|
title: >-
|
|
supply_limit defines the maximum supply allowed for the asset -
|
|
a total or time based rate limit
|
|
type: object
|
|
properties:
|
|
limit:
|
|
type: string
|
|
title: limit defines the total supply allowed
|
|
time_limited:
|
|
type: boolean
|
|
format: boolean
|
|
title: time_limited enables or disables time based supply limiting
|
|
time_period:
|
|
type: string
|
|
title: >-
|
|
time_period specifies the duration that time_based_limit is
|
|
evalulated
|
|
time_based_limit:
|
|
type: string
|
|
title: >-
|
|
time_based_limit defines the maximum supply that can be
|
|
swapped within time_period
|
|
description: >-
|
|
SupplyLimit define the absolute and time-based limits for an
|
|
assets's supply.
|
|
active:
|
|
type: boolean
|
|
format: boolean
|
|
title: active specifies if the asset is live or paused
|
|
deputy_address:
|
|
type: string
|
|
format: byte
|
|
title: deputy_address the kava address of the deputy
|
|
fixed_fee:
|
|
type: string
|
|
title: fixed_fee defines the fee for incoming swaps
|
|
min_swap_amount:
|
|
type: string
|
|
title: >-
|
|
min_swap_amount defines the minimum amount able to be swapped in
|
|
a single message
|
|
max_swap_amount:
|
|
type: string
|
|
title: >-
|
|
max_swap_amount defines the maximum amount able to be swapped in
|
|
a single message
|
|
min_block_lock:
|
|
type: string
|
|
format: uint64
|
|
title: min_block_lock defined the minimum blocks to lock
|
|
max_block_lock:
|
|
type: string
|
|
format: uint64
|
|
title: min_block_lock defined the maximum blocks to lock
|
|
description: AssetParam defines parameters for each bep3 asset.
|
|
title: asset_params define the parameters for each bep3 asset
|
|
description: Params defines the parameters for the bep3 module.
|
|
kava.bep3.v1beta1.QueryAssetSuppliesResponse:
|
|
type: object
|
|
properties:
|
|
asset_supplies:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
incoming_supply:
|
|
title: incoming_supply represents the incoming supply of an asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
outgoing_supply:
|
|
title: outgoing_supply represents the outgoing supply of an asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
current_supply:
|
|
title: >-
|
|
current_supply represents the current on-chain supply of an
|
|
asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
time_limited_current_supply:
|
|
title: >-
|
|
time_limited_current_supply represents the time limited current
|
|
supply of an asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
time_elapsed:
|
|
type: string
|
|
title: time_elapsed represents the time elapsed
|
|
description: AssetSupplyResponse defines information about an asset's supply.
|
|
title: asset_supplies represents the supplies of returned assets
|
|
description: >-
|
|
QueryAssetSuppliesResponse is the response type for the
|
|
Query/AssetSupplies RPC method.
|
|
kava.bep3.v1beta1.QueryAssetSupplyResponse:
|
|
type: object
|
|
properties:
|
|
asset_supply:
|
|
type: object
|
|
properties:
|
|
incoming_supply:
|
|
title: incoming_supply represents the incoming supply of an asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
outgoing_supply:
|
|
title: outgoing_supply represents the outgoing supply of an asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
current_supply:
|
|
title: current_supply represents the current on-chain supply of an asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
time_limited_current_supply:
|
|
title: >-
|
|
time_limited_current_supply represents the time limited current
|
|
supply of an asset
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
time_elapsed:
|
|
type: string
|
|
title: time_elapsed represents the time elapsed
|
|
description: AssetSupplyResponse defines information about an asset's supply.
|
|
title: asset_supply represents the supply of the asset
|
|
description: >-
|
|
QueryAssetSupplyResponse is the response type for the Query/AssetSupply
|
|
RPC method.
|
|
kava.bep3.v1beta1.QueryAtomicSwapResponse:
|
|
type: object
|
|
properties:
|
|
atomic_swap:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: id represents the id of the atomic swap
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
title: amount represents the amount being swapped
|
|
random_number_hash:
|
|
type: string
|
|
title: random_number_hash represents the hash of the random number
|
|
expire_height:
|
|
type: string
|
|
format: uint64
|
|
title: expire_height represents the height when the swap expires
|
|
timestamp:
|
|
type: string
|
|
format: int64
|
|
title: timestamp represents the timestamp of the swap
|
|
sender:
|
|
type: string
|
|
title: sender is the kava chain sender of the swap
|
|
recipient:
|
|
type: string
|
|
title: recipient is the kava chain recipient of the swap
|
|
sender_other_chain:
|
|
type: string
|
|
title: sender_other_chain is the sender on the other chain
|
|
recipient_other_chain:
|
|
type: string
|
|
title: recipient_other_chain is the recipient on the other chain
|
|
closed_block:
|
|
type: string
|
|
format: int64
|
|
title: closed_block is the block when the swap is closed
|
|
status:
|
|
title: status represents the current status of the swap
|
|
type: string
|
|
enum:
|
|
- SWAP_STATUS_UNSPECIFIED
|
|
- SWAP_STATUS_OPEN
|
|
- SWAP_STATUS_COMPLETED
|
|
- SWAP_STATUS_EXPIRED
|
|
default: SWAP_STATUS_UNSPECIFIED
|
|
description: >-
|
|
- SWAP_STATUS_UNSPECIFIED: SWAP_STATUS_UNSPECIFIED represents an
|
|
unspecified status
|
|
- SWAP_STATUS_OPEN: SWAP_STATUS_OPEN represents an open swap
|
|
- SWAP_STATUS_COMPLETED: SWAP_STATUS_COMPLETED represents a completed swap
|
|
- SWAP_STATUS_EXPIRED: SWAP_STATUS_EXPIRED represents an expired swap
|
|
cross_chain:
|
|
type: boolean
|
|
format: boolean
|
|
title: cross_chain identifies whether the atomic swap is cross chain
|
|
direction:
|
|
title: direction identifies if the swap is incoming or outgoing
|
|
type: string
|
|
enum:
|
|
- SWAP_DIRECTION_UNSPECIFIED
|
|
- SWAP_DIRECTION_INCOMING
|
|
- SWAP_DIRECTION_OUTGOING
|
|
default: SWAP_DIRECTION_UNSPECIFIED
|
|
description: >-
|
|
- SWAP_DIRECTION_UNSPECIFIED: SWAP_DIRECTION_UNSPECIFIED
|
|
represents unspecified or invalid swap direcation
|
|
- SWAP_DIRECTION_INCOMING: SWAP_DIRECTION_INCOMING represents is incoming swap (to the kava chain)
|
|
- SWAP_DIRECTION_OUTGOING: SWAP_DIRECTION_OUTGOING represents an outgoing swap (from the kava chain)
|
|
title: AtomicSwapResponse represents the returned atomic swap properties
|
|
description: >-
|
|
QueryAtomicSwapResponse is the response type for the Query/AtomicSwap RPC
|
|
method.
|
|
kava.bep3.v1beta1.QueryAtomicSwapsResponse:
|
|
type: object
|
|
properties:
|
|
atomic_swaps:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
title: id represents the id of the atomic swap
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
title: amount represents the amount being swapped
|
|
random_number_hash:
|
|
type: string
|
|
title: random_number_hash represents the hash of the random number
|
|
expire_height:
|
|
type: string
|
|
format: uint64
|
|
title: expire_height represents the height when the swap expires
|
|
timestamp:
|
|
type: string
|
|
format: int64
|
|
title: timestamp represents the timestamp of the swap
|
|
sender:
|
|
type: string
|
|
title: sender is the kava chain sender of the swap
|
|
recipient:
|
|
type: string
|
|
title: recipient is the kava chain recipient of the swap
|
|
sender_other_chain:
|
|
type: string
|
|
title: sender_other_chain is the sender on the other chain
|
|
recipient_other_chain:
|
|
type: string
|
|
title: recipient_other_chain is the recipient on the other chain
|
|
closed_block:
|
|
type: string
|
|
format: int64
|
|
title: closed_block is the block when the swap is closed
|
|
status:
|
|
title: status represents the current status of the swap
|
|
type: string
|
|
enum:
|
|
- SWAP_STATUS_UNSPECIFIED
|
|
- SWAP_STATUS_OPEN
|
|
- SWAP_STATUS_COMPLETED
|
|
- SWAP_STATUS_EXPIRED
|
|
default: SWAP_STATUS_UNSPECIFIED
|
|
description: >-
|
|
- SWAP_STATUS_UNSPECIFIED: SWAP_STATUS_UNSPECIFIED represents an
|
|
unspecified status
|
|
- SWAP_STATUS_OPEN: SWAP_STATUS_OPEN represents an open swap
|
|
- SWAP_STATUS_COMPLETED: SWAP_STATUS_COMPLETED represents a completed swap
|
|
- SWAP_STATUS_EXPIRED: SWAP_STATUS_EXPIRED represents an expired swap
|
|
cross_chain:
|
|
type: boolean
|
|
format: boolean
|
|
title: cross_chain identifies whether the atomic swap is cross chain
|
|
direction:
|
|
title: direction identifies if the swap is incoming or outgoing
|
|
type: string
|
|
enum:
|
|
- SWAP_DIRECTION_UNSPECIFIED
|
|
- SWAP_DIRECTION_INCOMING
|
|
- SWAP_DIRECTION_OUTGOING
|
|
default: SWAP_DIRECTION_UNSPECIFIED
|
|
description: >-
|
|
- SWAP_DIRECTION_UNSPECIFIED: SWAP_DIRECTION_UNSPECIFIED
|
|
represents unspecified or invalid swap direcation
|
|
- SWAP_DIRECTION_INCOMING: SWAP_DIRECTION_INCOMING represents is incoming swap (to the kava chain)
|
|
- SWAP_DIRECTION_OUTGOING: SWAP_DIRECTION_OUTGOING represents an outgoing swap (from the kava chain)
|
|
title: AtomicSwapResponse represents the returned atomic swap properties
|
|
title: atomic_swap represents the returned atomic swaps for the request
|
|
pagination:
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
PageResponse is to be embedded in gRPC response messages where the
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
description: >-
|
|
QueryAtomicSwapsResponse is the response type for the Query/AtomicSwaps
|
|
RPC method.
|
|
kava.bep3.v1beta1.QueryParamsResponse:
|
|
type: object
|
|
properties:
|
|
params:
|
|
title: params represents the parameters of the module
|
|
type: object
|
|
properties:
|
|
asset_params:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
title: denom represents the denominatin for this asset
|
|
coin_id:
|
|
type: string
|
|
format: int64
|
|
title: >-
|
|
coin_id represents the registered coin type to use
|
|
(https://github.com/satoshilabs/slips/blob/master/slip-0044.md)
|
|
supply_limit:
|
|
title: >-
|
|
supply_limit defines the maximum supply allowed for the
|
|
asset - a total or time based rate limit
|
|
type: object
|
|
properties:
|
|
limit:
|
|
type: string
|
|
title: limit defines the total supply allowed
|
|
time_limited:
|
|
type: boolean
|
|
format: boolean
|
|
title: >-
|
|
time_limited enables or disables time based supply
|
|
limiting
|
|
time_period:
|
|
type: string
|
|
title: >-
|
|
time_period specifies the duration that time_based_limit
|
|
is evalulated
|
|
time_based_limit:
|
|
type: string
|
|
title: >-
|
|
time_based_limit defines the maximum supply that can be
|
|
swapped within time_period
|
|
description: >-
|
|
SupplyLimit define the absolute and time-based limits for an
|
|
assets's supply.
|
|
active:
|
|
type: boolean
|
|
format: boolean
|
|
title: active specifies if the asset is live or paused
|
|
deputy_address:
|
|
type: string
|
|
format: byte
|
|
title: deputy_address the kava address of the deputy
|
|
fixed_fee:
|
|
type: string
|
|
title: fixed_fee defines the fee for incoming swaps
|
|
min_swap_amount:
|
|
type: string
|
|
title: >-
|
|
min_swap_amount defines the minimum amount able to be
|
|
swapped in a single message
|
|
max_swap_amount:
|
|
type: string
|
|
title: >-
|
|
max_swap_amount defines the maximum amount able to be
|
|
swapped in a single message
|
|
min_block_lock:
|
|
type: string
|
|
format: uint64
|
|
title: min_block_lock defined the minimum blocks to lock
|
|
max_block_lock:
|
|
type: string
|
|
format: uint64
|
|
title: min_block_lock defined the maximum blocks to lock
|
|
description: AssetParam defines parameters for each bep3 asset.
|
|
title: asset_params define the parameters for each bep3 asset
|
|
description: Params defines the parameters for the bep3 module.
|
|
description: >-
|
|
QueryParamsResponse defines the response type for querying x/bep3
|
|
parameters.
|
|
kava.bep3.v1beta1.SupplyLimit:
|
|
type: object
|
|
properties:
|
|
limit:
|
|
type: string
|
|
title: limit defines the total supply allowed
|
|
time_limited:
|
|
type: boolean
|
|
format: boolean
|
|
title: time_limited enables or disables time based supply limiting
|
|
time_period:
|
|
type: string
|
|
title: time_period specifies the duration that time_based_limit is evalulated
|
|
time_based_limit:
|
|
type: string
|
|
title: >-
|
|
time_based_limit defines the maximum supply that can be swapped within
|
|
time_period
|
|
description: >-
|
|
SupplyLimit define the absolute and time-based limits for an assets's
|
|
supply.
|
|
kava.bep3.v1beta1.SwapDirection:
|
|
type: string
|
|
enum:
|
|
- SWAP_DIRECTION_UNSPECIFIED
|
|
- SWAP_DIRECTION_INCOMING
|
|
- SWAP_DIRECTION_OUTGOING
|
|
default: SWAP_DIRECTION_UNSPECIFIED
|
|
description: >-
|
|
- SWAP_DIRECTION_UNSPECIFIED: SWAP_DIRECTION_UNSPECIFIED represents
|
|
unspecified or invalid swap direcation
|
|
- SWAP_DIRECTION_INCOMING: SWAP_DIRECTION_INCOMING represents is incoming swap (to the kava chain)
|
|
- SWAP_DIRECTION_OUTGOING: SWAP_DIRECTION_OUTGOING represents an outgoing swap (from the kava chain)
|
|
title: SwapDirection is the direction of an AtomicSwap
|
|
kava.bep3.v1beta1.SwapStatus:
|
|
type: string
|
|
enum:
|
|
- SWAP_STATUS_UNSPECIFIED
|
|
- SWAP_STATUS_OPEN
|
|
- SWAP_STATUS_COMPLETED
|
|
- SWAP_STATUS_EXPIRED
|
|
default: SWAP_STATUS_UNSPECIFIED
|
|
description: >-
|
|
- SWAP_STATUS_UNSPECIFIED: SWAP_STATUS_UNSPECIFIED represents an
|
|
unspecified status
|
|
- SWAP_STATUS_OPEN: SWAP_STATUS_OPEN represents an open swap
|
|
- SWAP_STATUS_COMPLETED: SWAP_STATUS_COMPLETED represents a completed swap
|
|
- SWAP_STATUS_EXPIRED: SWAP_STATUS_EXPIRED represents an expired swap
|
|
title: SwapStatus is the status of an AtomicSwap
|
|
cosmos.auth.v1beta1.BaseAccount:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
pub_key:
|
|
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"
|
|
}
|
|
account_number:
|
|
type: string
|
|
format: uint64
|
|
sequence:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
BaseAccount defines a base account type. It contains all the necessary
|
|
fields
|
|
|
|
for basic account functionality. Any custom account type should extend
|
|
this
|
|
|
|
type for additional functionality (e.g. vesting).
|
|
cosmos.auth.v1beta1.ModuleAccount:
|
|
type: object
|
|
properties:
|
|
base_account:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
pub_key:
|
|
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"
|
|
}
|
|
account_number:
|
|
type: string
|
|
format: uint64
|
|
sequence:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
BaseAccount defines a base account type. It contains all the necessary
|
|
fields
|
|
|
|
for basic account functionality. Any custom account type should extend
|
|
this
|
|
|
|
type for additional functionality (e.g. vesting).
|
|
name:
|
|
type: string
|
|
permissions:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: ModuleAccount defines an account for modules that holds coins on a pool.
|
|
kava.cdp.v1beta1.CDPResponse:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uint64
|
|
owner:
|
|
type: string
|
|
type:
|
|
type: string
|
|
collateral:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
principal:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
accumulated_fees:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
fees_updated:
|
|
type: string
|
|
format: date-time
|
|
interest_factor:
|
|
type: string
|
|
collateral_value:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
collateralization_ratio:
|
|
type: string
|
|
description: CDPResponse defines the state of a single collateralized debt position.
|
|
kava.cdp.v1beta1.CollateralParam:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
type:
|
|
type: string
|
|
liquidation_ratio:
|
|
type: string
|
|
debt_limit:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
stability_fee:
|
|
type: string
|
|
auction_size:
|
|
type: string
|
|
liquidation_penalty:
|
|
type: string
|
|
spot_market_id:
|
|
type: string
|
|
liquidation_market_id:
|
|
type: string
|
|
keeper_reward_percentage:
|
|
type: string
|
|
check_collateralization_index_count:
|
|
type: string
|
|
conversion_factor:
|
|
type: string
|
|
title: >-
|
|
CollateralParam defines governance parameters for each collateral type
|
|
within the cdp module
|
|
kava.cdp.v1beta1.DebtParam:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
reference_asset:
|
|
type: string
|
|
conversion_factor:
|
|
type: string
|
|
debt_floor:
|
|
type: string
|
|
title: DebtParam defines governance params for debt assets
|
|
kava.cdp.v1beta1.Deposit:
|
|
type: object
|
|
properties:
|
|
cdp_id:
|
|
type: string
|
|
format: uint64
|
|
depositor:
|
|
type: string
|
|
amount:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
title: Deposit defines an amount of coins deposited by an account to a cdp
|
|
kava.cdp.v1beta1.Params:
|
|
type: object
|
|
properties:
|
|
collateral_params:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
type:
|
|
type: string
|
|
liquidation_ratio:
|
|
type: string
|
|
debt_limit:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
stability_fee:
|
|
type: string
|
|
auction_size:
|
|
type: string
|
|
liquidation_penalty:
|
|
type: string
|
|
spot_market_id:
|
|
type: string
|
|
liquidation_market_id:
|
|
type: string
|
|
keeper_reward_percentage:
|
|
type: string
|
|
check_collateralization_index_count:
|
|
type: string
|
|
conversion_factor:
|
|
type: string
|
|
title: >-
|
|
CollateralParam defines governance parameters for each collateral
|
|
type within the cdp module
|
|
debt_param:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
reference_asset:
|
|
type: string
|
|
conversion_factor:
|
|
type: string
|
|
debt_floor:
|
|
type: string
|
|
title: DebtParam defines governance params for debt assets
|
|
global_debt_limit:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
surplus_auction_threshold:
|
|
type: string
|
|
surplus_auction_lot:
|
|
type: string
|
|
debt_auction_threshold:
|
|
type: string
|
|
debt_auction_lot:
|
|
type: string
|
|
circuit_breaker:
|
|
type: boolean
|
|
format: boolean
|
|
description: Params defines the parameters for the cdp module.
|
|
kava.cdp.v1beta1.QueryAccountsResponse:
|
|
type: object
|
|
properties:
|
|
accounts:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
base_account:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
pub_key:
|
|
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"
|
|
}
|
|
account_number:
|
|
type: string
|
|
format: uint64
|
|
sequence:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
BaseAccount defines a base account type. It contains all the
|
|
necessary fields
|
|
|
|
for basic account functionality. Any custom account type should
|
|
extend this
|
|
|
|
type for additional functionality (e.g. vesting).
|
|
name:
|
|
type: string
|
|
permissions:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: >-
|
|
ModuleAccount defines an account for modules that holds coins on a
|
|
pool.
|
|
description: >-
|
|
QueryAccountsResponse defines the response type for the Query/Accounts RPC
|
|
method.
|
|
kava.cdp.v1beta1.QueryCdpResponse:
|
|
type: object
|
|
properties:
|
|
cdp:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uint64
|
|
owner:
|
|
type: string
|
|
type:
|
|
type: string
|
|
collateral:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
principal:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
accumulated_fees:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
fees_updated:
|
|
type: string
|
|
format: date-time
|
|
interest_factor:
|
|
type: string
|
|
collateral_value:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
collateralization_ratio:
|
|
type: string
|
|
description: >-
|
|
CDPResponse defines the state of a single collateralized debt
|
|
position.
|
|
description: QueryCdpResponse defines the response type for the Query/Cdp RPC method.
|
|
kava.cdp.v1beta1.QueryCdpsResponse:
|
|
type: object
|
|
properties:
|
|
cdps:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
format: uint64
|
|
owner:
|
|
type: string
|
|
type:
|
|
type: string
|
|
collateral:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
principal:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
accumulated_fees:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
fees_updated:
|
|
type: string
|
|
format: date-time
|
|
interest_factor:
|
|
type: string
|
|
collateral_value:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
collateralization_ratio:
|
|
type: string
|
|
description: >-
|
|
CDPResponse defines the state of a single collateralized debt
|
|
position.
|
|
pagination:
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
PageResponse is to be embedded in gRPC response messages where the
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
description: QueryCdpsResponse defines the response type for the Query/Cdps RPC method.
|
|
kava.cdp.v1beta1.QueryDepositsResponse:
|
|
type: object
|
|
properties:
|
|
deposits:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
cdp_id:
|
|
type: string
|
|
format: uint64
|
|
depositor:
|
|
type: string
|
|
amount:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
title: Deposit defines an amount of coins deposited by an account to a cdp
|
|
description: >-
|
|
QueryDepositsResponse defines the response type for the Query/Deposits RPC
|
|
method.
|
|
kava.cdp.v1beta1.QueryParamsResponse:
|
|
type: object
|
|
properties:
|
|
params:
|
|
type: object
|
|
properties:
|
|
collateral_params:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
type:
|
|
type: string
|
|
liquidation_ratio:
|
|
type: string
|
|
debt_limit:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
stability_fee:
|
|
type: string
|
|
auction_size:
|
|
type: string
|
|
liquidation_penalty:
|
|
type: string
|
|
spot_market_id:
|
|
type: string
|
|
liquidation_market_id:
|
|
type: string
|
|
keeper_reward_percentage:
|
|
type: string
|
|
check_collateralization_index_count:
|
|
type: string
|
|
conversion_factor:
|
|
type: string
|
|
title: >-
|
|
CollateralParam defines governance parameters for each
|
|
collateral type within the cdp module
|
|
debt_param:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
reference_asset:
|
|
type: string
|
|
conversion_factor:
|
|
type: string
|
|
debt_floor:
|
|
type: string
|
|
title: DebtParam defines governance params for debt assets
|
|
global_debt_limit:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
surplus_auction_threshold:
|
|
type: string
|
|
surplus_auction_lot:
|
|
type: string
|
|
debt_auction_threshold:
|
|
type: string
|
|
debt_auction_lot:
|
|
type: string
|
|
circuit_breaker:
|
|
type: boolean
|
|
format: boolean
|
|
description: Params defines the parameters for the cdp module.
|
|
description: >-
|
|
QueryParamsResponse defines the response type for the Query/Params RPC
|
|
method.
|
|
kava.cdp.v1beta1.QueryTotalCollateralResponse:
|
|
type: object
|
|
properties:
|
|
total_collateral:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
amount:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
title: >-
|
|
TotalCollateral defines the total collateral of a given collateral
|
|
type
|
|
description: >-
|
|
QueryTotalCollateralResponse defines the response type for the
|
|
Query/TotalCollateral RPC method.
|
|
kava.cdp.v1beta1.QueryTotalPrincipalResponse:
|
|
type: object
|
|
properties:
|
|
total_principal:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
amount:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
title: >-
|
|
TotalPrincipal defines the total principal of a given collateral
|
|
type
|
|
description: >-
|
|
QueryTotalPrincipalResponse defines the response type for the
|
|
Query/TotalPrincipal RPC method.
|
|
kava.cdp.v1beta1.TotalCollateral:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
amount:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
title: TotalCollateral defines the total collateral of a given collateral type
|
|
kava.cdp.v1beta1.TotalPrincipal:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
amount:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
title: TotalPrincipal defines the total principal of a given collateral type
|
|
kava.committee.v1beta1.QueryCommitteeResponse:
|
|
type: object
|
|
properties:
|
|
committee:
|
|
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"
|
|
}
|
|
description: >-
|
|
QueryCommitteeResponse defines the response type for querying x/committee
|
|
committee.
|
|
kava.committee.v1beta1.QueryCommitteesResponse:
|
|
type: object
|
|
properties:
|
|
committees:
|
|
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"
|
|
}
|
|
description: >-
|
|
QueryCommitteesResponse defines the response type for querying x/committee
|
|
committees.
|
|
kava.committee.v1beta1.QueryNextProposalIDResponse:
|
|
type: object
|
|
properties:
|
|
next_proposal_id:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
QueryNextProposalIDRequest defines the response type for querying
|
|
x/committee NextProposalID.
|
|
kava.committee.v1beta1.QueryProposalResponse:
|
|
type: object
|
|
properties:
|
|
pub_proposal:
|
|
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"
|
|
}
|
|
id:
|
|
type: string
|
|
format: uint64
|
|
committee_id:
|
|
type: string
|
|
format: uint64
|
|
deadline:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
QueryProposalResponse defines the response type for querying x/committee
|
|
proposal.
|
|
kava.committee.v1beta1.QueryProposalsResponse:
|
|
type: object
|
|
properties:
|
|
proposals:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
pub_proposal:
|
|
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"
|
|
}
|
|
id:
|
|
type: string
|
|
format: uint64
|
|
committee_id:
|
|
type: string
|
|
format: uint64
|
|
deadline:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
QueryProposalResponse defines the response type for querying
|
|
x/committee proposal.
|
|
description: >-
|
|
QueryProposalsResponse defines the response type for querying x/committee
|
|
proposals.
|
|
kava.committee.v1beta1.QueryRawParamsResponse:
|
|
type: object
|
|
properties:
|
|
raw_data:
|
|
type: string
|
|
description: >-
|
|
QueryRawParamsResponse defines the response type for querying x/committee
|
|
raw params.
|
|
kava.committee.v1beta1.QueryTallyResponse:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
yes_votes:
|
|
type: string
|
|
no_votes:
|
|
type: string
|
|
current_votes:
|
|
type: string
|
|
possible_votes:
|
|
type: string
|
|
vote_threshold:
|
|
type: string
|
|
quorum:
|
|
type: string
|
|
description: >-
|
|
QueryTallyResponse defines the response type for querying x/committee
|
|
tally.
|
|
kava.committee.v1beta1.QueryVoteResponse:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
voter:
|
|
type: string
|
|
vote_type:
|
|
type: string
|
|
enum:
|
|
- VOTE_TYPE_UNSPECIFIED
|
|
- VOTE_TYPE_YES
|
|
- VOTE_TYPE_NO
|
|
- VOTE_TYPE_ABSTAIN
|
|
default: VOTE_TYPE_UNSPECIFIED
|
|
description: |-
|
|
VoteType enumerates the valid types of a vote.
|
|
|
|
- VOTE_TYPE_UNSPECIFIED: VOTE_TYPE_UNSPECIFIED defines a no-op vote option.
|
|
- VOTE_TYPE_YES: VOTE_TYPE_YES defines a yes vote option.
|
|
- VOTE_TYPE_NO: VOTE_TYPE_NO defines a no vote option.
|
|
- VOTE_TYPE_ABSTAIN: VOTE_TYPE_ABSTAIN defines an abstain vote option.
|
|
description: QueryVoteResponse defines the response type for querying x/committee vote.
|
|
kava.committee.v1beta1.QueryVotesResponse:
|
|
type: object
|
|
properties:
|
|
votes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
voter:
|
|
type: string
|
|
vote_type:
|
|
type: string
|
|
enum:
|
|
- VOTE_TYPE_UNSPECIFIED
|
|
- VOTE_TYPE_YES
|
|
- VOTE_TYPE_NO
|
|
- VOTE_TYPE_ABSTAIN
|
|
default: VOTE_TYPE_UNSPECIFIED
|
|
description: |-
|
|
VoteType enumerates the valid types of a vote.
|
|
|
|
- VOTE_TYPE_UNSPECIFIED: VOTE_TYPE_UNSPECIFIED defines a no-op vote option.
|
|
- VOTE_TYPE_YES: VOTE_TYPE_YES defines a yes vote option.
|
|
- VOTE_TYPE_NO: VOTE_TYPE_NO defines a no vote option.
|
|
- VOTE_TYPE_ABSTAIN: VOTE_TYPE_ABSTAIN defines an abstain vote option.
|
|
description: >-
|
|
QueryVoteResponse defines the response type for querying x/committee
|
|
vote.
|
|
description: votes defined the queried votes.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryVotesResponse defines the response type for querying x/committee
|
|
votes.
|
|
kava.committee.v1beta1.VoteType:
|
|
type: string
|
|
enum:
|
|
- VOTE_TYPE_UNSPECIFIED
|
|
- VOTE_TYPE_YES
|
|
- VOTE_TYPE_NO
|
|
- VOTE_TYPE_ABSTAIN
|
|
default: VOTE_TYPE_UNSPECIFIED
|
|
description: |-
|
|
VoteType enumerates the valid types of a vote.
|
|
|
|
- VOTE_TYPE_UNSPECIFIED: VOTE_TYPE_UNSPECIFIED defines a no-op vote option.
|
|
- VOTE_TYPE_YES: VOTE_TYPE_YES defines a yes vote option.
|
|
- VOTE_TYPE_NO: VOTE_TYPE_NO defines a no vote option.
|
|
- VOTE_TYPE_ABSTAIN: VOTE_TYPE_ABSTAIN defines an abstain vote option.
|
|
kava.hard.v1beta1.BorrowInterestFactorResponse:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
value:
|
|
type: string
|
|
title: sdk.Dec as string
|
|
description: BorrowInterestFactorResponse defines an individual borrow interest factor.
|
|
kava.hard.v1beta1.BorrowLimit:
|
|
type: object
|
|
properties:
|
|
has_max_limit:
|
|
type: boolean
|
|
format: boolean
|
|
maximum_limit:
|
|
type: string
|
|
loan_to_value:
|
|
type: string
|
|
description: BorrowLimit enforces restrictions on a money market.
|
|
kava.hard.v1beta1.BorrowResponse:
|
|
type: object
|
|
properties:
|
|
borrower:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
index:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
value:
|
|
type: string
|
|
title: sdk.Dec as string
|
|
description: >-
|
|
BorrowInterestFactorResponse defines an individual borrow interest
|
|
factor.
|
|
description: >-
|
|
BorrowResponse defines an amount of coins borrowed from a hard module
|
|
account.
|
|
kava.hard.v1beta1.DepositResponse:
|
|
type: object
|
|
properties:
|
|
depositor:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
index:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
value:
|
|
type: string
|
|
title: sdk.Dec as string
|
|
description: >-
|
|
SupplyInterestFactorResponse defines an individual borrow interest
|
|
factor.
|
|
description: >-
|
|
DepositResponse defines an amount of coins deposited into a hard module
|
|
account.
|
|
kava.hard.v1beta1.InterestFactor:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
borrow_interest_factor:
|
|
type: string
|
|
title: sdk.Dec as String
|
|
supply_interest_factor:
|
|
type: string
|
|
title: sdk.Dec as String
|
|
title: InterestFactor is a unique type returned by interest factor queries
|
|
kava.hard.v1beta1.InterestRateModel:
|
|
type: object
|
|
properties:
|
|
base_rate_apy:
|
|
type: string
|
|
base_multiplier:
|
|
type: string
|
|
kink:
|
|
type: string
|
|
jump_multiplier:
|
|
type: string
|
|
description: InterestRateModel contains information about an asset's interest rate.
|
|
kava.hard.v1beta1.MoneyMarket:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
borrow_limit:
|
|
type: object
|
|
properties:
|
|
has_max_limit:
|
|
type: boolean
|
|
format: boolean
|
|
maximum_limit:
|
|
type: string
|
|
loan_to_value:
|
|
type: string
|
|
description: BorrowLimit enforces restrictions on a money market.
|
|
spot_market_id:
|
|
type: string
|
|
conversion_factor:
|
|
type: string
|
|
interest_rate_model:
|
|
type: object
|
|
properties:
|
|
base_rate_apy:
|
|
type: string
|
|
base_multiplier:
|
|
type: string
|
|
kink:
|
|
type: string
|
|
jump_multiplier:
|
|
type: string
|
|
description: InterestRateModel contains information about an asset's interest rate.
|
|
reserve_factor:
|
|
type: string
|
|
keeper_reward_percentage:
|
|
type: string
|
|
description: MoneyMarket is a money market for an individual asset.
|
|
kava.hard.v1beta1.MoneyMarketInterestRate:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
supply_interest_rate:
|
|
type: string
|
|
title: sdk.Dec as String
|
|
borrow_interest_rate:
|
|
type: string
|
|
title: sdk.Dec as String
|
|
title: MoneyMarketInterestRate is a unique type returned by interest rate queries
|
|
kava.hard.v1beta1.Params:
|
|
type: object
|
|
properties:
|
|
money_markets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
borrow_limit:
|
|
type: object
|
|
properties:
|
|
has_max_limit:
|
|
type: boolean
|
|
format: boolean
|
|
maximum_limit:
|
|
type: string
|
|
loan_to_value:
|
|
type: string
|
|
description: BorrowLimit enforces restrictions on a money market.
|
|
spot_market_id:
|
|
type: string
|
|
conversion_factor:
|
|
type: string
|
|
interest_rate_model:
|
|
type: object
|
|
properties:
|
|
base_rate_apy:
|
|
type: string
|
|
base_multiplier:
|
|
type: string
|
|
kink:
|
|
type: string
|
|
jump_multiplier:
|
|
type: string
|
|
description: >-
|
|
InterestRateModel contains information about an asset's interest
|
|
rate.
|
|
reserve_factor:
|
|
type: string
|
|
keeper_reward_percentage:
|
|
type: string
|
|
description: MoneyMarket is a money market for an individual asset.
|
|
minimum_borrow_usd_value:
|
|
type: string
|
|
description: Params defines the parameters for the hard module.
|
|
kava.hard.v1beta1.QueryAccountsResponse:
|
|
type: object
|
|
properties:
|
|
accounts:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
base_account:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
pub_key:
|
|
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"
|
|
}
|
|
account_number:
|
|
type: string
|
|
format: uint64
|
|
sequence:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
BaseAccount defines a base account type. It contains all the
|
|
necessary fields
|
|
|
|
for basic account functionality. Any custom account type should
|
|
extend this
|
|
|
|
type for additional functionality (e.g. vesting).
|
|
name:
|
|
type: string
|
|
permissions:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: >-
|
|
ModuleAccount defines an account for modules that holds coins on a
|
|
pool.
|
|
description: >-
|
|
QueryAccountsResponse is the response type for the Query/Accounts RPC
|
|
method.
|
|
kava.hard.v1beta1.QueryBorrowsResponse:
|
|
type: object
|
|
properties:
|
|
borrows:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
borrower:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
index:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
value:
|
|
type: string
|
|
title: sdk.Dec as string
|
|
description: >-
|
|
BorrowInterestFactorResponse defines an individual borrow
|
|
interest factor.
|
|
description: >-
|
|
BorrowResponse defines an amount of coins borrowed from a hard
|
|
module account.
|
|
pagination:
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
PageResponse is to be embedded in gRPC response messages where the
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
description: >-
|
|
QueryBorrowsResponse is the response type for the Query/Borrows RPC
|
|
method.
|
|
kava.hard.v1beta1.QueryDepositsResponse:
|
|
type: object
|
|
properties:
|
|
deposits:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
depositor:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
index:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
value:
|
|
type: string
|
|
title: sdk.Dec as string
|
|
description: >-
|
|
SupplyInterestFactorResponse defines an individual borrow
|
|
interest factor.
|
|
description: >-
|
|
DepositResponse defines an amount of coins deposited into a hard
|
|
module account.
|
|
pagination:
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
PageResponse is to be embedded in gRPC response messages where the
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
description: >-
|
|
QueryDepositsResponse is the response type for the Query/Deposits RPC
|
|
method.
|
|
kava.hard.v1beta1.QueryInterestFactorsResponse:
|
|
type: object
|
|
properties:
|
|
interest_factors:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
borrow_interest_factor:
|
|
type: string
|
|
title: sdk.Dec as String
|
|
supply_interest_factor:
|
|
type: string
|
|
title: sdk.Dec as String
|
|
title: InterestFactor is a unique type returned by interest factor queries
|
|
description: >-
|
|
QueryInterestFactorsResponse is the response type for the
|
|
Query/InterestFactors RPC method.
|
|
kava.hard.v1beta1.QueryInterestRateResponse:
|
|
type: object
|
|
properties:
|
|
interest_rates:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
supply_interest_rate:
|
|
type: string
|
|
title: sdk.Dec as String
|
|
borrow_interest_rate:
|
|
type: string
|
|
title: sdk.Dec as String
|
|
title: >-
|
|
MoneyMarketInterestRate is a unique type returned by interest rate
|
|
queries
|
|
description: >-
|
|
QueryInterestRateResponse is the response type for the Query/InterestRate
|
|
RPC method.
|
|
kava.hard.v1beta1.QueryParamsResponse:
|
|
type: object
|
|
properties:
|
|
params:
|
|
type: object
|
|
properties:
|
|
money_markets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
borrow_limit:
|
|
type: object
|
|
properties:
|
|
has_max_limit:
|
|
type: boolean
|
|
format: boolean
|
|
maximum_limit:
|
|
type: string
|
|
loan_to_value:
|
|
type: string
|
|
description: BorrowLimit enforces restrictions on a money market.
|
|
spot_market_id:
|
|
type: string
|
|
conversion_factor:
|
|
type: string
|
|
interest_rate_model:
|
|
type: object
|
|
properties:
|
|
base_rate_apy:
|
|
type: string
|
|
base_multiplier:
|
|
type: string
|
|
kink:
|
|
type: string
|
|
jump_multiplier:
|
|
type: string
|
|
description: >-
|
|
InterestRateModel contains information about an asset's
|
|
interest rate.
|
|
reserve_factor:
|
|
type: string
|
|
keeper_reward_percentage:
|
|
type: string
|
|
description: MoneyMarket is a money market for an individual asset.
|
|
minimum_borrow_usd_value:
|
|
type: string
|
|
description: Params defines the parameters for the hard module.
|
|
description: QueryParamsResponse is the response type for the Query/Params RPC method.
|
|
kava.hard.v1beta1.QueryReservesResponse:
|
|
type: object
|
|
properties:
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
QueryReservesResponse is the response type for the Query/Reserves RPC
|
|
method.
|
|
kava.hard.v1beta1.QueryTotalBorrowedResponse:
|
|
type: object
|
|
properties:
|
|
borrowed_coins:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
QueryTotalBorrowedResponse is the response type for the
|
|
Query/TotalBorrowed RPC method.
|
|
kava.hard.v1beta1.QueryTotalDepositedResponse:
|
|
type: object
|
|
properties:
|
|
supplied_coins:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
QueryTotalDepositedResponse is the response type for the
|
|
Query/TotalDeposited RPC method.
|
|
kava.hard.v1beta1.QueryUnsyncedBorrowsResponse:
|
|
type: object
|
|
properties:
|
|
borrows:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
borrower:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
index:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
value:
|
|
type: string
|
|
title: sdk.Dec as string
|
|
description: >-
|
|
BorrowInterestFactorResponse defines an individual borrow
|
|
interest factor.
|
|
description: >-
|
|
BorrowResponse defines an amount of coins borrowed from a hard
|
|
module account.
|
|
pagination:
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
PageResponse is to be embedded in gRPC response messages where the
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
description: >-
|
|
QueryUnsyncedBorrowsResponse is the response type for the
|
|
Query/UnsyncedBorrows RPC method.
|
|
kava.hard.v1beta1.QueryUnsyncedDepositsResponse:
|
|
type: object
|
|
properties:
|
|
deposits:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
depositor:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
index:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
value:
|
|
type: string
|
|
title: sdk.Dec as string
|
|
description: >-
|
|
SupplyInterestFactorResponse defines an individual borrow
|
|
interest factor.
|
|
description: >-
|
|
DepositResponse defines an amount of coins deposited into a hard
|
|
module account.
|
|
pagination:
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
PageResponse is to be embedded in gRPC response messages where the
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
description: >-
|
|
QueryUnsyncedDepositsResponse is the response type for the
|
|
Query/UnsyncedDeposits RPC method.
|
|
kava.hard.v1beta1.SupplyInterestFactorResponse:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
value:
|
|
type: string
|
|
title: sdk.Dec as string
|
|
description: SupplyInterestFactorResponse defines an individual borrow interest factor.
|
|
kava.issuance.v1beta1.Asset:
|
|
type: object
|
|
properties:
|
|
owner:
|
|
type: string
|
|
denom:
|
|
type: string
|
|
blocked_addresses:
|
|
type: array
|
|
items:
|
|
type: string
|
|
paused:
|
|
type: boolean
|
|
format: boolean
|
|
blockable:
|
|
type: boolean
|
|
format: boolean
|
|
rate_limit:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
format: boolean
|
|
limit:
|
|
type: string
|
|
format: byte
|
|
time_period:
|
|
type: string
|
|
title: RateLimit parameters for rate-limiting the supply of an issued asset
|
|
title: Asset type for assets in the issuance module
|
|
kava.issuance.v1beta1.Params:
|
|
type: object
|
|
properties:
|
|
assets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
owner:
|
|
type: string
|
|
denom:
|
|
type: string
|
|
blocked_addresses:
|
|
type: array
|
|
items:
|
|
type: string
|
|
paused:
|
|
type: boolean
|
|
format: boolean
|
|
blockable:
|
|
type: boolean
|
|
format: boolean
|
|
rate_limit:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
format: boolean
|
|
limit:
|
|
type: string
|
|
format: byte
|
|
time_period:
|
|
type: string
|
|
title: >-
|
|
RateLimit parameters for rate-limiting the supply of an issued
|
|
asset
|
|
title: Asset type for assets in the issuance module
|
|
description: Params defines the parameters for the issuance module.
|
|
kava.issuance.v1beta1.QueryParamsResponse:
|
|
type: object
|
|
properties:
|
|
params:
|
|
type: object
|
|
properties:
|
|
assets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
owner:
|
|
type: string
|
|
denom:
|
|
type: string
|
|
blocked_addresses:
|
|
type: array
|
|
items:
|
|
type: string
|
|
paused:
|
|
type: boolean
|
|
format: boolean
|
|
blockable:
|
|
type: boolean
|
|
format: boolean
|
|
rate_limit:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
format: boolean
|
|
limit:
|
|
type: string
|
|
format: byte
|
|
time_period:
|
|
type: string
|
|
title: >-
|
|
RateLimit parameters for rate-limiting the supply of an
|
|
issued asset
|
|
title: Asset type for assets in the issuance module
|
|
description: Params defines the parameters for the issuance module.
|
|
description: >-
|
|
QueryParamsResponse defines the response type for querying x/issuance
|
|
parameters.
|
|
kava.issuance.v1beta1.RateLimit:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
format: boolean
|
|
limit:
|
|
type: string
|
|
format: byte
|
|
time_period:
|
|
type: string
|
|
title: RateLimit parameters for rate-limiting the supply of an issued asset
|
|
kava.kavadist.v1beta1.Params:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
format: boolean
|
|
periods:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
start:
|
|
type: string
|
|
format: date-time
|
|
title: example "2020-03-01T15:20:00Z"
|
|
end:
|
|
type: string
|
|
format: date-time
|
|
title: example "2020-06-01T15:20:00Z"
|
|
inflation:
|
|
type: string
|
|
format: byte
|
|
title: example "1.000000003022265980" - 10% inflation
|
|
title: >-
|
|
Period stores the specified start and end dates, and the inflation,
|
|
expressed as a decimal
|
|
|
|
representing the yearly APR of KAVA tokens that will be minted
|
|
during that period
|
|
title: Params governance parameters for kavadist module
|
|
kava.kavadist.v1beta1.Period:
|
|
type: object
|
|
properties:
|
|
start:
|
|
type: string
|
|
format: date-time
|
|
title: example "2020-03-01T15:20:00Z"
|
|
end:
|
|
type: string
|
|
format: date-time
|
|
title: example "2020-06-01T15:20:00Z"
|
|
inflation:
|
|
type: string
|
|
format: byte
|
|
title: example "1.000000003022265980" - 10% inflation
|
|
title: >-
|
|
Period stores the specified start and end dates, and the inflation,
|
|
expressed as a decimal
|
|
|
|
representing the yearly APR of KAVA tokens that will be minted during that
|
|
period
|
|
kava.kavadist.v1beta1.QueryBalanceResponse:
|
|
type: object
|
|
properties:
|
|
coins:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
QueryBalanceResponse defines the response type for querying x/kavadist
|
|
balance.
|
|
kava.kavadist.v1beta1.QueryParamsResponse:
|
|
type: object
|
|
properties:
|
|
params:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
format: boolean
|
|
periods:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
start:
|
|
type: string
|
|
format: date-time
|
|
title: example "2020-03-01T15:20:00Z"
|
|
end:
|
|
type: string
|
|
format: date-time
|
|
title: example "2020-06-01T15:20:00Z"
|
|
inflation:
|
|
type: string
|
|
format: byte
|
|
title: example "1.000000003022265980" - 10% inflation
|
|
title: >-
|
|
Period stores the specified start and end dates, and the
|
|
inflation, expressed as a decimal
|
|
|
|
representing the yearly APR of KAVA tokens that will be minted
|
|
during that period
|
|
title: Params governance parameters for kavadist module
|
|
description: >-
|
|
QueryParamsResponse defines the response type for querying x/kavadist
|
|
parameters.
|
|
kava.pricefeed.v1beta1.CurrentPriceResponse:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
price:
|
|
type: string
|
|
description: >-
|
|
CurrentPriceResponse defines a current price for a particular market in
|
|
the pricefeed
|
|
|
|
module.
|
|
kava.pricefeed.v1beta1.Market:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
base_asset:
|
|
type: string
|
|
quote_asset:
|
|
type: string
|
|
oracles:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: byte
|
|
active:
|
|
type: boolean
|
|
format: boolean
|
|
description: Market defines an asset in the pricefeed.
|
|
kava.pricefeed.v1beta1.MarketResponse:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
base_asset:
|
|
type: string
|
|
quote_asset:
|
|
type: string
|
|
oracles:
|
|
type: array
|
|
items:
|
|
type: string
|
|
active:
|
|
type: boolean
|
|
format: boolean
|
|
description: MarketResponse defines an asset in the pricefeed.
|
|
kava.pricefeed.v1beta1.Params:
|
|
type: object
|
|
properties:
|
|
markets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
base_asset:
|
|
type: string
|
|
quote_asset:
|
|
type: string
|
|
oracles:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: byte
|
|
active:
|
|
type: boolean
|
|
format: boolean
|
|
description: Market defines an asset in the pricefeed.
|
|
description: Params defines the parameters for the pricefeed module.
|
|
kava.pricefeed.v1beta1.PostedPriceResponse:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
oracle_address:
|
|
type: string
|
|
price:
|
|
type: string
|
|
expiry:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
PostedPriceResponse defines a price for market posted by a specific
|
|
oracle.
|
|
kava.pricefeed.v1beta1.QueryMarketsResponse:
|
|
type: object
|
|
properties:
|
|
markets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
base_asset:
|
|
type: string
|
|
quote_asset:
|
|
type: string
|
|
oracles:
|
|
type: array
|
|
items:
|
|
type: string
|
|
active:
|
|
type: boolean
|
|
format: boolean
|
|
description: MarketResponse defines an asset in the pricefeed.
|
|
title: List of markets
|
|
description: >-
|
|
QueryMarketsResponse is the response type for the Query/Markets RPC
|
|
method.
|
|
kava.pricefeed.v1beta1.QueryOraclesResponse:
|
|
type: object
|
|
properties:
|
|
oracles:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: List of oracle addresses
|
|
description: >-
|
|
QueryOraclesResponse is the response type for the Query/Oracles RPC
|
|
method.
|
|
kava.pricefeed.v1beta1.QueryParamsResponse:
|
|
type: object
|
|
properties:
|
|
params:
|
|
type: object
|
|
properties:
|
|
markets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
base_asset:
|
|
type: string
|
|
quote_asset:
|
|
type: string
|
|
oracles:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: byte
|
|
active:
|
|
type: boolean
|
|
format: boolean
|
|
description: Market defines an asset in the pricefeed.
|
|
description: Params defines the parameters for the pricefeed module.
|
|
description: |-
|
|
QueryParamsResponse defines the response type for querying x/pricefeed
|
|
parameters.
|
|
kava.pricefeed.v1beta1.QueryPriceResponse:
|
|
type: object
|
|
properties:
|
|
price:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
price:
|
|
type: string
|
|
description: >-
|
|
CurrentPriceResponse defines a current price for a particular market
|
|
in the pricefeed
|
|
|
|
module.
|
|
description: QueryPriceResponse is the response type for the Query/Prices RPC method.
|
|
kava.pricefeed.v1beta1.QueryPricesResponse:
|
|
type: object
|
|
properties:
|
|
prices:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
price:
|
|
type: string
|
|
description: >-
|
|
CurrentPriceResponse defines a current price for a particular market
|
|
in the pricefeed
|
|
|
|
module.
|
|
description: QueryPricesResponse is the response type for the Query/Prices RPC method.
|
|
kava.pricefeed.v1beta1.QueryRawPricesResponse:
|
|
type: object
|
|
properties:
|
|
raw_prices:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
oracle_address:
|
|
type: string
|
|
price:
|
|
type: string
|
|
expiry:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
PostedPriceResponse defines a price for market posted by a specific
|
|
oracle.
|
|
description: |-
|
|
QueryRawPricesResponse is the response type for the Query/RawPrices RPC
|
|
method.
|
|
kava.swap.v1beta1.AllowedPool:
|
|
type: object
|
|
properties:
|
|
token_a:
|
|
type: string
|
|
title: token_a represents the a token allowed
|
|
token_b:
|
|
type: string
|
|
title: token_b represents the b token allowed
|
|
title: AllowedPool defines a pool that is allowed to be created
|
|
kava.swap.v1beta1.DepositResponse:
|
|
type: object
|
|
properties:
|
|
depositor:
|
|
type: string
|
|
title: depositor represents the owner of the deposit
|
|
pool_id:
|
|
type: string
|
|
title: pool_id represents the pool the deposit is for
|
|
shares_owned:
|
|
type: string
|
|
title: shares_owned presents the shares owned by the depositor for the pool
|
|
shares_value:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
title: shares_value represents the coin value of the shares_owned
|
|
description: DepositResponse defines a single deposit query response type.
|
|
kava.swap.v1beta1.Params:
|
|
type: object
|
|
properties:
|
|
allowed_pools:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
token_a:
|
|
type: string
|
|
title: token_a represents the a token allowed
|
|
token_b:
|
|
type: string
|
|
title: token_b represents the b token allowed
|
|
title: AllowedPool defines a pool that is allowed to be created
|
|
title: allowed_pools defines that pools that are allowed to be created
|
|
swap_fee:
|
|
type: string
|
|
title: swap_fee defines the swap fee for all pools
|
|
description: Params defines the parameters for the swap module.
|
|
kava.swap.v1beta1.PoolResponse:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
title: name represents the name of the pool
|
|
coins:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
title: coins represents the total reserves of the pool
|
|
total_shares:
|
|
type: string
|
|
title: total_shares represents the total shares of the pool
|
|
title: Pool represents the state of a single pool
|
|
kava.swap.v1beta1.QueryDepositsResponse:
|
|
type: object
|
|
properties:
|
|
deposits:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
depositor:
|
|
type: string
|
|
title: depositor represents the owner of the deposit
|
|
pool_id:
|
|
type: string
|
|
title: pool_id represents the pool the deposit is for
|
|
shares_owned:
|
|
type: string
|
|
title: >-
|
|
shares_owned presents the shares owned by the depositor for the
|
|
pool
|
|
shares_value:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
title: shares_value represents the coin value of the shares_owned
|
|
description: DepositResponse defines a single deposit query response type.
|
|
title: deposits returns the deposits matching the requested parameters
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryDepositsResponse is the response type for the Query/Deposits RPC
|
|
method.
|
|
kava.swap.v1beta1.QueryParamsResponse:
|
|
type: object
|
|
properties:
|
|
params:
|
|
title: params represents the swap module parameters
|
|
type: object
|
|
properties:
|
|
allowed_pools:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
token_a:
|
|
type: string
|
|
title: token_a represents the a token allowed
|
|
token_b:
|
|
type: string
|
|
title: token_b represents the b token allowed
|
|
title: AllowedPool defines a pool that is allowed to be created
|
|
title: allowed_pools defines that pools that are allowed to be created
|
|
swap_fee:
|
|
type: string
|
|
title: swap_fee defines the swap fee for all pools
|
|
description: Params defines the parameters for the swap module.
|
|
description: >-
|
|
QueryParamsResponse defines the response type for querying x/swap
|
|
parameters.
|
|
kava.swap.v1beta1.QueryPoolsResponse:
|
|
type: object
|
|
properties:
|
|
pools:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
title: name represents the name of the pool
|
|
coins:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
title: coins represents the total reserves of the pool
|
|
total_shares:
|
|
type: string
|
|
title: total_shares represents the total shares of the pool
|
|
title: Pool represents the state of a single pool
|
|
title: pools represents returned pools
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: QueryPoolsResponse is the response type for the Query/Pools RPC method.
|
|
CheckTxResult:
|
|
type: object
|
|
properties:
|
|
code:
|
|
type: integer
|
|
data:
|
|
type: string
|
|
gas_used:
|
|
type: integer
|
|
gas_wanted:
|
|
type: integer
|
|
info:
|
|
type: string
|
|
log:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
example:
|
|
code: 0
|
|
data: data
|
|
log: log
|
|
gas_used: 5000
|
|
gas_wanted: 10000
|
|
info: info
|
|
tags:
|
|
- ''
|
|
- ''
|
|
DeliverTxResult:
|
|
type: object
|
|
properties:
|
|
code:
|
|
type: integer
|
|
data:
|
|
type: string
|
|
gas_used:
|
|
type: integer
|
|
gas_wanted:
|
|
type: integer
|
|
info:
|
|
type: string
|
|
log:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
example:
|
|
code: 5
|
|
data: data
|
|
log: log
|
|
gas_used: 5000
|
|
gas_wanted: 10000
|
|
info: info
|
|
tags:
|
|
- ''
|
|
- ''
|
|
BroadcastTxCommitResult:
|
|
type: object
|
|
properties:
|
|
check_tx:
|
|
type: object
|
|
properties:
|
|
code:
|
|
type: integer
|
|
data:
|
|
type: string
|
|
gas_used:
|
|
type: integer
|
|
gas_wanted:
|
|
type: integer
|
|
info:
|
|
type: string
|
|
log:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
example:
|
|
code: 0
|
|
data: data
|
|
log: log
|
|
gas_used: 5000
|
|
gas_wanted: 10000
|
|
info: info
|
|
tags:
|
|
- ''
|
|
- ''
|
|
deliver_tx:
|
|
type: object
|
|
properties:
|
|
code:
|
|
type: integer
|
|
data:
|
|
type: string
|
|
gas_used:
|
|
type: integer
|
|
gas_wanted:
|
|
type: integer
|
|
info:
|
|
type: string
|
|
log:
|
|
type: string
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
example:
|
|
code: 5
|
|
data: data
|
|
log: log
|
|
gas_used: 5000
|
|
gas_wanted: 10000
|
|
info: info
|
|
tags:
|
|
- ''
|
|
- ''
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
height:
|
|
type: integer
|
|
KVPair:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
Msg:
|
|
type: string
|
|
Address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
ValidatorAddress:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
Coin:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
Hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
TxQuery:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: D085138D913993919295FF4B0A9107F1F2CDE0D37A87CE0644E217CBF3B49656
|
|
height:
|
|
type: number
|
|
example: 368
|
|
tx:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
result:
|
|
type: object
|
|
properties:
|
|
log:
|
|
type: string
|
|
gas_wanted:
|
|
type: string
|
|
example: '200000'
|
|
gas_used:
|
|
type: string
|
|
example: '26354'
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
PaginatedQueryTxs:
|
|
type: object
|
|
properties:
|
|
total_count:
|
|
type: number
|
|
example: 1
|
|
count:
|
|
type: number
|
|
example: 1
|
|
page_number:
|
|
type: number
|
|
example: 1
|
|
page_total:
|
|
type: number
|
|
example: 1
|
|
limit:
|
|
type: number
|
|
example: 30
|
|
txs:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: D085138D913993919295FF4B0A9107F1F2CDE0D37A87CE0644E217CBF3B49656
|
|
height:
|
|
type: number
|
|
example: 368
|
|
tx:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
result:
|
|
type: object
|
|
properties:
|
|
log:
|
|
type: string
|
|
gas_wanted:
|
|
type: string
|
|
example: '200000'
|
|
gas_used:
|
|
type: string
|
|
example: '26354'
|
|
tags:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
StdTx:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: string
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
memo:
|
|
type: string
|
|
signature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
MEUCIQD02fsDPra8MtbRsyB1w7bqTM55Wu138zQbFcWx4+CFyAIge5WNPfKIuvzBZ69MyqHsqD8S1IwiEp+iUb6VSdtlpgY=
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Avz04VhtKJh8ACCVzlI8aTosGy0ikFXKIVHQ3jKMrosH
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
BlockID:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
BlockHeader:
|
|
type: object
|
|
properties:
|
|
chain_id:
|
|
type: string
|
|
example: cosmoshub-2
|
|
height:
|
|
type: number
|
|
example: 1
|
|
time:
|
|
type: string
|
|
example: '2017-12-30T05:53:09.287+01:00'
|
|
num_txs:
|
|
type: number
|
|
example: 0
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
total_txs:
|
|
type: number
|
|
example: 35
|
|
last_commit_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
data_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
validators_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
next_validators_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
consensus_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
app_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
last_results_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
evidence_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
proposer_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
version:
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
example: 10
|
|
app:
|
|
type: string
|
|
example: 0
|
|
Block:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
chain_id:
|
|
type: string
|
|
example: cosmoshub-2
|
|
height:
|
|
type: number
|
|
example: 1
|
|
time:
|
|
type: string
|
|
example: '2017-12-30T05:53:09.287+01:00'
|
|
num_txs:
|
|
type: number
|
|
example: 0
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
total_txs:
|
|
type: number
|
|
example: 35
|
|
last_commit_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
data_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
validators_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
next_validators_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
consensus_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
app_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
last_results_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
evidence_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
proposer_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
version:
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
example: 10
|
|
app:
|
|
type: string
|
|
example: 0
|
|
txs:
|
|
type: array
|
|
items:
|
|
type: string
|
|
evidence:
|
|
type: array
|
|
items:
|
|
type: string
|
|
last_commit:
|
|
type: object
|
|
properties:
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
precommits:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
validator_address:
|
|
type: string
|
|
validator_index:
|
|
type: string
|
|
example: '0'
|
|
height:
|
|
type: string
|
|
example: '0'
|
|
round:
|
|
type: string
|
|
example: '0'
|
|
timestamp:
|
|
type: string
|
|
example: '2017-12-30T05:53:09.287+01:00'
|
|
type:
|
|
type: number
|
|
example: 2
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
7uTC74QlknqYWEwg7Vn6M8Om7FuZ0EO4bjvuj6rwH1mTUJrRuMMZvAAqT9VjNgP0RA/TDp6u/92AqrZfXJSpBQ==
|
|
BlockQuery:
|
|
type: object
|
|
properties:
|
|
block_meta:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
chain_id:
|
|
type: string
|
|
example: cosmoshub-2
|
|
height:
|
|
type: number
|
|
example: 1
|
|
time:
|
|
type: string
|
|
example: '2017-12-30T05:53:09.287+01:00'
|
|
num_txs:
|
|
type: number
|
|
example: 0
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
total_txs:
|
|
type: number
|
|
example: 35
|
|
last_commit_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
data_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
validators_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
next_validators_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
consensus_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
app_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
last_results_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
evidence_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
proposer_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
version:
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
example: 10
|
|
app:
|
|
type: string
|
|
example: 0
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
block:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
chain_id:
|
|
type: string
|
|
example: cosmoshub-2
|
|
height:
|
|
type: number
|
|
example: 1
|
|
time:
|
|
type: string
|
|
example: '2017-12-30T05:53:09.287+01:00'
|
|
num_txs:
|
|
type: number
|
|
example: 0
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
total_txs:
|
|
type: number
|
|
example: 35
|
|
last_commit_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
data_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
validators_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
next_validators_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
consensus_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
app_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
last_results_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
evidence_hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
proposer_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
version:
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
example: 10
|
|
app:
|
|
type: string
|
|
example: 0
|
|
txs:
|
|
type: array
|
|
items:
|
|
type: string
|
|
evidence:
|
|
type: array
|
|
items:
|
|
type: string
|
|
last_commit:
|
|
type: object
|
|
properties:
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
precommits:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
validator_address:
|
|
type: string
|
|
validator_index:
|
|
type: string
|
|
example: '0'
|
|
height:
|
|
type: string
|
|
example: '0'
|
|
round:
|
|
type: string
|
|
example: '0'
|
|
timestamp:
|
|
type: string
|
|
example: '2017-12-30T05:53:09.287+01:00'
|
|
type:
|
|
type: number
|
|
example: 2
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
parts:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: number
|
|
example: 0
|
|
hash:
|
|
type: string
|
|
example: EE5F3404034C524501629B56E0DDC38FAD651F04
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
7uTC74QlknqYWEwg7Vn6M8Om7FuZ0EO4bjvuj6rwH1mTUJrRuMMZvAAqT9VjNgP0RA/TDp6u/92AqrZfXJSpBQ==
|
|
DelegationDelegatorReward:
|
|
type: object
|
|
properties:
|
|
validator_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
reward:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
DelegatorTotalRewards:
|
|
type: object
|
|
properties:
|
|
rewards:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
validator_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
reward:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
total:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
BaseReq:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: cosmos1g9ahr6xhht5rmqven628nklxluzyv8z9jqjcmc
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: Sent via Cosmos Voyager 🚀
|
|
chain_id:
|
|
type: string
|
|
example: Cosmos-Hub
|
|
account_number:
|
|
type: string
|
|
example: '0'
|
|
sequence:
|
|
type: string
|
|
example: '1'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.2'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in conjunction with
|
|
generate_only)
|
|
TendermintValidator:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
pub_key:
|
|
type: string
|
|
example: >-
|
|
cosmosvalconspub1zcjduepq0vu2zgkgk49efa0nqwzndanq5m4c7pa3u4apz4g2r9gspqg6g9cs3k9cuf
|
|
voting_power:
|
|
type: string
|
|
example: '1000'
|
|
proposer_priority:
|
|
type: string
|
|
example: '1000'
|
|
TextProposal:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: integer
|
|
title:
|
|
type: string
|
|
description:
|
|
type: string
|
|
proposal_type:
|
|
type: string
|
|
proposal_status:
|
|
type: string
|
|
final_tally_result:
|
|
type: object
|
|
properties:
|
|
'yes':
|
|
type: string
|
|
example: '0.0000000000'
|
|
abstain:
|
|
type: string
|
|
example: '0.0000000000'
|
|
'no':
|
|
type: string
|
|
example: '0.0000000000'
|
|
no_with_veto:
|
|
type: string
|
|
example: '0.0000000000'
|
|
submit_time:
|
|
type: string
|
|
total_deposit:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
voting_start_time:
|
|
type: string
|
|
Proposer:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
proposer:
|
|
type: string
|
|
Deposit:
|
|
type: object
|
|
properties:
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
proposal_id:
|
|
type: string
|
|
depositor:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmos1depk54cuajgkzea6zpgkq36tnjwdzv4afc3d27
|
|
TallyResult:
|
|
type: object
|
|
properties:
|
|
'yes':
|
|
type: string
|
|
example: '0.0000000000'
|
|
abstain:
|
|
type: string
|
|
example: '0.0000000000'
|
|
'no':
|
|
type: string
|
|
example: '0.0000000000'
|
|
no_with_veto:
|
|
type: string
|
|
example: '0.0000000000'
|
|
Vote:
|
|
type: object
|
|
properties:
|
|
voter:
|
|
type: string
|
|
proposal_id:
|
|
type: string
|
|
option:
|
|
type: string
|
|
Validator:
|
|
type: object
|
|
properties:
|
|
operator_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
consensus_pubkey:
|
|
type: string
|
|
example: >-
|
|
cosmosvalconspub1zcjduepq0vu2zgkgk49efa0nqwzndanq5m4c7pa3u4apz4g2r9gspqg6g9cs3k9cuf
|
|
jailed:
|
|
type: boolean
|
|
status:
|
|
type: integer
|
|
tokens:
|
|
type: string
|
|
delegator_shares:
|
|
type: string
|
|
description:
|
|
type: object
|
|
properties:
|
|
moniker:
|
|
type: string
|
|
identity:
|
|
type: string
|
|
website:
|
|
type: string
|
|
security_contact:
|
|
type: string
|
|
details:
|
|
type: string
|
|
bond_height:
|
|
type: string
|
|
example: '0'
|
|
bond_intra_tx_counter:
|
|
type: integer
|
|
example: 0
|
|
unbonding_height:
|
|
type: string
|
|
example: '0'
|
|
unbonding_time:
|
|
type: string
|
|
example: '1970-01-01T00:00:00Z'
|
|
commission:
|
|
type: object
|
|
properties:
|
|
rate:
|
|
type: string
|
|
example: '0'
|
|
max_rate:
|
|
type: string
|
|
example: '0'
|
|
max_change_rate:
|
|
type: string
|
|
example: '0'
|
|
update_time:
|
|
type: string
|
|
example: '1970-01-01T00:00:00Z'
|
|
Delegation:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
validator_address:
|
|
type: string
|
|
shares:
|
|
type: string
|
|
balance:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
UnbondingDelegationPair:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
validator_address:
|
|
type: string
|
|
entries:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
initial_balance:
|
|
type: string
|
|
balance:
|
|
type: string
|
|
creation_height:
|
|
type: string
|
|
min_time:
|
|
type: string
|
|
UnbondingEntries:
|
|
type: object
|
|
properties:
|
|
initial_balance:
|
|
type: string
|
|
balance:
|
|
type: string
|
|
creation_height:
|
|
type: string
|
|
min_time:
|
|
type: string
|
|
UnbondingDelegation:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
validator_address:
|
|
type: string
|
|
initial_balance:
|
|
type: string
|
|
balance:
|
|
type: string
|
|
creation_height:
|
|
type: integer
|
|
min_time:
|
|
type: integer
|
|
Redelegation:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
validator_src_address:
|
|
type: string
|
|
validator_dst_address:
|
|
type: string
|
|
entries:
|
|
type: array
|
|
items:
|
|
$ref: '#/definitions/Redelegation'
|
|
RedelegationEntry:
|
|
type: object
|
|
properties:
|
|
creation_height:
|
|
type: integer
|
|
completion_time:
|
|
type: integer
|
|
initial_balance:
|
|
type: string
|
|
balance:
|
|
type: string
|
|
shares_dst:
|
|
type: string
|
|
ValidatorDistInfo:
|
|
type: object
|
|
properties:
|
|
operator_address:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: cosmosvaloper16xyempempp92x9hyzz9wrgf94r6j9h5f2w4n2l
|
|
self_bond_rewards:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
val_commission:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
PublicKey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
value:
|
|
type: string
|
|
SigningInfo:
|
|
type: object
|
|
properties:
|
|
start_height:
|
|
type: string
|
|
index_offset:
|
|
type: string
|
|
jailed_until:
|
|
type: string
|
|
missed_blocks_counter:
|
|
type: string
|
|
ParamChange:
|
|
type: object
|
|
properties:
|
|
subspace:
|
|
type: string
|
|
example: staking
|
|
key:
|
|
type: string
|
|
example: MaxValidators
|
|
subkey:
|
|
type: string
|
|
example: ''
|
|
value:
|
|
type: object
|
|
Supply:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: stake
|
|
amount:
|
|
type: string
|
|
example: '50'
|
|
cosmos.auth.v1beta1.Params:
|
|
type: object
|
|
properties:
|
|
max_memo_characters:
|
|
type: string
|
|
format: uint64
|
|
tx_sig_limit:
|
|
type: string
|
|
format: uint64
|
|
tx_size_cost_per_byte:
|
|
type: string
|
|
format: uint64
|
|
sig_verify_cost_ed25519:
|
|
type: string
|
|
format: uint64
|
|
sig_verify_cost_secp256k1:
|
|
type: string
|
|
format: uint64
|
|
description: Params defines the parameters for the auth module.
|
|
cosmos.auth.v1beta1.QueryAccountResponse:
|
|
type: object
|
|
properties:
|
|
account:
|
|
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"
|
|
}
|
|
description: >-
|
|
QueryAccountResponse is the response type for the Query/Account RPC
|
|
method.
|
|
cosmos.auth.v1beta1.QueryAccountsResponse:
|
|
type: object
|
|
properties:
|
|
accounts:
|
|
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"
|
|
}
|
|
title: accounts are the existing accounts
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryAccountsResponse is the response type for the Query/Accounts RPC
|
|
method.
|
|
cosmos.auth.v1beta1.QueryParamsResponse:
|
|
type: object
|
|
properties:
|
|
params:
|
|
description: params defines the parameters of the module.
|
|
type: object
|
|
properties:
|
|
max_memo_characters:
|
|
type: string
|
|
format: uint64
|
|
tx_sig_limit:
|
|
type: string
|
|
format: uint64
|
|
tx_size_cost_per_byte:
|
|
type: string
|
|
format: uint64
|
|
sig_verify_cost_ed25519:
|
|
type: string
|
|
format: uint64
|
|
sig_verify_cost_secp256k1:
|
|
type: string
|
|
format: uint64
|
|
description: QueryParamsResponse is the response type for the Query/Params RPC method.
|
|
cosmos.bank.v1beta1.DenomOwner:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
description: address defines the address that owns a particular denomination.
|
|
balance:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
description: |-
|
|
DenomOwner defines structure representing an account that owns or holds a
|
|
particular denominated token. It contains the account address and account
|
|
balance of the denominated token.
|
|
cosmos.bank.v1beta1.DenomUnit:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
description: denom represents the string name of the given denom unit (e.g uatom).
|
|
exponent:
|
|
type: integer
|
|
format: int64
|
|
description: >-
|
|
exponent represents power of 10 exponent that one must
|
|
|
|
raise the base_denom to in order to equal the given DenomUnit's denom
|
|
|
|
1 denom = 1^exponent base_denom
|
|
|
|
(e.g. with a base_denom of uatom, one can create a DenomUnit of 'atom'
|
|
with
|
|
|
|
exponent = 6, thus: 1 atom = 10^6 uatom).
|
|
aliases:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: aliases is a list of string aliases for the given denom
|
|
description: |-
|
|
DenomUnit represents a struct that describes a given
|
|
denomination unit of the basic token.
|
|
cosmos.bank.v1beta1.Metadata:
|
|
type: object
|
|
properties:
|
|
description:
|
|
type: string
|
|
denom_units:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
description: >-
|
|
denom represents the string name of the given denom unit (e.g
|
|
uatom).
|
|
exponent:
|
|
type: integer
|
|
format: int64
|
|
description: >-
|
|
exponent represents power of 10 exponent that one must
|
|
|
|
raise the base_denom to in order to equal the given DenomUnit's
|
|
denom
|
|
|
|
1 denom = 1^exponent base_denom
|
|
|
|
(e.g. with a base_denom of uatom, one can create a DenomUnit of
|
|
'atom' with
|
|
|
|
exponent = 6, thus: 1 atom = 10^6 uatom).
|
|
aliases:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: aliases is a list of string aliases for the given denom
|
|
description: |-
|
|
DenomUnit represents a struct that describes a given
|
|
denomination unit of the basic token.
|
|
title: denom_units represents the list of DenomUnit's for a given coin
|
|
base:
|
|
type: string
|
|
description: >-
|
|
base represents the base denom (should be the DenomUnit with exponent
|
|
= 0).
|
|
display:
|
|
type: string
|
|
description: |-
|
|
display indicates the suggested denom that should be
|
|
displayed in clients.
|
|
name:
|
|
type: string
|
|
title: 'name defines the name of the token (eg: Cosmos Atom)'
|
|
symbol:
|
|
type: string
|
|
description: >-
|
|
symbol is the token symbol usually shown on exchanges (eg: ATOM). This
|
|
can
|
|
|
|
be the same as the display.
|
|
uri:
|
|
type: string
|
|
description: >-
|
|
URI to a document (on or off-chain) that contains additional
|
|
information. Optional.
|
|
uri_hash:
|
|
type: string
|
|
description: >-
|
|
URIHash is a sha256 hash of a document pointed by URI. It's used to
|
|
verify that
|
|
|
|
the document didn't change. Optional.
|
|
description: |-
|
|
Metadata represents a struct that describes
|
|
a basic token.
|
|
cosmos.bank.v1beta1.Params:
|
|
type: object
|
|
properties:
|
|
send_enabled:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
enabled:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
SendEnabled maps coin denom to a send_enabled status (whether a
|
|
denom is
|
|
|
|
sendable).
|
|
default_send_enabled:
|
|
type: boolean
|
|
format: boolean
|
|
description: Params defines the parameters for the bank module.
|
|
cosmos.bank.v1beta1.QueryAllBalancesResponse:
|
|
type: object
|
|
properties:
|
|
balances:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
description: balances is the balances of all the coins.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryAllBalancesResponse is the response type for the Query/AllBalances
|
|
RPC
|
|
|
|
method.
|
|
cosmos.bank.v1beta1.QueryBalanceResponse:
|
|
type: object
|
|
properties:
|
|
balance:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
QueryBalanceResponse is the response type for the Query/Balance RPC
|
|
method.
|
|
cosmos.bank.v1beta1.QueryDenomMetadataResponse:
|
|
type: object
|
|
properties:
|
|
metadata:
|
|
type: object
|
|
properties:
|
|
description:
|
|
type: string
|
|
denom_units:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
description: >-
|
|
denom represents the string name of the given denom unit
|
|
(e.g uatom).
|
|
exponent:
|
|
type: integer
|
|
format: int64
|
|
description: >-
|
|
exponent represents power of 10 exponent that one must
|
|
|
|
raise the base_denom to in order to equal the given
|
|
DenomUnit's denom
|
|
|
|
1 denom = 1^exponent base_denom
|
|
|
|
(e.g. with a base_denom of uatom, one can create a DenomUnit
|
|
of 'atom' with
|
|
|
|
exponent = 6, thus: 1 atom = 10^6 uatom).
|
|
aliases:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: aliases is a list of string aliases for the given denom
|
|
description: |-
|
|
DenomUnit represents a struct that describes a given
|
|
denomination unit of the basic token.
|
|
title: denom_units represents the list of DenomUnit's for a given coin
|
|
base:
|
|
type: string
|
|
description: >-
|
|
base represents the base denom (should be the DenomUnit with
|
|
exponent = 0).
|
|
display:
|
|
type: string
|
|
description: |-
|
|
display indicates the suggested denom that should be
|
|
displayed in clients.
|
|
name:
|
|
type: string
|
|
title: 'name defines the name of the token (eg: Cosmos Atom)'
|
|
symbol:
|
|
type: string
|
|
description: >-
|
|
symbol is the token symbol usually shown on exchanges (eg: ATOM).
|
|
This can
|
|
|
|
be the same as the display.
|
|
uri:
|
|
type: string
|
|
description: >-
|
|
URI to a document (on or off-chain) that contains additional
|
|
information. Optional.
|
|
uri_hash:
|
|
type: string
|
|
description: >-
|
|
URIHash is a sha256 hash of a document pointed by URI. It's used
|
|
to verify that
|
|
|
|
the document didn't change. Optional.
|
|
description: |-
|
|
Metadata represents a struct that describes
|
|
a basic token.
|
|
description: >-
|
|
QueryDenomMetadataResponse is the response type for the
|
|
Query/DenomMetadata RPC
|
|
|
|
method.
|
|
cosmos.bank.v1beta1.QueryDenomOwnersResponse:
|
|
type: object
|
|
properties:
|
|
denom_owners:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
description: address defines the address that owns a particular denomination.
|
|
balance:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
DenomOwner defines structure representing an account that owns or
|
|
holds a
|
|
|
|
particular denominated token. It contains the account address and
|
|
account
|
|
|
|
balance of the denominated token.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryDenomOwnersResponse defines the RPC response of a DenomOwners RPC
|
|
query.
|
|
cosmos.bank.v1beta1.QueryDenomsMetadataResponse:
|
|
type: object
|
|
properties:
|
|
metadatas:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
description:
|
|
type: string
|
|
denom_units:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
description: >-
|
|
denom represents the string name of the given denom unit
|
|
(e.g uatom).
|
|
exponent:
|
|
type: integer
|
|
format: int64
|
|
description: >-
|
|
exponent represents power of 10 exponent that one must
|
|
|
|
raise the base_denom to in order to equal the given
|
|
DenomUnit's denom
|
|
|
|
1 denom = 1^exponent base_denom
|
|
|
|
(e.g. with a base_denom of uatom, one can create a
|
|
DenomUnit of 'atom' with
|
|
|
|
exponent = 6, thus: 1 atom = 10^6 uatom).
|
|
aliases:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: aliases is a list of string aliases for the given denom
|
|
description: |-
|
|
DenomUnit represents a struct that describes a given
|
|
denomination unit of the basic token.
|
|
title: denom_units represents the list of DenomUnit's for a given coin
|
|
base:
|
|
type: string
|
|
description: >-
|
|
base represents the base denom (should be the DenomUnit with
|
|
exponent = 0).
|
|
display:
|
|
type: string
|
|
description: |-
|
|
display indicates the suggested denom that should be
|
|
displayed in clients.
|
|
name:
|
|
type: string
|
|
title: 'name defines the name of the token (eg: Cosmos Atom)'
|
|
symbol:
|
|
type: string
|
|
description: >-
|
|
symbol is the token symbol usually shown on exchanges (eg:
|
|
ATOM). This can
|
|
|
|
be the same as the display.
|
|
uri:
|
|
type: string
|
|
description: >-
|
|
URI to a document (on or off-chain) that contains additional
|
|
information. Optional.
|
|
uri_hash:
|
|
type: string
|
|
description: >-
|
|
URIHash is a sha256 hash of a document pointed by URI. It's used
|
|
to verify that
|
|
|
|
the document didn't change. Optional.
|
|
description: |-
|
|
Metadata represents a struct that describes
|
|
a basic token.
|
|
description: >-
|
|
metadata provides the client information for all the registered
|
|
tokens.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryDenomsMetadataResponse is the response type for the
|
|
Query/DenomsMetadata RPC
|
|
|
|
method.
|
|
cosmos.bank.v1beta1.QueryParamsResponse:
|
|
type: object
|
|
properties:
|
|
params:
|
|
type: object
|
|
properties:
|
|
send_enabled:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
enabled:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
SendEnabled maps coin denom to a send_enabled status (whether a
|
|
denom is
|
|
|
|
sendable).
|
|
default_send_enabled:
|
|
type: boolean
|
|
format: boolean
|
|
description: Params defines the parameters for the bank module.
|
|
description: >-
|
|
QueryParamsResponse defines the response type for querying x/bank
|
|
parameters.
|
|
cosmos.bank.v1beta1.QuerySupplyOfResponse:
|
|
type: object
|
|
properties:
|
|
amount:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
QuerySupplyOfResponse is the response type for the Query/SupplyOf RPC
|
|
method.
|
|
cosmos.bank.v1beta1.QueryTotalSupplyResponse:
|
|
type: object
|
|
properties:
|
|
supply:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
title: supply is the supply of the coins
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
title: >-
|
|
QueryTotalSupplyResponse is the response type for the Query/TotalSupply
|
|
RPC
|
|
|
|
method
|
|
cosmos.bank.v1beta1.SendEnabled:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
enabled:
|
|
type: boolean
|
|
format: boolean
|
|
description: |-
|
|
SendEnabled maps coin denom to a send_enabled status (whether a denom is
|
|
sendable).
|
|
cosmos.base.tendermint.v1beta1.GetBlockByHeightResponse:
|
|
type: object
|
|
properties:
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
block:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
version:
|
|
title: basic block info
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules for processing a block
|
|
in the blockchain,
|
|
|
|
including all blockchain data structures and the rules of the
|
|
application's
|
|
|
|
state transition machine.
|
|
chain_id:
|
|
type: string
|
|
height:
|
|
type: string
|
|
format: int64
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
last_commit_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes of block data
|
|
data_hash:
|
|
type: string
|
|
format: byte
|
|
validators_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes from the app output from the prev block
|
|
next_validators_hash:
|
|
type: string
|
|
format: byte
|
|
consensus_hash:
|
|
type: string
|
|
format: byte
|
|
app_hash:
|
|
type: string
|
|
format: byte
|
|
last_results_hash:
|
|
type: string
|
|
format: byte
|
|
evidence_hash:
|
|
type: string
|
|
format: byte
|
|
title: consensus info
|
|
proposer_address:
|
|
type: string
|
|
format: byte
|
|
description: Header defines the structure of a Tendermint block header.
|
|
data:
|
|
type: object
|
|
properties:
|
|
txs:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Txs that will be applied by state @ block.Height+1.
|
|
|
|
NOTE: not all txs here are valid. We're just agreeing on the
|
|
order first.
|
|
|
|
This means that block.AppHash does not include these txs.
|
|
title: Data contains the set of transactions included in the block
|
|
evidence:
|
|
type: object
|
|
properties:
|
|
evidence:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
duplicate_vote_evidence:
|
|
type: object
|
|
properties:
|
|
vote_a:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SIGNED_MSG_TYPE_UNKNOWN
|
|
- SIGNED_MSG_TYPE_PREVOTE
|
|
- SIGNED_MSG_TYPE_PRECOMMIT
|
|
- SIGNED_MSG_TYPE_PROPOSAL
|
|
default: SIGNED_MSG_TYPE_UNKNOWN
|
|
description: >-
|
|
SignedMsgType is a type of signed message in the
|
|
consensus.
|
|
|
|
- SIGNED_MSG_TYPE_PREVOTE: Votes
|
|
- SIGNED_MSG_TYPE_PROPOSAL: Proposals
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
validator_index:
|
|
type: integer
|
|
format: int32
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Vote represents a prevote, precommit, or commit vote
|
|
from validators for
|
|
|
|
consensus.
|
|
vote_b:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SIGNED_MSG_TYPE_UNKNOWN
|
|
- SIGNED_MSG_TYPE_PREVOTE
|
|
- SIGNED_MSG_TYPE_PRECOMMIT
|
|
- SIGNED_MSG_TYPE_PROPOSAL
|
|
default: SIGNED_MSG_TYPE_UNKNOWN
|
|
description: >-
|
|
SignedMsgType is a type of signed message in the
|
|
consensus.
|
|
|
|
- SIGNED_MSG_TYPE_PREVOTE: Votes
|
|
- SIGNED_MSG_TYPE_PROPOSAL: Proposals
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
validator_index:
|
|
type: integer
|
|
format: int32
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Vote represents a prevote, precommit, or commit vote
|
|
from validators for
|
|
|
|
consensus.
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
validator_power:
|
|
type: string
|
|
format: int64
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
DuplicateVoteEvidence contains evidence of a validator
|
|
signed two conflicting votes.
|
|
light_client_attack_evidence:
|
|
type: object
|
|
properties:
|
|
conflicting_block:
|
|
type: object
|
|
properties:
|
|
signed_header:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
version:
|
|
title: basic block info
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules
|
|
for processing a block in the
|
|
blockchain,
|
|
|
|
including all blockchain data structures
|
|
and the rules of the application's
|
|
|
|
state transition machine.
|
|
chain_id:
|
|
type: string
|
|
height:
|
|
type: string
|
|
format: int64
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
last_commit_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes of block data
|
|
data_hash:
|
|
type: string
|
|
format: byte
|
|
validators_hash:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
hashes from the app output from the prev
|
|
block
|
|
next_validators_hash:
|
|
type: string
|
|
format: byte
|
|
consensus_hash:
|
|
type: string
|
|
format: byte
|
|
app_hash:
|
|
type: string
|
|
format: byte
|
|
last_results_hash:
|
|
type: string
|
|
format: byte
|
|
evidence_hash:
|
|
type: string
|
|
format: byte
|
|
title: consensus info
|
|
proposer_address:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Header defines the structure of a Tendermint
|
|
block header.
|
|
commit:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
block_id_flag:
|
|
type: string
|
|
enum:
|
|
- BLOCK_ID_FLAG_UNKNOWN
|
|
- BLOCK_ID_FLAG_ABSENT
|
|
- BLOCK_ID_FLAG_COMMIT
|
|
- BLOCK_ID_FLAG_NIL
|
|
default: BLOCK_ID_FLAG_UNKNOWN
|
|
title: >-
|
|
BlockIdFlag indicates which BlcokID the
|
|
signature is for
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
CommitSig is a part of the Vote included
|
|
in a Commit.
|
|
description: >-
|
|
Commit contains the evidence that a block
|
|
was committed by a set of validators.
|
|
validator_set:
|
|
type: object
|
|
properties:
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for
|
|
use with Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
proposer:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for
|
|
use with Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
common_height:
|
|
type: string
|
|
format: int64
|
|
byzantine_validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for use
|
|
with Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
LightClientAttackEvidence contains evidence of a set of
|
|
validators attempting to mislead a light client.
|
|
last_commit:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
block_id_flag:
|
|
type: string
|
|
enum:
|
|
- BLOCK_ID_FLAG_UNKNOWN
|
|
- BLOCK_ID_FLAG_ABSENT
|
|
- BLOCK_ID_FLAG_COMMIT
|
|
- BLOCK_ID_FLAG_NIL
|
|
default: BLOCK_ID_FLAG_UNKNOWN
|
|
title: BlockIdFlag indicates which BlcokID the signature is for
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: CommitSig is a part of the Vote included in a Commit.
|
|
description: >-
|
|
Commit contains the evidence that a block was committed by a set
|
|
of validators.
|
|
description: >-
|
|
GetBlockByHeightResponse is the response type for the
|
|
Query/GetBlockByHeight RPC method.
|
|
cosmos.base.tendermint.v1beta1.GetLatestBlockResponse:
|
|
type: object
|
|
properties:
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
block:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
version:
|
|
title: basic block info
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules for processing a block
|
|
in the blockchain,
|
|
|
|
including all blockchain data structures and the rules of the
|
|
application's
|
|
|
|
state transition machine.
|
|
chain_id:
|
|
type: string
|
|
height:
|
|
type: string
|
|
format: int64
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
last_commit_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes of block data
|
|
data_hash:
|
|
type: string
|
|
format: byte
|
|
validators_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes from the app output from the prev block
|
|
next_validators_hash:
|
|
type: string
|
|
format: byte
|
|
consensus_hash:
|
|
type: string
|
|
format: byte
|
|
app_hash:
|
|
type: string
|
|
format: byte
|
|
last_results_hash:
|
|
type: string
|
|
format: byte
|
|
evidence_hash:
|
|
type: string
|
|
format: byte
|
|
title: consensus info
|
|
proposer_address:
|
|
type: string
|
|
format: byte
|
|
description: Header defines the structure of a Tendermint block header.
|
|
data:
|
|
type: object
|
|
properties:
|
|
txs:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Txs that will be applied by state @ block.Height+1.
|
|
|
|
NOTE: not all txs here are valid. We're just agreeing on the
|
|
order first.
|
|
|
|
This means that block.AppHash does not include these txs.
|
|
title: Data contains the set of transactions included in the block
|
|
evidence:
|
|
type: object
|
|
properties:
|
|
evidence:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
duplicate_vote_evidence:
|
|
type: object
|
|
properties:
|
|
vote_a:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SIGNED_MSG_TYPE_UNKNOWN
|
|
- SIGNED_MSG_TYPE_PREVOTE
|
|
- SIGNED_MSG_TYPE_PRECOMMIT
|
|
- SIGNED_MSG_TYPE_PROPOSAL
|
|
default: SIGNED_MSG_TYPE_UNKNOWN
|
|
description: >-
|
|
SignedMsgType is a type of signed message in the
|
|
consensus.
|
|
|
|
- SIGNED_MSG_TYPE_PREVOTE: Votes
|
|
- SIGNED_MSG_TYPE_PROPOSAL: Proposals
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
validator_index:
|
|
type: integer
|
|
format: int32
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Vote represents a prevote, precommit, or commit vote
|
|
from validators for
|
|
|
|
consensus.
|
|
vote_b:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SIGNED_MSG_TYPE_UNKNOWN
|
|
- SIGNED_MSG_TYPE_PREVOTE
|
|
- SIGNED_MSG_TYPE_PRECOMMIT
|
|
- SIGNED_MSG_TYPE_PROPOSAL
|
|
default: SIGNED_MSG_TYPE_UNKNOWN
|
|
description: >-
|
|
SignedMsgType is a type of signed message in the
|
|
consensus.
|
|
|
|
- SIGNED_MSG_TYPE_PREVOTE: Votes
|
|
- SIGNED_MSG_TYPE_PROPOSAL: Proposals
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
validator_index:
|
|
type: integer
|
|
format: int32
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Vote represents a prevote, precommit, or commit vote
|
|
from validators for
|
|
|
|
consensus.
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
validator_power:
|
|
type: string
|
|
format: int64
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
DuplicateVoteEvidence contains evidence of a validator
|
|
signed two conflicting votes.
|
|
light_client_attack_evidence:
|
|
type: object
|
|
properties:
|
|
conflicting_block:
|
|
type: object
|
|
properties:
|
|
signed_header:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
version:
|
|
title: basic block info
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules
|
|
for processing a block in the
|
|
blockchain,
|
|
|
|
including all blockchain data structures
|
|
and the rules of the application's
|
|
|
|
state transition machine.
|
|
chain_id:
|
|
type: string
|
|
height:
|
|
type: string
|
|
format: int64
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
last_commit_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes of block data
|
|
data_hash:
|
|
type: string
|
|
format: byte
|
|
validators_hash:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
hashes from the app output from the prev
|
|
block
|
|
next_validators_hash:
|
|
type: string
|
|
format: byte
|
|
consensus_hash:
|
|
type: string
|
|
format: byte
|
|
app_hash:
|
|
type: string
|
|
format: byte
|
|
last_results_hash:
|
|
type: string
|
|
format: byte
|
|
evidence_hash:
|
|
type: string
|
|
format: byte
|
|
title: consensus info
|
|
proposer_address:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Header defines the structure of a Tendermint
|
|
block header.
|
|
commit:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
block_id_flag:
|
|
type: string
|
|
enum:
|
|
- BLOCK_ID_FLAG_UNKNOWN
|
|
- BLOCK_ID_FLAG_ABSENT
|
|
- BLOCK_ID_FLAG_COMMIT
|
|
- BLOCK_ID_FLAG_NIL
|
|
default: BLOCK_ID_FLAG_UNKNOWN
|
|
title: >-
|
|
BlockIdFlag indicates which BlcokID the
|
|
signature is for
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
CommitSig is a part of the Vote included
|
|
in a Commit.
|
|
description: >-
|
|
Commit contains the evidence that a block
|
|
was committed by a set of validators.
|
|
validator_set:
|
|
type: object
|
|
properties:
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for
|
|
use with Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
proposer:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for
|
|
use with Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
common_height:
|
|
type: string
|
|
format: int64
|
|
byzantine_validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for use
|
|
with Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
LightClientAttackEvidence contains evidence of a set of
|
|
validators attempting to mislead a light client.
|
|
last_commit:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
block_id_flag:
|
|
type: string
|
|
enum:
|
|
- BLOCK_ID_FLAG_UNKNOWN
|
|
- BLOCK_ID_FLAG_ABSENT
|
|
- BLOCK_ID_FLAG_COMMIT
|
|
- BLOCK_ID_FLAG_NIL
|
|
default: BLOCK_ID_FLAG_UNKNOWN
|
|
title: BlockIdFlag indicates which BlcokID the signature is for
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: CommitSig is a part of the Vote included in a Commit.
|
|
description: >-
|
|
Commit contains the evidence that a block was committed by a set
|
|
of validators.
|
|
description: >-
|
|
GetLatestBlockResponse is the response type for the Query/GetLatestBlock
|
|
RPC method.
|
|
cosmos.base.tendermint.v1beta1.GetLatestValidatorSetResponse:
|
|
type: object
|
|
properties:
|
|
block_height:
|
|
type: string
|
|
format: int64
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
pub_key:
|
|
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"
|
|
}
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
description: Validator is the type for the validator-set.
|
|
pagination:
|
|
description: pagination defines an pagination for the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
GetLatestValidatorSetResponse is the response type for the
|
|
Query/GetValidatorSetByHeight RPC method.
|
|
cosmos.base.tendermint.v1beta1.GetNodeInfoResponse:
|
|
type: object
|
|
properties:
|
|
default_node_info:
|
|
type: object
|
|
properties:
|
|
protocol_version:
|
|
type: object
|
|
properties:
|
|
p2p:
|
|
type: string
|
|
format: uint64
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
default_node_id:
|
|
type: string
|
|
listen_addr:
|
|
type: string
|
|
network:
|
|
type: string
|
|
version:
|
|
type: string
|
|
channels:
|
|
type: string
|
|
format: byte
|
|
moniker:
|
|
type: string
|
|
other:
|
|
type: object
|
|
properties:
|
|
tx_index:
|
|
type: string
|
|
rpc_address:
|
|
type: string
|
|
application_version:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
app_name:
|
|
type: string
|
|
version:
|
|
type: string
|
|
git_commit:
|
|
type: string
|
|
build_tags:
|
|
type: string
|
|
go_version:
|
|
type: string
|
|
build_deps:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
title: module path
|
|
version:
|
|
type: string
|
|
title: module version
|
|
sum:
|
|
type: string
|
|
title: checksum
|
|
title: Module is the type for VersionInfo
|
|
cosmos_sdk_version:
|
|
type: string
|
|
description: VersionInfo is the type for the GetNodeInfoResponse message.
|
|
description: >-
|
|
GetNodeInfoResponse is the request type for the Query/GetNodeInfo RPC
|
|
method.
|
|
cosmos.base.tendermint.v1beta1.GetSyncingResponse:
|
|
type: object
|
|
properties:
|
|
syncing:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
GetSyncingResponse is the response type for the Query/GetSyncing RPC
|
|
method.
|
|
cosmos.base.tendermint.v1beta1.GetValidatorSetByHeightResponse:
|
|
type: object
|
|
properties:
|
|
block_height:
|
|
type: string
|
|
format: int64
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
pub_key:
|
|
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"
|
|
}
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
description: Validator is the type for the validator-set.
|
|
pagination:
|
|
description: pagination defines an pagination for the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
GetValidatorSetByHeightResponse is the response type for the
|
|
Query/GetValidatorSetByHeight RPC method.
|
|
cosmos.base.tendermint.v1beta1.Module:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
title: module path
|
|
version:
|
|
type: string
|
|
title: module version
|
|
sum:
|
|
type: string
|
|
title: checksum
|
|
title: Module is the type for VersionInfo
|
|
cosmos.base.tendermint.v1beta1.Validator:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
pub_key:
|
|
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"
|
|
}
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
description: Validator is the type for the validator-set.
|
|
cosmos.base.tendermint.v1beta1.VersionInfo:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
app_name:
|
|
type: string
|
|
version:
|
|
type: string
|
|
git_commit:
|
|
type: string
|
|
build_tags:
|
|
type: string
|
|
go_version:
|
|
type: string
|
|
build_deps:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
title: module path
|
|
version:
|
|
type: string
|
|
title: module version
|
|
sum:
|
|
type: string
|
|
title: checksum
|
|
title: Module is the type for VersionInfo
|
|
cosmos_sdk_version:
|
|
type: string
|
|
description: VersionInfo is the type for the GetNodeInfoResponse message.
|
|
tendermint.crypto.PublicKey:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: PublicKey defines the keys available for use with Tendermint Validators
|
|
tendermint.p2p.DefaultNodeInfo:
|
|
type: object
|
|
properties:
|
|
protocol_version:
|
|
type: object
|
|
properties:
|
|
p2p:
|
|
type: string
|
|
format: uint64
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
default_node_id:
|
|
type: string
|
|
listen_addr:
|
|
type: string
|
|
network:
|
|
type: string
|
|
version:
|
|
type: string
|
|
channels:
|
|
type: string
|
|
format: byte
|
|
moniker:
|
|
type: string
|
|
other:
|
|
type: object
|
|
properties:
|
|
tx_index:
|
|
type: string
|
|
rpc_address:
|
|
type: string
|
|
tendermint.p2p.DefaultNodeInfoOther:
|
|
type: object
|
|
properties:
|
|
tx_index:
|
|
type: string
|
|
rpc_address:
|
|
type: string
|
|
tendermint.p2p.ProtocolVersion:
|
|
type: object
|
|
properties:
|
|
p2p:
|
|
type: string
|
|
format: uint64
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
tendermint.types.Block:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
version:
|
|
title: basic block info
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules for processing a block in
|
|
the blockchain,
|
|
|
|
including all blockchain data structures and the rules of the
|
|
application's
|
|
|
|
state transition machine.
|
|
chain_id:
|
|
type: string
|
|
height:
|
|
type: string
|
|
format: int64
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
last_commit_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes of block data
|
|
data_hash:
|
|
type: string
|
|
format: byte
|
|
validators_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes from the app output from the prev block
|
|
next_validators_hash:
|
|
type: string
|
|
format: byte
|
|
consensus_hash:
|
|
type: string
|
|
format: byte
|
|
app_hash:
|
|
type: string
|
|
format: byte
|
|
last_results_hash:
|
|
type: string
|
|
format: byte
|
|
evidence_hash:
|
|
type: string
|
|
format: byte
|
|
title: consensus info
|
|
proposer_address:
|
|
type: string
|
|
format: byte
|
|
description: Header defines the structure of a Tendermint block header.
|
|
data:
|
|
type: object
|
|
properties:
|
|
txs:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Txs that will be applied by state @ block.Height+1.
|
|
|
|
NOTE: not all txs here are valid. We're just agreeing on the
|
|
order first.
|
|
|
|
This means that block.AppHash does not include these txs.
|
|
title: Data contains the set of transactions included in the block
|
|
evidence:
|
|
type: object
|
|
properties:
|
|
evidence:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
duplicate_vote_evidence:
|
|
type: object
|
|
properties:
|
|
vote_a:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SIGNED_MSG_TYPE_UNKNOWN
|
|
- SIGNED_MSG_TYPE_PREVOTE
|
|
- SIGNED_MSG_TYPE_PRECOMMIT
|
|
- SIGNED_MSG_TYPE_PROPOSAL
|
|
default: SIGNED_MSG_TYPE_UNKNOWN
|
|
description: >-
|
|
SignedMsgType is a type of signed message in the
|
|
consensus.
|
|
|
|
- SIGNED_MSG_TYPE_PREVOTE: Votes
|
|
- SIGNED_MSG_TYPE_PROPOSAL: Proposals
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
validator_index:
|
|
type: integer
|
|
format: int32
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Vote represents a prevote, precommit, or commit vote
|
|
from validators for
|
|
|
|
consensus.
|
|
vote_b:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SIGNED_MSG_TYPE_UNKNOWN
|
|
- SIGNED_MSG_TYPE_PREVOTE
|
|
- SIGNED_MSG_TYPE_PRECOMMIT
|
|
- SIGNED_MSG_TYPE_PROPOSAL
|
|
default: SIGNED_MSG_TYPE_UNKNOWN
|
|
description: >-
|
|
SignedMsgType is a type of signed message in the
|
|
consensus.
|
|
|
|
- SIGNED_MSG_TYPE_PREVOTE: Votes
|
|
- SIGNED_MSG_TYPE_PROPOSAL: Proposals
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
validator_index:
|
|
type: integer
|
|
format: int32
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Vote represents a prevote, precommit, or commit vote
|
|
from validators for
|
|
|
|
consensus.
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
validator_power:
|
|
type: string
|
|
format: int64
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
DuplicateVoteEvidence contains evidence of a validator
|
|
signed two conflicting votes.
|
|
light_client_attack_evidence:
|
|
type: object
|
|
properties:
|
|
conflicting_block:
|
|
type: object
|
|
properties:
|
|
signed_header:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
version:
|
|
title: basic block info
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules for
|
|
processing a block in the blockchain,
|
|
|
|
including all blockchain data structures and
|
|
the rules of the application's
|
|
|
|
state transition machine.
|
|
chain_id:
|
|
type: string
|
|
height:
|
|
type: string
|
|
format: int64
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
last_commit_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes of block data
|
|
data_hash:
|
|
type: string
|
|
format: byte
|
|
validators_hash:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
hashes from the app output from the prev
|
|
block
|
|
next_validators_hash:
|
|
type: string
|
|
format: byte
|
|
consensus_hash:
|
|
type: string
|
|
format: byte
|
|
app_hash:
|
|
type: string
|
|
format: byte
|
|
last_results_hash:
|
|
type: string
|
|
format: byte
|
|
evidence_hash:
|
|
type: string
|
|
format: byte
|
|
title: consensus info
|
|
proposer_address:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Header defines the structure of a Tendermint
|
|
block header.
|
|
commit:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
block_id_flag:
|
|
type: string
|
|
enum:
|
|
- BLOCK_ID_FLAG_UNKNOWN
|
|
- BLOCK_ID_FLAG_ABSENT
|
|
- BLOCK_ID_FLAG_COMMIT
|
|
- BLOCK_ID_FLAG_NIL
|
|
default: BLOCK_ID_FLAG_UNKNOWN
|
|
title: >-
|
|
BlockIdFlag indicates which BlcokID the
|
|
signature is for
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
CommitSig is a part of the Vote included
|
|
in a Commit.
|
|
description: >-
|
|
Commit contains the evidence that a block was
|
|
committed by a set of validators.
|
|
validator_set:
|
|
type: object
|
|
properties:
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for
|
|
use with Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
proposer:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for use
|
|
with Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
common_height:
|
|
type: string
|
|
format: int64
|
|
byzantine_validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for use with
|
|
Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
LightClientAttackEvidence contains evidence of a set of
|
|
validators attempting to mislead a light client.
|
|
last_commit:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
block_id_flag:
|
|
type: string
|
|
enum:
|
|
- BLOCK_ID_FLAG_UNKNOWN
|
|
- BLOCK_ID_FLAG_ABSENT
|
|
- BLOCK_ID_FLAG_COMMIT
|
|
- BLOCK_ID_FLAG_NIL
|
|
default: BLOCK_ID_FLAG_UNKNOWN
|
|
title: BlockIdFlag indicates which BlcokID the signature is for
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: CommitSig is a part of the Vote included in a Commit.
|
|
description: >-
|
|
Commit contains the evidence that a block was committed by a set of
|
|
validators.
|
|
tendermint.types.BlockID:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
tendermint.types.BlockIDFlag:
|
|
type: string
|
|
enum:
|
|
- BLOCK_ID_FLAG_UNKNOWN
|
|
- BLOCK_ID_FLAG_ABSENT
|
|
- BLOCK_ID_FLAG_COMMIT
|
|
- BLOCK_ID_FLAG_NIL
|
|
default: BLOCK_ID_FLAG_UNKNOWN
|
|
title: BlockIdFlag indicates which BlcokID the signature is for
|
|
tendermint.types.Commit:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
block_id_flag:
|
|
type: string
|
|
enum:
|
|
- BLOCK_ID_FLAG_UNKNOWN
|
|
- BLOCK_ID_FLAG_ABSENT
|
|
- BLOCK_ID_FLAG_COMMIT
|
|
- BLOCK_ID_FLAG_NIL
|
|
default: BLOCK_ID_FLAG_UNKNOWN
|
|
title: BlockIdFlag indicates which BlcokID the signature is for
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: CommitSig is a part of the Vote included in a Commit.
|
|
description: >-
|
|
Commit contains the evidence that a block was committed by a set of
|
|
validators.
|
|
tendermint.types.CommitSig:
|
|
type: object
|
|
properties:
|
|
block_id_flag:
|
|
type: string
|
|
enum:
|
|
- BLOCK_ID_FLAG_UNKNOWN
|
|
- BLOCK_ID_FLAG_ABSENT
|
|
- BLOCK_ID_FLAG_COMMIT
|
|
- BLOCK_ID_FLAG_NIL
|
|
default: BLOCK_ID_FLAG_UNKNOWN
|
|
title: BlockIdFlag indicates which BlcokID the signature is for
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: CommitSig is a part of the Vote included in a Commit.
|
|
tendermint.types.Data:
|
|
type: object
|
|
properties:
|
|
txs:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Txs that will be applied by state @ block.Height+1.
|
|
|
|
NOTE: not all txs here are valid. We're just agreeing on the order
|
|
first.
|
|
|
|
This means that block.AppHash does not include these txs.
|
|
title: Data contains the set of transactions included in the block
|
|
tendermint.types.DuplicateVoteEvidence:
|
|
type: object
|
|
properties:
|
|
vote_a:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SIGNED_MSG_TYPE_UNKNOWN
|
|
- SIGNED_MSG_TYPE_PREVOTE
|
|
- SIGNED_MSG_TYPE_PRECOMMIT
|
|
- SIGNED_MSG_TYPE_PROPOSAL
|
|
default: SIGNED_MSG_TYPE_UNKNOWN
|
|
description: |-
|
|
SignedMsgType is a type of signed message in the consensus.
|
|
|
|
- SIGNED_MSG_TYPE_PREVOTE: Votes
|
|
- SIGNED_MSG_TYPE_PROPOSAL: Proposals
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
validator_index:
|
|
type: integer
|
|
format: int32
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Vote represents a prevote, precommit, or commit vote from validators
|
|
for
|
|
|
|
consensus.
|
|
vote_b:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SIGNED_MSG_TYPE_UNKNOWN
|
|
- SIGNED_MSG_TYPE_PREVOTE
|
|
- SIGNED_MSG_TYPE_PRECOMMIT
|
|
- SIGNED_MSG_TYPE_PROPOSAL
|
|
default: SIGNED_MSG_TYPE_UNKNOWN
|
|
description: |-
|
|
SignedMsgType is a type of signed message in the consensus.
|
|
|
|
- SIGNED_MSG_TYPE_PREVOTE: Votes
|
|
- SIGNED_MSG_TYPE_PROPOSAL: Proposals
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
validator_index:
|
|
type: integer
|
|
format: int32
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Vote represents a prevote, precommit, or commit vote from validators
|
|
for
|
|
|
|
consensus.
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
validator_power:
|
|
type: string
|
|
format: int64
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
DuplicateVoteEvidence contains evidence of a validator signed two
|
|
conflicting votes.
|
|
tendermint.types.Evidence:
|
|
type: object
|
|
properties:
|
|
duplicate_vote_evidence:
|
|
type: object
|
|
properties:
|
|
vote_a:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SIGNED_MSG_TYPE_UNKNOWN
|
|
- SIGNED_MSG_TYPE_PREVOTE
|
|
- SIGNED_MSG_TYPE_PRECOMMIT
|
|
- SIGNED_MSG_TYPE_PROPOSAL
|
|
default: SIGNED_MSG_TYPE_UNKNOWN
|
|
description: |-
|
|
SignedMsgType is a type of signed message in the consensus.
|
|
|
|
- SIGNED_MSG_TYPE_PREVOTE: Votes
|
|
- SIGNED_MSG_TYPE_PROPOSAL: Proposals
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
validator_index:
|
|
type: integer
|
|
format: int32
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Vote represents a prevote, precommit, or commit vote from
|
|
validators for
|
|
|
|
consensus.
|
|
vote_b:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SIGNED_MSG_TYPE_UNKNOWN
|
|
- SIGNED_MSG_TYPE_PREVOTE
|
|
- SIGNED_MSG_TYPE_PRECOMMIT
|
|
- SIGNED_MSG_TYPE_PROPOSAL
|
|
default: SIGNED_MSG_TYPE_UNKNOWN
|
|
description: |-
|
|
SignedMsgType is a type of signed message in the consensus.
|
|
|
|
- SIGNED_MSG_TYPE_PREVOTE: Votes
|
|
- SIGNED_MSG_TYPE_PROPOSAL: Proposals
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
validator_index:
|
|
type: integer
|
|
format: int32
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Vote represents a prevote, precommit, or commit vote from
|
|
validators for
|
|
|
|
consensus.
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
validator_power:
|
|
type: string
|
|
format: int64
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
DuplicateVoteEvidence contains evidence of a validator signed two
|
|
conflicting votes.
|
|
light_client_attack_evidence:
|
|
type: object
|
|
properties:
|
|
conflicting_block:
|
|
type: object
|
|
properties:
|
|
signed_header:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
version:
|
|
title: basic block info
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules for processing
|
|
a block in the blockchain,
|
|
|
|
including all blockchain data structures and the rules
|
|
of the application's
|
|
|
|
state transition machine.
|
|
chain_id:
|
|
type: string
|
|
height:
|
|
type: string
|
|
format: int64
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
last_commit_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes of block data
|
|
data_hash:
|
|
type: string
|
|
format: byte
|
|
validators_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes from the app output from the prev block
|
|
next_validators_hash:
|
|
type: string
|
|
format: byte
|
|
consensus_hash:
|
|
type: string
|
|
format: byte
|
|
app_hash:
|
|
type: string
|
|
format: byte
|
|
last_results_hash:
|
|
type: string
|
|
format: byte
|
|
evidence_hash:
|
|
type: string
|
|
format: byte
|
|
title: consensus info
|
|
proposer_address:
|
|
type: string
|
|
format: byte
|
|
description: Header defines the structure of a Tendermint block header.
|
|
commit:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
block_id_flag:
|
|
type: string
|
|
enum:
|
|
- BLOCK_ID_FLAG_UNKNOWN
|
|
- BLOCK_ID_FLAG_ABSENT
|
|
- BLOCK_ID_FLAG_COMMIT
|
|
- BLOCK_ID_FLAG_NIL
|
|
default: BLOCK_ID_FLAG_UNKNOWN
|
|
title: >-
|
|
BlockIdFlag indicates which BlcokID the
|
|
signature is for
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
CommitSig is a part of the Vote included in a
|
|
Commit.
|
|
description: >-
|
|
Commit contains the evidence that a block was committed by
|
|
a set of validators.
|
|
validator_set:
|
|
type: object
|
|
properties:
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for use with
|
|
Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
proposer:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for use with
|
|
Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
common_height:
|
|
type: string
|
|
format: int64
|
|
byzantine_validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for use with Tendermint
|
|
Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
LightClientAttackEvidence contains evidence of a set of validators
|
|
attempting to mislead a light client.
|
|
tendermint.types.EvidenceList:
|
|
type: object
|
|
properties:
|
|
evidence:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
duplicate_vote_evidence:
|
|
type: object
|
|
properties:
|
|
vote_a:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SIGNED_MSG_TYPE_UNKNOWN
|
|
- SIGNED_MSG_TYPE_PREVOTE
|
|
- SIGNED_MSG_TYPE_PRECOMMIT
|
|
- SIGNED_MSG_TYPE_PROPOSAL
|
|
default: SIGNED_MSG_TYPE_UNKNOWN
|
|
description: >-
|
|
SignedMsgType is a type of signed message in the
|
|
consensus.
|
|
|
|
- SIGNED_MSG_TYPE_PREVOTE: Votes
|
|
- SIGNED_MSG_TYPE_PROPOSAL: Proposals
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
validator_index:
|
|
type: integer
|
|
format: int32
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Vote represents a prevote, precommit, or commit vote from
|
|
validators for
|
|
|
|
consensus.
|
|
vote_b:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SIGNED_MSG_TYPE_UNKNOWN
|
|
- SIGNED_MSG_TYPE_PREVOTE
|
|
- SIGNED_MSG_TYPE_PRECOMMIT
|
|
- SIGNED_MSG_TYPE_PROPOSAL
|
|
default: SIGNED_MSG_TYPE_UNKNOWN
|
|
description: >-
|
|
SignedMsgType is a type of signed message in the
|
|
consensus.
|
|
|
|
- SIGNED_MSG_TYPE_PREVOTE: Votes
|
|
- SIGNED_MSG_TYPE_PROPOSAL: Proposals
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
validator_index:
|
|
type: integer
|
|
format: int32
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Vote represents a prevote, precommit, or commit vote from
|
|
validators for
|
|
|
|
consensus.
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
validator_power:
|
|
type: string
|
|
format: int64
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
DuplicateVoteEvidence contains evidence of a validator signed
|
|
two conflicting votes.
|
|
light_client_attack_evidence:
|
|
type: object
|
|
properties:
|
|
conflicting_block:
|
|
type: object
|
|
properties:
|
|
signed_header:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
version:
|
|
title: basic block info
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules for
|
|
processing a block in the blockchain,
|
|
|
|
including all blockchain data structures and the
|
|
rules of the application's
|
|
|
|
state transition machine.
|
|
chain_id:
|
|
type: string
|
|
height:
|
|
type: string
|
|
format: int64
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
last_commit_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes of block data
|
|
data_hash:
|
|
type: string
|
|
format: byte
|
|
validators_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes from the app output from the prev block
|
|
next_validators_hash:
|
|
type: string
|
|
format: byte
|
|
consensus_hash:
|
|
type: string
|
|
format: byte
|
|
app_hash:
|
|
type: string
|
|
format: byte
|
|
last_results_hash:
|
|
type: string
|
|
format: byte
|
|
evidence_hash:
|
|
type: string
|
|
format: byte
|
|
title: consensus info
|
|
proposer_address:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Header defines the structure of a Tendermint block
|
|
header.
|
|
commit:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
block_id_flag:
|
|
type: string
|
|
enum:
|
|
- BLOCK_ID_FLAG_UNKNOWN
|
|
- BLOCK_ID_FLAG_ABSENT
|
|
- BLOCK_ID_FLAG_COMMIT
|
|
- BLOCK_ID_FLAG_NIL
|
|
default: BLOCK_ID_FLAG_UNKNOWN
|
|
title: >-
|
|
BlockIdFlag indicates which BlcokID the
|
|
signature is for
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
CommitSig is a part of the Vote included in a
|
|
Commit.
|
|
description: >-
|
|
Commit contains the evidence that a block was
|
|
committed by a set of validators.
|
|
validator_set:
|
|
type: object
|
|
properties:
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for use
|
|
with Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
proposer:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for use
|
|
with Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
common_height:
|
|
type: string
|
|
format: int64
|
|
byzantine_validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for use with
|
|
Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
LightClientAttackEvidence contains evidence of a set of
|
|
validators attempting to mislead a light client.
|
|
tendermint.types.Header:
|
|
type: object
|
|
properties:
|
|
version:
|
|
title: basic block info
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules for processing a block in the
|
|
blockchain,
|
|
|
|
including all blockchain data structures and the rules of the
|
|
application's
|
|
|
|
state transition machine.
|
|
chain_id:
|
|
type: string
|
|
height:
|
|
type: string
|
|
format: int64
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
last_commit_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes of block data
|
|
data_hash:
|
|
type: string
|
|
format: byte
|
|
validators_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes from the app output from the prev block
|
|
next_validators_hash:
|
|
type: string
|
|
format: byte
|
|
consensus_hash:
|
|
type: string
|
|
format: byte
|
|
app_hash:
|
|
type: string
|
|
format: byte
|
|
last_results_hash:
|
|
type: string
|
|
format: byte
|
|
evidence_hash:
|
|
type: string
|
|
format: byte
|
|
title: consensus info
|
|
proposer_address:
|
|
type: string
|
|
format: byte
|
|
description: Header defines the structure of a Tendermint block header.
|
|
tendermint.types.LightBlock:
|
|
type: object
|
|
properties:
|
|
signed_header:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
version:
|
|
title: basic block info
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules for processing a block
|
|
in the blockchain,
|
|
|
|
including all blockchain data structures and the rules of the
|
|
application's
|
|
|
|
state transition machine.
|
|
chain_id:
|
|
type: string
|
|
height:
|
|
type: string
|
|
format: int64
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
last_commit_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes of block data
|
|
data_hash:
|
|
type: string
|
|
format: byte
|
|
validators_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes from the app output from the prev block
|
|
next_validators_hash:
|
|
type: string
|
|
format: byte
|
|
consensus_hash:
|
|
type: string
|
|
format: byte
|
|
app_hash:
|
|
type: string
|
|
format: byte
|
|
last_results_hash:
|
|
type: string
|
|
format: byte
|
|
evidence_hash:
|
|
type: string
|
|
format: byte
|
|
title: consensus info
|
|
proposer_address:
|
|
type: string
|
|
format: byte
|
|
description: Header defines the structure of a Tendermint block header.
|
|
commit:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
block_id_flag:
|
|
type: string
|
|
enum:
|
|
- BLOCK_ID_FLAG_UNKNOWN
|
|
- BLOCK_ID_FLAG_ABSENT
|
|
- BLOCK_ID_FLAG_COMMIT
|
|
- BLOCK_ID_FLAG_NIL
|
|
default: BLOCK_ID_FLAG_UNKNOWN
|
|
title: BlockIdFlag indicates which BlcokID the signature is for
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: CommitSig is a part of the Vote included in a Commit.
|
|
description: >-
|
|
Commit contains the evidence that a block was committed by a set
|
|
of validators.
|
|
validator_set:
|
|
type: object
|
|
properties:
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for use with Tendermint
|
|
Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
proposer:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for use with Tendermint
|
|
Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
tendermint.types.LightClientAttackEvidence:
|
|
type: object
|
|
properties:
|
|
conflicting_block:
|
|
type: object
|
|
properties:
|
|
signed_header:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
version:
|
|
title: basic block info
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules for processing a
|
|
block in the blockchain,
|
|
|
|
including all blockchain data structures and the rules of
|
|
the application's
|
|
|
|
state transition machine.
|
|
chain_id:
|
|
type: string
|
|
height:
|
|
type: string
|
|
format: int64
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
last_commit_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes of block data
|
|
data_hash:
|
|
type: string
|
|
format: byte
|
|
validators_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes from the app output from the prev block
|
|
next_validators_hash:
|
|
type: string
|
|
format: byte
|
|
consensus_hash:
|
|
type: string
|
|
format: byte
|
|
app_hash:
|
|
type: string
|
|
format: byte
|
|
last_results_hash:
|
|
type: string
|
|
format: byte
|
|
evidence_hash:
|
|
type: string
|
|
format: byte
|
|
title: consensus info
|
|
proposer_address:
|
|
type: string
|
|
format: byte
|
|
description: Header defines the structure of a Tendermint block header.
|
|
commit:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
block_id_flag:
|
|
type: string
|
|
enum:
|
|
- BLOCK_ID_FLAG_UNKNOWN
|
|
- BLOCK_ID_FLAG_ABSENT
|
|
- BLOCK_ID_FLAG_COMMIT
|
|
- BLOCK_ID_FLAG_NIL
|
|
default: BLOCK_ID_FLAG_UNKNOWN
|
|
title: >-
|
|
BlockIdFlag indicates which BlcokID the signature is
|
|
for
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: CommitSig is a part of the Vote included in a Commit.
|
|
description: >-
|
|
Commit contains the evidence that a block was committed by a
|
|
set of validators.
|
|
validator_set:
|
|
type: object
|
|
properties:
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for use with
|
|
Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
proposer:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for use with
|
|
Tendermint Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
common_height:
|
|
type: string
|
|
format: int64
|
|
byzantine_validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for use with Tendermint
|
|
Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
LightClientAttackEvidence contains evidence of a set of validators
|
|
attempting to mislead a light client.
|
|
tendermint.types.PartSetHeader:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
tendermint.types.SignedHeader:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
version:
|
|
title: basic block info
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules for processing a block in
|
|
the blockchain,
|
|
|
|
including all blockchain data structures and the rules of the
|
|
application's
|
|
|
|
state transition machine.
|
|
chain_id:
|
|
type: string
|
|
height:
|
|
type: string
|
|
format: int64
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
last_block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
last_commit_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes of block data
|
|
data_hash:
|
|
type: string
|
|
format: byte
|
|
validators_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes from the app output from the prev block
|
|
next_validators_hash:
|
|
type: string
|
|
format: byte
|
|
consensus_hash:
|
|
type: string
|
|
format: byte
|
|
app_hash:
|
|
type: string
|
|
format: byte
|
|
last_results_hash:
|
|
type: string
|
|
format: byte
|
|
evidence_hash:
|
|
type: string
|
|
format: byte
|
|
title: consensus info
|
|
proposer_address:
|
|
type: string
|
|
format: byte
|
|
description: Header defines the structure of a Tendermint block header.
|
|
commit:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
block_id_flag:
|
|
type: string
|
|
enum:
|
|
- BLOCK_ID_FLAG_UNKNOWN
|
|
- BLOCK_ID_FLAG_ABSENT
|
|
- BLOCK_ID_FLAG_COMMIT
|
|
- BLOCK_ID_FLAG_NIL
|
|
default: BLOCK_ID_FLAG_UNKNOWN
|
|
title: BlockIdFlag indicates which BlcokID the signature is for
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: CommitSig is a part of the Vote included in a Commit.
|
|
description: >-
|
|
Commit contains the evidence that a block was committed by a set of
|
|
validators.
|
|
tendermint.types.SignedMsgType:
|
|
type: string
|
|
enum:
|
|
- SIGNED_MSG_TYPE_UNKNOWN
|
|
- SIGNED_MSG_TYPE_PREVOTE
|
|
- SIGNED_MSG_TYPE_PRECOMMIT
|
|
- SIGNED_MSG_TYPE_PROPOSAL
|
|
default: SIGNED_MSG_TYPE_UNKNOWN
|
|
description: |-
|
|
SignedMsgType is a type of signed message in the consensus.
|
|
|
|
- SIGNED_MSG_TYPE_PREVOTE: Votes
|
|
- SIGNED_MSG_TYPE_PROPOSAL: Proposals
|
|
tendermint.types.Validator:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for use with Tendermint
|
|
Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
tendermint.types.ValidatorSet:
|
|
type: object
|
|
properties:
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for use with Tendermint
|
|
Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
proposer:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
format: byte
|
|
pub_key:
|
|
type: object
|
|
properties:
|
|
ed25519:
|
|
type: string
|
|
format: byte
|
|
secp256k1:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
PublicKey defines the keys available for use with Tendermint
|
|
Validators
|
|
voting_power:
|
|
type: string
|
|
format: int64
|
|
proposer_priority:
|
|
type: string
|
|
format: int64
|
|
total_voting_power:
|
|
type: string
|
|
format: int64
|
|
tendermint.types.Vote:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
enum:
|
|
- SIGNED_MSG_TYPE_UNKNOWN
|
|
- SIGNED_MSG_TYPE_PREVOTE
|
|
- SIGNED_MSG_TYPE_PRECOMMIT
|
|
- SIGNED_MSG_TYPE_PROPOSAL
|
|
default: SIGNED_MSG_TYPE_UNKNOWN
|
|
description: |-
|
|
SignedMsgType is a type of signed message in the consensus.
|
|
|
|
- SIGNED_MSG_TYPE_PREVOTE: Votes
|
|
- SIGNED_MSG_TYPE_PROPOSAL: Proposals
|
|
height:
|
|
type: string
|
|
format: int64
|
|
round:
|
|
type: integer
|
|
format: int32
|
|
block_id:
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
title: BlockID
|
|
timestamp:
|
|
type: string
|
|
format: date-time
|
|
validator_address:
|
|
type: string
|
|
format: byte
|
|
validator_index:
|
|
type: integer
|
|
format: int32
|
|
signature:
|
|
type: string
|
|
format: byte
|
|
description: |-
|
|
Vote represents a prevote, precommit, or commit vote from validators for
|
|
consensus.
|
|
tendermint.version.Consensus:
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules for processing a block in the
|
|
blockchain,
|
|
|
|
including all blockchain data structures and the rules of the
|
|
application's
|
|
|
|
state transition machine.
|
|
cosmos.base.v1beta1.DecCoin:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
DecCoin defines a token with a denomination and a decimal amount.
|
|
|
|
NOTE: The amount field is an Dec which implements the custom method
|
|
signatures required by gogoproto.
|
|
cosmos.distribution.v1beta1.DelegationDelegatorReward:
|
|
type: object
|
|
properties:
|
|
validator_address:
|
|
type: string
|
|
reward:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
DecCoin defines a token with a denomination and a decimal amount.
|
|
|
|
NOTE: The amount field is an Dec which implements the custom method
|
|
signatures required by gogoproto.
|
|
description: |-
|
|
DelegationDelegatorReward represents the properties
|
|
of a delegator's delegation reward.
|
|
cosmos.distribution.v1beta1.Params:
|
|
type: object
|
|
properties:
|
|
community_tax:
|
|
type: string
|
|
base_proposer_reward:
|
|
type: string
|
|
bonus_proposer_reward:
|
|
type: string
|
|
withdraw_addr_enabled:
|
|
type: boolean
|
|
format: boolean
|
|
description: Params defines the set of params for the distribution module.
|
|
cosmos.distribution.v1beta1.QueryCommunityPoolResponse:
|
|
type: object
|
|
properties:
|
|
pool:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
DecCoin defines a token with a denomination and a decimal amount.
|
|
|
|
NOTE: The amount field is an Dec which implements the custom method
|
|
signatures required by gogoproto.
|
|
description: pool defines community pool's coins.
|
|
description: >-
|
|
QueryCommunityPoolResponse is the response type for the
|
|
Query/CommunityPool
|
|
|
|
RPC method.
|
|
cosmos.distribution.v1beta1.QueryDelegationRewardsResponse:
|
|
type: object
|
|
properties:
|
|
rewards:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
DecCoin defines a token with a denomination and a decimal amount.
|
|
|
|
NOTE: The amount field is an Dec which implements the custom method
|
|
signatures required by gogoproto.
|
|
description: rewards defines the rewards accrued by a delegation.
|
|
description: |-
|
|
QueryDelegationRewardsResponse is the response type for the
|
|
Query/DelegationRewards RPC method.
|
|
cosmos.distribution.v1beta1.QueryDelegationTotalRewardsResponse:
|
|
type: object
|
|
properties:
|
|
rewards:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
validator_address:
|
|
type: string
|
|
reward:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
DecCoin defines a token with a denomination and a decimal
|
|
amount.
|
|
|
|
|
|
NOTE: The amount field is an Dec which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
description: |-
|
|
DelegationDelegatorReward represents the properties
|
|
of a delegator's delegation reward.
|
|
description: rewards defines all the rewards accrued by a delegator.
|
|
total:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
DecCoin defines a token with a denomination and a decimal amount.
|
|
|
|
NOTE: The amount field is an Dec which implements the custom method
|
|
signatures required by gogoproto.
|
|
description: total defines the sum of all the rewards.
|
|
description: |-
|
|
QueryDelegationTotalRewardsResponse is the response type for the
|
|
Query/DelegationTotalRewards RPC method.
|
|
cosmos.distribution.v1beta1.QueryDelegatorValidatorsResponse:
|
|
type: object
|
|
properties:
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: validators defines the validators a delegator is delegating for.
|
|
description: |-
|
|
QueryDelegatorValidatorsResponse is the response type for the
|
|
Query/DelegatorValidators RPC method.
|
|
cosmos.distribution.v1beta1.QueryDelegatorWithdrawAddressResponse:
|
|
type: object
|
|
properties:
|
|
withdraw_address:
|
|
type: string
|
|
description: withdraw_address defines the delegator address to query for.
|
|
description: |-
|
|
QueryDelegatorWithdrawAddressResponse is the response type for the
|
|
Query/DelegatorWithdrawAddress RPC method.
|
|
cosmos.distribution.v1beta1.QueryParamsResponse:
|
|
type: object
|
|
properties:
|
|
params:
|
|
description: params defines the parameters of the module.
|
|
type: object
|
|
properties:
|
|
community_tax:
|
|
type: string
|
|
base_proposer_reward:
|
|
type: string
|
|
bonus_proposer_reward:
|
|
type: string
|
|
withdraw_addr_enabled:
|
|
type: boolean
|
|
format: boolean
|
|
description: QueryParamsResponse is the response type for the Query/Params RPC method.
|
|
cosmos.distribution.v1beta1.QueryValidatorCommissionResponse:
|
|
type: object
|
|
properties:
|
|
commission:
|
|
description: commission defines the commision the validator received.
|
|
type: object
|
|
properties:
|
|
commission:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
DecCoin defines a token with a denomination and a decimal
|
|
amount.
|
|
|
|
|
|
NOTE: The amount field is an Dec which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
title: |-
|
|
QueryValidatorCommissionResponse is the response type for the
|
|
Query/ValidatorCommission RPC method
|
|
cosmos.distribution.v1beta1.QueryValidatorOutstandingRewardsResponse:
|
|
type: object
|
|
properties:
|
|
rewards:
|
|
type: object
|
|
properties:
|
|
rewards:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
DecCoin defines a token with a denomination and a decimal
|
|
amount.
|
|
|
|
|
|
NOTE: The amount field is an Dec which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
ValidatorOutstandingRewards represents outstanding (un-withdrawn)
|
|
rewards
|
|
|
|
for a validator inexpensive to track, allows simple sanity checks.
|
|
description: |-
|
|
QueryValidatorOutstandingRewardsResponse is the response type for the
|
|
Query/ValidatorOutstandingRewards RPC method.
|
|
cosmos.distribution.v1beta1.QueryValidatorSlashesResponse:
|
|
type: object
|
|
properties:
|
|
slashes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
validator_period:
|
|
type: string
|
|
format: uint64
|
|
fraction:
|
|
type: string
|
|
description: |-
|
|
ValidatorSlashEvent represents a validator slash event.
|
|
Height is implicit within the store key.
|
|
This is needed to calculate appropriate amount of staking tokens
|
|
for delegations which are withdrawn after a slash has occurred.
|
|
description: slashes defines the slashes the validator received.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
QueryValidatorSlashesResponse is the response type for the
|
|
Query/ValidatorSlashes RPC method.
|
|
cosmos.distribution.v1beta1.ValidatorAccumulatedCommission:
|
|
type: object
|
|
properties:
|
|
commission:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
DecCoin defines a token with a denomination and a decimal amount.
|
|
|
|
NOTE: The amount field is an Dec which implements the custom method
|
|
signatures required by gogoproto.
|
|
description: |-
|
|
ValidatorAccumulatedCommission represents accumulated commission
|
|
for a validator kept as a running counter, can be withdrawn at any time.
|
|
cosmos.distribution.v1beta1.ValidatorOutstandingRewards:
|
|
type: object
|
|
properties:
|
|
rewards:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
DecCoin defines a token with a denomination and a decimal amount.
|
|
|
|
NOTE: The amount field is an Dec which implements the custom method
|
|
signatures required by gogoproto.
|
|
description: |-
|
|
ValidatorOutstandingRewards represents outstanding (un-withdrawn) rewards
|
|
for a validator inexpensive to track, allows simple sanity checks.
|
|
cosmos.distribution.v1beta1.ValidatorSlashEvent:
|
|
type: object
|
|
properties:
|
|
validator_period:
|
|
type: string
|
|
format: uint64
|
|
fraction:
|
|
type: string
|
|
description: |-
|
|
ValidatorSlashEvent represents a validator slash event.
|
|
Height is implicit within the store key.
|
|
This is needed to calculate appropriate amount of staking tokens
|
|
for delegations which are withdrawn after a slash has occurred.
|
|
cosmos.evidence.v1beta1.QueryAllEvidenceResponse:
|
|
type: object
|
|
properties:
|
|
evidence:
|
|
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"
|
|
}
|
|
description: evidence returns all evidences.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryAllEvidenceResponse is the response type for the Query/AllEvidence
|
|
RPC
|
|
|
|
method.
|
|
cosmos.evidence.v1beta1.QueryEvidenceResponse:
|
|
type: object
|
|
properties:
|
|
evidence:
|
|
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"
|
|
}
|
|
description: >-
|
|
QueryEvidenceResponse is the response type for the Query/Evidence RPC
|
|
method.
|
|
cosmos.gov.v1beta1.Deposit:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
depositor:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
description: |-
|
|
Deposit defines an amount deposited by an account address to an active
|
|
proposal.
|
|
cosmos.gov.v1beta1.DepositParams:
|
|
type: object
|
|
properties:
|
|
min_deposit:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
description: Minimum deposit for a proposal to enter voting period.
|
|
max_deposit_period:
|
|
type: string
|
|
description: >-
|
|
Maximum period for Atom holders to deposit on a proposal. Initial
|
|
value: 2
|
|
months.
|
|
description: DepositParams defines the params for deposits on governance proposals.
|
|
cosmos.gov.v1beta1.Proposal:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
content:
|
|
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"
|
|
}
|
|
status:
|
|
type: string
|
|
enum:
|
|
- PROPOSAL_STATUS_UNSPECIFIED
|
|
- PROPOSAL_STATUS_DEPOSIT_PERIOD
|
|
- PROPOSAL_STATUS_VOTING_PERIOD
|
|
- PROPOSAL_STATUS_PASSED
|
|
- PROPOSAL_STATUS_REJECTED
|
|
- PROPOSAL_STATUS_FAILED
|
|
default: PROPOSAL_STATUS_UNSPECIFIED
|
|
description: |-
|
|
ProposalStatus enumerates the valid statuses of a proposal.
|
|
|
|
- PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default propopsal status.
|
|
- PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit
|
|
period.
|
|
- PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting
|
|
period.
|
|
- PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has
|
|
passed.
|
|
- PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has
|
|
been rejected.
|
|
- PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has
|
|
failed.
|
|
final_tally_result:
|
|
type: object
|
|
properties:
|
|
'yes':
|
|
type: string
|
|
abstain:
|
|
type: string
|
|
'no':
|
|
type: string
|
|
no_with_veto:
|
|
type: string
|
|
description: TallyResult defines a standard tally for a governance proposal.
|
|
submit_time:
|
|
type: string
|
|
format: date-time
|
|
deposit_end_time:
|
|
type: string
|
|
format: date-time
|
|
total_deposit:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
voting_start_time:
|
|
type: string
|
|
format: date-time
|
|
voting_end_time:
|
|
type: string
|
|
format: date-time
|
|
description: Proposal defines the core field members of a governance proposal.
|
|
cosmos.gov.v1beta1.ProposalStatus:
|
|
type: string
|
|
enum:
|
|
- PROPOSAL_STATUS_UNSPECIFIED
|
|
- PROPOSAL_STATUS_DEPOSIT_PERIOD
|
|
- PROPOSAL_STATUS_VOTING_PERIOD
|
|
- PROPOSAL_STATUS_PASSED
|
|
- PROPOSAL_STATUS_REJECTED
|
|
- PROPOSAL_STATUS_FAILED
|
|
default: PROPOSAL_STATUS_UNSPECIFIED
|
|
description: |-
|
|
ProposalStatus enumerates the valid statuses of a proposal.
|
|
|
|
- PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default propopsal status.
|
|
- PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit
|
|
period.
|
|
- PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting
|
|
period.
|
|
- PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has
|
|
passed.
|
|
- PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has
|
|
been rejected.
|
|
- PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has
|
|
failed.
|
|
cosmos.gov.v1beta1.QueryDepositResponse:
|
|
type: object
|
|
properties:
|
|
deposit:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
depositor:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
description: |-
|
|
Deposit defines an amount deposited by an account address to an active
|
|
proposal.
|
|
description: >-
|
|
QueryDepositResponse is the response type for the Query/Deposit RPC
|
|
method.
|
|
cosmos.gov.v1beta1.QueryDepositsResponse:
|
|
type: object
|
|
properties:
|
|
deposits:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
depositor:
|
|
type: string
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
Deposit defines an amount deposited by an account address to an
|
|
active
|
|
|
|
proposal.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryDepositsResponse is the response type for the Query/Deposits RPC
|
|
method.
|
|
cosmos.gov.v1beta1.QueryParamsResponse:
|
|
type: object
|
|
properties:
|
|
voting_params:
|
|
description: voting_params defines the parameters related to voting.
|
|
type: object
|
|
properties:
|
|
voting_period:
|
|
type: string
|
|
description: Length of the voting period.
|
|
deposit_params:
|
|
description: deposit_params defines the parameters related to deposit.
|
|
type: object
|
|
properties:
|
|
min_deposit:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
description: Minimum deposit for a proposal to enter voting period.
|
|
max_deposit_period:
|
|
type: string
|
|
description: >-
|
|
Maximum period for Atom holders to deposit on a proposal. Initial
|
|
value: 2
|
|
months.
|
|
tally_params:
|
|
description: tally_params defines the parameters related to tally.
|
|
type: object
|
|
properties:
|
|
quorum:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Minimum percentage of total stake needed to vote for a result to
|
|
be
|
|
considered valid.
|
|
threshold:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Minimum proportion of Yes votes for proposal to pass. Default
|
|
value: 0.5.
|
|
veto_threshold:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Minimum value of Veto votes to Total votes ratio for proposal to
|
|
be
|
|
vetoed. Default value: 1/3.
|
|
description: QueryParamsResponse is the response type for the Query/Params RPC method.
|
|
cosmos.gov.v1beta1.QueryProposalResponse:
|
|
type: object
|
|
properties:
|
|
proposal:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
content:
|
|
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"
|
|
}
|
|
status:
|
|
type: string
|
|
enum:
|
|
- PROPOSAL_STATUS_UNSPECIFIED
|
|
- PROPOSAL_STATUS_DEPOSIT_PERIOD
|
|
- PROPOSAL_STATUS_VOTING_PERIOD
|
|
- PROPOSAL_STATUS_PASSED
|
|
- PROPOSAL_STATUS_REJECTED
|
|
- PROPOSAL_STATUS_FAILED
|
|
default: PROPOSAL_STATUS_UNSPECIFIED
|
|
description: |-
|
|
ProposalStatus enumerates the valid statuses of a proposal.
|
|
|
|
- PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default propopsal status.
|
|
- PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit
|
|
period.
|
|
- PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting
|
|
period.
|
|
- PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has
|
|
passed.
|
|
- PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has
|
|
been rejected.
|
|
- PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has
|
|
failed.
|
|
final_tally_result:
|
|
type: object
|
|
properties:
|
|
'yes':
|
|
type: string
|
|
abstain:
|
|
type: string
|
|
'no':
|
|
type: string
|
|
no_with_veto:
|
|
type: string
|
|
description: TallyResult defines a standard tally for a governance proposal.
|
|
submit_time:
|
|
type: string
|
|
format: date-time
|
|
deposit_end_time:
|
|
type: string
|
|
format: date-time
|
|
total_deposit:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
voting_start_time:
|
|
type: string
|
|
format: date-time
|
|
voting_end_time:
|
|
type: string
|
|
format: date-time
|
|
description: Proposal defines the core field members of a governance proposal.
|
|
description: >-
|
|
QueryProposalResponse is the response type for the Query/Proposal RPC
|
|
method.
|
|
cosmos.gov.v1beta1.QueryProposalsResponse:
|
|
type: object
|
|
properties:
|
|
proposals:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
content:
|
|
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"
|
|
}
|
|
status:
|
|
type: string
|
|
enum:
|
|
- PROPOSAL_STATUS_UNSPECIFIED
|
|
- PROPOSAL_STATUS_DEPOSIT_PERIOD
|
|
- PROPOSAL_STATUS_VOTING_PERIOD
|
|
- PROPOSAL_STATUS_PASSED
|
|
- PROPOSAL_STATUS_REJECTED
|
|
- PROPOSAL_STATUS_FAILED
|
|
default: PROPOSAL_STATUS_UNSPECIFIED
|
|
description: |-
|
|
ProposalStatus enumerates the valid statuses of a proposal.
|
|
|
|
- PROPOSAL_STATUS_UNSPECIFIED: PROPOSAL_STATUS_UNSPECIFIED defines the default propopsal status.
|
|
- PROPOSAL_STATUS_DEPOSIT_PERIOD: PROPOSAL_STATUS_DEPOSIT_PERIOD defines a proposal status during the deposit
|
|
period.
|
|
- PROPOSAL_STATUS_VOTING_PERIOD: PROPOSAL_STATUS_VOTING_PERIOD defines a proposal status during the voting
|
|
period.
|
|
- PROPOSAL_STATUS_PASSED: PROPOSAL_STATUS_PASSED defines a proposal status of a proposal that has
|
|
passed.
|
|
- PROPOSAL_STATUS_REJECTED: PROPOSAL_STATUS_REJECTED defines a proposal status of a proposal that has
|
|
been rejected.
|
|
- PROPOSAL_STATUS_FAILED: PROPOSAL_STATUS_FAILED defines a proposal status of a proposal that has
|
|
failed.
|
|
final_tally_result:
|
|
type: object
|
|
properties:
|
|
'yes':
|
|
type: string
|
|
abstain:
|
|
type: string
|
|
'no':
|
|
type: string
|
|
no_with_veto:
|
|
type: string
|
|
description: TallyResult defines a standard tally for a governance proposal.
|
|
submit_time:
|
|
type: string
|
|
format: date-time
|
|
deposit_end_time:
|
|
type: string
|
|
format: date-time
|
|
total_deposit:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
voting_start_time:
|
|
type: string
|
|
format: date-time
|
|
voting_end_time:
|
|
type: string
|
|
format: date-time
|
|
description: Proposal defines the core field members of a governance proposal.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
QueryProposalsResponse is the response type for the Query/Proposals RPC
|
|
method.
|
|
cosmos.gov.v1beta1.QueryTallyResultResponse:
|
|
type: object
|
|
properties:
|
|
tally:
|
|
type: object
|
|
properties:
|
|
'yes':
|
|
type: string
|
|
abstain:
|
|
type: string
|
|
'no':
|
|
type: string
|
|
no_with_veto:
|
|
type: string
|
|
description: TallyResult defines a standard tally for a governance proposal.
|
|
description: >-
|
|
QueryTallyResultResponse is the response type for the Query/Tally RPC
|
|
method.
|
|
cosmos.gov.v1beta1.QueryVoteResponse:
|
|
type: object
|
|
properties:
|
|
vote:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
voter:
|
|
type: string
|
|
option:
|
|
description: >-
|
|
Deprecated: Prefer to use `options` instead. This field is set in
|
|
queries
|
|
|
|
if and only if `len(options) == 1` and that option has weight 1.
|
|
In all
|
|
|
|
other cases, this field will default to VOTE_OPTION_UNSPECIFIED.
|
|
type: string
|
|
enum:
|
|
- VOTE_OPTION_UNSPECIFIED
|
|
- VOTE_OPTION_YES
|
|
- VOTE_OPTION_ABSTAIN
|
|
- VOTE_OPTION_NO
|
|
- VOTE_OPTION_NO_WITH_VETO
|
|
default: VOTE_OPTION_UNSPECIFIED
|
|
options:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
option:
|
|
type: string
|
|
enum:
|
|
- VOTE_OPTION_UNSPECIFIED
|
|
- VOTE_OPTION_YES
|
|
- VOTE_OPTION_ABSTAIN
|
|
- VOTE_OPTION_NO
|
|
- VOTE_OPTION_NO_WITH_VETO
|
|
default: VOTE_OPTION_UNSPECIFIED
|
|
description: >-
|
|
VoteOption enumerates the valid vote options for a given
|
|
governance proposal.
|
|
|
|
- VOTE_OPTION_UNSPECIFIED: VOTE_OPTION_UNSPECIFIED defines a no-op vote option.
|
|
- VOTE_OPTION_YES: VOTE_OPTION_YES defines a yes vote option.
|
|
- VOTE_OPTION_ABSTAIN: VOTE_OPTION_ABSTAIN defines an abstain vote option.
|
|
- VOTE_OPTION_NO: VOTE_OPTION_NO defines a no vote option.
|
|
- VOTE_OPTION_NO_WITH_VETO: VOTE_OPTION_NO_WITH_VETO defines a no with veto vote option.
|
|
weight:
|
|
type: string
|
|
description: WeightedVoteOption defines a unit of vote for vote split.
|
|
description: |-
|
|
Vote defines a vote on a governance proposal.
|
|
A Vote consists of a proposal ID, the voter, and the vote option.
|
|
description: QueryVoteResponse is the response type for the Query/Vote RPC method.
|
|
cosmos.gov.v1beta1.QueryVotesResponse:
|
|
type: object
|
|
properties:
|
|
votes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
voter:
|
|
type: string
|
|
option:
|
|
description: >-
|
|
Deprecated: Prefer to use `options` instead. This field is set
|
|
in queries
|
|
|
|
if and only if `len(options) == 1` and that option has weight 1.
|
|
In all
|
|
|
|
other cases, this field will default to VOTE_OPTION_UNSPECIFIED.
|
|
type: string
|
|
enum:
|
|
- VOTE_OPTION_UNSPECIFIED
|
|
- VOTE_OPTION_YES
|
|
- VOTE_OPTION_ABSTAIN
|
|
- VOTE_OPTION_NO
|
|
- VOTE_OPTION_NO_WITH_VETO
|
|
default: VOTE_OPTION_UNSPECIFIED
|
|
options:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
option:
|
|
type: string
|
|
enum:
|
|
- VOTE_OPTION_UNSPECIFIED
|
|
- VOTE_OPTION_YES
|
|
- VOTE_OPTION_ABSTAIN
|
|
- VOTE_OPTION_NO
|
|
- VOTE_OPTION_NO_WITH_VETO
|
|
default: VOTE_OPTION_UNSPECIFIED
|
|
description: >-
|
|
VoteOption enumerates the valid vote options for a given
|
|
governance proposal.
|
|
|
|
- VOTE_OPTION_UNSPECIFIED: VOTE_OPTION_UNSPECIFIED defines a no-op vote option.
|
|
- VOTE_OPTION_YES: VOTE_OPTION_YES defines a yes vote option.
|
|
- VOTE_OPTION_ABSTAIN: VOTE_OPTION_ABSTAIN defines an abstain vote option.
|
|
- VOTE_OPTION_NO: VOTE_OPTION_NO defines a no vote option.
|
|
- VOTE_OPTION_NO_WITH_VETO: VOTE_OPTION_NO_WITH_VETO defines a no with veto vote option.
|
|
weight:
|
|
type: string
|
|
description: WeightedVoteOption defines a unit of vote for vote split.
|
|
description: |-
|
|
Vote defines a vote on a governance proposal.
|
|
A Vote consists of a proposal ID, the voter, and the vote option.
|
|
description: votes defined the queried votes.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: QueryVotesResponse is the response type for the Query/Votes RPC method.
|
|
cosmos.gov.v1beta1.TallyParams:
|
|
type: object
|
|
properties:
|
|
quorum:
|
|
type: string
|
|
format: byte
|
|
description: |-
|
|
Minimum percentage of total stake needed to vote for a result to be
|
|
considered valid.
|
|
threshold:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Minimum proportion of Yes votes for proposal to pass. Default value:
|
|
0.5.
|
|
veto_threshold:
|
|
type: string
|
|
format: byte
|
|
description: |-
|
|
Minimum value of Veto votes to Total votes ratio for proposal to be
|
|
vetoed. Default value: 1/3.
|
|
description: TallyParams defines the params for tallying votes on governance proposals.
|
|
cosmos.gov.v1beta1.TallyResult:
|
|
type: object
|
|
properties:
|
|
'yes':
|
|
type: string
|
|
abstain:
|
|
type: string
|
|
'no':
|
|
type: string
|
|
no_with_veto:
|
|
type: string
|
|
description: TallyResult defines a standard tally for a governance proposal.
|
|
cosmos.gov.v1beta1.Vote:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
format: uint64
|
|
voter:
|
|
type: string
|
|
option:
|
|
description: >-
|
|
Deprecated: Prefer to use `options` instead. This field is set in
|
|
queries
|
|
|
|
if and only if `len(options) == 1` and that option has weight 1. In
|
|
all
|
|
|
|
other cases, this field will default to VOTE_OPTION_UNSPECIFIED.
|
|
type: string
|
|
enum:
|
|
- VOTE_OPTION_UNSPECIFIED
|
|
- VOTE_OPTION_YES
|
|
- VOTE_OPTION_ABSTAIN
|
|
- VOTE_OPTION_NO
|
|
- VOTE_OPTION_NO_WITH_VETO
|
|
default: VOTE_OPTION_UNSPECIFIED
|
|
options:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
option:
|
|
type: string
|
|
enum:
|
|
- VOTE_OPTION_UNSPECIFIED
|
|
- VOTE_OPTION_YES
|
|
- VOTE_OPTION_ABSTAIN
|
|
- VOTE_OPTION_NO
|
|
- VOTE_OPTION_NO_WITH_VETO
|
|
default: VOTE_OPTION_UNSPECIFIED
|
|
description: >-
|
|
VoteOption enumerates the valid vote options for a given
|
|
governance proposal.
|
|
|
|
- VOTE_OPTION_UNSPECIFIED: VOTE_OPTION_UNSPECIFIED defines a no-op vote option.
|
|
- VOTE_OPTION_YES: VOTE_OPTION_YES defines a yes vote option.
|
|
- VOTE_OPTION_ABSTAIN: VOTE_OPTION_ABSTAIN defines an abstain vote option.
|
|
- VOTE_OPTION_NO: VOTE_OPTION_NO defines a no vote option.
|
|
- VOTE_OPTION_NO_WITH_VETO: VOTE_OPTION_NO_WITH_VETO defines a no with veto vote option.
|
|
weight:
|
|
type: string
|
|
description: WeightedVoteOption defines a unit of vote for vote split.
|
|
description: |-
|
|
Vote defines a vote on a governance proposal.
|
|
A Vote consists of a proposal ID, the voter, and the vote option.
|
|
cosmos.gov.v1beta1.VoteOption:
|
|
type: string
|
|
enum:
|
|
- VOTE_OPTION_UNSPECIFIED
|
|
- VOTE_OPTION_YES
|
|
- VOTE_OPTION_ABSTAIN
|
|
- VOTE_OPTION_NO
|
|
- VOTE_OPTION_NO_WITH_VETO
|
|
default: VOTE_OPTION_UNSPECIFIED
|
|
description: >-
|
|
VoteOption enumerates the valid vote options for a given governance
|
|
proposal.
|
|
|
|
- VOTE_OPTION_UNSPECIFIED: VOTE_OPTION_UNSPECIFIED defines a no-op vote option.
|
|
- VOTE_OPTION_YES: VOTE_OPTION_YES defines a yes vote option.
|
|
- VOTE_OPTION_ABSTAIN: VOTE_OPTION_ABSTAIN defines an abstain vote option.
|
|
- VOTE_OPTION_NO: VOTE_OPTION_NO defines a no vote option.
|
|
- VOTE_OPTION_NO_WITH_VETO: VOTE_OPTION_NO_WITH_VETO defines a no with veto vote option.
|
|
cosmos.gov.v1beta1.VotingParams:
|
|
type: object
|
|
properties:
|
|
voting_period:
|
|
type: string
|
|
description: Length of the voting period.
|
|
description: VotingParams defines the params for voting on governance proposals.
|
|
cosmos.gov.v1beta1.WeightedVoteOption:
|
|
type: object
|
|
properties:
|
|
option:
|
|
type: string
|
|
enum:
|
|
- VOTE_OPTION_UNSPECIFIED
|
|
- VOTE_OPTION_YES
|
|
- VOTE_OPTION_ABSTAIN
|
|
- VOTE_OPTION_NO
|
|
- VOTE_OPTION_NO_WITH_VETO
|
|
default: VOTE_OPTION_UNSPECIFIED
|
|
description: >-
|
|
VoteOption enumerates the valid vote options for a given governance
|
|
proposal.
|
|
|
|
- VOTE_OPTION_UNSPECIFIED: VOTE_OPTION_UNSPECIFIED defines a no-op vote option.
|
|
- VOTE_OPTION_YES: VOTE_OPTION_YES defines a yes vote option.
|
|
- VOTE_OPTION_ABSTAIN: VOTE_OPTION_ABSTAIN defines an abstain vote option.
|
|
- VOTE_OPTION_NO: VOTE_OPTION_NO defines a no vote option.
|
|
- VOTE_OPTION_NO_WITH_VETO: VOTE_OPTION_NO_WITH_VETO defines a no with veto vote option.
|
|
weight:
|
|
type: string
|
|
description: WeightedVoteOption defines a unit of vote for vote split.
|
|
cosmos.mint.v1beta1.Params:
|
|
type: object
|
|
properties:
|
|
mint_denom:
|
|
type: string
|
|
title: type of coin to mint
|
|
inflation_rate_change:
|
|
type: string
|
|
title: maximum annual change in inflation rate
|
|
inflation_max:
|
|
type: string
|
|
title: maximum inflation rate
|
|
inflation_min:
|
|
type: string
|
|
title: minimum inflation rate
|
|
goal_bonded:
|
|
type: string
|
|
title: goal of percent bonded atoms
|
|
blocks_per_year:
|
|
type: string
|
|
format: uint64
|
|
title: expected blocks per year
|
|
description: Params holds parameters for the mint module.
|
|
cosmos.mint.v1beta1.QueryAnnualProvisionsResponse:
|
|
type: object
|
|
properties:
|
|
annual_provisions:
|
|
type: string
|
|
format: byte
|
|
description: annual_provisions is the current minting annual provisions value.
|
|
description: |-
|
|
QueryAnnualProvisionsResponse is the response type for the
|
|
Query/AnnualProvisions RPC method.
|
|
cosmos.mint.v1beta1.QueryInflationResponse:
|
|
type: object
|
|
properties:
|
|
inflation:
|
|
type: string
|
|
format: byte
|
|
description: inflation is the current minting inflation value.
|
|
description: |-
|
|
QueryInflationResponse is the response type for the Query/Inflation RPC
|
|
method.
|
|
cosmos.mint.v1beta1.QueryParamsResponse:
|
|
type: object
|
|
properties:
|
|
params:
|
|
description: params defines the parameters of the module.
|
|
type: object
|
|
properties:
|
|
mint_denom:
|
|
type: string
|
|
title: type of coin to mint
|
|
inflation_rate_change:
|
|
type: string
|
|
title: maximum annual change in inflation rate
|
|
inflation_max:
|
|
type: string
|
|
title: maximum inflation rate
|
|
inflation_min:
|
|
type: string
|
|
title: minimum inflation rate
|
|
goal_bonded:
|
|
type: string
|
|
title: goal of percent bonded atoms
|
|
blocks_per_year:
|
|
type: string
|
|
format: uint64
|
|
title: expected blocks per year
|
|
description: QueryParamsResponse is the response type for the Query/Params RPC method.
|
|
cosmos.params.v1beta1.ParamChange:
|
|
type: object
|
|
properties:
|
|
subspace:
|
|
type: string
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
description: |-
|
|
ParamChange defines an individual parameter change, for use in
|
|
ParameterChangeProposal.
|
|
cosmos.params.v1beta1.QueryParamsResponse:
|
|
type: object
|
|
properties:
|
|
param:
|
|
description: param defines the queried parameter.
|
|
type: object
|
|
properties:
|
|
subspace:
|
|
type: string
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
description: QueryParamsResponse is response type for the Query/Params RPC method.
|
|
cosmos.slashing.v1beta1.Params:
|
|
type: object
|
|
properties:
|
|
signed_blocks_window:
|
|
type: string
|
|
format: int64
|
|
min_signed_per_window:
|
|
type: string
|
|
format: byte
|
|
downtime_jail_duration:
|
|
type: string
|
|
slash_fraction_double_sign:
|
|
type: string
|
|
format: byte
|
|
slash_fraction_downtime:
|
|
type: string
|
|
format: byte
|
|
description: Params represents the parameters used for by the slashing module.
|
|
cosmos.slashing.v1beta1.QueryParamsResponse:
|
|
type: object
|
|
properties:
|
|
params:
|
|
type: object
|
|
properties:
|
|
signed_blocks_window:
|
|
type: string
|
|
format: int64
|
|
min_signed_per_window:
|
|
type: string
|
|
format: byte
|
|
downtime_jail_duration:
|
|
type: string
|
|
slash_fraction_double_sign:
|
|
type: string
|
|
format: byte
|
|
slash_fraction_downtime:
|
|
type: string
|
|
format: byte
|
|
description: Params represents the parameters used for by the slashing module.
|
|
title: QueryParamsResponse is the response type for the Query/Params RPC method
|
|
cosmos.slashing.v1beta1.QuerySigningInfoResponse:
|
|
type: object
|
|
properties:
|
|
val_signing_info:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
start_height:
|
|
type: string
|
|
format: int64
|
|
title: Height at which validator was first a candidate OR was unjailed
|
|
index_offset:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
Index which is incremented each time the validator was a bonded
|
|
|
|
in a block and may have signed a precommit or not. This in
|
|
conjunction with the
|
|
|
|
`SignedBlocksWindow` param determines the index in the
|
|
`MissedBlocksBitArray`.
|
|
jailed_until:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
Timestamp until which the validator is jailed due to liveness
|
|
downtime.
|
|
tombstoned:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
Whether or not a validator has been tombstoned (killed out of
|
|
validator set). It is set
|
|
|
|
once the validator commits an equivocation or for any other
|
|
configured misbehiavor.
|
|
missed_blocks_counter:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
A counter kept to avoid unnecessary array reads.
|
|
|
|
Note that `Sum(MissedBlocksBitArray)` always equals
|
|
`MissedBlocksCounter`.
|
|
description: >-
|
|
ValidatorSigningInfo defines a validator's signing info for monitoring
|
|
their
|
|
|
|
liveness activity.
|
|
title: val_signing_info is the signing info of requested val cons address
|
|
title: >-
|
|
QuerySigningInfoResponse is the response type for the Query/SigningInfo
|
|
RPC
|
|
|
|
method
|
|
cosmos.slashing.v1beta1.QuerySigningInfosResponse:
|
|
type: object
|
|
properties:
|
|
info:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
start_height:
|
|
type: string
|
|
format: int64
|
|
title: Height at which validator was first a candidate OR was unjailed
|
|
index_offset:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
Index which is incremented each time the validator was a bonded
|
|
|
|
in a block and may have signed a precommit or not. This in
|
|
conjunction with the
|
|
|
|
`SignedBlocksWindow` param determines the index in the
|
|
`MissedBlocksBitArray`.
|
|
jailed_until:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
Timestamp until which the validator is jailed due to liveness
|
|
downtime.
|
|
tombstoned:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
Whether or not a validator has been tombstoned (killed out of
|
|
validator set). It is set
|
|
|
|
once the validator commits an equivocation or for any other
|
|
configured misbehiavor.
|
|
missed_blocks_counter:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
A counter kept to avoid unnecessary array reads.
|
|
|
|
Note that `Sum(MissedBlocksBitArray)` always equals
|
|
`MissedBlocksCounter`.
|
|
description: >-
|
|
ValidatorSigningInfo defines a validator's signing info for
|
|
monitoring their
|
|
|
|
liveness activity.
|
|
title: info is the signing info of all validators
|
|
pagination:
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
PageResponse is to be embedded in gRPC response messages where the
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
title: >-
|
|
QuerySigningInfosResponse is the response type for the Query/SigningInfos
|
|
RPC
|
|
|
|
method
|
|
cosmos.slashing.v1beta1.ValidatorSigningInfo:
|
|
type: object
|
|
properties:
|
|
address:
|
|
type: string
|
|
start_height:
|
|
type: string
|
|
format: int64
|
|
title: Height at which validator was first a candidate OR was unjailed
|
|
index_offset:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
Index which is incremented each time the validator was a bonded
|
|
|
|
in a block and may have signed a precommit or not. This in conjunction
|
|
with the
|
|
|
|
`SignedBlocksWindow` param determines the index in the
|
|
`MissedBlocksBitArray`.
|
|
jailed_until:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
Timestamp until which the validator is jailed due to liveness
|
|
downtime.
|
|
tombstoned:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
Whether or not a validator has been tombstoned (killed out of
|
|
validator set). It is set
|
|
|
|
once the validator commits an equivocation or for any other configured
|
|
misbehiavor.
|
|
missed_blocks_counter:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
A counter kept to avoid unnecessary array reads.
|
|
|
|
Note that `Sum(MissedBlocksBitArray)` always equals
|
|
`MissedBlocksCounter`.
|
|
description: >-
|
|
ValidatorSigningInfo defines a validator's signing info for monitoring
|
|
their
|
|
|
|
liveness activity.
|
|
cosmos.staking.v1beta1.BondStatus:
|
|
type: string
|
|
enum:
|
|
- BOND_STATUS_UNSPECIFIED
|
|
- BOND_STATUS_UNBONDED
|
|
- BOND_STATUS_UNBONDING
|
|
- BOND_STATUS_BONDED
|
|
default: BOND_STATUS_UNSPECIFIED
|
|
description: |-
|
|
BondStatus is the status of a validator.
|
|
|
|
- BOND_STATUS_UNSPECIFIED: UNSPECIFIED defines an invalid validator status.
|
|
- BOND_STATUS_UNBONDED: UNBONDED defines a validator that is not bonded.
|
|
- BOND_STATUS_UNBONDING: UNBONDING defines a validator that is unbonding.
|
|
- BOND_STATUS_BONDED: BONDED defines a validator that is bonded.
|
|
cosmos.staking.v1beta1.Commission:
|
|
type: object
|
|
properties:
|
|
commission_rates:
|
|
description: >-
|
|
commission_rates defines the initial commission rates to be used for
|
|
creating a validator.
|
|
type: object
|
|
properties:
|
|
rate:
|
|
type: string
|
|
description: rate is the commission rate charged to delegators, as a fraction.
|
|
max_rate:
|
|
type: string
|
|
description: >-
|
|
max_rate defines the maximum commission rate which validator can
|
|
ever charge, as a fraction.
|
|
max_change_rate:
|
|
type: string
|
|
description: >-
|
|
max_change_rate defines the maximum daily increase of the
|
|
validator commission, as a fraction.
|
|
update_time:
|
|
type: string
|
|
format: date-time
|
|
description: update_time is the last time the commission rate was changed.
|
|
description: Commission defines commission parameters for a given validator.
|
|
cosmos.staking.v1beta1.CommissionRates:
|
|
type: object
|
|
properties:
|
|
rate:
|
|
type: string
|
|
description: rate is the commission rate charged to delegators, as a fraction.
|
|
max_rate:
|
|
type: string
|
|
description: >-
|
|
max_rate defines the maximum commission rate which validator can ever
|
|
charge, as a fraction.
|
|
max_change_rate:
|
|
type: string
|
|
description: >-
|
|
max_change_rate defines the maximum daily increase of the validator
|
|
commission, as a fraction.
|
|
description: >-
|
|
CommissionRates defines the initial commission rates to be used for
|
|
creating
|
|
|
|
a validator.
|
|
cosmos.staking.v1beta1.Delegation:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
description: delegator_address is the bech32-encoded address of the delegator.
|
|
validator_address:
|
|
type: string
|
|
description: validator_address is the bech32-encoded address of the validator.
|
|
shares:
|
|
type: string
|
|
description: shares define the delegation shares received.
|
|
description: |-
|
|
Delegation represents the bond with tokens held by an account. It is
|
|
owned by one delegator, and is associated with the voting power of one
|
|
validator.
|
|
cosmos.staking.v1beta1.DelegationResponse:
|
|
type: object
|
|
properties:
|
|
delegation:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
description: delegator_address is the bech32-encoded address of the delegator.
|
|
validator_address:
|
|
type: string
|
|
description: validator_address is the bech32-encoded address of the validator.
|
|
shares:
|
|
type: string
|
|
description: shares define the delegation shares received.
|
|
description: |-
|
|
Delegation represents the bond with tokens held by an account. It is
|
|
owned by one delegator, and is associated with the voting power of one
|
|
validator.
|
|
balance:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
description: |-
|
|
DelegationResponse is equivalent to Delegation except that it contains a
|
|
balance in addition to shares which is more suitable for client responses.
|
|
cosmos.staking.v1beta1.Description:
|
|
type: object
|
|
properties:
|
|
moniker:
|
|
type: string
|
|
description: moniker defines a human-readable name for the validator.
|
|
identity:
|
|
type: string
|
|
description: >-
|
|
identity defines an optional identity signature (ex. UPort or
|
|
Keybase).
|
|
website:
|
|
type: string
|
|
description: website defines an optional website link.
|
|
security_contact:
|
|
type: string
|
|
description: security_contact defines an optional email for security contact.
|
|
details:
|
|
type: string
|
|
description: details define other optional details.
|
|
description: Description defines a validator description.
|
|
cosmos.staking.v1beta1.HistoricalInfo:
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
version:
|
|
title: basic block info
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules for processing a block in
|
|
the blockchain,
|
|
|
|
including all blockchain data structures and the rules of the
|
|
application's
|
|
|
|
state transition machine.
|
|
chain_id:
|
|
type: string
|
|
height:
|
|
type: string
|
|
format: int64
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
last_block_id:
|
|
title: prev block info
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
last_commit_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes of block data
|
|
data_hash:
|
|
type: string
|
|
format: byte
|
|
validators_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes from the app output from the prev block
|
|
next_validators_hash:
|
|
type: string
|
|
format: byte
|
|
consensus_hash:
|
|
type: string
|
|
format: byte
|
|
app_hash:
|
|
type: string
|
|
format: byte
|
|
last_results_hash:
|
|
type: string
|
|
format: byte
|
|
evidence_hash:
|
|
type: string
|
|
format: byte
|
|
title: consensus info
|
|
proposer_address:
|
|
type: string
|
|
format: byte
|
|
description: Header defines the structure of a Tendermint block header.
|
|
valset:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
operator_address:
|
|
type: string
|
|
description: >-
|
|
operator_address defines the address of the validator's
|
|
operator; bech encoded in JSON.
|
|
consensus_pubkey:
|
|
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"
|
|
}
|
|
jailed:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
jailed defined whether the validator has been jailed from bonded
|
|
status or not.
|
|
status:
|
|
description: status is the validator status (bonded/unbonding/unbonded).
|
|
type: string
|
|
enum:
|
|
- BOND_STATUS_UNSPECIFIED
|
|
- BOND_STATUS_UNBONDED
|
|
- BOND_STATUS_UNBONDING
|
|
- BOND_STATUS_BONDED
|
|
default: BOND_STATUS_UNSPECIFIED
|
|
tokens:
|
|
type: string
|
|
description: tokens define the delegated tokens (incl. self-delegation).
|
|
delegator_shares:
|
|
type: string
|
|
description: >-
|
|
delegator_shares defines total shares issued to a validator's
|
|
delegators.
|
|
description:
|
|
description: description defines the description terms for the validator.
|
|
type: object
|
|
properties:
|
|
moniker:
|
|
type: string
|
|
description: moniker defines a human-readable name for the validator.
|
|
identity:
|
|
type: string
|
|
description: >-
|
|
identity defines an optional identity signature (ex. UPort
|
|
or Keybase).
|
|
website:
|
|
type: string
|
|
description: website defines an optional website link.
|
|
security_contact:
|
|
type: string
|
|
description: >-
|
|
security_contact defines an optional email for security
|
|
contact.
|
|
details:
|
|
type: string
|
|
description: details define other optional details.
|
|
unbonding_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
unbonding_height defines, if unbonding, the height at which this
|
|
validator has begun unbonding.
|
|
unbonding_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
unbonding_time defines, if unbonding, the min time for the
|
|
validator to complete unbonding.
|
|
commission:
|
|
description: commission defines the commission parameters.
|
|
type: object
|
|
properties:
|
|
commission_rates:
|
|
description: >-
|
|
commission_rates defines the initial commission rates to be
|
|
used for creating a validator.
|
|
type: object
|
|
properties:
|
|
rate:
|
|
type: string
|
|
description: >-
|
|
rate is the commission rate charged to delegators, as a
|
|
fraction.
|
|
max_rate:
|
|
type: string
|
|
description: >-
|
|
max_rate defines the maximum commission rate which
|
|
validator can ever charge, as a fraction.
|
|
max_change_rate:
|
|
type: string
|
|
description: >-
|
|
max_change_rate defines the maximum daily increase of
|
|
the validator commission, as a fraction.
|
|
update_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
update_time is the last time the commission rate was
|
|
changed.
|
|
min_self_delegation:
|
|
type: string
|
|
description: >-
|
|
min_self_delegation is the validator's self declared minimum
|
|
self delegation.
|
|
description: >-
|
|
Validator defines a validator, together with the total amount of the
|
|
|
|
Validator's bond shares and their exchange rate to coins. Slashing
|
|
results in
|
|
|
|
a decrease in the exchange rate, allowing correct calculation of
|
|
future
|
|
|
|
undelegations without iterating over delegators. When coins are
|
|
delegated to
|
|
|
|
this validator, the validator is credited with a delegation whose
|
|
number of
|
|
|
|
bond shares is based on the amount of coins delegated divided by the
|
|
current
|
|
|
|
exchange rate. Voting power can be calculated as total bonded shares
|
|
|
|
multiplied by exchange rate.
|
|
description: >-
|
|
HistoricalInfo contains header and validator information for a given
|
|
block.
|
|
|
|
It is stored as part of staking module's state, which persists the `n`
|
|
most
|
|
|
|
recent HistoricalInfo
|
|
|
|
(`n` is set by the staking module's `historical_entries` parameter).
|
|
cosmos.staking.v1beta1.Params:
|
|
type: object
|
|
properties:
|
|
unbonding_time:
|
|
type: string
|
|
description: unbonding_time is the time duration of unbonding.
|
|
max_validators:
|
|
type: integer
|
|
format: int64
|
|
description: max_validators is the maximum number of validators.
|
|
max_entries:
|
|
type: integer
|
|
format: int64
|
|
description: >-
|
|
max_entries is the max entries for either unbonding delegation or
|
|
redelegation (per pair/trio).
|
|
historical_entries:
|
|
type: integer
|
|
format: int64
|
|
description: historical_entries is the number of historical entries to persist.
|
|
bond_denom:
|
|
type: string
|
|
description: bond_denom defines the bondable coin denomination.
|
|
description: Params defines the parameters for the staking module.
|
|
cosmos.staking.v1beta1.Pool:
|
|
type: object
|
|
properties:
|
|
not_bonded_tokens:
|
|
type: string
|
|
bonded_tokens:
|
|
type: string
|
|
description: |-
|
|
Pool is used for tracking bonded and not-bonded token supply of the bond
|
|
denomination.
|
|
cosmos.staking.v1beta1.QueryDelegationResponse:
|
|
type: object
|
|
properties:
|
|
delegation_response:
|
|
type: object
|
|
properties:
|
|
delegation:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
description: >-
|
|
delegator_address is the bech32-encoded address of the
|
|
delegator.
|
|
validator_address:
|
|
type: string
|
|
description: >-
|
|
validator_address is the bech32-encoded address of the
|
|
validator.
|
|
shares:
|
|
type: string
|
|
description: shares define the delegation shares received.
|
|
description: >-
|
|
Delegation represents the bond with tokens held by an account. It
|
|
is
|
|
|
|
owned by one delegator, and is associated with the voting power of
|
|
one
|
|
|
|
validator.
|
|
balance:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
DelegationResponse is equivalent to Delegation except that it contains
|
|
a
|
|
|
|
balance in addition to shares which is more suitable for client
|
|
responses.
|
|
description: >-
|
|
QueryDelegationResponse is response type for the Query/Delegation RPC
|
|
method.
|
|
cosmos.staking.v1beta1.QueryDelegatorDelegationsResponse:
|
|
type: object
|
|
properties:
|
|
delegation_responses:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
delegation:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
description: >-
|
|
delegator_address is the bech32-encoded address of the
|
|
delegator.
|
|
validator_address:
|
|
type: string
|
|
description: >-
|
|
validator_address is the bech32-encoded address of the
|
|
validator.
|
|
shares:
|
|
type: string
|
|
description: shares define the delegation shares received.
|
|
description: >-
|
|
Delegation represents the bond with tokens held by an account.
|
|
It is
|
|
|
|
owned by one delegator, and is associated with the voting power
|
|
of one
|
|
|
|
validator.
|
|
balance:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
DelegationResponse is equivalent to Delegation except that it
|
|
contains a
|
|
|
|
balance in addition to shares which is more suitable for client
|
|
responses.
|
|
description: delegation_responses defines all the delegations' info of a delegator.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
QueryDelegatorDelegationsResponse is response type for the
|
|
Query/DelegatorDelegations RPC method.
|
|
cosmos.staking.v1beta1.QueryDelegatorUnbondingDelegationsResponse:
|
|
type: object
|
|
properties:
|
|
unbonding_responses:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
description: >-
|
|
delegator_address is the bech32-encoded address of the
|
|
delegator.
|
|
validator_address:
|
|
type: string
|
|
description: >-
|
|
validator_address is the bech32-encoded address of the
|
|
validator.
|
|
entries:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
creation_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
creation_height is the height which the unbonding took
|
|
place.
|
|
completion_time:
|
|
type: string
|
|
format: date-time
|
|
description: completion_time is the unix time for unbonding completion.
|
|
initial_balance:
|
|
type: string
|
|
description: >-
|
|
initial_balance defines the tokens initially scheduled to
|
|
receive at completion.
|
|
balance:
|
|
type: string
|
|
description: balance defines the tokens to receive at completion.
|
|
description: >-
|
|
UnbondingDelegationEntry defines an unbonding object with
|
|
relevant metadata.
|
|
description: entries are the unbonding delegation entries.
|
|
description: >-
|
|
UnbondingDelegation stores all of a single delegator's unbonding
|
|
bonds
|
|
|
|
for a single validator in an time-ordered list.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
QueryUnbondingDelegatorDelegationsResponse is response type for the
|
|
Query/UnbondingDelegatorDelegations RPC method.
|
|
cosmos.staking.v1beta1.QueryDelegatorValidatorResponse:
|
|
type: object
|
|
properties:
|
|
validator:
|
|
type: object
|
|
properties:
|
|
operator_address:
|
|
type: string
|
|
description: >-
|
|
operator_address defines the address of the validator's operator;
|
|
bech encoded in JSON.
|
|
consensus_pubkey:
|
|
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"
|
|
}
|
|
jailed:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
jailed defined whether the validator has been jailed from bonded
|
|
status or not.
|
|
status:
|
|
description: status is the validator status (bonded/unbonding/unbonded).
|
|
type: string
|
|
enum:
|
|
- BOND_STATUS_UNSPECIFIED
|
|
- BOND_STATUS_UNBONDED
|
|
- BOND_STATUS_UNBONDING
|
|
- BOND_STATUS_BONDED
|
|
default: BOND_STATUS_UNSPECIFIED
|
|
tokens:
|
|
type: string
|
|
description: tokens define the delegated tokens (incl. self-delegation).
|
|
delegator_shares:
|
|
type: string
|
|
description: >-
|
|
delegator_shares defines total shares issued to a validator's
|
|
delegators.
|
|
description:
|
|
description: description defines the description terms for the validator.
|
|
type: object
|
|
properties:
|
|
moniker:
|
|
type: string
|
|
description: moniker defines a human-readable name for the validator.
|
|
identity:
|
|
type: string
|
|
description: >-
|
|
identity defines an optional identity signature (ex. UPort or
|
|
Keybase).
|
|
website:
|
|
type: string
|
|
description: website defines an optional website link.
|
|
security_contact:
|
|
type: string
|
|
description: >-
|
|
security_contact defines an optional email for security
|
|
contact.
|
|
details:
|
|
type: string
|
|
description: details define other optional details.
|
|
unbonding_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
unbonding_height defines, if unbonding, the height at which this
|
|
validator has begun unbonding.
|
|
unbonding_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
unbonding_time defines, if unbonding, the min time for the
|
|
validator to complete unbonding.
|
|
commission:
|
|
description: commission defines the commission parameters.
|
|
type: object
|
|
properties:
|
|
commission_rates:
|
|
description: >-
|
|
commission_rates defines the initial commission rates to be
|
|
used for creating a validator.
|
|
type: object
|
|
properties:
|
|
rate:
|
|
type: string
|
|
description: >-
|
|
rate is the commission rate charged to delegators, as a
|
|
fraction.
|
|
max_rate:
|
|
type: string
|
|
description: >-
|
|
max_rate defines the maximum commission rate which
|
|
validator can ever charge, as a fraction.
|
|
max_change_rate:
|
|
type: string
|
|
description: >-
|
|
max_change_rate defines the maximum daily increase of the
|
|
validator commission, as a fraction.
|
|
update_time:
|
|
type: string
|
|
format: date-time
|
|
description: update_time is the last time the commission rate was changed.
|
|
min_self_delegation:
|
|
type: string
|
|
description: >-
|
|
min_self_delegation is the validator's self declared minimum self
|
|
delegation.
|
|
description: >-
|
|
Validator defines a validator, together with the total amount of the
|
|
|
|
Validator's bond shares and their exchange rate to coins. Slashing
|
|
results in
|
|
|
|
a decrease in the exchange rate, allowing correct calculation of
|
|
future
|
|
|
|
undelegations without iterating over delegators. When coins are
|
|
delegated to
|
|
|
|
this validator, the validator is credited with a delegation whose
|
|
number of
|
|
|
|
bond shares is based on the amount of coins delegated divided by the
|
|
current
|
|
|
|
exchange rate. Voting power can be calculated as total bonded shares
|
|
|
|
multiplied by exchange rate.
|
|
description: |-
|
|
QueryDelegatorValidatorResponse response type for the
|
|
Query/DelegatorValidator RPC method.
|
|
cosmos.staking.v1beta1.QueryDelegatorValidatorsResponse:
|
|
type: object
|
|
properties:
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
operator_address:
|
|
type: string
|
|
description: >-
|
|
operator_address defines the address of the validator's
|
|
operator; bech encoded in JSON.
|
|
consensus_pubkey:
|
|
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"
|
|
}
|
|
jailed:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
jailed defined whether the validator has been jailed from bonded
|
|
status or not.
|
|
status:
|
|
description: status is the validator status (bonded/unbonding/unbonded).
|
|
type: string
|
|
enum:
|
|
- BOND_STATUS_UNSPECIFIED
|
|
- BOND_STATUS_UNBONDED
|
|
- BOND_STATUS_UNBONDING
|
|
- BOND_STATUS_BONDED
|
|
default: BOND_STATUS_UNSPECIFIED
|
|
tokens:
|
|
type: string
|
|
description: tokens define the delegated tokens (incl. self-delegation).
|
|
delegator_shares:
|
|
type: string
|
|
description: >-
|
|
delegator_shares defines total shares issued to a validator's
|
|
delegators.
|
|
description:
|
|
description: description defines the description terms for the validator.
|
|
type: object
|
|
properties:
|
|
moniker:
|
|
type: string
|
|
description: moniker defines a human-readable name for the validator.
|
|
identity:
|
|
type: string
|
|
description: >-
|
|
identity defines an optional identity signature (ex. UPort
|
|
or Keybase).
|
|
website:
|
|
type: string
|
|
description: website defines an optional website link.
|
|
security_contact:
|
|
type: string
|
|
description: >-
|
|
security_contact defines an optional email for security
|
|
contact.
|
|
details:
|
|
type: string
|
|
description: details define other optional details.
|
|
unbonding_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
unbonding_height defines, if unbonding, the height at which this
|
|
validator has begun unbonding.
|
|
unbonding_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
unbonding_time defines, if unbonding, the min time for the
|
|
validator to complete unbonding.
|
|
commission:
|
|
description: commission defines the commission parameters.
|
|
type: object
|
|
properties:
|
|
commission_rates:
|
|
description: >-
|
|
commission_rates defines the initial commission rates to be
|
|
used for creating a validator.
|
|
type: object
|
|
properties:
|
|
rate:
|
|
type: string
|
|
description: >-
|
|
rate is the commission rate charged to delegators, as a
|
|
fraction.
|
|
max_rate:
|
|
type: string
|
|
description: >-
|
|
max_rate defines the maximum commission rate which
|
|
validator can ever charge, as a fraction.
|
|
max_change_rate:
|
|
type: string
|
|
description: >-
|
|
max_change_rate defines the maximum daily increase of
|
|
the validator commission, as a fraction.
|
|
update_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
update_time is the last time the commission rate was
|
|
changed.
|
|
min_self_delegation:
|
|
type: string
|
|
description: >-
|
|
min_self_delegation is the validator's self declared minimum
|
|
self delegation.
|
|
description: >-
|
|
Validator defines a validator, together with the total amount of the
|
|
|
|
Validator's bond shares and their exchange rate to coins. Slashing
|
|
results in
|
|
|
|
a decrease in the exchange rate, allowing correct calculation of
|
|
future
|
|
|
|
undelegations without iterating over delegators. When coins are
|
|
delegated to
|
|
|
|
this validator, the validator is credited with a delegation whose
|
|
number of
|
|
|
|
bond shares is based on the amount of coins delegated divided by the
|
|
current
|
|
|
|
exchange rate. Voting power can be calculated as total bonded shares
|
|
|
|
multiplied by exchange rate.
|
|
description: validators defines the the validators' info of a delegator.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
QueryDelegatorValidatorsResponse is response type for the
|
|
Query/DelegatorValidators RPC method.
|
|
cosmos.staking.v1beta1.QueryHistoricalInfoResponse:
|
|
type: object
|
|
properties:
|
|
hist:
|
|
description: hist defines the historical info at the given height.
|
|
type: object
|
|
properties:
|
|
header:
|
|
type: object
|
|
properties:
|
|
version:
|
|
title: basic block info
|
|
type: object
|
|
properties:
|
|
block:
|
|
type: string
|
|
format: uint64
|
|
app:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
Consensus captures the consensus rules for processing a block
|
|
in the blockchain,
|
|
|
|
including all blockchain data structures and the rules of the
|
|
application's
|
|
|
|
state transition machine.
|
|
chain_id:
|
|
type: string
|
|
height:
|
|
type: string
|
|
format: int64
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
last_block_id:
|
|
title: prev block info
|
|
type: object
|
|
properties:
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
part_set_header:
|
|
type: object
|
|
properties:
|
|
total:
|
|
type: integer
|
|
format: int64
|
|
hash:
|
|
type: string
|
|
format: byte
|
|
title: PartsetHeader
|
|
last_commit_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes of block data
|
|
data_hash:
|
|
type: string
|
|
format: byte
|
|
validators_hash:
|
|
type: string
|
|
format: byte
|
|
title: hashes from the app output from the prev block
|
|
next_validators_hash:
|
|
type: string
|
|
format: byte
|
|
consensus_hash:
|
|
type: string
|
|
format: byte
|
|
app_hash:
|
|
type: string
|
|
format: byte
|
|
last_results_hash:
|
|
type: string
|
|
format: byte
|
|
evidence_hash:
|
|
type: string
|
|
format: byte
|
|
title: consensus info
|
|
proposer_address:
|
|
type: string
|
|
format: byte
|
|
description: Header defines the structure of a Tendermint block header.
|
|
valset:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
operator_address:
|
|
type: string
|
|
description: >-
|
|
operator_address defines the address of the validator's
|
|
operator; bech encoded in JSON.
|
|
consensus_pubkey:
|
|
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"
|
|
}
|
|
jailed:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
jailed defined whether the validator has been jailed from
|
|
bonded status or not.
|
|
status:
|
|
description: status is the validator status (bonded/unbonding/unbonded).
|
|
type: string
|
|
enum:
|
|
- BOND_STATUS_UNSPECIFIED
|
|
- BOND_STATUS_UNBONDED
|
|
- BOND_STATUS_UNBONDING
|
|
- BOND_STATUS_BONDED
|
|
default: BOND_STATUS_UNSPECIFIED
|
|
tokens:
|
|
type: string
|
|
description: tokens define the delegated tokens (incl. self-delegation).
|
|
delegator_shares:
|
|
type: string
|
|
description: >-
|
|
delegator_shares defines total shares issued to a
|
|
validator's delegators.
|
|
description:
|
|
description: description defines the description terms for the validator.
|
|
type: object
|
|
properties:
|
|
moniker:
|
|
type: string
|
|
description: moniker defines a human-readable name for the validator.
|
|
identity:
|
|
type: string
|
|
description: >-
|
|
identity defines an optional identity signature (ex.
|
|
UPort or Keybase).
|
|
website:
|
|
type: string
|
|
description: website defines an optional website link.
|
|
security_contact:
|
|
type: string
|
|
description: >-
|
|
security_contact defines an optional email for security
|
|
contact.
|
|
details:
|
|
type: string
|
|
description: details define other optional details.
|
|
unbonding_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
unbonding_height defines, if unbonding, the height at which
|
|
this validator has begun unbonding.
|
|
unbonding_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
unbonding_time defines, if unbonding, the min time for the
|
|
validator to complete unbonding.
|
|
commission:
|
|
description: commission defines the commission parameters.
|
|
type: object
|
|
properties:
|
|
commission_rates:
|
|
description: >-
|
|
commission_rates defines the initial commission rates to
|
|
be used for creating a validator.
|
|
type: object
|
|
properties:
|
|
rate:
|
|
type: string
|
|
description: >-
|
|
rate is the commission rate charged to delegators,
|
|
as a fraction.
|
|
max_rate:
|
|
type: string
|
|
description: >-
|
|
max_rate defines the maximum commission rate which
|
|
validator can ever charge, as a fraction.
|
|
max_change_rate:
|
|
type: string
|
|
description: >-
|
|
max_change_rate defines the maximum daily increase
|
|
of the validator commission, as a fraction.
|
|
update_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
update_time is the last time the commission rate was
|
|
changed.
|
|
min_self_delegation:
|
|
type: string
|
|
description: >-
|
|
min_self_delegation is the validator's self declared minimum
|
|
self delegation.
|
|
description: >-
|
|
Validator defines a validator, together with the total amount of
|
|
the
|
|
|
|
Validator's bond shares and their exchange rate to coins.
|
|
Slashing results in
|
|
|
|
a decrease in the exchange rate, allowing correct calculation of
|
|
future
|
|
|
|
undelegations without iterating over delegators. When coins are
|
|
delegated to
|
|
|
|
this validator, the validator is credited with a delegation
|
|
whose number of
|
|
|
|
bond shares is based on the amount of coins delegated divided by
|
|
the current
|
|
|
|
exchange rate. Voting power can be calculated as total bonded
|
|
shares
|
|
|
|
multiplied by exchange rate.
|
|
description: >-
|
|
QueryHistoricalInfoResponse is response type for the Query/HistoricalInfo
|
|
RPC
|
|
|
|
method.
|
|
cosmos.staking.v1beta1.QueryParamsResponse:
|
|
type: object
|
|
properties:
|
|
params:
|
|
description: params holds all the parameters of this module.
|
|
type: object
|
|
properties:
|
|
unbonding_time:
|
|
type: string
|
|
description: unbonding_time is the time duration of unbonding.
|
|
max_validators:
|
|
type: integer
|
|
format: int64
|
|
description: max_validators is the maximum number of validators.
|
|
max_entries:
|
|
type: integer
|
|
format: int64
|
|
description: >-
|
|
max_entries is the max entries for either unbonding delegation or
|
|
redelegation (per pair/trio).
|
|
historical_entries:
|
|
type: integer
|
|
format: int64
|
|
description: historical_entries is the number of historical entries to persist.
|
|
bond_denom:
|
|
type: string
|
|
description: bond_denom defines the bondable coin denomination.
|
|
description: QueryParamsResponse is response type for the Query/Params RPC method.
|
|
cosmos.staking.v1beta1.QueryPoolResponse:
|
|
type: object
|
|
properties:
|
|
pool:
|
|
description: pool defines the pool info.
|
|
type: object
|
|
properties:
|
|
not_bonded_tokens:
|
|
type: string
|
|
bonded_tokens:
|
|
type: string
|
|
description: QueryPoolResponse is response type for the Query/Pool RPC method.
|
|
cosmos.staking.v1beta1.QueryRedelegationsResponse:
|
|
type: object
|
|
properties:
|
|
redelegation_responses:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
redelegation:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
description: >-
|
|
delegator_address is the bech32-encoded address of the
|
|
delegator.
|
|
validator_src_address:
|
|
type: string
|
|
description: >-
|
|
validator_src_address is the validator redelegation source
|
|
operator address.
|
|
validator_dst_address:
|
|
type: string
|
|
description: >-
|
|
validator_dst_address is the validator redelegation
|
|
destination operator address.
|
|
entries:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
creation_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
creation_height defines the height which the
|
|
redelegation took place.
|
|
completion_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
completion_time defines the unix time for redelegation
|
|
completion.
|
|
initial_balance:
|
|
type: string
|
|
description: >-
|
|
initial_balance defines the initial balance when
|
|
redelegation started.
|
|
shares_dst:
|
|
type: string
|
|
description: >-
|
|
shares_dst is the amount of destination-validator
|
|
shares created by redelegation.
|
|
description: >-
|
|
RedelegationEntry defines a redelegation object with
|
|
relevant metadata.
|
|
description: entries are the redelegation entries.
|
|
description: >-
|
|
Redelegation contains the list of a particular delegator's
|
|
redelegating bonds
|
|
|
|
from a particular source validator to a particular destination
|
|
validator.
|
|
entries:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
redelegation_entry:
|
|
type: object
|
|
properties:
|
|
creation_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
creation_height defines the height which the
|
|
redelegation took place.
|
|
completion_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
completion_time defines the unix time for redelegation
|
|
completion.
|
|
initial_balance:
|
|
type: string
|
|
description: >-
|
|
initial_balance defines the initial balance when
|
|
redelegation started.
|
|
shares_dst:
|
|
type: string
|
|
description: >-
|
|
shares_dst is the amount of destination-validator
|
|
shares created by redelegation.
|
|
description: >-
|
|
RedelegationEntry defines a redelegation object with
|
|
relevant metadata.
|
|
balance:
|
|
type: string
|
|
description: >-
|
|
RedelegationEntryResponse is equivalent to a RedelegationEntry
|
|
except that it
|
|
|
|
contains a balance in addition to shares which is more
|
|
suitable for client
|
|
|
|
responses.
|
|
description: >-
|
|
RedelegationResponse is equivalent to a Redelegation except that its
|
|
entries
|
|
|
|
contain a balance in addition to shares which is more suitable for
|
|
client
|
|
|
|
responses.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryRedelegationsResponse is response type for the Query/Redelegations
|
|
RPC
|
|
|
|
method.
|
|
cosmos.staking.v1beta1.QueryUnbondingDelegationResponse:
|
|
type: object
|
|
properties:
|
|
unbond:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
description: delegator_address is the bech32-encoded address of the delegator.
|
|
validator_address:
|
|
type: string
|
|
description: validator_address is the bech32-encoded address of the validator.
|
|
entries:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
creation_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
creation_height is the height which the unbonding took
|
|
place.
|
|
completion_time:
|
|
type: string
|
|
format: date-time
|
|
description: completion_time is the unix time for unbonding completion.
|
|
initial_balance:
|
|
type: string
|
|
description: >-
|
|
initial_balance defines the tokens initially scheduled to
|
|
receive at completion.
|
|
balance:
|
|
type: string
|
|
description: balance defines the tokens to receive at completion.
|
|
description: >-
|
|
UnbondingDelegationEntry defines an unbonding object with
|
|
relevant metadata.
|
|
description: entries are the unbonding delegation entries.
|
|
description: |-
|
|
UnbondingDelegation stores all of a single delegator's unbonding bonds
|
|
for a single validator in an time-ordered list.
|
|
description: |-
|
|
QueryDelegationResponse is response type for the Query/UnbondingDelegation
|
|
RPC method.
|
|
cosmos.staking.v1beta1.QueryValidatorDelegationsResponse:
|
|
type: object
|
|
properties:
|
|
delegation_responses:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
delegation:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
description: >-
|
|
delegator_address is the bech32-encoded address of the
|
|
delegator.
|
|
validator_address:
|
|
type: string
|
|
description: >-
|
|
validator_address is the bech32-encoded address of the
|
|
validator.
|
|
shares:
|
|
type: string
|
|
description: shares define the delegation shares received.
|
|
description: >-
|
|
Delegation represents the bond with tokens held by an account.
|
|
It is
|
|
|
|
owned by one delegator, and is associated with the voting power
|
|
of one
|
|
|
|
validator.
|
|
balance:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
description: >-
|
|
DelegationResponse is equivalent to Delegation except that it
|
|
contains a
|
|
|
|
balance in addition to shares which is more suitable for client
|
|
responses.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
title: |-
|
|
QueryValidatorDelegationsResponse is response type for the
|
|
Query/ValidatorDelegations RPC method
|
|
cosmos.staking.v1beta1.QueryValidatorResponse:
|
|
type: object
|
|
properties:
|
|
validator:
|
|
type: object
|
|
properties:
|
|
operator_address:
|
|
type: string
|
|
description: >-
|
|
operator_address defines the address of the validator's operator;
|
|
bech encoded in JSON.
|
|
consensus_pubkey:
|
|
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"
|
|
}
|
|
jailed:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
jailed defined whether the validator has been jailed from bonded
|
|
status or not.
|
|
status:
|
|
description: status is the validator status (bonded/unbonding/unbonded).
|
|
type: string
|
|
enum:
|
|
- BOND_STATUS_UNSPECIFIED
|
|
- BOND_STATUS_UNBONDED
|
|
- BOND_STATUS_UNBONDING
|
|
- BOND_STATUS_BONDED
|
|
default: BOND_STATUS_UNSPECIFIED
|
|
tokens:
|
|
type: string
|
|
description: tokens define the delegated tokens (incl. self-delegation).
|
|
delegator_shares:
|
|
type: string
|
|
description: >-
|
|
delegator_shares defines total shares issued to a validator's
|
|
delegators.
|
|
description:
|
|
description: description defines the description terms for the validator.
|
|
type: object
|
|
properties:
|
|
moniker:
|
|
type: string
|
|
description: moniker defines a human-readable name for the validator.
|
|
identity:
|
|
type: string
|
|
description: >-
|
|
identity defines an optional identity signature (ex. UPort or
|
|
Keybase).
|
|
website:
|
|
type: string
|
|
description: website defines an optional website link.
|
|
security_contact:
|
|
type: string
|
|
description: >-
|
|
security_contact defines an optional email for security
|
|
contact.
|
|
details:
|
|
type: string
|
|
description: details define other optional details.
|
|
unbonding_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
unbonding_height defines, if unbonding, the height at which this
|
|
validator has begun unbonding.
|
|
unbonding_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
unbonding_time defines, if unbonding, the min time for the
|
|
validator to complete unbonding.
|
|
commission:
|
|
description: commission defines the commission parameters.
|
|
type: object
|
|
properties:
|
|
commission_rates:
|
|
description: >-
|
|
commission_rates defines the initial commission rates to be
|
|
used for creating a validator.
|
|
type: object
|
|
properties:
|
|
rate:
|
|
type: string
|
|
description: >-
|
|
rate is the commission rate charged to delegators, as a
|
|
fraction.
|
|
max_rate:
|
|
type: string
|
|
description: >-
|
|
max_rate defines the maximum commission rate which
|
|
validator can ever charge, as a fraction.
|
|
max_change_rate:
|
|
type: string
|
|
description: >-
|
|
max_change_rate defines the maximum daily increase of the
|
|
validator commission, as a fraction.
|
|
update_time:
|
|
type: string
|
|
format: date-time
|
|
description: update_time is the last time the commission rate was changed.
|
|
min_self_delegation:
|
|
type: string
|
|
description: >-
|
|
min_self_delegation is the validator's self declared minimum self
|
|
delegation.
|
|
description: >-
|
|
Validator defines a validator, together with the total amount of the
|
|
|
|
Validator's bond shares and their exchange rate to coins. Slashing
|
|
results in
|
|
|
|
a decrease in the exchange rate, allowing correct calculation of
|
|
future
|
|
|
|
undelegations without iterating over delegators. When coins are
|
|
delegated to
|
|
|
|
this validator, the validator is credited with a delegation whose
|
|
number of
|
|
|
|
bond shares is based on the amount of coins delegated divided by the
|
|
current
|
|
|
|
exchange rate. Voting power can be calculated as total bonded shares
|
|
|
|
multiplied by exchange rate.
|
|
title: QueryValidatorResponse is response type for the Query/Validator RPC method
|
|
cosmos.staking.v1beta1.QueryValidatorUnbondingDelegationsResponse:
|
|
type: object
|
|
properties:
|
|
unbonding_responses:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
description: >-
|
|
delegator_address is the bech32-encoded address of the
|
|
delegator.
|
|
validator_address:
|
|
type: string
|
|
description: >-
|
|
validator_address is the bech32-encoded address of the
|
|
validator.
|
|
entries:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
creation_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
creation_height is the height which the unbonding took
|
|
place.
|
|
completion_time:
|
|
type: string
|
|
format: date-time
|
|
description: completion_time is the unix time for unbonding completion.
|
|
initial_balance:
|
|
type: string
|
|
description: >-
|
|
initial_balance defines the tokens initially scheduled to
|
|
receive at completion.
|
|
balance:
|
|
type: string
|
|
description: balance defines the tokens to receive at completion.
|
|
description: >-
|
|
UnbondingDelegationEntry defines an unbonding object with
|
|
relevant metadata.
|
|
description: entries are the unbonding delegation entries.
|
|
description: >-
|
|
UnbondingDelegation stores all of a single delegator's unbonding
|
|
bonds
|
|
|
|
for a single validator in an time-ordered list.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
QueryValidatorUnbondingDelegationsResponse is response type for the
|
|
Query/ValidatorUnbondingDelegations RPC method.
|
|
cosmos.staking.v1beta1.QueryValidatorsResponse:
|
|
type: object
|
|
properties:
|
|
validators:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
operator_address:
|
|
type: string
|
|
description: >-
|
|
operator_address defines the address of the validator's
|
|
operator; bech encoded in JSON.
|
|
consensus_pubkey:
|
|
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"
|
|
}
|
|
jailed:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
jailed defined whether the validator has been jailed from bonded
|
|
status or not.
|
|
status:
|
|
description: status is the validator status (bonded/unbonding/unbonded).
|
|
type: string
|
|
enum:
|
|
- BOND_STATUS_UNSPECIFIED
|
|
- BOND_STATUS_UNBONDED
|
|
- BOND_STATUS_UNBONDING
|
|
- BOND_STATUS_BONDED
|
|
default: BOND_STATUS_UNSPECIFIED
|
|
tokens:
|
|
type: string
|
|
description: tokens define the delegated tokens (incl. self-delegation).
|
|
delegator_shares:
|
|
type: string
|
|
description: >-
|
|
delegator_shares defines total shares issued to a validator's
|
|
delegators.
|
|
description:
|
|
description: description defines the description terms for the validator.
|
|
type: object
|
|
properties:
|
|
moniker:
|
|
type: string
|
|
description: moniker defines a human-readable name for the validator.
|
|
identity:
|
|
type: string
|
|
description: >-
|
|
identity defines an optional identity signature (ex. UPort
|
|
or Keybase).
|
|
website:
|
|
type: string
|
|
description: website defines an optional website link.
|
|
security_contact:
|
|
type: string
|
|
description: >-
|
|
security_contact defines an optional email for security
|
|
contact.
|
|
details:
|
|
type: string
|
|
description: details define other optional details.
|
|
unbonding_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
unbonding_height defines, if unbonding, the height at which this
|
|
validator has begun unbonding.
|
|
unbonding_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
unbonding_time defines, if unbonding, the min time for the
|
|
validator to complete unbonding.
|
|
commission:
|
|
description: commission defines the commission parameters.
|
|
type: object
|
|
properties:
|
|
commission_rates:
|
|
description: >-
|
|
commission_rates defines the initial commission rates to be
|
|
used for creating a validator.
|
|
type: object
|
|
properties:
|
|
rate:
|
|
type: string
|
|
description: >-
|
|
rate is the commission rate charged to delegators, as a
|
|
fraction.
|
|
max_rate:
|
|
type: string
|
|
description: >-
|
|
max_rate defines the maximum commission rate which
|
|
validator can ever charge, as a fraction.
|
|
max_change_rate:
|
|
type: string
|
|
description: >-
|
|
max_change_rate defines the maximum daily increase of
|
|
the validator commission, as a fraction.
|
|
update_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
update_time is the last time the commission rate was
|
|
changed.
|
|
min_self_delegation:
|
|
type: string
|
|
description: >-
|
|
min_self_delegation is the validator's self declared minimum
|
|
self delegation.
|
|
description: >-
|
|
Validator defines a validator, together with the total amount of the
|
|
|
|
Validator's bond shares and their exchange rate to coins. Slashing
|
|
results in
|
|
|
|
a decrease in the exchange rate, allowing correct calculation of
|
|
future
|
|
|
|
undelegations without iterating over delegators. When coins are
|
|
delegated to
|
|
|
|
this validator, the validator is credited with a delegation whose
|
|
number of
|
|
|
|
bond shares is based on the amount of coins delegated divided by the
|
|
current
|
|
|
|
exchange rate. Voting power can be calculated as total bonded shares
|
|
|
|
multiplied by exchange rate.
|
|
description: validators contains all the queried validators.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
title: >-
|
|
QueryValidatorsResponse is response type for the Query/Validators RPC
|
|
method
|
|
cosmos.staking.v1beta1.Redelegation:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
description: delegator_address is the bech32-encoded address of the delegator.
|
|
validator_src_address:
|
|
type: string
|
|
description: >-
|
|
validator_src_address is the validator redelegation source operator
|
|
address.
|
|
validator_dst_address:
|
|
type: string
|
|
description: >-
|
|
validator_dst_address is the validator redelegation destination
|
|
operator address.
|
|
entries:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
creation_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
creation_height defines the height which the redelegation took
|
|
place.
|
|
completion_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
completion_time defines the unix time for redelegation
|
|
completion.
|
|
initial_balance:
|
|
type: string
|
|
description: >-
|
|
initial_balance defines the initial balance when redelegation
|
|
started.
|
|
shares_dst:
|
|
type: string
|
|
description: >-
|
|
shares_dst is the amount of destination-validator shares created
|
|
by redelegation.
|
|
description: >-
|
|
RedelegationEntry defines a redelegation object with relevant
|
|
metadata.
|
|
description: entries are the redelegation entries.
|
|
description: >-
|
|
Redelegation contains the list of a particular delegator's redelegating
|
|
bonds
|
|
|
|
from a particular source validator to a particular destination validator.
|
|
cosmos.staking.v1beta1.RedelegationEntry:
|
|
type: object
|
|
properties:
|
|
creation_height:
|
|
type: string
|
|
format: int64
|
|
description: creation_height defines the height which the redelegation took place.
|
|
completion_time:
|
|
type: string
|
|
format: date-time
|
|
description: completion_time defines the unix time for redelegation completion.
|
|
initial_balance:
|
|
type: string
|
|
description: initial_balance defines the initial balance when redelegation started.
|
|
shares_dst:
|
|
type: string
|
|
description: >-
|
|
shares_dst is the amount of destination-validator shares created by
|
|
redelegation.
|
|
description: RedelegationEntry defines a redelegation object with relevant metadata.
|
|
cosmos.staking.v1beta1.RedelegationEntryResponse:
|
|
type: object
|
|
properties:
|
|
redelegation_entry:
|
|
type: object
|
|
properties:
|
|
creation_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
creation_height defines the height which the redelegation took
|
|
place.
|
|
completion_time:
|
|
type: string
|
|
format: date-time
|
|
description: completion_time defines the unix time for redelegation completion.
|
|
initial_balance:
|
|
type: string
|
|
description: >-
|
|
initial_balance defines the initial balance when redelegation
|
|
started.
|
|
shares_dst:
|
|
type: string
|
|
description: >-
|
|
shares_dst is the amount of destination-validator shares created
|
|
by redelegation.
|
|
description: >-
|
|
RedelegationEntry defines a redelegation object with relevant
|
|
metadata.
|
|
balance:
|
|
type: string
|
|
description: >-
|
|
RedelegationEntryResponse is equivalent to a RedelegationEntry except that
|
|
it
|
|
|
|
contains a balance in addition to shares which is more suitable for client
|
|
|
|
responses.
|
|
cosmos.staking.v1beta1.RedelegationResponse:
|
|
type: object
|
|
properties:
|
|
redelegation:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
description: delegator_address is the bech32-encoded address of the delegator.
|
|
validator_src_address:
|
|
type: string
|
|
description: >-
|
|
validator_src_address is the validator redelegation source
|
|
operator address.
|
|
validator_dst_address:
|
|
type: string
|
|
description: >-
|
|
validator_dst_address is the validator redelegation destination
|
|
operator address.
|
|
entries:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
creation_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
creation_height defines the height which the redelegation
|
|
took place.
|
|
completion_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
completion_time defines the unix time for redelegation
|
|
completion.
|
|
initial_balance:
|
|
type: string
|
|
description: >-
|
|
initial_balance defines the initial balance when
|
|
redelegation started.
|
|
shares_dst:
|
|
type: string
|
|
description: >-
|
|
shares_dst is the amount of destination-validator shares
|
|
created by redelegation.
|
|
description: >-
|
|
RedelegationEntry defines a redelegation object with relevant
|
|
metadata.
|
|
description: entries are the redelegation entries.
|
|
description: >-
|
|
Redelegation contains the list of a particular delegator's
|
|
redelegating bonds
|
|
|
|
from a particular source validator to a particular destination
|
|
validator.
|
|
entries:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
redelegation_entry:
|
|
type: object
|
|
properties:
|
|
creation_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
creation_height defines the height which the redelegation
|
|
took place.
|
|
completion_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
completion_time defines the unix time for redelegation
|
|
completion.
|
|
initial_balance:
|
|
type: string
|
|
description: >-
|
|
initial_balance defines the initial balance when
|
|
redelegation started.
|
|
shares_dst:
|
|
type: string
|
|
description: >-
|
|
shares_dst is the amount of destination-validator shares
|
|
created by redelegation.
|
|
description: >-
|
|
RedelegationEntry defines a redelegation object with relevant
|
|
metadata.
|
|
balance:
|
|
type: string
|
|
description: >-
|
|
RedelegationEntryResponse is equivalent to a RedelegationEntry
|
|
except that it
|
|
|
|
contains a balance in addition to shares which is more suitable for
|
|
client
|
|
|
|
responses.
|
|
description: >-
|
|
RedelegationResponse is equivalent to a Redelegation except that its
|
|
entries
|
|
|
|
contain a balance in addition to shares which is more suitable for client
|
|
|
|
responses.
|
|
cosmos.staking.v1beta1.UnbondingDelegation:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
description: delegator_address is the bech32-encoded address of the delegator.
|
|
validator_address:
|
|
type: string
|
|
description: validator_address is the bech32-encoded address of the validator.
|
|
entries:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
creation_height:
|
|
type: string
|
|
format: int64
|
|
description: creation_height is the height which the unbonding took place.
|
|
completion_time:
|
|
type: string
|
|
format: date-time
|
|
description: completion_time is the unix time for unbonding completion.
|
|
initial_balance:
|
|
type: string
|
|
description: >-
|
|
initial_balance defines the tokens initially scheduled to
|
|
receive at completion.
|
|
balance:
|
|
type: string
|
|
description: balance defines the tokens to receive at completion.
|
|
description: >-
|
|
UnbondingDelegationEntry defines an unbonding object with relevant
|
|
metadata.
|
|
description: entries are the unbonding delegation entries.
|
|
description: |-
|
|
UnbondingDelegation stores all of a single delegator's unbonding bonds
|
|
for a single validator in an time-ordered list.
|
|
cosmos.staking.v1beta1.UnbondingDelegationEntry:
|
|
type: object
|
|
properties:
|
|
creation_height:
|
|
type: string
|
|
format: int64
|
|
description: creation_height is the height which the unbonding took place.
|
|
completion_time:
|
|
type: string
|
|
format: date-time
|
|
description: completion_time is the unix time for unbonding completion.
|
|
initial_balance:
|
|
type: string
|
|
description: >-
|
|
initial_balance defines the tokens initially scheduled to receive at
|
|
completion.
|
|
balance:
|
|
type: string
|
|
description: balance defines the tokens to receive at completion.
|
|
description: >-
|
|
UnbondingDelegationEntry defines an unbonding object with relevant
|
|
metadata.
|
|
cosmos.staking.v1beta1.Validator:
|
|
type: object
|
|
properties:
|
|
operator_address:
|
|
type: string
|
|
description: >-
|
|
operator_address defines the address of the validator's operator; bech
|
|
encoded in JSON.
|
|
consensus_pubkey:
|
|
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"
|
|
}
|
|
jailed:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
jailed defined whether the validator has been jailed from bonded
|
|
status or not.
|
|
status:
|
|
description: status is the validator status (bonded/unbonding/unbonded).
|
|
type: string
|
|
enum:
|
|
- BOND_STATUS_UNSPECIFIED
|
|
- BOND_STATUS_UNBONDED
|
|
- BOND_STATUS_UNBONDING
|
|
- BOND_STATUS_BONDED
|
|
default: BOND_STATUS_UNSPECIFIED
|
|
tokens:
|
|
type: string
|
|
description: tokens define the delegated tokens (incl. self-delegation).
|
|
delegator_shares:
|
|
type: string
|
|
description: >-
|
|
delegator_shares defines total shares issued to a validator's
|
|
delegators.
|
|
description:
|
|
description: description defines the description terms for the validator.
|
|
type: object
|
|
properties:
|
|
moniker:
|
|
type: string
|
|
description: moniker defines a human-readable name for the validator.
|
|
identity:
|
|
type: string
|
|
description: >-
|
|
identity defines an optional identity signature (ex. UPort or
|
|
Keybase).
|
|
website:
|
|
type: string
|
|
description: website defines an optional website link.
|
|
security_contact:
|
|
type: string
|
|
description: security_contact defines an optional email for security contact.
|
|
details:
|
|
type: string
|
|
description: details define other optional details.
|
|
unbonding_height:
|
|
type: string
|
|
format: int64
|
|
description: >-
|
|
unbonding_height defines, if unbonding, the height at which this
|
|
validator has begun unbonding.
|
|
unbonding_time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
unbonding_time defines, if unbonding, the min time for the validator
|
|
to complete unbonding.
|
|
commission:
|
|
description: commission defines the commission parameters.
|
|
type: object
|
|
properties:
|
|
commission_rates:
|
|
description: >-
|
|
commission_rates defines the initial commission rates to be used
|
|
for creating a validator.
|
|
type: object
|
|
properties:
|
|
rate:
|
|
type: string
|
|
description: >-
|
|
rate is the commission rate charged to delegators, as a
|
|
fraction.
|
|
max_rate:
|
|
type: string
|
|
description: >-
|
|
max_rate defines the maximum commission rate which validator
|
|
can ever charge, as a fraction.
|
|
max_change_rate:
|
|
type: string
|
|
description: >-
|
|
max_change_rate defines the maximum daily increase of the
|
|
validator commission, as a fraction.
|
|
update_time:
|
|
type: string
|
|
format: date-time
|
|
description: update_time is the last time the commission rate was changed.
|
|
min_self_delegation:
|
|
type: string
|
|
description: >-
|
|
min_self_delegation is the validator's self declared minimum self
|
|
delegation.
|
|
description: >-
|
|
Validator defines a validator, together with the total amount of the
|
|
|
|
Validator's bond shares and their exchange rate to coins. Slashing results
|
|
in
|
|
|
|
a decrease in the exchange rate, allowing correct calculation of future
|
|
|
|
undelegations without iterating over delegators. When coins are delegated
|
|
to
|
|
|
|
this validator, the validator is credited with a delegation whose number
|
|
of
|
|
|
|
bond shares is based on the amount of coins delegated divided by the
|
|
current
|
|
|
|
exchange rate. Voting power can be calculated as total bonded shares
|
|
|
|
multiplied by exchange rate.
|
|
cosmos.base.abci.v1beta1.ABCIMessageLog:
|
|
type: object
|
|
properties:
|
|
msg_index:
|
|
type: integer
|
|
format: int64
|
|
log:
|
|
type: string
|
|
events:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
description: >-
|
|
Attribute defines an attribute wrapper where the key and value
|
|
are
|
|
|
|
strings instead of raw bytes.
|
|
description: |-
|
|
StringEvent defines en Event object wrapper where all the attributes
|
|
contain key/value pairs that are strings instead of raw bytes.
|
|
description: |-
|
|
Events contains a slice of Event objects that were emitted during some
|
|
execution.
|
|
description: >-
|
|
ABCIMessageLog defines a structure containing an indexed tx ABCI message
|
|
log.
|
|
cosmos.base.abci.v1beta1.Attribute:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
description: |-
|
|
Attribute defines an attribute wrapper where the key and value are
|
|
strings instead of raw bytes.
|
|
cosmos.base.abci.v1beta1.GasInfo:
|
|
type: object
|
|
properties:
|
|
gas_wanted:
|
|
type: string
|
|
format: uint64
|
|
description: GasWanted is the maximum units of work we allow this tx to perform.
|
|
gas_used:
|
|
type: string
|
|
format: uint64
|
|
description: GasUsed is the amount of gas actually consumed.
|
|
description: GasInfo defines tx execution gas context.
|
|
cosmos.base.abci.v1beta1.Result:
|
|
type: object
|
|
properties:
|
|
data:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Data is any data returned from message or handler execution. It MUST
|
|
be
|
|
|
|
length prefixed in order to separate data from multiple message
|
|
executions.
|
|
log:
|
|
type: string
|
|
description: Log contains the log information from message or handler execution.
|
|
events:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
format: byte
|
|
value:
|
|
type: string
|
|
format: byte
|
|
index:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
EventAttribute is a single key-value pair, associated with an
|
|
event.
|
|
description: >-
|
|
Event allows application developers to attach additional information
|
|
to
|
|
|
|
ResponseBeginBlock, ResponseEndBlock, ResponseCheckTx and
|
|
ResponseDeliverTx.
|
|
|
|
Later, transactions may be queried using these events.
|
|
description: >-
|
|
Events contains a slice of Event objects that were emitted during
|
|
message
|
|
|
|
or handler execution.
|
|
description: Result is the union of ResponseFormat and ResponseCheckTx.
|
|
cosmos.base.abci.v1beta1.StringEvent:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
description: |-
|
|
Attribute defines an attribute wrapper where the key and value are
|
|
strings instead of raw bytes.
|
|
description: |-
|
|
StringEvent defines en Event object wrapper where all the attributes
|
|
contain key/value pairs that are strings instead of raw bytes.
|
|
cosmos.base.abci.v1beta1.TxResponse:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
title: The block height
|
|
txhash:
|
|
type: string
|
|
description: The transaction hash.
|
|
codespace:
|
|
type: string
|
|
title: Namespace for the Code
|
|
code:
|
|
type: integer
|
|
format: int64
|
|
description: Response code.
|
|
data:
|
|
type: string
|
|
description: Result bytes, if any.
|
|
raw_log:
|
|
type: string
|
|
description: |-
|
|
The output of the application's logger (raw string). May be
|
|
non-deterministic.
|
|
logs:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
msg_index:
|
|
type: integer
|
|
format: int64
|
|
log:
|
|
type: string
|
|
events:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
description: >-
|
|
Attribute defines an attribute wrapper where the key and
|
|
value are
|
|
|
|
strings instead of raw bytes.
|
|
description: >-
|
|
StringEvent defines en Event object wrapper where all the
|
|
attributes
|
|
|
|
contain key/value pairs that are strings instead of raw bytes.
|
|
description: >-
|
|
Events contains a slice of Event objects that were emitted
|
|
during some
|
|
|
|
execution.
|
|
description: >-
|
|
ABCIMessageLog defines a structure containing an indexed tx ABCI
|
|
message log.
|
|
description: >-
|
|
The output of the application's logger (typed). May be
|
|
non-deterministic.
|
|
info:
|
|
type: string
|
|
description: Additional information. May be non-deterministic.
|
|
gas_wanted:
|
|
type: string
|
|
format: int64
|
|
description: Amount of gas requested for transaction.
|
|
gas_used:
|
|
type: string
|
|
format: int64
|
|
description: Amount of gas consumed by transaction.
|
|
tx:
|
|
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"
|
|
}
|
|
timestamp:
|
|
type: string
|
|
description: >-
|
|
Time of the previous block. For heights > 1, it's the weighted median
|
|
of
|
|
|
|
the timestamps of the valid votes in the block.LastCommit. For height
|
|
== 1,
|
|
|
|
it's genesis time.
|
|
description: >-
|
|
TxResponse defines a structure containing relevant tx data and metadata.
|
|
The
|
|
|
|
tags are stringified and the log is JSON decoded.
|
|
cosmos.crypto.multisig.v1beta1.CompactBitArray:
|
|
type: object
|
|
properties:
|
|
extra_bits_stored:
|
|
type: integer
|
|
format: int64
|
|
elems:
|
|
type: string
|
|
format: byte
|
|
description: |-
|
|
CompactBitArray is an implementation of a space efficient bit array.
|
|
This is used to ensure that the encoded data takes up a minimal amount of
|
|
space after proto encoding.
|
|
This is not thread safe, and is not intended for concurrent usage.
|
|
cosmos.tx.signing.v1beta1.SignMode:
|
|
type: string
|
|
enum:
|
|
- SIGN_MODE_UNSPECIFIED
|
|
- SIGN_MODE_DIRECT
|
|
- SIGN_MODE_TEXTUAL
|
|
- SIGN_MODE_LEGACY_AMINO_JSON
|
|
default: SIGN_MODE_UNSPECIFIED
|
|
description: |-
|
|
SignMode represents a signing mode with its own security guarantees.
|
|
|
|
- SIGN_MODE_UNSPECIFIED: SIGN_MODE_UNSPECIFIED specifies an unknown signing mode and will be
|
|
rejected
|
|
- SIGN_MODE_DIRECT: SIGN_MODE_DIRECT specifies a signing mode which uses SignDoc and is
|
|
verified with raw bytes from Tx
|
|
- SIGN_MODE_TEXTUAL: SIGN_MODE_TEXTUAL is a future signing mode that will verify some
|
|
human-readable textual representation on top of the binary representation
|
|
from SIGN_MODE_DIRECT
|
|
- SIGN_MODE_LEGACY_AMINO_JSON: SIGN_MODE_LEGACY_AMINO_JSON is a backwards compatibility mode which uses
|
|
Amino JSON and will be removed in the future
|
|
cosmos.tx.v1beta1.AuthInfo:
|
|
type: object
|
|
properties:
|
|
signer_infos:
|
|
type: array
|
|
items:
|
|
$ref: '#/definitions/cosmos.tx.v1beta1.SignerInfo'
|
|
description: >-
|
|
signer_infos defines the signing modes for the required signers. The
|
|
number
|
|
|
|
and order of elements must match the required signers from TxBody's
|
|
|
|
messages. The first element is the primary signer and the one which
|
|
pays
|
|
|
|
the fee.
|
|
fee:
|
|
description: >-
|
|
Fee is the fee and gas limit for the transaction. The first signer is
|
|
the
|
|
|
|
primary signer and the one which pays the fee. The fee can be
|
|
calculated
|
|
|
|
based on the cost of evaluating the body and doing signature
|
|
verification
|
|
|
|
of the signers. This can be estimated via simulation.
|
|
type: object
|
|
properties:
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: >-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
|
|
NOTE: The amount field is an Int which implements the custom
|
|
method
|
|
|
|
signatures required by gogoproto.
|
|
title: amount is the amount of coins to be paid as a fee
|
|
gas_limit:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
gas_limit is the maximum gas that can be used in transaction
|
|
processing
|
|
|
|
before an out of gas error occurs
|
|
payer:
|
|
type: string
|
|
description: >-
|
|
if unset, the first signer is responsible for paying the fees. If
|
|
set, the specified account must pay the fees.
|
|
|
|
the payer must be a tx signer (and thus have signed this field in
|
|
AuthInfo).
|
|
|
|
setting this field does *not* change the ordering of required
|
|
signers for the transaction.
|
|
granter:
|
|
type: string
|
|
title: >-
|
|
if set, the fee payer (either the first signer or the value of the
|
|
payer field) requests that a fee grant be used
|
|
|
|
to pay fees instead of the fee payer's own balance. If an
|
|
appropriate fee grant does not exist or the chain does
|
|
|
|
not support fee grants, this will fail
|
|
description: |-
|
|
AuthInfo describes the fee and signer modes that are used to sign a
|
|
transaction.
|
|
cosmos.tx.v1beta1.BroadcastMode:
|
|
type: string
|
|
enum:
|
|
- BROADCAST_MODE_UNSPECIFIED
|
|
- BROADCAST_MODE_BLOCK
|
|
- BROADCAST_MODE_SYNC
|
|
- BROADCAST_MODE_ASYNC
|
|
default: BROADCAST_MODE_UNSPECIFIED
|
|
description: >-
|
|
BroadcastMode specifies the broadcast mode for the TxService.Broadcast RPC
|
|
method.
|
|
|
|
- BROADCAST_MODE_UNSPECIFIED: zero-value for mode ordering
|
|
- BROADCAST_MODE_BLOCK: BROADCAST_MODE_BLOCK defines a tx broadcasting mode where the client waits for
|
|
the tx to be committed in a block.
|
|
- BROADCAST_MODE_SYNC: BROADCAST_MODE_SYNC defines a tx broadcasting mode where the client waits for
|
|
a CheckTx execution response only.
|
|
- BROADCAST_MODE_ASYNC: BROADCAST_MODE_ASYNC defines a tx broadcasting mode where the client returns
|
|
immediately.
|
|
cosmos.tx.v1beta1.BroadcastTxRequest:
|
|
type: object
|
|
properties:
|
|
tx_bytes:
|
|
type: string
|
|
format: byte
|
|
description: tx_bytes is the raw transaction.
|
|
mode:
|
|
type: string
|
|
enum:
|
|
- BROADCAST_MODE_UNSPECIFIED
|
|
- BROADCAST_MODE_BLOCK
|
|
- BROADCAST_MODE_SYNC
|
|
- BROADCAST_MODE_ASYNC
|
|
default: BROADCAST_MODE_UNSPECIFIED
|
|
description: >-
|
|
BroadcastMode specifies the broadcast mode for the TxService.Broadcast
|
|
RPC method.
|
|
|
|
- BROADCAST_MODE_UNSPECIFIED: zero-value for mode ordering
|
|
- BROADCAST_MODE_BLOCK: BROADCAST_MODE_BLOCK defines a tx broadcasting mode where the client waits for
|
|
the tx to be committed in a block.
|
|
- BROADCAST_MODE_SYNC: BROADCAST_MODE_SYNC defines a tx broadcasting mode where the client waits for
|
|
a CheckTx execution response only.
|
|
- BROADCAST_MODE_ASYNC: BROADCAST_MODE_ASYNC defines a tx broadcasting mode where the client returns
|
|
immediately.
|
|
description: |-
|
|
BroadcastTxRequest is the request type for the Service.BroadcastTxRequest
|
|
RPC method.
|
|
cosmos.tx.v1beta1.BroadcastTxResponse:
|
|
type: object
|
|
properties:
|
|
tx_response:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
title: The block height
|
|
txhash:
|
|
type: string
|
|
description: The transaction hash.
|
|
codespace:
|
|
type: string
|
|
title: Namespace for the Code
|
|
code:
|
|
type: integer
|
|
format: int64
|
|
description: Response code.
|
|
data:
|
|
type: string
|
|
description: Result bytes, if any.
|
|
raw_log:
|
|
type: string
|
|
description: |-
|
|
The output of the application's logger (raw string). May be
|
|
non-deterministic.
|
|
logs:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
msg_index:
|
|
type: integer
|
|
format: int64
|
|
log:
|
|
type: string
|
|
events:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
description: >-
|
|
Attribute defines an attribute wrapper where the key
|
|
and value are
|
|
|
|
strings instead of raw bytes.
|
|
description: >-
|
|
StringEvent defines en Event object wrapper where all the
|
|
attributes
|
|
|
|
contain key/value pairs that are strings instead of raw
|
|
bytes.
|
|
description: >-
|
|
Events contains a slice of Event objects that were emitted
|
|
during some
|
|
|
|
execution.
|
|
description: >-
|
|
ABCIMessageLog defines a structure containing an indexed tx ABCI
|
|
message log.
|
|
description: >-
|
|
The output of the application's logger (typed). May be
|
|
non-deterministic.
|
|
info:
|
|
type: string
|
|
description: Additional information. May be non-deterministic.
|
|
gas_wanted:
|
|
type: string
|
|
format: int64
|
|
description: Amount of gas requested for transaction.
|
|
gas_used:
|
|
type: string
|
|
format: int64
|
|
description: Amount of gas consumed by transaction.
|
|
tx:
|
|
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"
|
|
}
|
|
timestamp:
|
|
type: string
|
|
description: >-
|
|
Time of the previous block. For heights > 1, it's the weighted
|
|
median of
|
|
|
|
the timestamps of the valid votes in the block.LastCommit. For
|
|
height == 1,
|
|
|
|
it's genesis time.
|
|
description: >-
|
|
TxResponse defines a structure containing relevant tx data and
|
|
metadata. The
|
|
|
|
tags are stringified and the log is JSON decoded.
|
|
description: |-
|
|
BroadcastTxResponse is the response type for the
|
|
Service.BroadcastTx method.
|
|
cosmos.tx.v1beta1.Fee:
|
|
type: object
|
|
properties:
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
amount:
|
|
type: string
|
|
description: |-
|
|
Coin defines a token with a denomination and an amount.
|
|
|
|
NOTE: The amount field is an Int which implements the custom method
|
|
signatures required by gogoproto.
|
|
title: amount is the amount of coins to be paid as a fee
|
|
gas_limit:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
gas_limit is the maximum gas that can be used in transaction
|
|
processing
|
|
|
|
before an out of gas error occurs
|
|
payer:
|
|
type: string
|
|
description: >-
|
|
if unset, the first signer is responsible for paying the fees. If set,
|
|
the specified account must pay the fees.
|
|
|
|
the payer must be a tx signer (and thus have signed this field in
|
|
AuthInfo).
|
|
|
|
setting this field does *not* change the ordering of required signers
|
|
for the transaction.
|
|
granter:
|
|
type: string
|
|
title: >-
|
|
if set, the fee payer (either the first signer or the value of the
|
|
payer field) requests that a fee grant be used
|
|
|
|
to pay fees instead of the fee payer's own balance. If an appropriate
|
|
fee grant does not exist or the chain does
|
|
|
|
not support fee grants, this will fail
|
|
description: >-
|
|
Fee includes the amount of coins paid in fees and the maximum
|
|
|
|
gas to be used by the transaction. The ratio yields an effective
|
|
"gasprice",
|
|
|
|
which must be above some miminum to be accepted into the mempool.
|
|
cosmos.tx.v1beta1.GetTxResponse:
|
|
type: object
|
|
properties:
|
|
tx:
|
|
$ref: '#/definitions/cosmos.tx.v1beta1.Tx'
|
|
description: tx is the queried transaction.
|
|
tx_response:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
title: The block height
|
|
txhash:
|
|
type: string
|
|
description: The transaction hash.
|
|
codespace:
|
|
type: string
|
|
title: Namespace for the Code
|
|
code:
|
|
type: integer
|
|
format: int64
|
|
description: Response code.
|
|
data:
|
|
type: string
|
|
description: Result bytes, if any.
|
|
raw_log:
|
|
type: string
|
|
description: |-
|
|
The output of the application's logger (raw string). May be
|
|
non-deterministic.
|
|
logs:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
msg_index:
|
|
type: integer
|
|
format: int64
|
|
log:
|
|
type: string
|
|
events:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
description: >-
|
|
Attribute defines an attribute wrapper where the key
|
|
and value are
|
|
|
|
strings instead of raw bytes.
|
|
description: >-
|
|
StringEvent defines en Event object wrapper where all the
|
|
attributes
|
|
|
|
contain key/value pairs that are strings instead of raw
|
|
bytes.
|
|
description: >-
|
|
Events contains a slice of Event objects that were emitted
|
|
during some
|
|
|
|
execution.
|
|
description: >-
|
|
ABCIMessageLog defines a structure containing an indexed tx ABCI
|
|
message log.
|
|
description: >-
|
|
The output of the application's logger (typed). May be
|
|
non-deterministic.
|
|
info:
|
|
type: string
|
|
description: Additional information. May be non-deterministic.
|
|
gas_wanted:
|
|
type: string
|
|
format: int64
|
|
description: Amount of gas requested for transaction.
|
|
gas_used:
|
|
type: string
|
|
format: int64
|
|
description: Amount of gas consumed by transaction.
|
|
tx:
|
|
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"
|
|
}
|
|
timestamp:
|
|
type: string
|
|
description: >-
|
|
Time of the previous block. For heights > 1, it's the weighted
|
|
median of
|
|
|
|
the timestamps of the valid votes in the block.LastCommit. For
|
|
height == 1,
|
|
|
|
it's genesis time.
|
|
description: >-
|
|
TxResponse defines a structure containing relevant tx data and
|
|
metadata. The
|
|
|
|
tags are stringified and the log is JSON decoded.
|
|
description: GetTxResponse is the response type for the Service.GetTx method.
|
|
cosmos.tx.v1beta1.GetTxsEventResponse:
|
|
type: object
|
|
properties:
|
|
txs:
|
|
type: array
|
|
items:
|
|
$ref: '#/definitions/cosmos.tx.v1beta1.Tx'
|
|
description: txs is the list of queried transactions.
|
|
tx_responses:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
title: The block height
|
|
txhash:
|
|
type: string
|
|
description: The transaction hash.
|
|
codespace:
|
|
type: string
|
|
title: Namespace for the Code
|
|
code:
|
|
type: integer
|
|
format: int64
|
|
description: Response code.
|
|
data:
|
|
type: string
|
|
description: Result bytes, if any.
|
|
raw_log:
|
|
type: string
|
|
description: |-
|
|
The output of the application's logger (raw string). May be
|
|
non-deterministic.
|
|
logs:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
msg_index:
|
|
type: integer
|
|
format: int64
|
|
log:
|
|
type: string
|
|
events:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
value:
|
|
type: string
|
|
description: >-
|
|
Attribute defines an attribute wrapper where the
|
|
key and value are
|
|
|
|
strings instead of raw bytes.
|
|
description: >-
|
|
StringEvent defines en Event object wrapper where all
|
|
the attributes
|
|
|
|
contain key/value pairs that are strings instead of raw
|
|
bytes.
|
|
description: >-
|
|
Events contains a slice of Event objects that were emitted
|
|
during some
|
|
|
|
execution.
|
|
description: >-
|
|
ABCIMessageLog defines a structure containing an indexed tx
|
|
ABCI message log.
|
|
description: >-
|
|
The output of the application's logger (typed). May be
|
|
non-deterministic.
|
|
info:
|
|
type: string
|
|
description: Additional information. May be non-deterministic.
|
|
gas_wanted:
|
|
type: string
|
|
format: int64
|
|
description: Amount of gas requested for transaction.
|
|
gas_used:
|
|
type: string
|
|
format: int64
|
|
description: Amount of gas consumed by transaction.
|
|
tx:
|
|
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"
|
|
}
|
|
timestamp:
|
|
type: string
|
|
description: >-
|
|
Time of the previous block. For heights > 1, it's the weighted
|
|
median of
|
|
|
|
the timestamps of the valid votes in the block.LastCommit. For
|
|
height == 1,
|
|
|
|
it's genesis time.
|
|
description: >-
|
|
TxResponse defines a structure containing relevant tx data and
|
|
metadata. The
|
|
|
|
tags are stringified and the log is JSON decoded.
|
|
description: tx_responses is the list of queried TxResponses.
|
|
pagination:
|
|
description: pagination defines an pagination for the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
GetTxsEventResponse is the response type for the Service.TxsByEvents
|
|
RPC method.
|
|
cosmos.tx.v1beta1.ModeInfo:
|
|
type: object
|
|
properties:
|
|
single:
|
|
title: single represents a single signer
|
|
type: object
|
|
properties:
|
|
mode:
|
|
title: mode is the signing mode of the single signer
|
|
type: string
|
|
enum:
|
|
- SIGN_MODE_UNSPECIFIED
|
|
- SIGN_MODE_DIRECT
|
|
- SIGN_MODE_TEXTUAL
|
|
- SIGN_MODE_LEGACY_AMINO_JSON
|
|
default: SIGN_MODE_UNSPECIFIED
|
|
description: >-
|
|
SignMode represents a signing mode with its own security
|
|
guarantees.
|
|
|
|
- SIGN_MODE_UNSPECIFIED: SIGN_MODE_UNSPECIFIED specifies an unknown signing mode and will be
|
|
rejected
|
|
- SIGN_MODE_DIRECT: SIGN_MODE_DIRECT specifies a signing mode which uses SignDoc and is
|
|
verified with raw bytes from Tx
|
|
- SIGN_MODE_TEXTUAL: SIGN_MODE_TEXTUAL is a future signing mode that will verify some
|
|
human-readable textual representation on top of the binary
|
|
representation
|
|
|
|
from SIGN_MODE_DIRECT
|
|
- SIGN_MODE_LEGACY_AMINO_JSON: SIGN_MODE_LEGACY_AMINO_JSON is a backwards compatibility mode which uses
|
|
Amino JSON and will be removed in the future
|
|
multi:
|
|
$ref: '#/definitions/cosmos.tx.v1beta1.ModeInfo.Multi'
|
|
title: multi represents a nested multisig signer
|
|
description: ModeInfo describes the signing mode of a single or nested multisig signer.
|
|
cosmos.tx.v1beta1.ModeInfo.Multi:
|
|
type: object
|
|
properties:
|
|
bitarray:
|
|
title: bitarray specifies which keys within the multisig are signing
|
|
type: object
|
|
properties:
|
|
extra_bits_stored:
|
|
type: integer
|
|
format: int64
|
|
elems:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
CompactBitArray is an implementation of a space efficient bit array.
|
|
|
|
This is used to ensure that the encoded data takes up a minimal amount
|
|
of
|
|
|
|
space after proto encoding.
|
|
|
|
This is not thread safe, and is not intended for concurrent usage.
|
|
mode_infos:
|
|
type: array
|
|
items:
|
|
$ref: '#/definitions/cosmos.tx.v1beta1.ModeInfo'
|
|
title: |-
|
|
mode_infos is the corresponding modes of the signers of the multisig
|
|
which could include nested multisig public keys
|
|
title: Multi is the mode info for a multisig public key
|
|
cosmos.tx.v1beta1.ModeInfo.Single:
|
|
type: object
|
|
properties:
|
|
mode:
|
|
title: mode is the signing mode of the single signer
|
|
type: string
|
|
enum:
|
|
- SIGN_MODE_UNSPECIFIED
|
|
- SIGN_MODE_DIRECT
|
|
- SIGN_MODE_TEXTUAL
|
|
- SIGN_MODE_LEGACY_AMINO_JSON
|
|
default: SIGN_MODE_UNSPECIFIED
|
|
description: >-
|
|
SignMode represents a signing mode with its own security guarantees.
|
|
|
|
- SIGN_MODE_UNSPECIFIED: SIGN_MODE_UNSPECIFIED specifies an unknown signing mode and will be
|
|
rejected
|
|
- SIGN_MODE_DIRECT: SIGN_MODE_DIRECT specifies a signing mode which uses SignDoc and is
|
|
verified with raw bytes from Tx
|
|
- SIGN_MODE_TEXTUAL: SIGN_MODE_TEXTUAL is a future signing mode that will verify some
|
|
human-readable textual representation on top of the binary
|
|
representation
|
|
|
|
from SIGN_MODE_DIRECT
|
|
- SIGN_MODE_LEGACY_AMINO_JSON: SIGN_MODE_LEGACY_AMINO_JSON is a backwards compatibility mode which uses
|
|
Amino JSON and will be removed in the future
|
|
title: |-
|
|
Single is the mode info for a single signer. It is structured as a message
|
|
to allow for additional fields such as locale for SIGN_MODE_TEXTUAL in the
|
|
future
|
|
cosmos.tx.v1beta1.OrderBy:
|
|
type: string
|
|
enum:
|
|
- ORDER_BY_UNSPECIFIED
|
|
- ORDER_BY_ASC
|
|
- ORDER_BY_DESC
|
|
default: ORDER_BY_UNSPECIFIED
|
|
description: >-
|
|
- ORDER_BY_UNSPECIFIED: ORDER_BY_UNSPECIFIED specifies an unknown sorting
|
|
order. OrderBy defaults to ASC in this case.
|
|
- ORDER_BY_ASC: ORDER_BY_ASC defines ascending order
|
|
- ORDER_BY_DESC: ORDER_BY_DESC defines descending order
|
|
title: OrderBy defines the sorting order
|
|
cosmos.tx.v1beta1.SignerInfo:
|
|
type: object
|
|
properties:
|
|
public_key:
|
|
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"
|
|
}
|
|
mode_info:
|
|
$ref: '#/definitions/cosmos.tx.v1beta1.ModeInfo'
|
|
title: |-
|
|
mode_info describes the signing mode of the signer and is a nested
|
|
structure to support nested multisig pubkey's
|
|
sequence:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
sequence is the sequence of the account, which describes the
|
|
|
|
number of committed transactions signed by a given address. It is used
|
|
to
|
|
|
|
prevent replay attacks.
|
|
description: |-
|
|
SignerInfo describes the public key and signing mode of a single top-level
|
|
signer.
|
|
cosmos.tx.v1beta1.SimulateRequest:
|
|
type: object
|
|
properties:
|
|
tx:
|
|
$ref: '#/definitions/cosmos.tx.v1beta1.Tx'
|
|
description: |-
|
|
tx is the transaction to simulate.
|
|
Deprecated. Send raw tx bytes instead.
|
|
tx_bytes:
|
|
type: string
|
|
format: byte
|
|
description: tx_bytes is the raw transaction.
|
|
description: |-
|
|
SimulateRequest is the request type for the Service.Simulate
|
|
RPC method.
|
|
cosmos.tx.v1beta1.SimulateResponse:
|
|
type: object
|
|
properties:
|
|
gas_info:
|
|
description: gas_info is the information about gas used in the simulation.
|
|
type: object
|
|
properties:
|
|
gas_wanted:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
GasWanted is the maximum units of work we allow this tx to
|
|
perform.
|
|
gas_used:
|
|
type: string
|
|
format: uint64
|
|
description: GasUsed is the amount of gas actually consumed.
|
|
result:
|
|
description: result is the result of the simulation.
|
|
type: object
|
|
properties:
|
|
data:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
Data is any data returned from message or handler execution. It
|
|
MUST be
|
|
|
|
length prefixed in order to separate data from multiple message
|
|
executions.
|
|
log:
|
|
type: string
|
|
description: >-
|
|
Log contains the log information from message or handler
|
|
execution.
|
|
events:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
format: byte
|
|
value:
|
|
type: string
|
|
format: byte
|
|
index:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
EventAttribute is a single key-value pair, associated with
|
|
an event.
|
|
description: >-
|
|
Event allows application developers to attach additional
|
|
information to
|
|
|
|
ResponseBeginBlock, ResponseEndBlock, ResponseCheckTx and
|
|
ResponseDeliverTx.
|
|
|
|
Later, transactions may be queried using these events.
|
|
description: >-
|
|
Events contains a slice of Event objects that were emitted during
|
|
message
|
|
|
|
or handler execution.
|
|
description: |-
|
|
SimulateResponse is the response type for the
|
|
Service.SimulateRPC method.
|
|
cosmos.tx.v1beta1.Tx:
|
|
type: object
|
|
properties:
|
|
body:
|
|
title: body is the processable content of the transaction
|
|
type: object
|
|
properties:
|
|
messages:
|
|
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"
|
|
}
|
|
description: >-
|
|
messages is a list of messages to be executed. The required
|
|
signers of
|
|
|
|
those messages define the number and order of elements in
|
|
AuthInfo's
|
|
|
|
signer_infos and Tx's signatures. Each required signer address is
|
|
added to
|
|
|
|
the list only the first time it occurs.
|
|
|
|
By convention, the first required signer (usually from the first
|
|
message)
|
|
|
|
is referred to as the primary signer and pays the fee for the
|
|
whole
|
|
|
|
transaction.
|
|
memo:
|
|
type: string
|
|
description: >-
|
|
memo is any arbitrary note/comment to be added to the transaction.
|
|
|
|
WARNING: in clients, any publicly exposed text should not be
|
|
called memo,
|
|
|
|
but should be called `note` instead (see
|
|
https://github.com/cosmos/cosmos-sdk/issues/9122).
|
|
timeout_height:
|
|
type: string
|
|
format: uint64
|
|
title: |-
|
|
timeout is the block height after which this transaction will not
|
|
be processed by the chain
|
|
extension_options:
|
|
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"
|
|
}
|
|
title: >-
|
|
extension_options are arbitrary options that can be added by
|
|
chains
|
|
|
|
when the default options are not sufficient. If any of these are
|
|
present
|
|
|
|
and can't be handled, the transaction will be rejected
|
|
non_critical_extension_options:
|
|
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"
|
|
}
|
|
title: >-
|
|
extension_options are arbitrary options that can be added by
|
|
chains
|
|
|
|
when the default options are not sufficient. If any of these are
|
|
present
|
|
|
|
and can't be handled, they will be ignored
|
|
description: TxBody is the body of a transaction that all signers sign over.
|
|
auth_info:
|
|
$ref: '#/definitions/cosmos.tx.v1beta1.AuthInfo'
|
|
title: |-
|
|
auth_info is the authorization related content of the transaction,
|
|
specifically signers, signer modes and fee
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
signatures is a list of signatures that matches the length and order
|
|
of
|
|
|
|
AuthInfo's signer_infos to allow connecting signature meta information
|
|
like
|
|
|
|
public key and signing mode by position.
|
|
description: Tx is the standard type used for broadcasting transactions.
|
|
cosmos.tx.v1beta1.TxBody:
|
|
type: object
|
|
properties:
|
|
messages:
|
|
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"
|
|
}
|
|
description: >-
|
|
messages is a list of messages to be executed. The required signers of
|
|
|
|
those messages define the number and order of elements in AuthInfo's
|
|
|
|
signer_infos and Tx's signatures. Each required signer address is
|
|
added to
|
|
|
|
the list only the first time it occurs.
|
|
|
|
By convention, the first required signer (usually from the first
|
|
message)
|
|
|
|
is referred to as the primary signer and pays the fee for the whole
|
|
|
|
transaction.
|
|
memo:
|
|
type: string
|
|
description: >-
|
|
memo is any arbitrary note/comment to be added to the transaction.
|
|
|
|
WARNING: in clients, any publicly exposed text should not be called
|
|
memo,
|
|
|
|
but should be called `note` instead (see
|
|
https://github.com/cosmos/cosmos-sdk/issues/9122).
|
|
timeout_height:
|
|
type: string
|
|
format: uint64
|
|
title: |-
|
|
timeout is the block height after which this transaction will not
|
|
be processed by the chain
|
|
extension_options:
|
|
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"
|
|
}
|
|
title: >-
|
|
extension_options are arbitrary options that can be added by chains
|
|
|
|
when the default options are not sufficient. If any of these are
|
|
present
|
|
|
|
and can't be handled, the transaction will be rejected
|
|
non_critical_extension_options:
|
|
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"
|
|
}
|
|
title: >-
|
|
extension_options are arbitrary options that can be added by chains
|
|
|
|
when the default options are not sufficient. If any of these are
|
|
present
|
|
|
|
and can't be handled, they will be ignored
|
|
description: TxBody is the body of a transaction that all signers sign over.
|
|
tendermint.abci.Event:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
attributes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
format: byte
|
|
value:
|
|
type: string
|
|
format: byte
|
|
index:
|
|
type: boolean
|
|
format: boolean
|
|
description: EventAttribute is a single key-value pair, associated with an event.
|
|
description: >-
|
|
Event allows application developers to attach additional information to
|
|
|
|
ResponseBeginBlock, ResponseEndBlock, ResponseCheckTx and
|
|
ResponseDeliverTx.
|
|
|
|
Later, transactions may be queried using these events.
|
|
tendermint.abci.EventAttribute:
|
|
type: object
|
|
properties:
|
|
key:
|
|
type: string
|
|
format: byte
|
|
value:
|
|
type: string
|
|
format: byte
|
|
index:
|
|
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:
|
|
name:
|
|
type: string
|
|
description: >-
|
|
Sets the name for the upgrade. This name will be used by the upgraded
|
|
|
|
version of the software to apply any special "on-upgrade" commands
|
|
during
|
|
|
|
the first BeginBlock method after the upgrade is applied. It is also
|
|
used
|
|
|
|
to detect whether a software version can handle a given upgrade. If no
|
|
|
|
upgrade handler with this name has been set in the software, it will
|
|
be
|
|
|
|
assumed that the software is out-of-date when the upgrade Time or
|
|
Height is
|
|
|
|
reached and the software will exit.
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
Deprecated: Time based upgrades have been deprecated. Time based
|
|
upgrade logic
|
|
|
|
has been removed from the SDK.
|
|
|
|
If this field is not empty, an error will be thrown.
|
|
height:
|
|
type: string
|
|
format: int64
|
|
description: |-
|
|
The height at which the upgrade must be performed.
|
|
Only used if Time is not set.
|
|
info:
|
|
type: string
|
|
title: |-
|
|
Any application specific upgrade info to be included on-chain
|
|
such as a git commit that validators could automatically upgrade to
|
|
upgraded_client_state:
|
|
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"
|
|
}
|
|
description: >-
|
|
Plan specifies information about a planned upgrade and when it should
|
|
occur.
|
|
cosmos.upgrade.v1beta1.QueryAppliedPlanResponse:
|
|
type: object
|
|
properties:
|
|
height:
|
|
type: string
|
|
format: int64
|
|
description: height is the block height at which the plan was applied.
|
|
description: >-
|
|
QueryAppliedPlanResponse is the response type for the Query/AppliedPlan
|
|
RPC
|
|
|
|
method.
|
|
cosmos.upgrade.v1beta1.QueryCurrentPlanResponse:
|
|
type: object
|
|
properties:
|
|
plan:
|
|
description: plan is the current upgrade plan.
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
description: >-
|
|
Sets the name for the upgrade. This name will be used by the
|
|
upgraded
|
|
|
|
version of the software to apply any special "on-upgrade" commands
|
|
during
|
|
|
|
the first BeginBlock method after the upgrade is applied. It is
|
|
also used
|
|
|
|
to detect whether a software version can handle a given upgrade.
|
|
If no
|
|
|
|
upgrade handler with this name has been set in the software, it
|
|
will be
|
|
|
|
assumed that the software is out-of-date when the upgrade Time or
|
|
Height is
|
|
|
|
reached and the software will exit.
|
|
time:
|
|
type: string
|
|
format: date-time
|
|
description: >-
|
|
Deprecated: Time based upgrades have been deprecated. Time based
|
|
upgrade logic
|
|
|
|
has been removed from the SDK.
|
|
|
|
If this field is not empty, an error will be thrown.
|
|
height:
|
|
type: string
|
|
format: int64
|
|
description: |-
|
|
The height at which the upgrade must be performed.
|
|
Only used if Time is not set.
|
|
info:
|
|
type: string
|
|
title: >-
|
|
Any application specific upgrade info to be included on-chain
|
|
|
|
such as a git commit that validators could automatically upgrade
|
|
to
|
|
upgraded_client_state:
|
|
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"
|
|
}
|
|
description: >-
|
|
QueryCurrentPlanResponse is the response type for the Query/CurrentPlan
|
|
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:
|
|
upgraded_consensus_state:
|
|
type: string
|
|
format: byte
|
|
description: >-
|
|
QueryUpgradedConsensusStateResponse is the response type for the
|
|
Query/UpgradedConsensusState
|
|
|
|
RPC method.
|
|
cosmos.authz.v1beta1.Grant:
|
|
type: object
|
|
properties:
|
|
authorization:
|
|
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"
|
|
}
|
|
expiration:
|
|
type: string
|
|
format: date-time
|
|
description: |-
|
|
Grant gives permissions to execute
|
|
the provide method with expiration time.
|
|
cosmos.authz.v1beta1.QueryGrantsResponse:
|
|
type: object
|
|
properties:
|
|
grants:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
authorization:
|
|
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"
|
|
}
|
|
expiration:
|
|
type: string
|
|
format: date-time
|
|
description: |-
|
|
Grant gives permissions to execute
|
|
the provide method with expiration time.
|
|
description: authorizations is a list of grants granted for grantee by granter.
|
|
pagination:
|
|
description: pagination defines an pagination for the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryGrantsResponse is the response type for the Query/Authorizations RPC
|
|
method.
|
|
cosmos.feegrant.v1beta1.Grant:
|
|
type: object
|
|
properties:
|
|
granter:
|
|
type: string
|
|
description: >-
|
|
granter is the address of the user granting an allowance of their
|
|
funds.
|
|
grantee:
|
|
type: string
|
|
description: >-
|
|
grantee is the address of the user being granted an allowance of
|
|
another user's funds.
|
|
allowance:
|
|
description: allowance can be any of basic and filtered fee allowance.
|
|
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.
|
|
title: Grant is stored in the KVStore to record a grant with full context
|
|
cosmos.feegrant.v1beta1.QueryAllowanceResponse:
|
|
type: object
|
|
properties:
|
|
allowance:
|
|
description: allowance is a allowance granted for grantee by granter.
|
|
type: object
|
|
properties:
|
|
granter:
|
|
type: string
|
|
description: >-
|
|
granter is the address of the user granting an allowance of their
|
|
funds.
|
|
grantee:
|
|
type: string
|
|
description: >-
|
|
grantee is the address of the user being granted an allowance of
|
|
another user's funds.
|
|
allowance:
|
|
description: allowance can be any of basic and filtered fee allowance.
|
|
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.
|
|
title: Grant is stored in the KVStore to record a grant with full context
|
|
description: >-
|
|
QueryAllowanceResponse is the response type for the Query/Allowance RPC
|
|
method.
|
|
cosmos.feegrant.v1beta1.QueryAllowancesResponse:
|
|
type: object
|
|
properties:
|
|
allowances:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
granter:
|
|
type: string
|
|
description: >-
|
|
granter is the address of the user granting an allowance of
|
|
their funds.
|
|
grantee:
|
|
type: string
|
|
description: >-
|
|
grantee is the address of the user being granted an allowance of
|
|
another user's funds.
|
|
allowance:
|
|
description: allowance can be any of basic and filtered fee allowance.
|
|
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.
|
|
title: Grant is stored in the KVStore to record a grant with full context
|
|
description: allowances are allowance's granted for grantee by granter.
|
|
pagination:
|
|
description: pagination defines an pagination for the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryAllowancesResponse is the response type for the Query/Allowances RPC
|
|
method.
|
|
ibc.applications.transfer.v1.DenomTrace:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
description: >-
|
|
path defines the chain of port/channel identifiers used for tracing
|
|
the
|
|
|
|
source of the fungible token.
|
|
base_denom:
|
|
type: string
|
|
description: base denomination of the relayed fungible token.
|
|
description: >-
|
|
DenomTrace contains the base denomination for ICS20 fungible tokens and
|
|
the
|
|
|
|
source tracing information path.
|
|
ibc.applications.transfer.v1.Params:
|
|
type: object
|
|
properties:
|
|
send_enabled:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
send_enabled enables or disables all cross-chain token transfers from
|
|
this
|
|
|
|
chain.
|
|
receive_enabled:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
receive_enabled enables or disables all cross-chain token transfers to
|
|
this
|
|
|
|
chain.
|
|
description: >-
|
|
Params defines the set of IBC transfer parameters.
|
|
|
|
NOTE: To prevent a single token from being transferred, set the
|
|
|
|
TransfersEnabled parameter to true and then set the bank module's
|
|
SendEnabled
|
|
|
|
parameter for the denomination to false.
|
|
ibc.applications.transfer.v1.QueryDenomTraceResponse:
|
|
type: object
|
|
properties:
|
|
denom_trace:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
description: >-
|
|
path defines the chain of port/channel identifiers used for
|
|
tracing the
|
|
|
|
source of the fungible token.
|
|
base_denom:
|
|
type: string
|
|
description: base denomination of the relayed fungible token.
|
|
description: >-
|
|
DenomTrace contains the base denomination for ICS20 fungible tokens
|
|
and the
|
|
|
|
source tracing information path.
|
|
description: |-
|
|
QueryDenomTraceResponse is the response type for the Query/DenomTrace RPC
|
|
method.
|
|
ibc.applications.transfer.v1.QueryDenomTracesResponse:
|
|
type: object
|
|
properties:
|
|
denom_traces:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
path:
|
|
type: string
|
|
description: >-
|
|
path defines the chain of port/channel identifiers used for
|
|
tracing the
|
|
|
|
source of the fungible token.
|
|
base_denom:
|
|
type: string
|
|
description: base denomination of the relayed fungible token.
|
|
description: >-
|
|
DenomTrace contains the base denomination for ICS20 fungible tokens
|
|
and the
|
|
|
|
source tracing information path.
|
|
description: denom_traces returns all denominations trace information.
|
|
pagination:
|
|
description: pagination defines the pagination in the response.
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: >-
|
|
QueryConnectionsResponse is the response type for the Query/DenomTraces
|
|
RPC
|
|
|
|
method.
|
|
ibc.applications.transfer.v1.QueryParamsResponse:
|
|
type: object
|
|
properties:
|
|
params:
|
|
description: params defines the parameters of the module.
|
|
type: object
|
|
properties:
|
|
send_enabled:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
send_enabled enables or disables all cross-chain token transfers
|
|
from this
|
|
|
|
chain.
|
|
receive_enabled:
|
|
type: boolean
|
|
format: boolean
|
|
description: >-
|
|
receive_enabled enables or disables all cross-chain token
|
|
transfers to this
|
|
|
|
chain.
|
|
description: QueryParamsResponse is the response type for the Query/Params RPC method.
|
|
ibc.core.client.v1.ConsensusStateWithHeight:
|
|
type: object
|
|
properties:
|
|
height:
|
|
title: consensus state height
|
|
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
|
|
consensus_state:
|
|
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"
|
|
}
|
|
title: consensus state
|
|
description: >-
|
|
ConsensusStateWithHeight defines a consensus state with an additional
|
|
height
|
|
|
|
field.
|
|
ibc.core.client.v1.Height:
|
|
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
|
|
title: >-
|
|
Height is a monotonically increasing data type
|
|
|
|
that can be compared against another Height for the purposes of updating
|
|
and
|
|
|
|
freezing clients
|
|
ibc.core.client.v1.IdentifiedClientState:
|
|
type: object
|
|
properties:
|
|
client_id:
|
|
type: string
|
|
title: client identifier
|
|
client_state:
|
|
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"
|
|
}
|
|
title: client state
|
|
description: |-
|
|
IdentifiedClientState defines a client state with an additional client
|
|
identifier field.
|
|
ibc.core.client.v1.Params:
|
|
type: object
|
|
properties:
|
|
allowed_clients:
|
|
type: array
|
|
items:
|
|
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:
|
|
client_state:
|
|
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"
|
|
}
|
|
title: client state associated with the request identifier
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
description: >-
|
|
QueryClientStateResponse is the response type for the Query/ClientState
|
|
RPC
|
|
|
|
method. Besides the client state, it includes a proof and the height from
|
|
|
|
which the proof was retrieved.
|
|
ibc.core.client.v1.QueryClientStatesResponse:
|
|
type: object
|
|
properties:
|
|
client_states:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
client_id:
|
|
type: string
|
|
title: client identifier
|
|
client_state:
|
|
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"
|
|
}
|
|
title: client state
|
|
description: >-
|
|
IdentifiedClientState defines a client state with an additional
|
|
client
|
|
|
|
identifier field.
|
|
description: list of stored ClientStates of the chain.
|
|
pagination:
|
|
title: pagination response
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
PageResponse is to be embedded in gRPC response messages where the
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
description: >-
|
|
QueryClientStatesResponse is the response type for the Query/ClientStates
|
|
RPC
|
|
|
|
method.
|
|
ibc.core.client.v1.QueryClientStatusResponse:
|
|
type: object
|
|
properties:
|
|
status:
|
|
type: string
|
|
description: >-
|
|
QueryClientStatusResponse is the response type for the Query/ClientStatus
|
|
RPC
|
|
|
|
method. It returns the current status of the IBC client.
|
|
ibc.core.client.v1.QueryConsensusStateResponse:
|
|
type: object
|
|
properties:
|
|
consensus_state:
|
|
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"
|
|
}
|
|
title: >-
|
|
consensus state associated with the client identifier at the given
|
|
height
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
title: >-
|
|
QueryConsensusStateResponse is the response type for the
|
|
Query/ConsensusState
|
|
|
|
RPC method
|
|
ibc.core.client.v1.QueryConsensusStatesResponse:
|
|
type: object
|
|
properties:
|
|
consensus_states:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
height:
|
|
title: consensus state height
|
|
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
|
|
consensus_state:
|
|
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"
|
|
}
|
|
title: consensus state
|
|
description: >-
|
|
ConsensusStateWithHeight defines a consensus state with an
|
|
additional height
|
|
|
|
field.
|
|
title: consensus states associated with the identifier
|
|
pagination:
|
|
title: pagination response
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
PageResponse is to be embedded in gRPC response messages where the
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
title: |-
|
|
QueryConsensusStatesResponse is the response type for the
|
|
Query/ConsensusStates RPC method
|
|
ibc.core.client.v1.QueryUpgradedClientStateResponse:
|
|
type: object
|
|
properties:
|
|
upgraded_client_state:
|
|
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"
|
|
}
|
|
title: client state associated with the request identifier
|
|
description: |-
|
|
QueryUpgradedClientStateResponse is the response type for the
|
|
Query/UpgradedClientState RPC method.
|
|
ibc.core.client.v1.QueryUpgradedConsensusStateResponse:
|
|
type: object
|
|
properties:
|
|
upgraded_consensus_state:
|
|
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"
|
|
}
|
|
title: Consensus state associated with the request identifier
|
|
description: |-
|
|
QueryUpgradedConsensusStateResponse is the response type for the
|
|
Query/UpgradedConsensusState RPC method.
|
|
ibc.core.commitment.v1.MerklePrefix:
|
|
type: object
|
|
properties:
|
|
key_prefix:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
MerklePrefix is merkle path prefixed to the key.
|
|
The constructed key from the Path and the key will be append(Path.KeyPath,
|
|
append(Path.KeyPrefix, key...))
|
|
ibc.core.connection.v1.ConnectionEnd:
|
|
type: object
|
|
properties:
|
|
client_id:
|
|
type: string
|
|
description: client associated with this connection.
|
|
versions:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
identifier:
|
|
type: string
|
|
title: unique version identifier
|
|
features:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: list of features compatible with the specified identifier
|
|
description: >-
|
|
Version defines the versioning scheme used to negotiate the IBC
|
|
verison in
|
|
|
|
the connection handshake.
|
|
description: >-
|
|
IBC version which can be utilised to determine encodings or protocols
|
|
for
|
|
|
|
channels or packets utilising this connection.
|
|
state:
|
|
description: current state of the connection end.
|
|
type: string
|
|
enum:
|
|
- STATE_UNINITIALIZED_UNSPECIFIED
|
|
- STATE_INIT
|
|
- STATE_TRYOPEN
|
|
- STATE_OPEN
|
|
default: STATE_UNINITIALIZED_UNSPECIFIED
|
|
counterparty:
|
|
description: counterparty chain associated with this connection.
|
|
type: object
|
|
properties:
|
|
client_id:
|
|
type: string
|
|
description: >-
|
|
identifies the client on the counterparty chain associated with a
|
|
given
|
|
|
|
connection.
|
|
connection_id:
|
|
type: string
|
|
description: >-
|
|
identifies the connection end on the counterparty chain associated
|
|
with a
|
|
|
|
given connection.
|
|
prefix:
|
|
description: commitment merkle prefix of the counterparty chain.
|
|
type: object
|
|
properties:
|
|
key_prefix:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
MerklePrefix is merkle path prefixed to the key.
|
|
|
|
The constructed key from the Path and the key will be
|
|
append(Path.KeyPath,
|
|
|
|
append(Path.KeyPrefix, key...))
|
|
delay_period:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
delay period that must pass before a consensus state can be used for
|
|
|
|
packet-verification NOTE: delay period logic is only implemented by
|
|
some
|
|
|
|
clients.
|
|
description: |-
|
|
ConnectionEnd defines a stateful object on a chain connected to another
|
|
separate one.
|
|
NOTE: there must only be 2 defined ConnectionEnds to establish
|
|
a connection between two chains.
|
|
ibc.core.connection.v1.Counterparty:
|
|
type: object
|
|
properties:
|
|
client_id:
|
|
type: string
|
|
description: >-
|
|
identifies the client on the counterparty chain associated with a
|
|
given
|
|
|
|
connection.
|
|
connection_id:
|
|
type: string
|
|
description: >-
|
|
identifies the connection end on the counterparty chain associated
|
|
with a
|
|
|
|
given connection.
|
|
prefix:
|
|
description: commitment merkle prefix of the counterparty chain.
|
|
type: object
|
|
properties:
|
|
key_prefix:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
MerklePrefix is merkle path prefixed to the key.
|
|
|
|
The constructed key from the Path and the key will be
|
|
append(Path.KeyPath,
|
|
|
|
append(Path.KeyPrefix, key...))
|
|
description: >-
|
|
Counterparty defines the counterparty chain associated with a connection
|
|
end.
|
|
ibc.core.connection.v1.IdentifiedConnection:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: connection identifier.
|
|
client_id:
|
|
type: string
|
|
description: client associated with this connection.
|
|
versions:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
identifier:
|
|
type: string
|
|
title: unique version identifier
|
|
features:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: list of features compatible with the specified identifier
|
|
description: >-
|
|
Version defines the versioning scheme used to negotiate the IBC
|
|
verison in
|
|
|
|
the connection handshake.
|
|
title: >-
|
|
IBC version which can be utilised to determine encodings or protocols
|
|
for
|
|
|
|
channels or packets utilising this connection
|
|
state:
|
|
description: current state of the connection end.
|
|
type: string
|
|
enum:
|
|
- STATE_UNINITIALIZED_UNSPECIFIED
|
|
- STATE_INIT
|
|
- STATE_TRYOPEN
|
|
- STATE_OPEN
|
|
default: STATE_UNINITIALIZED_UNSPECIFIED
|
|
counterparty:
|
|
description: counterparty chain associated with this connection.
|
|
type: object
|
|
properties:
|
|
client_id:
|
|
type: string
|
|
description: >-
|
|
identifies the client on the counterparty chain associated with a
|
|
given
|
|
|
|
connection.
|
|
connection_id:
|
|
type: string
|
|
description: >-
|
|
identifies the connection end on the counterparty chain associated
|
|
with a
|
|
|
|
given connection.
|
|
prefix:
|
|
description: commitment merkle prefix of the counterparty chain.
|
|
type: object
|
|
properties:
|
|
key_prefix:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
MerklePrefix is merkle path prefixed to the key.
|
|
|
|
The constructed key from the Path and the key will be
|
|
append(Path.KeyPath,
|
|
|
|
append(Path.KeyPrefix, key...))
|
|
delay_period:
|
|
type: string
|
|
format: uint64
|
|
description: delay period associated with this connection.
|
|
description: |-
|
|
IdentifiedConnection defines a connection with additional connection
|
|
identifier field.
|
|
ibc.core.connection.v1.QueryClientConnectionsResponse:
|
|
type: object
|
|
properties:
|
|
connection_paths:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: slice of all the connection paths associated with a client.
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was generated
|
|
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
|
|
title: |-
|
|
QueryClientConnectionsResponse is the response type for the
|
|
Query/ClientConnections RPC method
|
|
ibc.core.connection.v1.QueryConnectionClientStateResponse:
|
|
type: object
|
|
properties:
|
|
identified_client_state:
|
|
title: client state associated with the channel
|
|
type: object
|
|
properties:
|
|
client_id:
|
|
type: string
|
|
title: client identifier
|
|
client_state:
|
|
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"
|
|
}
|
|
title: client state
|
|
description: |-
|
|
IdentifiedClientState defines a client state with an additional client
|
|
identifier field.
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
title: |-
|
|
QueryConnectionClientStateResponse is the response type for the
|
|
Query/ConnectionClientState RPC method
|
|
ibc.core.connection.v1.QueryConnectionConsensusStateResponse:
|
|
type: object
|
|
properties:
|
|
consensus_state:
|
|
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"
|
|
}
|
|
title: consensus state associated with the channel
|
|
client_id:
|
|
type: string
|
|
title: client ID associated with the consensus state
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
title: |-
|
|
QueryConnectionConsensusStateResponse is the response type for the
|
|
Query/ConnectionConsensusState RPC method
|
|
ibc.core.connection.v1.QueryConnectionResponse:
|
|
type: object
|
|
properties:
|
|
connection:
|
|
title: connection associated with the request identifier
|
|
type: object
|
|
properties:
|
|
client_id:
|
|
type: string
|
|
description: client associated with this connection.
|
|
versions:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
identifier:
|
|
type: string
|
|
title: unique version identifier
|
|
features:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: list of features compatible with the specified identifier
|
|
description: >-
|
|
Version defines the versioning scheme used to negotiate the IBC
|
|
verison in
|
|
|
|
the connection handshake.
|
|
description: >-
|
|
IBC version which can be utilised to determine encodings or
|
|
protocols for
|
|
|
|
channels or packets utilising this connection.
|
|
state:
|
|
description: current state of the connection end.
|
|
type: string
|
|
enum:
|
|
- STATE_UNINITIALIZED_UNSPECIFIED
|
|
- STATE_INIT
|
|
- STATE_TRYOPEN
|
|
- STATE_OPEN
|
|
default: STATE_UNINITIALIZED_UNSPECIFIED
|
|
counterparty:
|
|
description: counterparty chain associated with this connection.
|
|
type: object
|
|
properties:
|
|
client_id:
|
|
type: string
|
|
description: >-
|
|
identifies the client on the counterparty chain associated
|
|
with a given
|
|
|
|
connection.
|
|
connection_id:
|
|
type: string
|
|
description: >-
|
|
identifies the connection end on the counterparty chain
|
|
associated with a
|
|
|
|
given connection.
|
|
prefix:
|
|
description: commitment merkle prefix of the counterparty chain.
|
|
type: object
|
|
properties:
|
|
key_prefix:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
MerklePrefix is merkle path prefixed to the key.
|
|
|
|
The constructed key from the Path and the key will be
|
|
append(Path.KeyPath,
|
|
|
|
append(Path.KeyPrefix, key...))
|
|
delay_period:
|
|
type: string
|
|
format: uint64
|
|
description: >-
|
|
delay period that must pass before a consensus state can be used
|
|
for
|
|
|
|
packet-verification NOTE: delay period logic is only implemented
|
|
by some
|
|
|
|
clients.
|
|
description: >-
|
|
ConnectionEnd defines a stateful object on a chain connected to
|
|
another
|
|
|
|
separate one.
|
|
|
|
NOTE: there must only be 2 defined ConnectionEnds to establish
|
|
|
|
a connection between two chains.
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
description: >-
|
|
QueryConnectionResponse is the response type for the Query/Connection RPC
|
|
|
|
method. Besides the connection end, it includes a proof and the height
|
|
from
|
|
|
|
which the proof was retrieved.
|
|
ibc.core.connection.v1.QueryConnectionsResponse:
|
|
type: object
|
|
properties:
|
|
connections:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: connection identifier.
|
|
client_id:
|
|
type: string
|
|
description: client associated with this connection.
|
|
versions:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
identifier:
|
|
type: string
|
|
title: unique version identifier
|
|
features:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: list of features compatible with the specified identifier
|
|
description: >-
|
|
Version defines the versioning scheme used to negotiate the
|
|
IBC verison in
|
|
|
|
the connection handshake.
|
|
title: >-
|
|
IBC version which can be utilised to determine encodings or
|
|
protocols for
|
|
|
|
channels or packets utilising this connection
|
|
state:
|
|
description: current state of the connection end.
|
|
type: string
|
|
enum:
|
|
- STATE_UNINITIALIZED_UNSPECIFIED
|
|
- STATE_INIT
|
|
- STATE_TRYOPEN
|
|
- STATE_OPEN
|
|
default: STATE_UNINITIALIZED_UNSPECIFIED
|
|
counterparty:
|
|
description: counterparty chain associated with this connection.
|
|
type: object
|
|
properties:
|
|
client_id:
|
|
type: string
|
|
description: >-
|
|
identifies the client on the counterparty chain associated
|
|
with a given
|
|
|
|
connection.
|
|
connection_id:
|
|
type: string
|
|
description: >-
|
|
identifies the connection end on the counterparty chain
|
|
associated with a
|
|
|
|
given connection.
|
|
prefix:
|
|
description: commitment merkle prefix of the counterparty chain.
|
|
type: object
|
|
properties:
|
|
key_prefix:
|
|
type: string
|
|
format: byte
|
|
title: >-
|
|
MerklePrefix is merkle path prefixed to the key.
|
|
|
|
The constructed key from the Path and the key will be
|
|
append(Path.KeyPath,
|
|
|
|
append(Path.KeyPrefix, key...))
|
|
delay_period:
|
|
type: string
|
|
format: uint64
|
|
description: delay period associated with this connection.
|
|
description: |-
|
|
IdentifiedConnection defines a connection with additional connection
|
|
identifier field.
|
|
description: list of stored connections of the chain.
|
|
pagination:
|
|
title: pagination response
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
PageResponse is to be embedded in gRPC response messages where the
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
height:
|
|
title: query block height
|
|
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
|
|
description: >-
|
|
QueryConnectionsResponse is the response type for the Query/Connections
|
|
RPC
|
|
|
|
method.
|
|
ibc.core.connection.v1.State:
|
|
type: string
|
|
enum:
|
|
- STATE_UNINITIALIZED_UNSPECIFIED
|
|
- STATE_INIT
|
|
- STATE_TRYOPEN
|
|
- STATE_OPEN
|
|
default: STATE_UNINITIALIZED_UNSPECIFIED
|
|
description: |-
|
|
State defines if a connection is in one of the following states:
|
|
INIT, TRYOPEN, OPEN or UNINITIALIZED.
|
|
|
|
- STATE_UNINITIALIZED_UNSPECIFIED: Default State
|
|
- STATE_INIT: A connection end has just started the opening handshake.
|
|
- STATE_TRYOPEN: A connection end has acknowledged the handshake step on the counterparty
|
|
chain.
|
|
- STATE_OPEN: A connection end has completed the handshake.
|
|
ibc.core.connection.v1.Version:
|
|
type: object
|
|
properties:
|
|
identifier:
|
|
type: string
|
|
title: unique version identifier
|
|
features:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: list of features compatible with the specified identifier
|
|
description: |-
|
|
Version defines the versioning scheme used to negotiate the IBC verison in
|
|
the connection handshake.
|
|
ibc.core.channel.v1.Channel:
|
|
type: object
|
|
properties:
|
|
state:
|
|
title: current state of the channel end
|
|
type: string
|
|
enum:
|
|
- STATE_UNINITIALIZED_UNSPECIFIED
|
|
- STATE_INIT
|
|
- STATE_TRYOPEN
|
|
- STATE_OPEN
|
|
- STATE_CLOSED
|
|
default: STATE_UNINITIALIZED_UNSPECIFIED
|
|
description: |-
|
|
State defines if a channel is in one of the following states:
|
|
CLOSED, INIT, TRYOPEN, OPEN or UNINITIALIZED.
|
|
|
|
- STATE_UNINITIALIZED_UNSPECIFIED: Default State
|
|
- STATE_INIT: A channel has just started the opening handshake.
|
|
- STATE_TRYOPEN: A channel has acknowledged the handshake step on the counterparty chain.
|
|
- STATE_OPEN: A channel has completed the handshake. Open channels are
|
|
ready to send and receive packets.
|
|
- STATE_CLOSED: A channel has been closed and can no longer be used to send or receive
|
|
packets.
|
|
ordering:
|
|
title: whether the channel is ordered or unordered
|
|
type: string
|
|
enum:
|
|
- ORDER_NONE_UNSPECIFIED
|
|
- ORDER_UNORDERED
|
|
- ORDER_ORDERED
|
|
default: ORDER_NONE_UNSPECIFIED
|
|
description: |-
|
|
- ORDER_NONE_UNSPECIFIED: zero-value for channel ordering
|
|
- ORDER_UNORDERED: packets can be delivered in any order, which may differ from the order in
|
|
which they were sent.
|
|
- ORDER_ORDERED: packets are delivered exactly in the order which they were sent
|
|
counterparty:
|
|
title: counterparty channel end
|
|
type: object
|
|
properties:
|
|
port_id:
|
|
type: string
|
|
description: >-
|
|
port on the counterparty chain which owns the other end of the
|
|
channel.
|
|
channel_id:
|
|
type: string
|
|
title: channel end on the counterparty chain
|
|
connection_hops:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: |-
|
|
list of connection identifiers, in order, along which packets sent on
|
|
this channel will travel
|
|
version:
|
|
type: string
|
|
title: opaque channel version, which is agreed upon during the handshake
|
|
description: |-
|
|
Channel defines pipeline for exactly-once packet delivery between specific
|
|
modules on separate blockchains, which has at least one end capable of
|
|
sending packets and one end capable of receiving packets.
|
|
ibc.core.channel.v1.Counterparty:
|
|
type: object
|
|
properties:
|
|
port_id:
|
|
type: string
|
|
description: >-
|
|
port on the counterparty chain which owns the other end of the
|
|
channel.
|
|
channel_id:
|
|
type: string
|
|
title: channel end on the counterparty chain
|
|
title: Counterparty defines a channel end counterparty
|
|
ibc.core.channel.v1.IdentifiedChannel:
|
|
type: object
|
|
properties:
|
|
state:
|
|
title: current state of the channel end
|
|
type: string
|
|
enum:
|
|
- STATE_UNINITIALIZED_UNSPECIFIED
|
|
- STATE_INIT
|
|
- STATE_TRYOPEN
|
|
- STATE_OPEN
|
|
- STATE_CLOSED
|
|
default: STATE_UNINITIALIZED_UNSPECIFIED
|
|
description: |-
|
|
State defines if a channel is in one of the following states:
|
|
CLOSED, INIT, TRYOPEN, OPEN or UNINITIALIZED.
|
|
|
|
- STATE_UNINITIALIZED_UNSPECIFIED: Default State
|
|
- STATE_INIT: A channel has just started the opening handshake.
|
|
- STATE_TRYOPEN: A channel has acknowledged the handshake step on the counterparty chain.
|
|
- STATE_OPEN: A channel has completed the handshake. Open channels are
|
|
ready to send and receive packets.
|
|
- STATE_CLOSED: A channel has been closed and can no longer be used to send or receive
|
|
packets.
|
|
ordering:
|
|
title: whether the channel is ordered or unordered
|
|
type: string
|
|
enum:
|
|
- ORDER_NONE_UNSPECIFIED
|
|
- ORDER_UNORDERED
|
|
- ORDER_ORDERED
|
|
default: ORDER_NONE_UNSPECIFIED
|
|
description: |-
|
|
- ORDER_NONE_UNSPECIFIED: zero-value for channel ordering
|
|
- ORDER_UNORDERED: packets can be delivered in any order, which may differ from the order in
|
|
which they were sent.
|
|
- ORDER_ORDERED: packets are delivered exactly in the order which they were sent
|
|
counterparty:
|
|
title: counterparty channel end
|
|
type: object
|
|
properties:
|
|
port_id:
|
|
type: string
|
|
description: >-
|
|
port on the counterparty chain which owns the other end of the
|
|
channel.
|
|
channel_id:
|
|
type: string
|
|
title: channel end on the counterparty chain
|
|
connection_hops:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: |-
|
|
list of connection identifiers, in order, along which packets sent on
|
|
this channel will travel
|
|
version:
|
|
type: string
|
|
title: opaque channel version, which is agreed upon during the handshake
|
|
port_id:
|
|
type: string
|
|
title: port identifier
|
|
channel_id:
|
|
type: string
|
|
title: channel identifier
|
|
description: |-
|
|
IdentifiedChannel defines a channel with additional port and channel
|
|
identifier fields.
|
|
ibc.core.channel.v1.Order:
|
|
type: string
|
|
enum:
|
|
- ORDER_NONE_UNSPECIFIED
|
|
- ORDER_UNORDERED
|
|
- ORDER_ORDERED
|
|
default: ORDER_NONE_UNSPECIFIED
|
|
description: |-
|
|
- ORDER_NONE_UNSPECIFIED: zero-value for channel ordering
|
|
- ORDER_UNORDERED: packets can be delivered in any order, which may differ from the order in
|
|
which they were sent.
|
|
- ORDER_ORDERED: packets are delivered exactly in the order which they were sent
|
|
title: Order defines if a channel is ORDERED or UNORDERED
|
|
ibc.core.channel.v1.PacketState:
|
|
type: object
|
|
properties:
|
|
port_id:
|
|
type: string
|
|
description: channel port identifier.
|
|
channel_id:
|
|
type: string
|
|
description: channel unique identifier.
|
|
sequence:
|
|
type: string
|
|
format: uint64
|
|
description: packet sequence.
|
|
data:
|
|
type: string
|
|
format: byte
|
|
description: embedded data that represents packet state.
|
|
description: |-
|
|
PacketState defines the generic type necessary to retrieve and store
|
|
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.QueryChannelClientStateResponse:
|
|
type: object
|
|
properties:
|
|
identified_client_state:
|
|
title: client state associated with the channel
|
|
type: object
|
|
properties:
|
|
client_id:
|
|
type: string
|
|
title: client identifier
|
|
client_state:
|
|
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"
|
|
}
|
|
title: client state
|
|
description: |-
|
|
IdentifiedClientState defines a client state with an additional client
|
|
identifier field.
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
title: |-
|
|
QueryChannelClientStateResponse is the Response type for the
|
|
Query/QueryChannelClientState RPC method
|
|
ibc.core.channel.v1.QueryChannelConsensusStateResponse:
|
|
type: object
|
|
properties:
|
|
consensus_state:
|
|
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"
|
|
}
|
|
title: consensus state associated with the channel
|
|
client_id:
|
|
type: string
|
|
title: client ID associated with the consensus state
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
title: |-
|
|
QueryChannelClientStateResponse is the Response type for the
|
|
Query/QueryChannelClientState RPC method
|
|
ibc.core.channel.v1.QueryChannelResponse:
|
|
type: object
|
|
properties:
|
|
channel:
|
|
title: channel associated with the request identifiers
|
|
type: object
|
|
properties:
|
|
state:
|
|
title: current state of the channel end
|
|
type: string
|
|
enum:
|
|
- STATE_UNINITIALIZED_UNSPECIFIED
|
|
- STATE_INIT
|
|
- STATE_TRYOPEN
|
|
- STATE_OPEN
|
|
- STATE_CLOSED
|
|
default: STATE_UNINITIALIZED_UNSPECIFIED
|
|
description: |-
|
|
State defines if a channel is in one of the following states:
|
|
CLOSED, INIT, TRYOPEN, OPEN or UNINITIALIZED.
|
|
|
|
- STATE_UNINITIALIZED_UNSPECIFIED: Default State
|
|
- STATE_INIT: A channel has just started the opening handshake.
|
|
- STATE_TRYOPEN: A channel has acknowledged the handshake step on the counterparty chain.
|
|
- STATE_OPEN: A channel has completed the handshake. Open channels are
|
|
ready to send and receive packets.
|
|
- STATE_CLOSED: A channel has been closed and can no longer be used to send or receive
|
|
packets.
|
|
ordering:
|
|
title: whether the channel is ordered or unordered
|
|
type: string
|
|
enum:
|
|
- ORDER_NONE_UNSPECIFIED
|
|
- ORDER_UNORDERED
|
|
- ORDER_ORDERED
|
|
default: ORDER_NONE_UNSPECIFIED
|
|
description: |-
|
|
- ORDER_NONE_UNSPECIFIED: zero-value for channel ordering
|
|
- ORDER_UNORDERED: packets can be delivered in any order, which may differ from the order in
|
|
which they were sent.
|
|
- ORDER_ORDERED: packets are delivered exactly in the order which they were sent
|
|
counterparty:
|
|
title: counterparty channel end
|
|
type: object
|
|
properties:
|
|
port_id:
|
|
type: string
|
|
description: >-
|
|
port on the counterparty chain which owns the other end of the
|
|
channel.
|
|
channel_id:
|
|
type: string
|
|
title: channel end on the counterparty chain
|
|
connection_hops:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: >-
|
|
list of connection identifiers, in order, along which packets sent
|
|
on
|
|
|
|
this channel will travel
|
|
version:
|
|
type: string
|
|
title: opaque channel version, which is agreed upon during the handshake
|
|
description: >-
|
|
Channel defines pipeline for exactly-once packet delivery between
|
|
specific
|
|
|
|
modules on separate blockchains, which has at least one end capable of
|
|
|
|
sending packets and one end capable of receiving packets.
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
description: >-
|
|
QueryChannelResponse is the response type for the Query/Channel RPC
|
|
method.
|
|
|
|
Besides the Channel end, it includes a proof and the height from which the
|
|
|
|
proof was retrieved.
|
|
ibc.core.channel.v1.QueryChannelsResponse:
|
|
type: object
|
|
properties:
|
|
channels:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
state:
|
|
title: current state of the channel end
|
|
type: string
|
|
enum:
|
|
- STATE_UNINITIALIZED_UNSPECIFIED
|
|
- STATE_INIT
|
|
- STATE_TRYOPEN
|
|
- STATE_OPEN
|
|
- STATE_CLOSED
|
|
default: STATE_UNINITIALIZED_UNSPECIFIED
|
|
description: |-
|
|
State defines if a channel is in one of the following states:
|
|
CLOSED, INIT, TRYOPEN, OPEN or UNINITIALIZED.
|
|
|
|
- STATE_UNINITIALIZED_UNSPECIFIED: Default State
|
|
- STATE_INIT: A channel has just started the opening handshake.
|
|
- STATE_TRYOPEN: A channel has acknowledged the handshake step on the counterparty chain.
|
|
- STATE_OPEN: A channel has completed the handshake. Open channels are
|
|
ready to send and receive packets.
|
|
- STATE_CLOSED: A channel has been closed and can no longer be used to send or receive
|
|
packets.
|
|
ordering:
|
|
title: whether the channel is ordered or unordered
|
|
type: string
|
|
enum:
|
|
- ORDER_NONE_UNSPECIFIED
|
|
- ORDER_UNORDERED
|
|
- ORDER_ORDERED
|
|
default: ORDER_NONE_UNSPECIFIED
|
|
description: |-
|
|
- ORDER_NONE_UNSPECIFIED: zero-value for channel ordering
|
|
- ORDER_UNORDERED: packets can be delivered in any order, which may differ from the order in
|
|
which they were sent.
|
|
- ORDER_ORDERED: packets are delivered exactly in the order which they were sent
|
|
counterparty:
|
|
title: counterparty channel end
|
|
type: object
|
|
properties:
|
|
port_id:
|
|
type: string
|
|
description: >-
|
|
port on the counterparty chain which owns the other end of
|
|
the channel.
|
|
channel_id:
|
|
type: string
|
|
title: channel end on the counterparty chain
|
|
connection_hops:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: >-
|
|
list of connection identifiers, in order, along which packets
|
|
sent on
|
|
|
|
this channel will travel
|
|
version:
|
|
type: string
|
|
title: >-
|
|
opaque channel version, which is agreed upon during the
|
|
handshake
|
|
port_id:
|
|
type: string
|
|
title: port identifier
|
|
channel_id:
|
|
type: string
|
|
title: channel identifier
|
|
description: |-
|
|
IdentifiedChannel defines a channel with additional port and channel
|
|
identifier fields.
|
|
description: list of stored channels of the chain.
|
|
pagination:
|
|
title: pagination response
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
PageResponse is to be embedded in gRPC response messages where the
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
height:
|
|
title: query block height
|
|
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
|
|
description: >-
|
|
QueryChannelsResponse is the response type for the Query/Channels RPC
|
|
method.
|
|
ibc.core.channel.v1.QueryConnectionChannelsResponse:
|
|
type: object
|
|
properties:
|
|
channels:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
state:
|
|
title: current state of the channel end
|
|
type: string
|
|
enum:
|
|
- STATE_UNINITIALIZED_UNSPECIFIED
|
|
- STATE_INIT
|
|
- STATE_TRYOPEN
|
|
- STATE_OPEN
|
|
- STATE_CLOSED
|
|
default: STATE_UNINITIALIZED_UNSPECIFIED
|
|
description: |-
|
|
State defines if a channel is in one of the following states:
|
|
CLOSED, INIT, TRYOPEN, OPEN or UNINITIALIZED.
|
|
|
|
- STATE_UNINITIALIZED_UNSPECIFIED: Default State
|
|
- STATE_INIT: A channel has just started the opening handshake.
|
|
- STATE_TRYOPEN: A channel has acknowledged the handshake step on the counterparty chain.
|
|
- STATE_OPEN: A channel has completed the handshake. Open channels are
|
|
ready to send and receive packets.
|
|
- STATE_CLOSED: A channel has been closed and can no longer be used to send or receive
|
|
packets.
|
|
ordering:
|
|
title: whether the channel is ordered or unordered
|
|
type: string
|
|
enum:
|
|
- ORDER_NONE_UNSPECIFIED
|
|
- ORDER_UNORDERED
|
|
- ORDER_ORDERED
|
|
default: ORDER_NONE_UNSPECIFIED
|
|
description: |-
|
|
- ORDER_NONE_UNSPECIFIED: zero-value for channel ordering
|
|
- ORDER_UNORDERED: packets can be delivered in any order, which may differ from the order in
|
|
which they were sent.
|
|
- ORDER_ORDERED: packets are delivered exactly in the order which they were sent
|
|
counterparty:
|
|
title: counterparty channel end
|
|
type: object
|
|
properties:
|
|
port_id:
|
|
type: string
|
|
description: >-
|
|
port on the counterparty chain which owns the other end of
|
|
the channel.
|
|
channel_id:
|
|
type: string
|
|
title: channel end on the counterparty chain
|
|
connection_hops:
|
|
type: array
|
|
items:
|
|
type: string
|
|
title: >-
|
|
list of connection identifiers, in order, along which packets
|
|
sent on
|
|
|
|
this channel will travel
|
|
version:
|
|
type: string
|
|
title: >-
|
|
opaque channel version, which is agreed upon during the
|
|
handshake
|
|
port_id:
|
|
type: string
|
|
title: port identifier
|
|
channel_id:
|
|
type: string
|
|
title: channel identifier
|
|
description: |-
|
|
IdentifiedChannel defines a channel with additional port and channel
|
|
identifier fields.
|
|
description: list of channels associated with a connection.
|
|
pagination:
|
|
title: pagination response
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
PageResponse is to be embedded in gRPC response messages where the
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
height:
|
|
title: query block height
|
|
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
|
|
title: |-
|
|
QueryConnectionChannelsResponse is the Response type for the
|
|
Query/QueryConnectionChannels RPC method
|
|
ibc.core.channel.v1.QueryNextSequenceReceiveResponse:
|
|
type: object
|
|
properties:
|
|
next_sequence_receive:
|
|
type: string
|
|
format: uint64
|
|
title: next sequence receive number
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
title: |-
|
|
QuerySequenceResponse is the request type for the
|
|
Query/QueryNextSequenceReceiveResponse RPC method
|
|
ibc.core.channel.v1.QueryPacketAcknowledgementResponse:
|
|
type: object
|
|
properties:
|
|
acknowledgement:
|
|
type: string
|
|
format: byte
|
|
title: packet associated with the request fields
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
title: |-
|
|
QueryPacketAcknowledgementResponse defines the client query response for a
|
|
packet which also includes a proof and the height from which the
|
|
proof was retrieved
|
|
ibc.core.channel.v1.QueryPacketAcknowledgementsResponse:
|
|
type: object
|
|
properties:
|
|
acknowledgements:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
port_id:
|
|
type: string
|
|
description: channel port identifier.
|
|
channel_id:
|
|
type: string
|
|
description: channel unique identifier.
|
|
sequence:
|
|
type: string
|
|
format: uint64
|
|
description: packet sequence.
|
|
data:
|
|
type: string
|
|
format: byte
|
|
description: embedded data that represents packet state.
|
|
description: >-
|
|
PacketState defines the generic type necessary to retrieve and store
|
|
|
|
packet commitments, acknowledgements, and receipts.
|
|
|
|
Caller is responsible for knowing the context necessary to interpret
|
|
this
|
|
|
|
state as a commitment, acknowledgement, or a receipt.
|
|
pagination:
|
|
title: pagination response
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
PageResponse is to be embedded in gRPC response messages where the
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
height:
|
|
title: query block height
|
|
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
|
|
title: |-
|
|
QueryPacketAcknowledgemetsResponse is the request type for the
|
|
Query/QueryPacketAcknowledgements RPC method
|
|
ibc.core.channel.v1.QueryPacketCommitmentResponse:
|
|
type: object
|
|
properties:
|
|
commitment:
|
|
type: string
|
|
format: byte
|
|
title: packet associated with the request fields
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
title: >-
|
|
QueryPacketCommitmentResponse defines the client query response for a
|
|
packet
|
|
|
|
which also includes a proof and the height from which the proof was
|
|
|
|
retrieved
|
|
ibc.core.channel.v1.QueryPacketCommitmentsResponse:
|
|
type: object
|
|
properties:
|
|
commitments:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
port_id:
|
|
type: string
|
|
description: channel port identifier.
|
|
channel_id:
|
|
type: string
|
|
description: channel unique identifier.
|
|
sequence:
|
|
type: string
|
|
format: uint64
|
|
description: packet sequence.
|
|
data:
|
|
type: string
|
|
format: byte
|
|
description: embedded data that represents packet state.
|
|
description: >-
|
|
PacketState defines the generic type necessary to retrieve and store
|
|
|
|
packet commitments, acknowledgements, and receipts.
|
|
|
|
Caller is responsible for knowing the context necessary to interpret
|
|
this
|
|
|
|
state as a commitment, acknowledgement, or a receipt.
|
|
pagination:
|
|
title: pagination response
|
|
type: object
|
|
properties:
|
|
next_key:
|
|
type: string
|
|
format: byte
|
|
title: |-
|
|
next_key is the key to be passed to PageRequest.key to
|
|
query the next page most efficiently
|
|
total:
|
|
type: string
|
|
format: uint64
|
|
title: >-
|
|
total is total number of results available if
|
|
PageRequest.count_total
|
|
|
|
was set, its value is undefined otherwise
|
|
description: |-
|
|
PageResponse is to be embedded in gRPC response messages where the
|
|
corresponding request message has used PageRequest.
|
|
|
|
message SomeResponse {
|
|
repeated Bar results = 1;
|
|
PageResponse page = 2;
|
|
}
|
|
height:
|
|
title: query block height
|
|
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
|
|
title: |-
|
|
QueryPacketCommitmentsResponse is the request type for the
|
|
Query/QueryPacketCommitments RPC method
|
|
ibc.core.channel.v1.QueryPacketReceiptResponse:
|
|
type: object
|
|
properties:
|
|
received:
|
|
type: boolean
|
|
format: boolean
|
|
title: success flag for if receipt exists
|
|
proof:
|
|
type: string
|
|
format: byte
|
|
title: merkle proof of existence
|
|
proof_height:
|
|
title: height at which the proof was retrieved
|
|
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
|
|
title: >-
|
|
QueryPacketReceiptResponse defines the client query response for a packet
|
|
|
|
receipt which also includes a proof, and the height from which the proof
|
|
was
|
|
|
|
retrieved
|
|
ibc.core.channel.v1.QueryUnreceivedAcksResponse:
|
|
type: object
|
|
properties:
|
|
sequences:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uint64
|
|
title: list of unreceived acknowledgement sequences
|
|
height:
|
|
title: query block height
|
|
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
|
|
title: |-
|
|
QueryUnreceivedAcksResponse is the response type for the
|
|
Query/UnreceivedAcks RPC method
|
|
ibc.core.channel.v1.QueryUnreceivedPacketsResponse:
|
|
type: object
|
|
properties:
|
|
sequences:
|
|
type: array
|
|
items:
|
|
type: string
|
|
format: uint64
|
|
title: list of unreceived packet sequences
|
|
height:
|
|
title: query block height
|
|
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
|
|
title: |-
|
|
QueryUnreceivedPacketsResponse is the response type for the
|
|
Query/UnreceivedPacketCommitments RPC method
|
|
ibc.core.channel.v1.State:
|
|
type: string
|
|
enum:
|
|
- STATE_UNINITIALIZED_UNSPECIFIED
|
|
- STATE_INIT
|
|
- STATE_TRYOPEN
|
|
- STATE_OPEN
|
|
- STATE_CLOSED
|
|
default: STATE_UNINITIALIZED_UNSPECIFIED
|
|
description: |-
|
|
State defines if a channel is in one of the following states:
|
|
CLOSED, INIT, TRYOPEN, OPEN or UNINITIALIZED.
|
|
|
|
- STATE_UNINITIALIZED_UNSPECIFIED: Default State
|
|
- STATE_INIT: A channel has just started the opening handshake.
|
|
- STATE_TRYOPEN: A channel has acknowledged the handshake step on the counterparty chain.
|
|
- STATE_OPEN: A channel has completed the handshake. Open channels are
|
|
ready to send and receive packets.
|
|
- STATE_CLOSED: A channel has been closed and can no longer be used to send or receive
|
|
packets.
|
|
LegacyCrossChain:
|
|
type: boolean
|
|
example: true
|
|
LegacyMsg:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
LegacyAddress:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
LegacyAddress2:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1atsrkjac6ulgmwhudfc36lnjfgv340vlvm757z
|
|
LegacyBinanceChainAddress:
|
|
type: string
|
|
description: address on another chain (binance)
|
|
example: bnb1uky3me9ggqypmrsvxk7ur6hqkzq7zmv4ed4ng7
|
|
LegacyBinanceChainAddress2:
|
|
type: string
|
|
description: address on another chain (binance)
|
|
example: bnb10uypsspvl6jlxcx5xse02pag39l8xpe7a3468h
|
|
LegacyRandomNumberHash:
|
|
type: string
|
|
description: hex-encoded sha256 hash of a 64bit random number
|
|
example: c0544b7f4b890a673ea3f61bdb4650fbfe2f3e56bda1b397d6d592fca7163c8c
|
|
LegacyTimestamp:
|
|
type: string
|
|
description: unix timestamp
|
|
example: '1585252531'
|
|
LegacyHeightSpan:
|
|
type: string
|
|
description: span of blocks for which an atomic swap is valid
|
|
example: '3600'
|
|
LegacyCoin:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
LegacyCoins:
|
|
type: array
|
|
items:
|
|
$ref: '#/definitions/LegacyCoins'
|
|
LegacyCoinBNB:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
amount:
|
|
type: string
|
|
example: '555555'
|
|
LegacyCollateralType:
|
|
type: string
|
|
example: xrpb-a
|
|
LegacyCoinCollateral:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: xrp
|
|
amount:
|
|
type: string
|
|
example: '10000000000'
|
|
LegacyCoinPrincipal:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
LegacyCoinBid:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '100000000'
|
|
LegacySignature:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
LegacyStdTx:
|
|
type: object
|
|
properties:
|
|
msg:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: cosmos-sdk/MsgSend
|
|
value:
|
|
type: object
|
|
properties:
|
|
from_address:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
to_address:
|
|
type: string
|
|
example: kava1ls82zzghsx0exkpr52m8vht5jqs3un0ceysshz
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
fee:
|
|
type: object
|
|
properties:
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
memo:
|
|
type: string
|
|
signatures:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
signature:
|
|
type: string
|
|
example: >-
|
|
W1HfKcc4F0rCSoxheZ7fsrB5nGK58U4gKysuzsmUwhloVnCxmbCx289uVMMvQN6tOcQsz7hMVTJrXSA1xzevvw==
|
|
pubkey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: tendermint/PubKeySecp256k1
|
|
value:
|
|
type: string
|
|
example: Agey31h/NYpcy0sYm4liHMrXJMzbQUrgV4uHd/w09CXN
|
|
LegacyBaseReq:
|
|
type: object
|
|
properties:
|
|
from:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
description: Sender address or Keybase name to generate a transaction
|
|
memo:
|
|
type: string
|
|
example: a memo
|
|
chain_id:
|
|
type: string
|
|
example: testing
|
|
account_number:
|
|
type: string
|
|
example: '1'
|
|
sequence:
|
|
type: string
|
|
example: '0'
|
|
gas:
|
|
type: string
|
|
example: '200000'
|
|
gas_adjustment:
|
|
type: string
|
|
example: '1.0'
|
|
fees:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
simulate:
|
|
type: boolean
|
|
example: false
|
|
description: >-
|
|
Estimate gas for a transaction (cannot be used in conjunction with
|
|
generate_only)
|
|
LegacyAtomicSwapResponse:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
example: FFEA80A3D9A42427CC12DB957866C6D428C16AA5EA6D9A4A756EF04BF9F2FF06
|
|
status:
|
|
type: string
|
|
example: Completed
|
|
amount:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
amount:
|
|
type: string
|
|
example: '555555'
|
|
random_number_hash:
|
|
type: string
|
|
example: 0b1e35e991bf052be230ae8dd3ff90b69a610160d28a9eb3c0701395f9d2b291
|
|
expire_hieght:
|
|
type: string
|
|
example: '532463'
|
|
timestamp:
|
|
type: string
|
|
example: '1589020884'
|
|
sender:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
recipient:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1atsrkjac6ulgmwhudfc36lnjfgv340vlvm757z
|
|
sender_other_chain:
|
|
type: string
|
|
description: address on another chain (binance)
|
|
example: bnb1uky3me9ggqypmrsvxk7ur6hqkzq7zmv4ed4ng7
|
|
recipient_other_chain:
|
|
type: string
|
|
description: address on another chain (binance)
|
|
example: bnb10uypsspvl6jlxcx5xse02pag39l8xpe7a3468h
|
|
closed_block:
|
|
type: string
|
|
example: '532105'
|
|
cross_chain:
|
|
type: boolean
|
|
example: true
|
|
direction:
|
|
type: string
|
|
example: Incoming
|
|
LegacyAssetSupplyResponse:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
incoming_supply:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
amount:
|
|
type: string
|
|
example: '555555'
|
|
outgoing_supply:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
amount:
|
|
type: string
|
|
example: '555555'
|
|
current_supply:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
amount:
|
|
type: string
|
|
example: '555555'
|
|
limit:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
amount:
|
|
type: string
|
|
example: '555555'
|
|
LegacyBep3ParamsResponse:
|
|
type: object
|
|
properties:
|
|
bnb_deputy_address:
|
|
type: string
|
|
example: kava1aphsdnz5hu2t5ty2au6znprug5kx3zpy6zwq29
|
|
min_block_lock:
|
|
type: string
|
|
example: '80'
|
|
max_block_lock:
|
|
type: string
|
|
example: '3600'
|
|
supported_assets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
coin_id:
|
|
type: string
|
|
example: '714'
|
|
limit:
|
|
type: string
|
|
example: '100'
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
LegacyBep3Asset:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
coin_id:
|
|
type: string
|
|
example: '714'
|
|
limit:
|
|
type: string
|
|
example: '100'
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
LegacyRewardResult:
|
|
type: object
|
|
properties:
|
|
hard_claims:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
base_claim:
|
|
type: object
|
|
properties:
|
|
owner:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
reward:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
supply_reward_indexes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_indexes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_factor:
|
|
type: string
|
|
example: '1.2581'
|
|
borrow_reward_indexes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_indexes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_factor:
|
|
type: string
|
|
example: '1.2581'
|
|
delegator_reward_indexes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_factor:
|
|
type: string
|
|
example: '1.2581'
|
|
usdx_minting_claims:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
base_claim:
|
|
type: object
|
|
properties:
|
|
owner:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
reward:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
reward_indexes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_factor:
|
|
type: string
|
|
example: '1.2581'
|
|
LegacyHardLiquidityProviderClaim:
|
|
type: object
|
|
properties:
|
|
base_claim:
|
|
type: object
|
|
properties:
|
|
owner:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
reward:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
supply_reward_indexes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_indexes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_factor:
|
|
type: string
|
|
example: '1.2581'
|
|
borrow_reward_indexes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_indexes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_factor:
|
|
type: string
|
|
example: '1.2581'
|
|
delegator_reward_indexes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_factor:
|
|
type: string
|
|
example: '1.2581'
|
|
LegacyUSDXMintingClaims:
|
|
type: object
|
|
properties:
|
|
base_claim:
|
|
type: object
|
|
properties:
|
|
owner:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
reward:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
reward_indexes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_factor:
|
|
type: string
|
|
example: '1.2581'
|
|
LegacyBaseClaim:
|
|
type: object
|
|
properties:
|
|
owner:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
reward:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
LegacyBaseMultiClaim:
|
|
type: object
|
|
properties:
|
|
owner:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
reward:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
LegacyMultiRewardIndex:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_indexes:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_factor:
|
|
type: string
|
|
example: '1.2581'
|
|
LegacyRewardIndex:
|
|
type: object
|
|
properties:
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
reward_factor:
|
|
type: string
|
|
example: '1.2581'
|
|
LegacyIncentiveParams:
|
|
type: object
|
|
properties:
|
|
usdx_minting_reward_periods:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
start:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
end:
|
|
type: string
|
|
example: '2024-02-05T23:45:55.761435272Z'
|
|
rewards_per_second:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
hard_supply_reward_periods:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
start:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
end:
|
|
type: string
|
|
example: '2024-02-05T23:45:55.761435272Z'
|
|
rewards_per_second:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
hard_borrow_reward_periods:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
start:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
end:
|
|
type: string
|
|
example: '2024-02-05T23:45:55.761435272Z'
|
|
rewards_per_second:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
hard_delegator_reward_periods:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
start:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
end:
|
|
type: string
|
|
example: '2024-02-05T23:45:55.761435272Z'
|
|
rewards_per_second:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
claim_multipliers:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
example: small
|
|
months_lockup:
|
|
type: string
|
|
example: '12'
|
|
factor:
|
|
type: string
|
|
example: '0.33'
|
|
claim_end:
|
|
type: string
|
|
example: '2022-02-05T23:45:55.761435272Z'
|
|
LegacyRewardPeriod:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
start:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
end:
|
|
type: string
|
|
example: '2024-02-05T23:45:55.761435272Z'
|
|
rewards_per_second:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
LegacyMultiRewardPeriod:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
collateral_type:
|
|
type: string
|
|
example: bnb
|
|
start:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
end:
|
|
type: string
|
|
example: '2024-02-05T23:45:55.761435272Z'
|
|
rewards_per_second:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
LegacyPubProposal:
|
|
type: object
|
|
properties:
|
|
title:
|
|
type: string
|
|
example: the title of the proposal
|
|
description:
|
|
type: string
|
|
example: the description of the proposal
|
|
LegacyCdpResponse:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
example: '1'
|
|
owner:
|
|
type: string
|
|
example: kava1q53rwutgpzx7szcrgzqguxyccjpzt9j4cyctn9
|
|
collateral:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: xrp
|
|
amount:
|
|
type: string
|
|
example: '10000000000'
|
|
type:
|
|
type: string
|
|
example: xrpb-a
|
|
principal:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
accumulated_fees:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
fees_updated:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
collateral_value:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
collateralization_ratio:
|
|
type: string
|
|
example: '2.721734157907653857'
|
|
LegacyCdpDepositResponse:
|
|
type: object
|
|
properties:
|
|
cdp_id:
|
|
type: string
|
|
example: '1'
|
|
depositor:
|
|
type: string
|
|
example: kava1q53rwutgpzx7szcrgzqguxyccjpzt9j4cyctn9
|
|
amount:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: xrp
|
|
amount:
|
|
type: string
|
|
example: '10000000000'
|
|
LegacyPricefeedParameters:
|
|
type: object
|
|
properties:
|
|
markets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
example: xrp:usd
|
|
base_asset:
|
|
type: string
|
|
example: xrp
|
|
quote_asset:
|
|
type: string
|
|
example: usd
|
|
oracles:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
LegacyPrice:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
example: xrp:usd
|
|
price:
|
|
type: string
|
|
example: '0.298758999999999997'
|
|
LegacyPostedPrice:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
example: xrp:usd
|
|
oracle_address:
|
|
type: string
|
|
example: kava10cw2m04528dwlc44k0myd7strj3eq5jr6s8pxs
|
|
price:
|
|
type: string
|
|
example: '0.298758999999999997'
|
|
expiry:
|
|
type: string
|
|
example: '2021-02-12T23:10:00Z'
|
|
LegacyMarket:
|
|
type: object
|
|
properties:
|
|
market_id:
|
|
type: string
|
|
example: xrp:usd
|
|
base_asset:
|
|
type: string
|
|
example: xrp
|
|
quote_asset:
|
|
type: string
|
|
example: usd
|
|
oracles:
|
|
type: array
|
|
x-nullable: true
|
|
items:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
LegacySwapParams:
|
|
type: object
|
|
properties:
|
|
allowed_pools:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
token_a:
|
|
type: string
|
|
example: ukava
|
|
token_b:
|
|
type: string
|
|
example: usdx
|
|
swap_fee:
|
|
type: string
|
|
example: '0.03'
|
|
LegacyAllowedPool:
|
|
type: object
|
|
properties:
|
|
token_a:
|
|
type: string
|
|
example: ukava
|
|
token_b:
|
|
type: string
|
|
example: usdx
|
|
LegacySwapDepositsQueryResult:
|
|
type: object
|
|
properties:
|
|
depositor:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
pool_id:
|
|
type: string
|
|
example: abc:xyz
|
|
shares_owned:
|
|
type: string
|
|
example: '500'
|
|
shares_value:
|
|
$ref: '#/definitions/LegacyCoins'
|
|
LegacySwapPoolStatsQueryResult:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
example: abc:xyz
|
|
coins:
|
|
$ref: '#/definitions/LegacyCoins'
|
|
total_shares:
|
|
type: string
|
|
example: '500'
|
|
LegacyHardParams:
|
|
type: object
|
|
properties:
|
|
money_markets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
borrow_limit:
|
|
type: object
|
|
properties:
|
|
has_max_limit:
|
|
type: boolean
|
|
example: true
|
|
maximum_limit:
|
|
type: string
|
|
example: '100000000000000'
|
|
loan_to_value:
|
|
type: string
|
|
example: '0.8'
|
|
spot_market_id:
|
|
type: string
|
|
example: bnb:usd
|
|
conversion_factor:
|
|
type: string
|
|
example: '100000000'
|
|
interest_rate_model:
|
|
type: object
|
|
properties:
|
|
base_rate_apy:
|
|
type: string
|
|
example: '0'
|
|
base_multiplier:
|
|
type: string
|
|
example: '0.1'
|
|
kink:
|
|
type: string
|
|
example: '0.8'
|
|
jump_multiplier:
|
|
type: string
|
|
example: '0.5'
|
|
reserve_factor:
|
|
type: string
|
|
example: '0.05'
|
|
keeper_reward_percentage:
|
|
type: string
|
|
example: '0.05'
|
|
minimum_borrow_usd_value:
|
|
type: string
|
|
example: '10'
|
|
LegacyMoneyMarket:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
borrow_limit:
|
|
type: object
|
|
properties:
|
|
has_max_limit:
|
|
type: boolean
|
|
example: true
|
|
maximum_limit:
|
|
type: string
|
|
example: '100000000000000'
|
|
loan_to_value:
|
|
type: string
|
|
example: '0.8'
|
|
spot_market_id:
|
|
type: string
|
|
example: bnb:usd
|
|
conversion_factor:
|
|
type: string
|
|
example: '100000000'
|
|
interest_rate_model:
|
|
type: object
|
|
properties:
|
|
base_rate_apy:
|
|
type: string
|
|
example: '0'
|
|
base_multiplier:
|
|
type: string
|
|
example: '0.1'
|
|
kink:
|
|
type: string
|
|
example: '0.8'
|
|
jump_multiplier:
|
|
type: string
|
|
example: '0.5'
|
|
reserve_factor:
|
|
type: string
|
|
example: '0.05'
|
|
keeper_reward_percentage:
|
|
type: string
|
|
example: '0.05'
|
|
LegacyBorrowLimit:
|
|
type: object
|
|
properties:
|
|
has_max_limit:
|
|
type: boolean
|
|
example: true
|
|
maximum_limit:
|
|
type: string
|
|
example: '100000000000000'
|
|
loan_to_value:
|
|
type: string
|
|
example: '0.8'
|
|
LegacyInterestRateModel:
|
|
type: object
|
|
properties:
|
|
base_rate_apy:
|
|
type: string
|
|
example: '0'
|
|
base_multiplier:
|
|
type: string
|
|
example: '0.1'
|
|
kink:
|
|
type: string
|
|
example: '0.8'
|
|
jump_multiplier:
|
|
type: string
|
|
example: '0.5'
|
|
LegacyHardDepositResponse:
|
|
type: object
|
|
properties:
|
|
depositor:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
index:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
value:
|
|
type: string
|
|
example: '0.1258'
|
|
LegacyHardBorrowResponse:
|
|
type: object
|
|
properties:
|
|
borrower:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
amount:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
index:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
value:
|
|
type: string
|
|
example: '0.1258'
|
|
LegacySupplyInterestFactor:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
value:
|
|
type: string
|
|
example: '0.1258'
|
|
LegacyBorrowInterestFactor:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
value:
|
|
type: string
|
|
example: '0.1258'
|
|
LegacyMoneyMarketInterestRate:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: bnb
|
|
supply_interest_rate:
|
|
type: string
|
|
example: '5.25'
|
|
borrow_interest_rate:
|
|
type: string
|
|
example: '5.25'
|
|
LegacyMultiplierName:
|
|
type: string
|
|
example: small
|
|
LegacyMultiplier:
|
|
type: object
|
|
properties:
|
|
name:
|
|
type: string
|
|
example: small
|
|
months_lockup:
|
|
type: string
|
|
example: '12'
|
|
factor:
|
|
type: string
|
|
example: '0.33'
|
|
LegacyIssuanceParams:
|
|
type: object
|
|
properties:
|
|
assets:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
owner:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
denom:
|
|
type: string
|
|
example: btc
|
|
blocked_addresses:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
paused:
|
|
type: boolean
|
|
example: false
|
|
blockable:
|
|
type: boolean
|
|
example: true
|
|
rate_limit:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
limit:
|
|
type: string
|
|
example: '500000000'
|
|
time_period:
|
|
type: string
|
|
example: '518400000000000'
|
|
LegacyIssuanceAsset:
|
|
type: object
|
|
properties:
|
|
owner:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
denom:
|
|
type: string
|
|
example: btc
|
|
blocked_addresses:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
paused:
|
|
type: boolean
|
|
example: false
|
|
blockable:
|
|
type: boolean
|
|
example: true
|
|
rate_limit:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
limit:
|
|
type: string
|
|
example: '500000000'
|
|
time_period:
|
|
type: string
|
|
example: '518400000000000'
|
|
LegacyRateLimit:
|
|
type: object
|
|
properties:
|
|
active:
|
|
type: boolean
|
|
example: true
|
|
limit:
|
|
type: string
|
|
example: '500000000'
|
|
time_period:
|
|
type: string
|
|
example: '518400000000000'
|
|
LegacyAuctionParameters:
|
|
type: object
|
|
properties:
|
|
max_auction_duration:
|
|
type: string
|
|
example: '172800000000000'
|
|
bid_duration:
|
|
type: string
|
|
example: '600000000000'
|
|
increment_surplus:
|
|
type: string
|
|
example: '0.05'
|
|
increment_debt:
|
|
type: string
|
|
example: '0.05'
|
|
increment_collateral:
|
|
type: string
|
|
example: '0.05'
|
|
LegacyAuctionResponse:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
example: '1'
|
|
initiator:
|
|
type: string
|
|
example: liquidator
|
|
lot:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: xrp
|
|
amount:
|
|
type: string
|
|
example: '10000000000'
|
|
bidder:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
bid:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: ukava
|
|
amount:
|
|
type: string
|
|
example: '50000'
|
|
has_received_bids:
|
|
type: boolean
|
|
example: false
|
|
end_time:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
max_end_time:
|
|
type: string
|
|
example: '2020-02-05T23:45:55.761435272Z'
|
|
type:
|
|
type: string
|
|
example: collateral
|
|
phase:
|
|
type: string
|
|
example: forward
|
|
LegacyCollateralParam:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: xrp
|
|
type:
|
|
type: string
|
|
example: xrp-a
|
|
liquidation_ratio:
|
|
type: string
|
|
example: '2.000000000000000000'
|
|
debt_limit:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
amount:
|
|
type: string
|
|
example: '10000000'
|
|
stability_fee:
|
|
type: string
|
|
example: '1.000000001547126000'
|
|
auction_size:
|
|
type: string
|
|
example: '5000000000'
|
|
liquidation_penalty:
|
|
type: string
|
|
example: '0.050000000000000000'
|
|
prefix:
|
|
type: integer
|
|
example: 0
|
|
spot_market_id:
|
|
type: string
|
|
example: xrp:usd
|
|
liquidation_market_id:
|
|
type: string
|
|
example: xrp:usd:30
|
|
keeper_reward_percentage:
|
|
type: string
|
|
example: '0.05'
|
|
check_collateralization_index_count:
|
|
type: string
|
|
example: '10'
|
|
conversion_factor:
|
|
type: string
|
|
example: '6'
|
|
LegacyDebtParam:
|
|
type: object
|
|
properties:
|
|
denom:
|
|
type: string
|
|
example: usdx
|
|
reference_asset:
|
|
type: string
|
|
example: usd
|
|
conversion_factor:
|
|
type: string
|
|
example: '6'
|
|
debt_floor:
|
|
type: string
|
|
example: '10000000'
|
|
LegacyProposer:
|
|
type: object
|
|
properties:
|
|
proposal_id:
|
|
type: string
|
|
example: '1'
|
|
proposer:
|
|
type: string
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
LegacyCommitteeVote:
|
|
type: object
|
|
properties:
|
|
voter:
|
|
type: string
|
|
proposal_id:
|
|
type: string
|
|
vote_type:
|
|
type: string
|
|
LegacyCommitteeProposal:
|
|
type: object
|
|
properties:
|
|
pub_proposal:
|
|
type: object
|
|
properties:
|
|
title:
|
|
type: string
|
|
example: the title of the proposal
|
|
description:
|
|
type: string
|
|
example: the description of the proposal
|
|
id:
|
|
type: string
|
|
example: '1'
|
|
committee_id:
|
|
type: string
|
|
example: '1'
|
|
deadline:
|
|
type: string
|
|
example: '2020-05-10T16:18:43.752522893Z'
|
|
LegacyCommittee:
|
|
type: object
|
|
properties:
|
|
id:
|
|
type: string
|
|
example: '1'
|
|
description:
|
|
type: string
|
|
example: description of committee
|
|
members:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: bech32 encoded address
|
|
example: kava1ffv7nhd3z6sych2qpqkk03ec6hzkmufy0r2s4c
|
|
permissions:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: param_change_permission
|
|
allowed_params:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
subspace:
|
|
type: string
|
|
example: cdp
|
|
key:
|
|
type: string
|
|
example: collateral_params
|
|
vote_threshold:
|
|
type: string
|
|
example: '0.5'
|
|
proposal_duration:
|
|
type: string
|
|
example: '3600000000000'
|
|
LegacyPermission:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
example: param_change_permission
|
|
allowed_params:
|
|
type: array
|
|
items:
|
|
type: object
|
|
properties:
|
|
subspace:
|
|
type: string
|
|
example: cdp
|
|
key:
|
|
type: string
|
|
example: collateral_params
|
|
LegacyAllowedParam:
|
|
type: object
|
|
properties:
|
|
subspace:
|
|
type: string
|
|
example: cdp
|
|
key:
|
|
type: string
|
|
example: collateral_params
|
|
LegacyRedelegation:
|
|
type: object
|
|
properties:
|
|
delegator_address:
|
|
type: string
|
|
validator_src_address:
|
|
type: string
|
|
validator_dst_address:
|
|
type: string
|
|
entries:
|
|
type: array
|
|
items:
|
|
$ref: '#/definitions/LegacyRedelegation'
|
|
LegacyPublicKey:
|
|
type: object
|
|
properties:
|
|
type:
|
|
type: string
|
|
value:
|
|
type: string
|
|
LegacyKavadistPeriod:
|
|
type: object
|
|
properties:
|
|
start:
|
|
type: string
|
|
example: 2020-06-01:14:00:00Z
|
|
end:
|
|
type: string
|
|
example: 2020-06-01:14:00:00Z
|
|
inflation:
|
|
type: string
|
|
example: '1.000000001167363430'
|
|
securityDefinitions:
|
|
kms:
|
|
type: basic
|