Cosmos · Schema
Cosmos SDK cosmos.bank.v1beta1 Schemas
JSON Schema definitions for the cosmos.bank.v1beta1 module of the Cosmos SDK gRPC-gateway REST API.
BlockchainCosmosIBCStakingGovernanceDeFiWeb3
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Cosmos SDK cosmos.bank.v1beta1 Schemas",
"description": "JSON Schema definitions for the cosmos.bank.v1beta1 module of the Cosmos SDK gRPC-gateway REST API.",
"definitions": {
"cosmos.bank.v1beta1.DenomOwner": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "address defines the address that owns a particular denomination."
},
"balance": {
"description": "balance is the balance of the denominated coin for an account.",
"type": "object",
"properties": {
"denom": {
"type": "string"
},
"amount": {
"type": "string"
}
}
}
},
"description": "DenomOwner defines structure representing an account that owns or holds a\nparticular denominated token. It contains the account address and account\nbalance of the denominated token."
},
"cosmos.bank.v1beta1.DenomUnit": {
"type": "object",
"properties": {
"denom": {
"type": "string",
"description": "denom represents the string name of the given denom unit (e.g uatom)."
},
"exponent": {
"type": "integer",
"format": "int64",
"description": "exponent represents power of 10 exponent that one must\nraise the base_denom to in order to equal the given DenomUnit's denom\n1 denom = 10^exponent base_denom\n(e.g. with a base_denom of uatom, one can create a DenomUnit of 'atom' with\nexponent = 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\ndenomination unit of the basic token."
},
"cosmos.bank.v1beta1.Metadata": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"denomUnits": {
"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\nraise the base_denom to in order to equal the given DenomUnit's denom\n1 denom = 10^exponent base_denom\n(e.g. with a base_denom of uatom, one can create a DenomUnit of 'atom' with\nexponent = 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\ndenomination 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\ndisplayed 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\nbe the same as the display."
},
"uri": {
"type": "string",
"description": "URI to a document (on or off-chain) that contains additional information. Optional."
},
"uriHash": {
"type": "string",
"description": "URIHash is a sha256 hash of a document pointed by URI. It's used to verify that\nthe document didn't change. Optional."
}
},
"description": "Metadata represents a struct that describes\na basic token."
},
"cosmos.bank.v1beta1.Params": {
"type": "object",
"properties": {
"sendEnabled": {
"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\nsendable)."
},
"description": "Deprecated: Use of SendEnabled in params is deprecated.\nFor genesis, use the newly added send_enabled field in the genesis object.\nStorage, lookup, and manipulation of this information is now in the keeper.\n\nAs of cosmos-sdk 0.47, this only exists for backwards compatibility of genesis files."
},
"defaultSendEnabled": {
"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.\n\nNOTE: The amount field is an Int which implements the custom method\nsignatures required by gogoproto."
},
"description": "balances is the balances of all the coins."
},
"pagination": {
"description": "pagination defines the pagination in the response.",
"type": "object",
"properties": {
"nextKey": {
"type": "string",
"format": "byte",
"description": "next_key is the key to be passed to PageRequest.key to\nquery the next page most efficiently. It will be empty if\nthere are no more results."
},
"total": {
"type": "string",
"format": "uint64",
"title": "total is total number of results available if PageRequest.count_total\nwas set, its value is undefined otherwise"
}
}
}
},
"description": "QueryAllBalancesResponse is the response type for the Query/AllBalances RPC\nmethod."
},
"cosmos.bank.v1beta1.QueryBalanceResponse": {
"type": "object",
"properties": {
"balance": {
"description": "balance is the balance of the coin.",
"type": "object",
"properties": {
"denom": {
"type": "string"
},
"amount": {
"type": "string"
}
}
}
},
"description": "QueryBalanceResponse is the response type for the Query/Balance RPC method."
},
"cosmos.bank.v1beta1.QueryDenomMetadataByQueryStringResponse": {
"type": "object",
"properties": {
"metadata": {
"description": "metadata describes and provides all the client information for the requested token.",
"type": "object",
"properties": {
"description": {
"type": "string"
},
"denomUnits": {
"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\nraise the base_denom to in order to equal the given DenomUnit's denom\n1 denom = 10^exponent base_denom\n(e.g. with a base_denom of uatom, one can create a DenomUnit of 'atom' with\nexponent = 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\ndenomination 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\ndisplayed 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\nbe the same as the display."
},
"uri": {
"type": "string",
"description": "URI to a document (on or off-chain) that contains additional information. Optional."
},
"uriHash": {
"type": "string",
"description": "URIHash is a sha256 hash of a document pointed by URI. It's used to verify that\nthe document didn't change. Optional."
}
}
}
},
"description": "QueryDenomMetadataByQueryStringResponse is the response type for the Query/DenomMetadata RPC\nmethod. Identical with QueryDenomMetadataResponse but receives denom as query string in request."
},
"cosmos.bank.v1beta1.QueryDenomMetadataResponse": {
"type": "object",
"properties": {
"metadata": {
"description": "metadata describes and provides all the client information for the requested token.",
"type": "object",
"properties": {
"description": {
"type": "string"
},
"denomUnits": {
"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\nraise the base_denom to in order to equal the given DenomUnit's denom\n1 denom = 10^exponent base_denom\n(e.g. with a base_denom of uatom, one can create a DenomUnit of 'atom' with\nexponent = 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\ndenomination 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\ndisplayed 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\nbe the same as the display."
},
"uri": {
"type": "string",
"description": "URI to a document (on or off-chain) that contains additional information. Optional."
},
"uriHash": {
"type": "string",
"description": "URIHash is a sha256 hash of a document pointed by URI. It's used to verify that\nthe document didn't change. Optional."
}
}
}
},
"description": "QueryDenomMetadataResponse is the response type for the Query/DenomMetadata RPC\nmethod."
},
"cosmos.bank.v1beta1.QueryDenomOwnersByQueryResponse": {
"type": "object",
"properties": {
"denomOwners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "address defines the address that owns a particular denomination."
},
"balance": {
"description": "balance is the balance of the denominated coin for an account.",
"type": "object",
"properties": {
"denom": {
"type": "string"
},
"amount": {
"type": "string"
}
}
}
},
"description": "DenomOwner defines structure representing an account that owns or holds a\nparticular denominated token. It contains the account address and account\nbalance of the denominated token."
}
},
"pagination": {
"description": "pagination defines the pagination in the response.",
"type": "object",
"properties": {
"nextKey": {
"type": "string",
"format": "byte",
"description": "next_key is the key to be passed to PageRequest.key to\nquery the next page most efficiently. It will be empty if\nthere are no more results."
},
"total": {
"type": "string",
"format": "uint64",
"title": "total is total number of results available if PageRequest.count_total\nwas set, its value is undefined otherwise"
}
}
}
},
"description": "QueryDenomOwnersByQueryResponse defines the RPC response of a DenomOwnersByQuery RPC query."
},
"cosmos.bank.v1beta1.QueryDenomOwnersResponse": {
"type": "object",
"properties": {
"denomOwners": {
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "address defines the address that owns a particular denomination."
},
"balance": {
"description": "balance is the balance of the denominated coin for an account.",
"type": "object",
"properties": {
"denom": {
"type": "string"
},
"amount": {
"type": "string"
}
}
}
},
"description": "DenomOwner defines structure representing an account that owns or holds a\nparticular denominated token. It contains the account address and account\nbalance of the denominated token."
}
},
"pagination": {
"description": "pagination defines the pagination in the response.",
"type": "object",
"properties": {
"nextKey": {
"type": "string",
"format": "byte",
"description": "next_key is the key to be passed to PageRequest.key to\nquery the next page most efficiently. It will be empty if\nthere are no more results."
},
"total": {
"type": "string",
"format": "uint64",
"title": "total is total number of results available if PageRequest.count_total\nwas set, its value is undefined otherwise"
}
}
}
},
"description": "QueryDenomOwnersResponse defines the RPC response of a DenomOwners RPC query."
},
"cosmos.bank.v1beta1.QueryDenomsMetadataResponse": {
"type": "object",
"properties": {
"metadatas": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string"
},
"denomUnits": {
"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\nraise the base_denom to in order to equal the given DenomUnit's denom\n1 denom = 10^exponent base_denom\n(e.g. with a base_denom of uatom, one can create a DenomUnit of 'atom' with\nexponent = 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\ndenomination 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\ndisplayed 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\nbe the same as the display."
},
"uri": {
"type": "string",
"description": "URI to a document (on or off-chain) that contains additional information. Optional."
},
"uriHash": {
"type": "string",
"description": "URIHash is a sha256 hash of a document pointed by URI. It's used to verify that\nthe document didn't change. Optional."
}
},
"description": "Metadata represents a struct that describes\na 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": {
"nextKey": {
"type": "string",
"format": "byte",
"description": "next_key is the key to be passed to PageRequest.key to\nquery the next page most efficiently. It will be empty if\nthere are no more results."
},
"total": {
"type": "string",
"format": "uint64",
"title": "total is total number of results available if PageRequest.count_total\nwas set, its value is undefined otherwise"
}
}
}
},
"description": "QueryDenomsMetadataResponse is the response type for the Query/DenomsMetadata RPC\nmethod."
},
"cosmos.bank.v1beta1.QueryParamsResponse": {
"type": "object",
"properties": {
"params": {
"description": "params provides the parameters of the bank module.",
"type": "object",
"properties": {
"sendEnabled": {
"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\nsendable)."
},
"description": "Deprecated: Use of SendEnabled in params is deprecated.\nFor genesis, use the newly added send_enabled field in the genesis object.\nStorage, lookup, and manipulation of this information is now in the keeper.\n\nAs of cosmos-sdk 0.47, this only exists for backwards compatibility of genesis files."
},
"defaultSendEnabled": {
"type": "boolean"
}
}
}
},
"description": "QueryParamsResponse defines the response type for querying x/bank parameters."
},
"cosmos.bank.v1beta1.QuerySendEnabledResponse": {
"type": "object",
"properties": {
"sendEnabled": {
"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\nsendable)."
}
},
"pagination": {
"description": "pagination defines the pagination in the response. This field is only\npopulated if the denoms field in the request is empty.",
"type": "object",
"properties": {
"nextKey": {
"type": "string",
"format": "byte",
"description": "next_key is the key to be passed to PageRequest.key to\nquery the next page most efficiently. It will be empty if\nthere are no more results."
},
"total": {
"type": "string",
"format": "uint64",
"title": "total is total number of results available if PageRequest.count_total\nwas set, its value is undefined otherwise"
}
}
}
},
"description": "QuerySendEnabledResponse defines the RPC response of a SendEnable query."
},
"cosmos.bank.v1beta1.QuerySpendableBalanceByDenomResponse": {
"type": "object",
"properties": {
"balance": {
"description": "balance is the balance of the coin.",
"type": "object",
"properties": {
"denom": {
"type": "string"
},
"amount": {
"type": "string"
}
}
}
},
"description": "QuerySpendableBalanceByDenomResponse defines the gRPC response structure for\nquerying an account's spendable balance for a specific denom."
},
"cosmos.bank.v1beta1.QuerySpendableBalancesResponse": {
"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.\n\nNOTE: The amount field is an Int which implements the custom method\nsignatures required by gogoproto."
},
"description": "balances is the spendable balances of all the coins."
},
"pagination": {
"description": "pagination defines the pagination in the response.",
"type": "object",
"properties": {
"nextKey": {
"type": "string",
"format": "byte",
"description": "next_key is the key to be passed to PageRequest.key to\nquery the next page most efficiently. It will be empty if\nthere are no more results."
},
"total": {
"type": "string",
"format": "uint64",
"title": "total is total number of results available if PageRequest.count_total\nwas set, its value is undefined otherwise"
}
}
}
},
"description": "QuerySpendableBalancesResponse defines the gRPC response structure for querying\nan account's spendable balances."
},
"cosmos.bank.v1beta1.QuerySupplyOfResponse": {
"type": "object",
"properties": {
"amount": {
"description": "amount is the supply of the coin.",
"type": "object",
"properties": {
"denom": {
"type": "string"
},
"amount": {
"type": "string"
}
}
}
},
"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.\n\nNOTE: The amount field is an Int which implements the custom method\nsignatures required by gogoproto."
},
"title": "supply is the supply of the coins"
},
"pagination": {
"description": "pagination defines the pagination in the response.",
"type": "object",
"properties": {
"nextKey": {
"type": "string",
"format": "byte",
"description": "next_key is the key to be passed to PageRequest.key to\nquery the next page most efficiently. It will be empty if\nthere are no more results."
},
"total": {
"type": "string",
"format": "uint64",
"title": "total is total number of results available if PageRequest.count_total\nwas set, its value is undefined otherwise"
}
}
}
},
"title": "QueryTotalSupplyResponse is the response type for the Query/TotalSupply RPC\nmethod"
},
"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\nsendable)."
}
}
}