package cosmos.bank.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Msg defines the bank Msg service.

• rpc Send (MsgSend, MsgSendResponse)

  tx.proto:13

  Send defines a method for sending coins from one account to another account.

  message MsgSend

  tx.proto:20

  MsgSend represents a message to send coins from one account to another.

  • string from_address = 1

  • string to_address = 2

  • repeated base.v1beta1.Coin amount = 3

  message MsgSendResponse

  tx.proto:31

  MsgSendResponse defines the Msg/Send response type.

  (message has no fields)

• rpc MultiSend (MsgMultiSend, MsgMultiSendResponse)

  tx.proto:16

  MultiSend defines a method for sending coins from some accounts to other accounts.

  message MsgMultiSend

  tx.proto:34

  MsgMultiSend represents an arbitrary multi-in, multi-out send message.

  • repeated Input inputs = 1

  • repeated Output outputs = 2

  message MsgMultiSendResponse

  tx.proto:42

  MsgMultiSendResponse defines the Msg/MultiSend response type.

  (message has no fields)

Query defines the gRPC querier service.

• rpc Balance (QueryBalanceRequest, QueryBalanceResponse)

  query.proto:15

  Balance queries the balance of a single coin for a single account.

  message QueryBalanceRequest

  query.proto:57

  QueryBalanceRequest 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 QueryBalanceResponse

  query.proto:69

  QueryBalanceResponse is the response type for the Query/Balance RPC method.

  • optional base.v1beta1.Coin balance = 1

    balance is the balance of the coin.

• rpc AllBalances (QueryAllBalancesRequest, QueryAllBalancesResponse)

  query.proto:20

  AllBalances queries the balance of all coins for a single account.

  message QueryAllBalancesRequest

  query.proto:75

  QueryBalanceRequest is the request type for the Query/AllBalances RPC method.

  • string address = 1

    address is the address to query balances for.

  • optional base.query.v1beta1.PageRequest pagination = 2

    pagination defines an optional pagination for the request.

  message QueryAllBalancesResponse

  query.proto:88

  QueryAllBalancesResponse is the response type for the Query/AllBalances RPC method.

  • repeated base.v1beta1.Coin balances = 1

    balances is the balances of all the coins.

  • optional base.query.v1beta1.PageResponse pagination = 2

    pagination defines the pagination in the response.

• rpc SpendableBalances (QuerySpendableBalancesRequest, QuerySpendableBalancesResponse)

  query.proto:26

  SpendableBalances queries the spenable balance of all coins for a single account.

  message QuerySpendableBalancesRequest

  query.proto:99

  QuerySpendableBalancesRequest defines the gRPC request structure for querying an account's spendable balances.

  • string address = 1

    address is the address to query spendable balances for.

  • optional base.query.v1beta1.PageRequest pagination = 2

    pagination defines an optional pagination for the request.

  message QuerySpendableBalancesResponse

  query.proto:112

  QuerySpendableBalancesResponse defines the gRPC response structure for querying an account's spendable balances.

  • repeated base.v1beta1.Coin balances = 1

    balances is the spendable balances of all the coins.

  • optional base.query.v1beta1.PageResponse pagination = 2

    pagination defines the pagination in the response.

• rpc TotalSupply (QueryTotalSupplyRequest, QueryTotalSupplyResponse)

  query.proto:31

  TotalSupply queries the total supply of all coins.

  message QueryTotalSupplyRequest

  query.proto:123

  QueryTotalSupplyRequest is the request type for the Query/TotalSupply RPC method.

  • optional base.query.v1beta1.PageRequest pagination = 1

    pagination defines an optional pagination for the request. Since: cosmos-sdk 0.43

  message QueryTotalSupplyResponse

  query.proto:135

  QueryTotalSupplyResponse is the response type for the Query/TotalSupply RPC method

  • repeated base.v1beta1.Coin supply = 1

    supply is the supply of the coins

  • optional base.query.v1beta1.PageResponse pagination = 2

    pagination defines the pagination in the response. Since: cosmos-sdk 0.43

• rpc SupplyOf (QuerySupplyOfRequest, QuerySupplyOfResponse)

  query.proto:36

  SupplyOf queries the supply of a single coin.

  message QuerySupplyOfRequest

  query.proto:147

  QuerySupplyOfRequest is the request type for the Query/SupplyOf RPC method.

  • string denom = 1

    denom is the coin denom to query balances for.

  message QuerySupplyOfResponse

  query.proto:153

  QuerySupplyOfResponse is the response type for the Query/SupplyOf RPC method.

  • optional base.v1beta1.Coin amount = 1

    amount is the supply of the coin.

• rpc Params (QueryParamsRequest, QueryParamsResponse)

  query.proto:41

  Params queries the parameters of x/bank module.

  message QueryParamsRequest

  query.proto:159

  QueryParamsRequest defines the request type for querying x/bank parameters.

  (message has no fields)

  message QueryParamsResponse

  query.proto:162

  QueryParamsResponse defines the response type for querying x/bank parameters.

  • optional Params params = 1

• rpc DenomMetadata (QueryDenomMetadataRequest, QueryDenomMetadataResponse)

  query.proto:46

  DenomsMetadata queries the client metadata of a given coin denomination.

  message QueryDenomMetadataRequest

  query.proto:183

  QueryDenomMetadataRequest is the request type for the Query/DenomMetadata RPC method.

  • string denom = 1

    denom is the coin denom to query the metadata for.

  message QueryDenomMetadataResponse

  query.proto:190

  QueryDenomMetadataResponse is the response type for the Query/DenomMetadata RPC method.

  • optional Metadata metadata = 1

    metadata describes and provides all the client information for the requested token.

• rpc DenomsMetadata (QueryDenomsMetadataRequest, QueryDenomsMetadataResponse)

  query.proto:51

  DenomsMetadata queries the client metadata for all registered coin denominations.

  message QueryDenomsMetadataRequest

  query.proto:167

  QueryDenomsMetadataRequest is the request type for the Query/DenomsMetadata RPC method.

  • optional base.query.v1beta1.PageRequest pagination = 1

    pagination defines an optional pagination for the request.

  message QueryDenomsMetadataResponse

  query.proto:174

  QueryDenomsMetadataResponse is the response type for the Query/DenomsMetadata RPC method.

  • repeated Metadata metadatas = 1

    metadata provides the client information for all the registered tokens.

  • optional base.query.v1beta1.PageResponse pagination = 2

    pagination defines the pagination in the response.

Balance defines an account address and balance pair used in the bank module's genesis state.

Used in: GenesisState

• string address = 1

  address is the address of the balance holder.

• repeated base.v1beta1.Coin coins = 2

  coins defines the different coins this balance holds.

DenomUnit represents a struct that describes a given denomination unit of the basic token.

Used in: Metadata

• 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 = 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).

• repeated string aliases = 3

  aliases is a list of string aliases for the given denom

GenesisState defines the bank module's genesis state.

• optional Params params = 1

  params defines all the paramaters of the module.

• repeated Balance balances = 2

  balances is an array containing the balances of all the accounts.

• repeated base.v1beta1.Coin 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 Metadata denom_metadata = 4

  denom_metadata defines the metadata of the differents coins.

Input models transaction input.

Used in: MsgMultiSend

• string address = 1

• repeated base.v1beta1.Coin coins = 2

Metadata represents a struct that describes a basic token.

Used in: GenesisState, QueryDenomMetadataResponse, QueryDenomsMetadataResponse

• string description = 1

• repeated DenomUnit 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

Output models transaction outputs.

Used in: MsgMultiSend

• string address = 1

• repeated base.v1beta1.Coin coins = 2

Params defines the parameters for the bank module.

Used in: GenesisState, QueryParamsResponse

• repeated SendEnabled send_enabled = 1

• bool default_send_enabled = 2

SendAuthorization allows the grantee to spend up to spend_limit coins from the granter's account. Since: cosmos-sdk 0.43

• repeated base.v1beta1.Coin spend_limit = 1

SendEnabled maps coin denom to a send_enabled status (whether a denom is sendable).

Used in: Params

• string denom = 1

• bool enabled = 2

Supply 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 base.v1beta1.Coin total = 1