deep-stack/laconicd-deprecated
6
0
Fork 0
forked from cerc-io/laconicd-deprecated
Code Pull Requests Activity
76922d2c6f
laconicd-deprecated/client/docs/swagger-ui/swagger.yaml
0xmuralik 76922d2c6f update from fork
2023-03-13 12:34:10 +05:30

21449 lines
736 KiB
YAML
Vendored
Raw Blame History

swagger: '2.0'
info:
title: Ethermint Chain - Legacy REST and gRPC Gateway docs
description: A REST interface for state queries, legacy transactions
version: 1.0.0
paths:
/ethermint/evm/v1/account/{address}:
get:
summary: Account queries an Ethereum account.
operationId: Account
responses:
'200':
description: A successful response.
schema:
type: object
properties:
balance:
type: string
description: balance is the balance of the EVM denomination.
code_hash:
type: string
description: code hash is the hex-formatted code bytes from the EOA.
nonce:
type: string
format: uint64
description: nonce is the account's sequence number.
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 := 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: address
description: address is the ethereum hex address to query the account for.
in: path
required: true
type: string
tags:
- Query
/ethermint/evm/v1/balances/{address}:
get:
summary: |-
Balance queries the balance of a the EVM denomination for a single
EthAccount.
operationId: Balance
responses:
'200':
description: A successful response.
schema:
type: object
properties:
balance:
type: string
description: balance is the balance of the EVM denomination.
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
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: address
description: address is the ethereum hex address to query the balance for.
in: path
required: true
type: string
tags:
- Query
/ethermint/evm/v1/base_fee:
get:
summary: >-
BaseFee queries the base fee of the parent block of the current block,
it's similar to feemarket module's method, but also checks london
hardfork status.
operationId: BaseFee
responses:
'200':
description: A successful response.
schema:
type: object
properties:
base_fee:
type: string
description: BaseFeeResponse returns the EIP1559 base fee.
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{...}
<<<<<<< HEAD
<<<<<<< HEAD
any, err := ptypes.MarshalAny(foo)
...
foo := &pb.Foo{}
if err := ptypes.UnmarshalAny(any, foo); err != nil {
=======
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
>>>>>>> v0.20.0
=======
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
>>>>>>> v0.21.0
...
}
The pack methods provided by protobuf library will by
default use
'type.googleapis.com/full.type.name' as the type URL and the
unpack
methods only use the fully qualified type name after the
last '/'
in the type URL, for example "foo.bar.com/x/y.z" will yield
type
name "y.z".
JSON
====
The JSON representation of an `Any` value uses the regular
representation of the deserialized, embedded message, with
an
additional field `@type` which contains the type URL.
Example:
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
If the embedded message type is well-known and has a custom
JSON
representation, that representation will be embedded adding
a field
`value` which holds the custom JSON in addition to the
`@type`
field. Example (for message [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
tags:
- Query
/ethermint/evm/v1/codes/{address}:
get:
summary: Code queries the balance of all coins for a single account.
operationId: Code
responses:
'200':
description: A successful response.
schema:
type: object
properties:
code:
type: string
format: byte
description: code represents the code bytes from an ethereum address.
description: |-
QueryCodeResponse is the response type for the Query/Code 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: address
description: address is the ethereum hex address to query the code for.
in: path
required: true
type: string
tags:
- Query
/ethermint/evm/v1/cosmos_account/{address}:
get:
summary: CosmosAccount queries an Ethereum account's Cosmos Address.
operationId: CosmosAccount
responses:
'200':
description: A successful response.
schema:
type: object
properties:
cosmos_address:
type: string
description: cosmos_address is the cosmos address of the account.
sequence:
type: string
format: uint64
description: sequence is the account's sequence number.
account_number:
type: string
format: uint64
title: account_number is the account numbert
description: >-
QueryCosmosAccountResponse is the response type for the
Query/CosmosAccount
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: address
description: address is the ethereum hex address to query the account for.
in: path
required: true
type: string
tags:
- Query
/ethermint/evm/v1/estimate_gas:
get:
summary: EstimateGas implements the `eth_estimateGas` rpc api
operationId: EstimateGas
responses:
'200':
description: A successful response.
schema:
type: object
properties:
gas:
type: string
format: uint64
title: the estimated gas
title: EstimateGasResponse defines EstimateGas response
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: args
description: same json format as the json rpc api.
in: query
required: false
type: string
format: byte
- name: gas_cap
description: the default gas cap to be used.
in: query
required: false
type: string
format: uint64
- name: proposer_address
description: the proposer of the requested block.
in: query
required: false
type: string
format: byte
- name: chain_id
description: the eip155 chain id parsed from the requested block header.
in: query
required: false
type: string
format: int64
tags:
- Query
/ethermint/evm/v1/eth_call:
get:
summary: EthCall implements the `eth_call` rpc api
operationId: EthCall
responses:
'200':
description: A successful response.
schema:
type: object
properties:
hash:
type: string
title: >-
ethereum transaction hash in hex format. This hash differs
from the
Tendermint sha256 hash of the transaction bytes. See
https://github.com/tendermint/tendermint/issues/6539 for
reference
logs:
type: array
items:
type: object
properties:
address:
type: string
title: address of the contract that generated the event
topics:
type: array
items:
type: string
description: list of topics provided by the contract.
data:
type: string
format: byte
title: supplied by the contract, usually ABI-encoded
block_number:
type: string
format: uint64
title: block in which the transaction was included
tx_hash:
type: string
title: hash of the transaction
tx_index:
type: string
format: uint64
title: index of the transaction in the block
block_hash:
type: string
title: hash of the block in which the transaction was included
index:
type: string
format: uint64
title: index of the log in the block
removed:
type: boolean
description: >-
The Removed field is true if this log was reverted due
to a chain
reorganisation. You must pay attention to this field if
you receive logs
through a filter query.
description: >-
Log represents an protobuf compatible Ethereum Log that
defines a contract
log event. These events are generated by the LOG opcode and
stored/indexed by
the node.
description: >-
logs contains the transaction hash and the proto-compatible
ethereum
logs.
ret:
type: string
format: byte
title: >-
returned data from evm function (result or data supplied with
revert
opcode)
vm_error:
type: string
title: vm error is the error returned by vm execution
gas_used:
type: string
format: uint64
title: gas consumed by the transaction
description: MsgEthereumTxResponse defines the Msg/EthereumTx response type.
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: args
description: same json format as the json rpc api.
in: query
required: false
type: string
format: byte
- name: gas_cap
description: the default gas cap to be used.
in: query
required: false
type: string
format: uint64
- name: proposer_address
description: the proposer of the requested block.
in: query
required: false
type: string
format: byte
- name: chain_id
description: the eip155 chain id parsed from the requested block header.
in: query
required: false
type: string
format: int64
tags:
- Query
/ethermint/evm/v1/params:
get:
summary: Params queries the parameters of x/evm module.
operationId: EvmParams
responses:
'200':
description: A successful response.
schema:
type: object
properties:
params:
description: params define the evm module parameters.
type: object
properties:
evm_denom:
type: string
description: >-
evm denom represents the token denomination used to run
the EVM state
transitions.
enable_create:
type: boolean
title: >-
enable create toggles state transitions that use the
vm.Create function
enable_call:
type: boolean
title: >-
enable call toggles state transitions that use the vm.Call
function
extra_eips:
type: array
items:
type: string
format: int64
title: extra eips defines the additional EIPs for the vm.Config
chain_config:
title: >-
chain config defines the EVM chain configuration
parameters
type: object
properties:
homestead_block:
type: string
title: >-
Homestead switch block (nil no fork, 0 = already
homestead)
dao_fork_block:
type: string
title: TheDAO hard-fork switch block (nil no fork)
dao_fork_support:
type: boolean
title: >-
Whether the nodes supports or opposes the DAO
hard-fork
eip150_block:
type: string
title: >-
EIP150 implements the Gas price changes
(https://github.com/ethereum/EIPs/issues/150) EIP150
HF block (nil no fork)
eip150_hash:
type: string
title: >-
EIP150 HF hash (needed for header only clients as only
gas pricing changed)
eip155_block:
type: string
title: EIP155Block HF block
eip158_block:
type: string
title: EIP158 HF block
byzantium_block:
type: string
title: >-
Byzantium switch block (nil no fork, 0 = already on
byzantium)
constantinople_block:
type: string
title: >-
Constantinople switch block (nil no fork, 0 = already
activated)
petersburg_block:
type: string
title: Petersburg switch block (nil same as Constantinople)
istanbul_block:
type: string
title: >-
Istanbul switch block (nil no fork, 0 = already on
istanbul)
muir_glacier_block:
type: string
title: >-
Eip-2384 (bomb delay) switch block (nil no fork, 0 =
already activated)
berlin_block:
type: string
title: >-
Berlin switch block (nil = no fork, 0 = already on
berlin)
london_block:
type: string
title: >-
London switch block (nil = no fork, 0 = already on
london)
arrow_glacier_block:
type: string
title: >-
Eip-4345 (bomb delay) switch block (nil = no fork, 0 =
already activated)
<<<<<<< HEAD
<<<<<<< HEAD
merge_fork_block:
type: string
title: >-
EIP-3675 (TheMerge) switch block (nil = no fork, 0 =
already in merge proceedings)
=======
gray_glacier_block:
type: string
title: >-
=======
gray_glacier_block:
type: string
title: >-
>>>>>>> v0.21.0
EIP-5133 (bomb delay) switch block (nil = no fork, 0 =
already activated)
merge_netsplit_block:
type: string
title: >-
Virtual fork after The Merge to use as a network
splitter
<<<<<<< HEAD
>>>>>>> v0.20.0
=======
>>>>>>> v0.21.0
description: >-
ChainConfig defines the Ethereum ChainConfig parameters
using *sdk.Int values
instead of *big.Int.
allow_unprotected_txs:
type: boolean
description: >-
Allow unprotected transactions defines if replay-protected
<<<<<<< HEAD
<<<<<<< HEAD
(i.e non EIP155
=======
(i.e non EIP155
>>>>>>> v0.20.0
=======
(i.e non EIP155
>>>>>>> v0.21.0
signed) transactions can be executed on the state machine.
title: Params defines the EVM module parameters
description: >-
QueryParamsResponse defines the response type for querying x/evm
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:
- Query
/ethermint/evm/v1/storage/{address}/{key}:
get:
summary: Storage queries the balance of all coins for a single account.
operationId: Storage
responses:
'200':
description: A successful response.
schema:
type: object
properties:
value:
type: string
description: >-
key defines the storage state value hash associated with the
given key.
description: >-
QueryStorageResponse is the response type for the Query/Storage
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: address
description: >-
/ address is the ethereum hex address to query the storage state
for.
in: path
required: true
type: string
- name: key
description: key defines the key of the storage state
in: path
required: true
type: string
tags:
- Query
/ethermint/evm/v1/trace_block:
get:
summary: >-
TraceBlock implements the `debug_traceBlockByNumber` and
`debug_traceBlockByHash` rpc api
operationId: TraceBlock
responses:
'200':
description: A successful response.
schema:
type: object
properties:
data:
type: string
format: byte
title: QueryTraceBlockResponse defines TraceBlock response
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: trace_config.tracer
description: custom javascript tracer.
in: query
required: false
type: string
- name: trace_config.timeout
description: >-
overrides the default timeout of 5 seconds for JavaScript-based
tracing
calls.
in: query
required: false
type: string
- name: trace_config.reexec
description: number of blocks the tracer is willing to go back.
in: query
required: false
type: string
format: uint64
- name: trace_config.disable_stack
description: disable stack capture.
in: query
required: false
type: boolean
- name: trace_config.disable_storage
description: disable storage capture.
in: query
required: false
type: boolean
- name: trace_config.debug
description: print output during capture end.
in: query
required: false
type: boolean
- name: trace_config.limit
description: maximum length of output, but zero means unlimited.
in: query
required: false
type: integer
format: int32
- name: trace_config.overrides.homestead_block
description: Homestead switch block (nil no fork, 0 = already homestead).
in: query
required: false
type: string
- name: trace_config.overrides.dao_fork_block
description: TheDAO hard-fork switch block (nil no fork).
in: query
required: false
type: string
- name: trace_config.overrides.dao_fork_support
description: Whether the nodes supports or opposes the DAO hard-fork.
in: query
required: false
type: boolean
- name: trace_config.overrides.eip150_block
description: >-
EIP150 implements the Gas price changes
(https://github.com/ethereum/EIPs/issues/150) EIP150 HF block (nil
no fork).
in: query
required: false
type: string
- name: trace_config.overrides.eip150_hash
description: >-
EIP150 HF hash (needed for header only clients as only gas pricing
changed).
in: query
required: false
type: string
- name: trace_config.overrides.eip155_block
description: EIP155Block HF block.
in: query
required: false
type: string
- name: trace_config.overrides.eip158_block
description: EIP158 HF block.
in: query
required: false
type: string
- name: trace_config.overrides.byzantium_block
description: Byzantium switch block (nil no fork, 0 = already on byzantium).
in: query
required: false
type: string
- name: trace_config.overrides.constantinople_block
description: Constantinople switch block (nil no fork, 0 = already activated).
in: query
required: false
type: string
- name: trace_config.overrides.petersburg_block
description: Petersburg switch block (nil same as Constantinople).
in: query
required: false
type: string
- name: trace_config.overrides.istanbul_block
description: Istanbul switch block (nil no fork, 0 = already on istanbul).
in: query
required: false
type: string
- name: trace_config.overrides.muir_glacier_block
description: >-
Eip-2384 (bomb delay) switch block (nil no fork, 0 = already
activated).
in: query
required: false
type: string
- name: trace_config.overrides.berlin_block
description: Berlin switch block (nil = no fork, 0 = already on berlin).
in: query
required: false
type: string
- name: trace_config.overrides.london_block
description: London switch block (nil = no fork, 0 = already on london).
in: query
required: false
type: string
- name: trace_config.overrides.arrow_glacier_block
description: >-
Eip-4345 (bomb delay) switch block (nil = no fork, 0 = already
activated).
in: query
required: false
type: string
<<<<<<< HEAD
<<<<<<< HEAD
- name: trace_config.overrides.merge_fork_block
description: >-
EIP-3675 (TheMerge) switch block (nil = no fork, 0 = already in
merge proceedings).
=======
- name: trace_config.overrides.gray_glacier_block
description: >-
=======
- name: trace_config.overrides.gray_glacier_block
description: >-
>>>>>>> v0.21.0
EIP-5133 (bomb delay) switch block (nil = no fork, 0 = already
activated).
in: query
required: false
type: string
- name: trace_config.overrides.merge_netsplit_block
description: Virtual fork after The Merge to use as a network splitter.
<<<<<<< HEAD
>>>>>>> v0.20.0
=======
>>>>>>> v0.21.0
in: query
required: false
type: string
- name: trace_config.enable_memory
description: enable memory capture.
in: query
required: false
type: boolean
- name: trace_config.enable_return_data
description: enable return data capture.
in: query
required: false
type: boolean
- name: trace_config.tracer_json_config
description: tracer config.
in: query
required: false
type: string
- name: block_number
description: block number.
in: query
required: false
type: string
format: int64
- name: block_hash
description: block hex hash.
in: query
required: false
type: string
- name: block_time
description: block time.
in: query
required: false
type: string
format: date-time
- name: proposer_address
description: the proposer of the requested block.
in: query
required: false
type: string
format: byte
- name: chain_id
description: the eip155 chain id parsed from the requested block header.
in: query
required: false
type: string
format: int64
tags:
- Query
/ethermint/evm/v1/trace_tx:
get:
summary: TraceTx implements the `debug_traceTransaction` rpc api
operationId: TraceTx
responses:
'200':
description: A successful response.
schema:
type: object
properties:
data:
type: string
format: byte
title: response serialized in bytes
title: QueryTraceTxResponse defines TraceTx response
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: msg.data.type_url
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.
in: query
required: false
type: string
- name: msg.data.value
description: >-
Must be a valid serialized protocol buffer of the above specified
type.
in: query
required: false
type: string
format: byte
- name: msg.size
description: 'DEPRECATED: encoded storage size of the transaction.'
in: query
required: false
type: number
format: double
- name: msg.hash
description: transaction hash in hex format.
in: query
required: false
type: string
- name: msg.from
description: |-
ethereum signer address in hex format. This address value is checked
against the address derived from the signature (V, R, S) using the
secp256k1 elliptic curve.
in: query
required: false
type: string
- name: trace_config.tracer
description: custom javascript tracer.
in: query
required: false
type: string
- name: trace_config.timeout
description: >-
overrides the default timeout of 5 seconds for JavaScript-based
tracing
calls.
in: query
required: false
type: string
- name: trace_config.reexec
description: number of blocks the tracer is willing to go back.
in: query
required: false
type: string
format: uint64
- name: trace_config.disable_stack
description: disable stack capture.
in: query
required: false
type: boolean
- name: trace_config.disable_storage
description: disable storage capture.
in: query
required: false
type: boolean
- name: trace_config.debug
description: print output during capture end.
in: query
required: false
type: boolean
- name: trace_config.limit
description: maximum length of output, but zero means unlimited.
in: query
required: false
type: integer
format: int32
- name: trace_config.overrides.homestead_block
description: Homestead switch block (nil no fork, 0 = already homestead).
in: query
required: false
type: string
- name: trace_config.overrides.dao_fork_block
description: TheDAO hard-fork switch block (nil no fork).
in: query
required: false
type: string
- name: trace_config.overrides.dao_fork_support
description: Whether the nodes supports or opposes the DAO hard-fork.
in: query
required: false
type: boolean
- name: trace_config.overrides.eip150_block
description: >-
EIP150 implements the Gas price changes
(https://github.com/ethereum/EIPs/issues/150) EIP150 HF block (nil
no fork).
in: query
required: false
type: string
- name: trace_config.overrides.eip150_hash
description: >-
EIP150 HF hash (needed for header only clients as only gas pricing
changed).
in: query
required: false
type: string
- name: trace_config.overrides.eip155_block
description: EIP155Block HF block.
in: query
required: false
type: string
- name: trace_config.overrides.eip158_block
description: EIP158 HF block.
in: query
required: false
type: string
- name: trace_config.overrides.byzantium_block
description: Byzantium switch block (nil no fork, 0 = already on byzantium).
in: query
required: false
type: string
- name: trace_config.overrides.constantinople_block
description: Constantinople switch block (nil no fork, 0 = already activated).
in: query
required: false
type: string
- name: trace_config.overrides.petersburg_block
description: Petersburg switch block (nil same as Constantinople).
in: query
required: false
type: string
- name: trace_config.overrides.istanbul_block
description: Istanbul switch block (nil no fork, 0 = already on istanbul).
in: query
required: false
type: string
- name: trace_config.overrides.muir_glacier_block
description: >-
Eip-2384 (bomb delay) switch block (nil no fork, 0 = already
activated).
in: query
required: false
type: string
- name: trace_config.overrides.berlin_block
description: Berlin switch block (nil = no fork, 0 = already on berlin).
in: query
required: false
type: string
- name: trace_config.overrides.london_block
description: London switch block (nil = no fork, 0 = already on london).
in: query
required: false
type: string
- name: trace_config.overrides.arrow_glacier_block
description: >-
Eip-4345 (bomb delay) switch block (nil = no fork, 0 = already
activated).
in: query
required: false
type: string
<<<<<<< HEAD
<<<<<<< HEAD
- name: trace_config.overrides.merge_fork_block
description: >-
EIP-3675 (TheMerge) switch block (nil = no fork, 0 = already in
merge proceedings).
=======
- name: trace_config.overrides.gray_glacier_block
description: >-
=======
- name: trace_config.overrides.gray_glacier_block
description: >-
>>>>>>> v0.21.0
EIP-5133 (bomb delay) switch block (nil = no fork, 0 = already
activated).
in: query
required: false
type: string
- name: trace_config.overrides.merge_netsplit_block
description: Virtual fork after The Merge to use as a network splitter.
<<<<<<< HEAD
>>>>>>> v0.20.0
=======
>>>>>>> v0.21.0
in: query
required: false
type: string
- name: trace_config.enable_memory
description: enable memory capture.
in: query
required: false
type: boolean
- name: trace_config.enable_return_data
description: enable return data capture.
in: query
required: false
type: boolean
- name: trace_config.tracer_json_config
description: tracer config.
in: query
required: false
type: string
- name: block_number
description: block number of requested transaction.
in: query
required: false
type: string
format: int64
- name: block_hash
description: block hex hash of requested transaction.
in: query
required: false
type: string
- name: block_time
description: block time of requested transaction.
in: query
required: false
type: string
format: date-time
- name: proposer_address
description: the proposer of the requested block.
in: query
required: false
type: string
format: byte
- name: chain_id
description: the eip155 chain id parsed from the requested block header.
in: query
required: false
type: string
format: int64
tags:
- Query
/ethermint/evm/v1/validator_account/{cons_address}:
get:
summary: >-
ValidatorAccount queries an Ethereum account's from a validator
consensus
Address.
operationId: ValidatorAccount
responses:
'200':
description: A successful response.
schema:
type: object
properties:
account_address:
type: string
description: >-
account_address is the cosmos address of the account in bech32
format.
sequence:
type: string
format: uint64
description: sequence is the account's sequence number.
account_number:
type: string
format: uint64
title: account_number is the account number
description: |-
QueryValidatorAccountResponse is the response type for the
Query/ValidatorAccount 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: cons_address
description: cons_address is the validator cons address to query the account for.
in: path
required: true
type: string
tags:
- Query
<<<<<<< HEAD
<<<<<<< HEAD
/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
- 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
tags:
- Query
/cosmos/auth/v1beta1/accounts/{address}:
get:
summary: Account returns account details based on address.
operationId: AuthAccount
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:
- Query
/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:
- Query
/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
- 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
tags:
- Query
/cosmos/bank/v1beta1/balances/{address}/{denom}:
get:
summary: Balance queries the balance of a single coin for a single account.
operationId: BankBalance
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:
- Query
/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.
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
- 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
tags:
- Query
/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.
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:
- Query
/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
description: >-
SendEnabled maps coin denom to a send_enabled status
(whether a denom is
sendable).
default_send_enabled:
type: 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:
- Query
/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
- 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
tags:
- Query
/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:
- Query
/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:
- Query
/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:
- Query
/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:
- Query
/cosmos/distribution/v1beta1/delegators/{delegator_address}/validators:
get:
summary: DelegatorValidators queries the validators of a delegator.
operationId: DistDelegatorValidators
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:
- Query
/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:
- Query
/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
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:
- Query
/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:
- Query
/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:
- Query
/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
- 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
tags:
- Query
/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:
- Query
/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:
- Query
/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:
- Query
/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:
- Query
/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
- 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
tags:
- Query
/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:
- Query
/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
- 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
tags:
- Query
/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:
- Query
/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:
- Query
/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
- 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
tags:
- Query
/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:
- Query
/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
- 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
tags:
- Query
/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
- 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
tags:
- Query
/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
- 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
tags:
- Query
/cosmos/staking/v1beta1/delegators/{delegator_addr}/validators:
get:
summary: |-
DelegatorValidators queries all validators info for given delegator
address.
operationId: DelegatorValidators
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
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
- 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
tags:
- Query
/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
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:
- Query
/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
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:
- Query
/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:
- Query
/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:
- Query
/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
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
- 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
tags:
- Query
/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
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:
- Query
/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
- 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
tags:
- Query
/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:
- Query
/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:
- Query
/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
- 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
tags:
- Query
=======
>>>>>>> v0.20.0
=======
>>>>>>> v0.21.0
definitions:
ethermint.evm.v1.ChainConfig:
type: object
properties:
homestead_block:
type: string
title: Homestead switch block (nil no fork, 0 = already homestead)
dao_fork_block:
type: string
title: TheDAO hard-fork switch block (nil no fork)
dao_fork_support:
type: boolean
title: Whether the nodes supports or opposes the DAO hard-fork
eip150_block:
type: string
title: >-
EIP150 implements the Gas price changes
(https://github.com/ethereum/EIPs/issues/150) EIP150 HF block (nil no
fork)
eip150_hash:
type: string
title: >-
EIP150 HF hash (needed for header only clients as only gas pricing
changed)
eip155_block:
type: string
title: EIP155Block HF block
eip158_block:
type: string
title: EIP158 HF block
byzantium_block:
type: string
title: Byzantium switch block (nil no fork, 0 = already on byzantium)
constantinople_block:
type: string
title: Constantinople switch block (nil no fork, 0 = already activated)
petersburg_block:
type: string
title: Petersburg switch block (nil same as Constantinople)
istanbul_block:
type: string
title: Istanbul switch block (nil no fork, 0 = already on istanbul)
muir_glacier_block:
type: string
title: >-
Eip-2384 (bomb delay) switch block (nil no fork, 0 = already
activated)
berlin_block:
type: string
title: Berlin switch block (nil = no fork, 0 = already on berlin)
london_block:
type: string
title: London switch block (nil = no fork, 0 = already on london)
arrow_glacier_block:
type: string
title: >-
Eip-4345 (bomb delay) switch block (nil = no fork, 0 = already
activated)
<<<<<<< HEAD
<<<<<<< HEAD
merge_fork_block:
type: string
title: >-
EIP-3675 (TheMerge) switch block (nil = no fork, 0 = already in merge
proceedings)
=======
gray_glacier_block:
type: string
title: >-
=======
gray_glacier_block:
type: string
title: >-
>>>>>>> v0.21.0
EIP-5133 (bomb delay) switch block (nil = no fork, 0 = already
activated)
merge_netsplit_block:
type: string
title: Virtual fork after The Merge to use as a network splitter
<<<<<<< HEAD
>>>>>>> v0.20.0
=======
>>>>>>> v0.21.0
description: >-
ChainConfig defines the Ethereum ChainConfig parameters using *sdk.Int
values
instead of *big.Int.
ethermint.evm.v1.EstimateGasResponse:
type: object
properties:
gas:
type: string
format: uint64
title: the estimated gas
title: EstimateGasResponse defines EstimateGas response
ethermint.evm.v1.Log:
type: object
properties:
address:
type: string
title: address of the contract that generated the event
topics:
type: array
items:
type: string
description: list of topics provided by the contract.
data:
type: string
format: byte
title: supplied by the contract, usually ABI-encoded
block_number:
type: string
format: uint64
title: block in which the transaction was included
tx_hash:
type: string
title: hash of the transaction
tx_index:
type: string
format: uint64
title: index of the transaction in the block
block_hash:
type: string
title: hash of the block in which the transaction was included
index:
type: string
format: uint64
title: index of the log in the block
removed:
type: boolean
description: >-
The Removed field is true if this log was reverted due to a chain
reorganisation. You must pay attention to this field if you receive
logs
through a filter query.
description: >-
Log represents an protobuf compatible Ethereum Log that defines a contract
log event. These events are generated by the LOG opcode and stored/indexed
by
the node.
ethermint.evm.v1.MsgEthereumTx:
type: object
properties:
data:
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"
}
title: inner transaction data
size:
type: number
format: double
title: 'DEPRECATED: encoded storage size of the transaction'
hash:
type: string
title: transaction hash in hex format
from:
type: string
title: |-
ethereum signer address in hex format. This address value is checked
against the address derived from the signature (V, R, S) using the
secp256k1 elliptic curve
description: MsgEthereumTx encapsulates an Ethereum transaction as an SDK message.
ethermint.evm.v1.MsgEthereumTxResponse:
type: object
properties:
hash:
type: string
title: |-
ethereum transaction hash in hex format. This hash differs from the
Tendermint sha256 hash of the transaction bytes. See
https://github.com/tendermint/tendermint/issues/6539 for reference
logs:
type: array
items:
type: object
properties:
address:
type: string
title: address of the contract that generated the event
topics:
type: array
items:
type: string
description: list of topics provided by the contract.
data:
type: string
format: byte
title: supplied by the contract, usually ABI-encoded
block_number:
type: string
format: uint64
title: block in which the transaction was included
tx_hash:
type: string
title: hash of the transaction
tx_index:
type: string
format: uint64
title: index of the transaction in the block
block_hash:
type: string
title: hash of the block in which the transaction was included
index:
type: string
format: uint64
title: index of the log in the block
removed:
type: boolean
description: >-
The Removed field is true if this log was reverted due to a
chain
reorganisation. You must pay attention to this field if you
receive logs
through a filter query.
description: >-
Log represents an protobuf compatible Ethereum Log that defines a
contract
log event. These events are generated by the LOG opcode and
stored/indexed by
the node.
description: |-
logs contains the transaction hash and the proto-compatible ethereum
logs.
ret:
type: string
format: byte
title: |-
returned data from evm function (result or data supplied with revert
opcode)
vm_error:
type: string
title: vm error is the error returned by vm execution
gas_used:
type: string
format: uint64
title: gas consumed by the transaction
description: MsgEthereumTxResponse defines the Msg/EthereumTx response type.
ethermint.evm.v1.Params:
type: object
properties:
evm_denom:
type: string
description: |-
evm denom represents the token denomination used to run the EVM state
transitions.
enable_create:
type: boolean
title: >-
enable create toggles state transitions that use the vm.Create
function
enable_call:
type: boolean
title: enable call toggles state transitions that use the vm.Call function
extra_eips:
type: array
items:
type: string
format: int64
title: extra eips defines the additional EIPs for the vm.Config
chain_config:
title: chain config defines the EVM chain configuration parameters
type: object
properties:
homestead_block:
type: string
title: Homestead switch block (nil no fork, 0 = already homestead)
dao_fork_block:
type: string
title: TheDAO hard-fork switch block (nil no fork)
dao_fork_support:
type: boolean
title: Whether the nodes supports or opposes the DAO hard-fork
eip150_block:
type: string
title: >-
EIP150 implements the Gas price changes
(https://github.com/ethereum/EIPs/issues/150) EIP150 HF block (nil
no fork)
eip150_hash:
type: string
title: >-
EIP150 HF hash (needed for header only clients as only gas pricing
changed)
eip155_block:
type: string
title: EIP155Block HF block
eip158_block:
type: string
title: EIP158 HF block
byzantium_block:
type: string
title: Byzantium switch block (nil no fork, 0 = already on byzantium)
constantinople_block:
type: string
title: Constantinople switch block (nil no fork, 0 = already activated)
petersburg_block:
type: string
title: Petersburg switch block (nil same as Constantinople)
istanbul_block:
type: string
title: Istanbul switch block (nil no fork, 0 = already on istanbul)
muir_glacier_block:
type: string
title: >-
Eip-2384 (bomb delay) switch block (nil no fork, 0 = already
activated)
berlin_block:
type: string
title: Berlin switch block (nil = no fork, 0 = already on berlin)
london_block:
type: string
title: London switch block (nil = no fork, 0 = already on london)
arrow_glacier_block:
type: string
title: >-
Eip-4345 (bomb delay) switch block (nil = no fork, 0 = already
activated)
<<<<<<< HEAD
<<<<<<< HEAD
merge_fork_block:
type: string
title: >-
EIP-3675 (TheMerge) switch block (nil = no fork, 0 = already in
merge proceedings)
=======
gray_glacier_block:
type: string
title: >-
=======
gray_glacier_block:
type: string
title: >-
>>>>>>> v0.21.0
EIP-5133 (bomb delay) switch block (nil = no fork, 0 = already
activated)
merge_netsplit_block:
type: string
title: Virtual fork after The Merge to use as a network splitter
<<<<<<< HEAD
>>>>>>> v0.20.0
=======
>>>>>>> v0.21.0
description: >-
ChainConfig defines the Ethereum ChainConfig parameters using *sdk.Int
values
instead of *big.Int.
allow_unprotected_txs:
type: boolean
description: >-
Allow unprotected transactions defines if replay-protected (i.e non
<<<<<<< HEAD
<<<<<<< HEAD
EIP155
=======
EIP155
>>>>>>> v0.20.0
=======
EIP155
>>>>>>> v0.21.0
signed) transactions can be executed on the state machine.
title: Params defines the EVM module parameters
ethermint.evm.v1.QueryAccountResponse:
type: object
properties:
balance:
type: string
description: balance is the balance of the EVM denomination.
code_hash:
type: string
description: code hash is the hex-formatted code bytes from the EOA.
nonce:
type: string
format: uint64
description: nonce is the account's sequence number.
description: >-
QueryAccountResponse is the response type for the Query/Account RPC
method.
ethermint.evm.v1.QueryBalanceResponse:
type: object
properties:
balance:
type: string
description: balance is the balance of the EVM denomination.
description: >-
QueryBalanceResponse is the response type for the Query/Balance RPC
method.
ethermint.evm.v1.QueryBaseFeeResponse:
type: object
properties:
base_fee:
type: string
description: BaseFeeResponse returns the EIP1559 base fee.
ethermint.evm.v1.QueryCodeResponse:
type: object
properties:
code:
type: string
format: byte
description: code represents the code bytes from an ethereum address.
description: |-
QueryCodeResponse is the response type for the Query/Code RPC
method.
ethermint.evm.v1.QueryCosmosAccountResponse:
type: object
properties:
cosmos_address:
type: string
description: cosmos_address is the cosmos address of the account.
sequence:
type: string
format: uint64
description: sequence is the account's sequence number.
account_number:
type: string
format: uint64
title: account_number is the account numbert
description: >-
QueryCosmosAccountResponse is the response type for the
Query/CosmosAccount
RPC method.
ethermint.evm.v1.QueryParamsResponse:
type: object
properties:
params:
description: params define the evm module parameters.
type: object
properties:
evm_denom:
type: string
description: >-
evm denom represents the token denomination used to run the EVM
state
transitions.
enable_create:
type: boolean
title: >-
enable create toggles state transitions that use the vm.Create
function
enable_call:
type: boolean
title: >-
enable call toggles state transitions that use the vm.Call
function
extra_eips:
type: array
items:
type: string
format: int64
title: extra eips defines the additional EIPs for the vm.Config
chain_config:
title: chain config defines the EVM chain configuration parameters
type: object
properties:
homestead_block:
type: string
title: Homestead switch block (nil no fork, 0 = already homestead)
dao_fork_block:
type: string
title: TheDAO hard-fork switch block (nil no fork)
dao_fork_support:
type: boolean
title: Whether the nodes supports or opposes the DAO hard-fork
eip150_block:
type: string
title: >-
EIP150 implements the Gas price changes
(https://github.com/ethereum/EIPs/issues/150) EIP150 HF block
(nil no fork)
eip150_hash:
type: string
title: >-
EIP150 HF hash (needed for header only clients as only gas
pricing changed)
eip155_block:
type: string
title: EIP155Block HF block
eip158_block:
type: string
title: EIP158 HF block
byzantium_block:
type: string
title: Byzantium switch block (nil no fork, 0 = already on byzantium)
constantinople_block:
type: string
title: >-
Constantinople switch block (nil no fork, 0 = already
activated)
petersburg_block:
type: string
title: Petersburg switch block (nil same as Constantinople)
istanbul_block:
type: string
title: Istanbul switch block (nil no fork, 0 = already on istanbul)
muir_glacier_block:
type: string
title: >-
Eip-2384 (bomb delay) switch block (nil no fork, 0 = already
activated)
berlin_block:
type: string
title: Berlin switch block (nil = no fork, 0 = already on berlin)
london_block:
type: string
title: London switch block (nil = no fork, 0 = already on london)
arrow_glacier_block:
type: string
title: >-
Eip-4345 (bomb delay) switch block (nil = no fork, 0 = already
activated)
<<<<<<< HEAD
<<<<<<< HEAD
merge_fork_block:
type: string
title: >-
EIP-3675 (TheMerge) switch block (nil = no fork, 0 = already
in merge proceedings)
=======
gray_glacier_block:
type: string
title: >-
=======
gray_glacier_block:
type: string
title: >-
>>>>>>> v0.21.0
EIP-5133 (bomb delay) switch block (nil = no fork, 0 = already
activated)
merge_netsplit_block:
type: string
title: Virtual fork after The Merge to use as a network splitter
<<<<<<< HEAD
>>>>>>> v0.20.0
=======
>>>>>>> v0.21.0
description: >-
ChainConfig defines the Ethereum ChainConfig parameters using
*sdk.Int values
instead of *big.Int.
allow_unprotected_txs:
type: boolean
description: >-
Allow unprotected transactions defines if replay-protected (i.e
<<<<<<< HEAD
<<<<<<< HEAD
non EIP155
=======
non EIP155
>>>>>>> v0.20.0
=======
non EIP155
>>>>>>> v0.21.0
signed) transactions can be executed on the state machine.
title: Params defines the EVM module parameters
description: >-
QueryParamsResponse defines the response type for querying x/evm
parameters.
ethermint.evm.v1.QueryStorageResponse:
type: object
properties:
value:
type: string
description: >-
key defines the storage state value hash associated with the given
key.
description: |-
QueryStorageResponse is the response type for the Query/Storage RPC
method.
ethermint.evm.v1.QueryTraceBlockResponse:
type: object
properties:
data:
type: string
format: byte
title: QueryTraceBlockResponse defines TraceBlock response
ethermint.evm.v1.QueryTraceTxResponse:
type: object
properties:
data:
type: string
format: byte
title: response serialized in bytes
title: QueryTraceTxResponse defines TraceTx response
ethermint.evm.v1.QueryValidatorAccountResponse:
type: object
properties:
account_address:
type: string
description: account_address is the cosmos address of the account in bech32 format.
sequence:
type: string
format: uint64
description: sequence is the account's sequence number.
account_number:
type: string
format: uint64
title: account_number is the account number
description: |-
QueryValidatorAccountResponse is the response type for the
Query/ValidatorAccount RPC method.
ethermint.evm.v1.TraceConfig:
type: object
properties:
tracer:
type: string
title: custom javascript tracer
timeout:
type: string
title: >-
overrides the default timeout of 5 seconds for JavaScript-based
tracing
calls
reexec:
type: string
format: uint64
title: number of blocks the tracer is willing to go back
disable_stack:
type: boolean
title: disable stack capture
disable_storage:
type: boolean
title: disable storage capture
debug:
type: boolean
title: print output during capture end
limit:
type: integer
format: int32
title: maximum length of output, but zero means unlimited
overrides:
title: >-
Chain overrides, can be used to execute a trace using future fork
rules
type: object
properties:
homestead_block:
type: string
title: Homestead switch block (nil no fork, 0 = already homestead)
dao_fork_block:
type: string
title: TheDAO hard-fork switch block (nil no fork)
dao_fork_support:
type: boolean
title: Whether the nodes supports or opposes the DAO hard-fork
eip150_block:
type: string
title: >-
EIP150 implements the Gas price changes
(https://github.com/ethereum/EIPs/issues/150) EIP150 HF block (nil
no fork)
eip150_hash:
type: string
title: >-
EIP150 HF hash (needed for header only clients as only gas pricing
changed)
eip155_block:
type: string
title: EIP155Block HF block
eip158_block:
type: string
title: EIP158 HF block
byzantium_block:
type: string
title: Byzantium switch block (nil no fork, 0 = already on byzantium)
constantinople_block:
type: string
title: Constantinople switch block (nil no fork, 0 = already activated)
petersburg_block:
type: string
title: Petersburg switch block (nil same as Constantinople)
istanbul_block:
type: string
title: Istanbul switch block (nil no fork, 0 = already on istanbul)
muir_glacier_block:
type: string
title: >-
Eip-2384 (bomb delay) switch block (nil no fork, 0 = already
activated)
berlin_block:
type: string
title: Berlin switch block (nil = no fork, 0 = already on berlin)
london_block:
type: string
title: London switch block (nil = no fork, 0 = already on london)
arrow_glacier_block:
type: string
title: >-
Eip-4345 (bomb delay) switch block (nil = no fork, 0 = already
activated)
<<<<<<< HEAD
<<<<<<< HEAD
merge_fork_block:
type: string
title: >-
EIP-3675 (TheMerge) switch block (nil = no fork, 0 = already in
merge proceedings)
=======
gray_glacier_block:
type: string
title: >-
=======
gray_glacier_block:
type: string
title: >-
>>>>>>> v0.21.0
EIP-5133 (bomb delay) switch block (nil = no fork, 0 = already
activated)
merge_netsplit_block:
type: string
title: Virtual fork after The Merge to use as a network splitter
<<<<<<< HEAD
>>>>>>> v0.20.0
=======
>>>>>>> v0.21.0
description: >-
ChainConfig defines the Ethereum ChainConfig parameters using *sdk.Int
values
instead of *big.Int.
enable_memory:
type: boolean
title: enable memory capture
enable_return_data:
type: boolean
title: enable return data capture
tracer_json_config:
type: string
title: tracer config
description: TraceConfig holds extra parameters to trace functions.
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"
}
<<<<<<< HEAD
<<<<<<< HEAD
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.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
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
description: >-
reverse is set to true if results are to be returned in the descending
order.
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;
}
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.
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
description: >-
SendEnabled maps coin denom to a send_enabled status (whether a
denom is
sendable).
default_send_enabled:
type: 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.
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.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.
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
description: >-
SendEnabled maps coin denom to a send_enabled status (whether a
denom is
sendable).
default_send_enabled:
type: 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
description: |-
SendEnabled maps coin denom to a send_enabled status (whether a denom is
sendable).
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.
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
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
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.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.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.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
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
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
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
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
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
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
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.
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.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.
tendermint.types.PartSetHeader:
type: object
properties:
total:
type: integer
format: int64
hash:
type: string
format: byte
title: PartsetHeader
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.
=======
>>>>>>> v0.20.0
=======
>>>>>>> v0.21.0
View Git Blame Copy Permalink