cosmos/auth

Table of Contents

• cosmos/auth/module/v1/module.proto
  • MModule
  • MModuleAccountPermission
• cosmos/auth/v1beta1/auth.proto
  • MBaseAccount
  • MModuleAccount
  • MModuleCredential
  • MParams
• cosmos/auth/v1beta1/genesis.proto
  • MGenesisState
• cosmos/auth/v1beta1/query.proto
  • MAddressBytesToStringRequest
  • MAddressBytesToStringResponse
  • MAddressStringToBytesRequest
  • MAddressStringToBytesResponse
  • MBech32PrefixRequest
  • MBech32PrefixResponse
  • MQueryAccountAddressByIDRequest
  • MQueryAccountAddressByIDResponse
  • MQueryAccountInfoRequest
  • MQueryAccountInfoResponse
  • MQueryAccountRequest
  • MQueryAccountResponse
  • MQueryAccountsRequest
  • MQueryAccountsResponse
  • MQueryModuleAccountByNameRequest
  • MQueryModuleAccountByNameResponse
  • MQueryModuleAccountsRequest
  • MQueryModuleAccountsResponse
  • MQueryParamsRequest
  • MQueryParamsResponse
  • SQuery
• cosmos/auth/v1beta1/tx.proto
  • MMsgUpdateParams
  • MMsgUpdateParamsResponse
  • SMsg
• Scalar Value Types

cosmos/auth/module/v1/module.proto

Top

Module

Module is the config object for the auth module.

Field	Type	Label	Description
bech32_prefix	string		bech32_prefix is the bech32 account prefix for the app.
module_account_permissions	ModuleAccountPermission	repeated	module_account_permissions are module account permissions.
authority	string		authority defines the custom module authority. If not set, defaults to the governance module.

ModuleAccountPermission

ModuleAccountPermission represents permissions for a module account.

Field	Type	Label	Description
account	string		account is the name of the module.
permissions	string	repeated	permissions are the permissions this module has. Currently recognized values are minter, burner and staking.

cosmos/auth/v1beta1/auth.proto

Top

BaseAccount

BaseAccount defines a base account type. It contains all the necessary fields

for basic account functionality. Any custom account type should extend this

type for additional functionality (e.g. vesting).

Field	Type	Label	Description
address	string
pub_key	google.protobuf.Any
account_number	uint64
sequence	uint64

ModuleAccount

ModuleAccount defines an account for modules that holds coins on a pool.

Field	Type	Label	Description
base_account	BaseAccount
name	string
permissions	string	repeated

ModuleCredential

ModuleCredential represents a unclaimable pubkey for base accounts controlled by modules.

Since: cosmos-sdk 0.47

Field	Type	Label	Description
module_name	string		module_name is the name of the module used for address derivation (passed into address.Module).
derivation_keys	bytes	repeated	derivation_keys is for deriving a module account address (passed into address.Module) adding more keys creates sub-account addresses (passed into address.Derive)

Params

Params defines the parameters for the auth module.

Field	Type	Label	Description
max_memo_characters	uint64
tx_sig_limit	uint64
tx_size_cost_per_byte	uint64
sig_verify_cost_ed25519	uint64
sig_verify_cost_secp256k1	uint64

cosmos/auth/v1beta1/genesis.proto

Top

GenesisState

GenesisState defines the auth module's genesis state.

Field	Type	Label	Description
params	Params		params defines all the parameters of the module.
accounts	google.protobuf.Any	repeated	accounts are the accounts present at genesis.

cosmos/auth/v1beta1/query.proto

Top

AddressBytesToStringRequest

AddressBytesToStringRequest is the request type for AddressString rpc method.

Since: cosmos-sdk 0.46

Field	Type	Label	Description
address_bytes	bytes

AddressBytesToStringResponse

AddressBytesToStringResponse is the response type for AddressString rpc method.

Since: cosmos-sdk 0.46

Field	Type	Label	Description
address_string	string

AddressStringToBytesRequest

AddressStringToBytesRequest is the request type for AccountBytes rpc method.

Since: cosmos-sdk 0.46

Field	Type	Label	Description
address_string	string

AddressStringToBytesResponse

AddressStringToBytesResponse is the response type for AddressBytes rpc method.

Since: cosmos-sdk 0.46

Field	Type	Label	Description
address_bytes	bytes

Bech32PrefixRequest

Bech32PrefixRequest is the request type for Bech32Prefix rpc method.

Since: cosmos-sdk 0.46

Bech32PrefixResponse

Bech32PrefixResponse is the response type for Bech32Prefix rpc method.

Since: cosmos-sdk 0.46

Field	Type	Label	Description
bech32_prefix	string

QueryAccountAddressByIDRequest

QueryAccountAddressByIDRequest is the request type for AccountAddressByID rpc method

Since: cosmos-sdk 0.46.2

Field	Type	Label	Description
id	int64		Deprecated. Deprecated, use account_id instead id is the account number of the address to be queried. This field should have been an uint64 (like all account numbers), and will be updated to uint64 in a future version of the auth query.
account_id	uint64		account_id is the account number of the address to be queried. Since: cosmos-sdk 0.47

Fields with deprecated option

Name	Option
id	true

QueryAccountAddressByIDResponse

QueryAccountAddressByIDResponse is the response type for AccountAddressByID rpc method

Since: cosmos-sdk 0.46.2

Field	Type	Label	Description
account_address	string

QueryAccountInfoRequest

QueryAccountInfoRequest is the Query/AccountInfo request type.

Since: cosmos-sdk 0.47

Field	Type	Label	Description
address	string		address is the account address string.

QueryAccountInfoResponse

QueryAccountInfoResponse is the Query/AccountInfo response type.

Since: cosmos-sdk 0.47

Field	Type	Label	Description
info	BaseAccount		info is the account info which is represented by BaseAccount.

QueryAccountRequest

QueryAccountRequest is the request type for the Query/Account RPC method.

Field	Type	Label	Description
address	string		address defines the address to query for.

QueryAccountResponse

QueryAccountResponse is the response type for the Query/Account RPC method.

Field	Type	Label	Description
account	google.protobuf.Any		account defines the account of the corresponding address.

QueryAccountsRequest

QueryAccountsRequest is the request type for the Query/Accounts RPC method.

Since: cosmos-sdk 0.43

Field	Type	Label	Description
pagination	cosmos.base.query.v1beta1.PageRequest		pagination defines an optional pagination for the request.

QueryAccountsResponse

QueryAccountsResponse is the response type for the Query/Accounts RPC method.

Since: cosmos-sdk 0.43

Field	Type	Label	Description
accounts	google.protobuf.Any	repeated	accounts are the existing accounts
pagination	cosmos.base.query.v1beta1.PageResponse		pagination defines the pagination in the response.

QueryModuleAccountByNameRequest

QueryModuleAccountByNameRequest is the request type for the Query/ModuleAccountByName RPC method.

Field	Type	Label	Description
name	string

QueryModuleAccountByNameResponse

QueryModuleAccountByNameResponse is the response type for the Query/ModuleAccountByName RPC method.

Field	Type	Label	Description
account	google.protobuf.Any

QueryModuleAccountsRequest

QueryModuleAccountsRequest is the request type for the Query/ModuleAccounts RPC method.

Since: cosmos-sdk 0.46

QueryModuleAccountsResponse

QueryModuleAccountsResponse is the response type for the Query/ModuleAccounts RPC method.

Since: cosmos-sdk 0.46

Field	Type	Label	Description
accounts	google.protobuf.Any	repeated

QueryParamsRequest

QueryParamsRequest is the request type for the Query/Params RPC method.

QueryParamsResponse

QueryParamsResponse is the response type for the Query/Params RPC method.

Field	Type	Label	Description
params	Params		params defines the parameters of the module.

Query

Query defines the gRPC querier service.

Method Name	Request Type	Response Type	Description
Accounts	QueryAccountsRequest	QueryAccountsResponse	Accounts returns all the existing accounts. 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.43
Account	QueryAccountRequest	QueryAccountResponse	Account returns account details based on address.
AccountAddressByID	QueryAccountAddressByIDRequest	QueryAccountAddressByIDResponse	AccountAddressByID returns account address based on account number. Since: cosmos-sdk 0.46.2
Params	QueryParamsRequest	QueryParamsResponse	Params queries all parameters.
ModuleAccounts	QueryModuleAccountsRequest	QueryModuleAccountsResponse	ModuleAccounts returns all the existing module accounts. Since: cosmos-sdk 0.46
ModuleAccountByName	QueryModuleAccountByNameRequest	QueryModuleAccountByNameResponse	ModuleAccountByName returns the module account info by module name
Bech32Prefix	Bech32PrefixRequest	Bech32PrefixResponse	Bech32Prefix queries bech32Prefix Since: cosmos-sdk 0.46
AddressBytesToString	AddressBytesToStringRequest	AddressBytesToStringResponse	AddressBytesToString converts Account Address bytes to string Since: cosmos-sdk 0.46
AddressStringToBytes	AddressStringToBytesRequest	AddressStringToBytesResponse	AddressStringToBytes converts Address string to bytes Since: cosmos-sdk 0.46
AccountInfo	QueryAccountInfoRequest	QueryAccountInfoResponse	AccountInfo queries account info which is common to all account types. Since: cosmos-sdk 0.47

Methods with HTTP bindings

Method Name	Method	Pattern	Body
Accounts	GET	/cosmos/auth/v1beta1/accounts
Account	GET	/cosmos/auth/v1beta1/accounts/{address}
AccountAddressByID	GET	/cosmos/auth/v1beta1/address_by_id/{id}
Params	GET	/cosmos/auth/v1beta1/params
ModuleAccounts	GET	/cosmos/auth/v1beta1/module_accounts
ModuleAccountByName	GET	/cosmos/auth/v1beta1/module_accounts/{name}
Bech32Prefix	GET	/cosmos/auth/v1beta1/bech32
AddressBytesToString	GET	/cosmos/auth/v1beta1/bech32/{address_bytes}
AddressStringToBytes	GET	/cosmos/auth/v1beta1/bech32/{address_string}
AccountInfo	GET	/cosmos/auth/v1beta1/account_info/{address}

cosmos/auth/v1beta1/tx.proto

Top

MsgUpdateParams

MsgUpdateParams is the Msg/UpdateParams request type.

Since: cosmos-sdk 0.47

Field	Type	Label	Description
authority	string		authority is the address that controls the module (defaults to x/gov unless overwritten).
params	Params		params defines the x/auth parameters to update. NOTE: All parameters must be supplied.

MsgUpdateParamsResponse

MsgUpdateParamsResponse defines the response structure for executing a

MsgUpdateParams message.

Since: cosmos-sdk 0.47

Msg

Msg defines the x/auth Msg service.

Method Name	Request Type	Response Type	Description
UpdateParams	MsgUpdateParams	MsgUpdateParamsResponse	UpdateParams defines a (governance) operation for updating the x/auth module parameters. The authority defaults to the x/gov module account. Since: cosmos-sdk 0.47

Scalar Value Types

.proto Type	Notes	Python Type
double		float
float		float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int/long
uint32	Uses variable-length encoding.	int/long
uint64	Uses variable-length encoding.	int/long
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int/long
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	int
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	int/long
sfixed32	Always four bytes.	int
sfixed64	Always eight bytes.	int/long
bool		boolean
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	str/unicode
bytes	May contain any arbitrary sequence of bytes.	str