package cosmos.bank.v1beta1
Get desktop application:
View/edit binary Protocol Buffers messages
service Msg
tx.proto:14Msg defines the bank Msg service.
rpc Send (, )
tx.proto:18Send defines a method for sending coins from one account to another account.
message
tx.proto:39MsgSend represents a message to send coins from one account to another.
string from_address = 1
string to_address = 2
repeated amount = 3
message
tx.proto:56MsgSendResponse defines the Msg/Send response type.
(message has no fields)
rpc MultiSend (, )
tx.proto:21MultiSend defines a method for sending coins from some accounts to other accounts.
message
tx.proto:59MsgMultiSend represents an arbitrary multi-in, multi-out send message.
repeated inputs = 1
Inputs, despite being `repeated`, only allows one sender input. This is checked in MsgMultiSend's ValidateBasic.
repeated outputs = 2
message
tx.proto:72MsgMultiSendResponse defines the Msg/MultiSend response type.
(message has no fields)
rpc UpdateParams (, )
tx.proto:27UpdateParams defines a governance operation for updating the x/bank module parameters. The authority is defined in the keeper. Since: cosmos-sdk 0.47
message
tx.proto:77MsgUpdateParams is the Msg/UpdateParams request type. Since: cosmos-sdk 0.47
string authority = 1
authority is the address that controls the module (defaults to x/gov unless overwritten).
optional params = 2
params defines the x/bank parameters to update. NOTE: All parameters must be supplied.
message
tx.proto:94MsgUpdateParamsResponse defines the response structure for executing a MsgUpdateParams message. Since: cosmos-sdk 0.47
(message has no fields)
rpc SetSendEnabled (, )
tx.proto:35SetSendEnabled is a governance operation for setting the SendEnabled flag on any number of Denoms. Only the entries to add or update should be included. Entries that already exist in the store, but that aren't included in this message, will be left unchanged. Since: cosmos-sdk 0.47
message
tx.proto:103MsgSetSendEnabled is the Msg/SetSendEnabled request type. Only entries to add/update/delete need to be included. Existing SendEnabled entries that are not included in this message are left unchanged. Since: cosmos-sdk 0.47
string authority = 1
repeated send_enabled = 2
send_enabled is the list of entries to add or update.
repeated string use_default_for = 3
use_default_for is a list of denoms that should use the params.default_send_enabled value. Denoms listed here will have their SendEnabled entries deleted. If a denom is included that doesn't have a SendEnabled entry, it will be ignored.
message
tx.proto:122MsgSetSendEnabledResponse defines the Msg/SetSendEnabled response type. Since: cosmos-sdk 0.47
(message has no fields)
service Query
query.proto:16Query defines the gRPC querier service.
rpc Balance (, )
query.proto:18Balance queries the balance of a single coin for a single account.
message
query.proto:119QueryBalanceRequest is the request type for the Query/Balance RPC method.
string address = 1
address is the address to query balances for.
string denom = 2
denom is the coin denom to query balances for.
message
query.proto:131QueryBalanceResponse is the response type for the Query/Balance RPC method.
optional balance = 1
balance is the balance of the coin.
rpc AllBalances (, )
query.proto:27AllBalances queries the balance of all coins for a single account. When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
message
query.proto:137QueryBalanceRequest is the request type for the Query/AllBalances RPC method.
string address = 1
address is the address to query balances for.
optional pagination = 2
pagination defines an optional pagination for the request.
message
query.proto:150QueryAllBalancesResponse is the response type for the Query/AllBalances RPC method.
repeated balances = 1
balances is the balances of all the coins.
optional pagination = 2
pagination defines the pagination in the response.
rpc SpendableBalances (, )
query.proto:39SpendableBalances queries the spendable balance of all coins for a single account. When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set. Since: cosmos-sdk 0.46
message
query.proto:166QuerySpendableBalancesRequest defines the gRPC request structure for querying an account's spendable balances. Since: cosmos-sdk 0.46
string address = 1
address is the address to query spendable balances for.
optional pagination = 2
pagination defines an optional pagination for the request.
message
query.proto:181QuerySpendableBalancesResponse defines the gRPC response structure for querying an account's spendable balances. Since: cosmos-sdk 0.46
repeated balances = 1
balances is the spendable balances of all the coins.
optional pagination = 2
pagination defines the pagination in the response.
SpendableBalanceByDenom queries the spendable balance of a single denom for a single account. When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set. Since: cosmos-sdk 0.47
message
query.proto:197QuerySpendableBalanceByDenomRequest defines the gRPC request structure for querying an account's spendable balance for a specific denom. Since: cosmos-sdk 0.47
string address = 1
address is the address to query balances for.
string denom = 2
denom is the coin denom to query balances for.
message
query.proto:212QuerySpendableBalanceByDenomResponse defines the gRPC response structure for querying an account's spendable balance for a specific denom. Since: cosmos-sdk 0.47
optional balance = 1
balance is the balance of the coin.
rpc TotalSupply (, )
query.proto:60TotalSupply queries the total supply of all coins. When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
message
query.proto:220QueryTotalSupplyRequest is the request type for the Query/TotalSupply RPC method.
optional pagination = 1
pagination defines an optional pagination for the request. Since: cosmos-sdk 0.43
message
query.proto:232QueryTotalSupplyResponse is the response type for the Query/TotalSupply RPC method
repeated supply = 1
supply is the supply of the coins
optional pagination = 2
pagination defines the pagination in the response. Since: cosmos-sdk 0.43
rpc SupplyOf (, )
query.proto:69SupplyOf queries the supply of a single coin. When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set.
message
query.proto:247QuerySupplyOfRequest is the request type for the Query/SupplyOf RPC method.
string denom = 1
denom is the coin denom to query balances for.
message
query.proto:253QuerySupplyOfResponse is the response type for the Query/SupplyOf RPC method.
optional amount = 1
amount is the supply of the coin.
rpc Params (, )
query.proto:75Params queries the parameters of x/bank module.
message
query.proto:259QueryParamsRequest defines the request type for querying x/bank parameters.
(message has no fields)
message
query.proto:262QueryParamsResponse defines the response type for querying x/bank parameters.
optional params = 1
rpc DenomMetadata (, )
query.proto:81DenomsMetadata queries the client metadata of a given coin denomination.
message
query.proto:283QueryDenomMetadataRequest is the request type for the Query/DenomMetadata RPC method.
string denom = 1
denom is the coin denom to query the metadata for.
message
query.proto:290QueryDenomMetadataResponse is the response type for the Query/DenomMetadata RPC method.
optional metadata = 1
metadata describes and provides all the client information for the requested token.
rpc DenomsMetadata (, )
query.proto:88DenomsMetadata queries the client metadata for all registered coin denominations.
message
query.proto:267QueryDenomsMetadataRequest is the request type for the Query/DenomsMetadata RPC method.
optional pagination = 1
pagination defines an optional pagination for the request.
message
query.proto:274QueryDenomsMetadataResponse is the response type for the Query/DenomsMetadata RPC method.
repeated metadatas = 1
metadata provides the client information for all the registered tokens.
optional pagination = 2
pagination defines the pagination in the response.
rpc DenomOwners (, )
query.proto:100DenomOwners queries for all account addresses that own a particular token denomination. When called from another module, this query might consume a high amount of gas if the pagination field is incorrectly set. Since: cosmos-sdk 0.46
message
query.proto:298QueryDenomOwnersRequest defines the request type for the DenomOwners RPC query, which queries for a paginated set of all account holders of a particular denomination.
string denom = 1
denom defines the coin denomination to query all account holders for.
optional pagination = 2
pagination defines an optional pagination for the request.
message
query.proto:322QueryDenomOwnersResponse defines the RPC response of a DenomOwners RPC query. Since: cosmos-sdk 0.46
repeated denom_owners = 1
optional pagination = 2
pagination defines the pagination in the response.
rpc SendEnabled (, )
query.proto:112SendEnabled queries for SendEnabled entries. This query only returns denominations that have specific SendEnabled settings. Any denomination that does not have a specific setting will use the default params.default_send_enabled, and will not be returned by this query. Since: cosmos-sdk 0.47
message
query.proto:332QuerySendEnabledRequest defines the RPC request for looking up SendEnabled entries. Since: cosmos-sdk 0.47
repeated string denoms = 1
denoms is the specific denoms you want look up. Leave empty to get all entries.
optional pagination = 99
pagination defines an optional pagination for the request. This field is only read if the denoms field is empty.
message
query.proto:343QuerySendEnabledResponse defines the RPC response of a SendEnable query. Since: cosmos-sdk 0.47
repeated send_enabled = 1
optional pagination = 99
pagination defines the pagination in the response. This field is only populated if the denoms field in the request is empty.
message
genesis.proto:39Balance defines an account address and balance pair used in the bank module's genesis state.
Used in:
string address = 1
address is the address of the balance holder.
repeated coins = 2
coins defines the different coins this balance holds.
message
query.proto:311DenomOwner defines structure representing an account that owns or holds a particular denominated token. It contains the account address and account balance of the denominated token. Since: cosmos-sdk 0.46
Used in:
string address = 1
address defines the address that owns a particular denomination.
optional balance = 2
balance is the balance of the denominated coin for an account.
message
bank.proto:82DenomUnit represents a struct that describes a given denomination unit of the basic token.
Used in:
string denom = 1
denom represents the string name of the given denom unit (e.g uatom).
uint32 exponent = 2
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 = 10^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).
repeated string aliases = 3
aliases is a list of string aliases for the given denom
message
genesis.proto:13GenesisState defines the bank module's genesis state.
optional params = 1
params defines all the parameters of the module.
repeated balances = 2
balances is an array containing the balances of all the accounts.
repeated supply = 3
supply represents the total supply. If it is left empty, then supply will be calculated based on the provided balances. Otherwise, it will be used to validate that the sum of the balances equals this amount.
repeated denom_metadata = 4
denom_metadata defines the metadata of the different coins.
repeated send_enabled = 5
send_enabled defines the denoms where send is enabled or disabled. Since: cosmos-sdk 0.47
message
bank.proto:35Input models transaction input.
Used in:
string address = 1
repeated coins = 2
message
bank.proto:97Metadata represents a struct that describes a basic token.
Used in: , ,
string description = 1
repeated denom_units = 2
denom_units represents the list of DenomUnit's for a given coin
string base = 3
base represents the base denom (should be the DenomUnit with exponent = 0).
string display = 4
display indicates the suggested denom that should be displayed in clients.
string name = 5
name defines the name of the token (eg: Cosmos Atom) Since: cosmos-sdk 0.43
string symbol = 6
symbol is the token symbol usually shown on exchanges (eg: ATOM). This can be the same as the display. Since: cosmos-sdk 0.43
string uri = 7
URI to a document (on or off-chain) that contains additional information. Optional. Since: cosmos-sdk 0.46
string uri_hash = 8
URIHash is a sha256 hash of a document pointed by URI. It's used to verify that the document didn't change. Optional. Since: cosmos-sdk 0.46
message
bank.proto:50Output models transaction outputs.
Used in:
string address = 1
repeated coins = 2
message
bank.proto:13Params defines the parameters for the bank module.
Used in: , ,
repeated send_enabled = 1
Deprecated: Use of SendEnabled in params is deprecated. For genesis, use the newly added send_enabled field in the genesis object. Storage, lookup, and manipulation of this information is now in the keeper. As of cosmos-sdk 0.47, this only exists for backwards compatibility of genesis files.
bool default_send_enabled = 2
message
authz.proto:15SendAuthorization allows the grantee to spend up to spend_limit coins from the granter's account. Since: cosmos-sdk 0.43
repeated spend_limit = 1
repeated string allow_list = 2
allow_list specifies an optional list of addresses to whom the grantee can send tokens on behalf of the granter. If omitted, any recipient is allowed. Since: cosmos-sdk 0.47
message
bank.proto:27SendEnabled maps coin denom to a send_enabled status (whether a denom is sendable).
Used in: , , ,
string denom = 1
bool enabled = 2
message
bank.proto:65Supply represents a struct that passively keeps track of the total supply amounts in the network. This message is deprecated now that supply is indexed by denom.
repeated total = 1