package cosmwasm.wasm.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Msg defines the wasm Msg service.

• rpc ClearAdmin (MsgClearAdmin, MsgClearAdminResponse)

  tx.proto:25

  ClearAdmin removes any admin stored for a smart contract

  message MsgClearAdmin

  tx.proto:127

  MsgClearAdmin removes any admin stored for a smart contract

  • string sender = 1

    Sender is the that actor that signed the messages

  • string contract = 3

    Contract is the address of the smart contract

  message MsgClearAdminResponse

  tx.proto:135

  MsgClearAdminResponse returns empty data

  (message has no fields)

• rpc ExecuteContract (MsgExecuteContract, MsgExecuteContractResponse)

  tx.proto:19

  Execute submits the given message data to a smart contract

  message MsgExecuteContractResponse

  tx.proto:89

  MsgExecuteContractResponse returns execution result data.

  • bytes data = 1

    Data contains base64-encoded bytes to returned from the contract

• rpc InstantiateContract (MsgInstantiateContract, MsgInstantiateContractResponse)

  tx.proto:16

  Instantiate creates a new smart contract instance for the given code id.

  message MsgInstantiateContractResponse

  tx.proto:66

  MsgInstantiateContractResponse return instantiation result data

  • string address = 1

    Address is the bech32 address of the new contract instance.

  • bytes data = 2

    Data contains base64-encoded bytes to returned from the contract

• rpc MigrateContract (MsgMigrateContract, MsgMigrateContractResponse)

  tx.proto:21

  Migrate runs a code upgrade/ downgrade for a smart contract

  message MsgMigrateContract

  tx.proto:95

  MsgMigrateContract runs a code upgrade/ downgrade for a smart contract

  • string sender = 1

    Sender is the that actor that signed the messages

  • string contract = 2

    Contract is the address of the smart contract

  • uint64 code_id = 3

    CodeID references the new WASM code

  • bytes msg = 4

    Msg json encoded message to be passed to the contract on migration

  message MsgMigrateContractResponse

  tx.proto:107

  MsgMigrateContractResponse returns contract migration result data.

  • bytes data = 1

    Data contains same raw bytes returned as data from the wasm contract. (May be empty)

• rpc StoreCode (MsgStoreCode, MsgStoreCodeResponse)

  tx.proto:14

  StoreCode to submit Wasm code to the system

  message MsgStoreCodeResponse

  tx.proto:41

  MsgStoreCodeResponse returns store result data.

  • uint64 code_id = 1

    CodeID is the reference to the stored WASM code

• rpc UpdateAdmin (MsgUpdateAdmin, MsgUpdateAdminResponse)

  tx.proto:23

  UpdateAdmin sets a new admin for a smart contract

  message MsgUpdateAdmin

  tx.proto:114

  MsgUpdateAdmin sets a new admin for a smart contract

  • string sender = 1

    Sender is the that actor that signed the messages

  • string new_admin = 2

    NewAdmin address to be set

  • string contract = 3

    Contract is the address of the smart contract

  message MsgUpdateAdminResponse

  tx.proto:124

  MsgUpdateAdminResponse returns empty data

  (message has no fields)

Query provides defines the gRPC querier service

• rpc AllContractState (QueryAllContractStateRequest, QueryAllContractStateResponse)

  query.proto:32

  AllContractState gets all raw store data for a single contract

  message QueryAllContractStateRequest

  query.proto:121

  QueryAllContractStateRequest is the request type for the Query/AllContractState RPC method

  • string address = 1

    address is the address of the contract

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

    pagination defines an optional pagination for the request.

  message QueryAllContractStateResponse

  query.proto:130

  QueryAllContractStateResponse is the response type for the Query/AllContractState RPC method

  • repeated Model models = 1

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

    pagination defines the pagination in the response.

• rpc Code (QueryCodeRequest, QueryCodeResponse)

  query.proto:49

  Code gets the binary code and metadata for a singe wasm code

  message QueryCodeRequest

  query.proto:168

  QueryCodeRequest is the request type for the Query/Code RPC method

  • uint64 code_id = 1

    grpc-gateway_out does not support Go style CodID

  message QueryCodeResponse

  query.proto:189

  QueryCodeResponse is the response type for the Query/Code RPC method

  • optional CodeInfoResponse code_info = 1

  • bytes data = 2

• rpc Codes (QueryCodesRequest, QueryCodesResponse)

  query.proto:53

  Codes gets the metadata for all stored wasm codes

  message QueryCodesRequest

  query.proto:197

  QueryCodesRequest is the request type for the Query/Codes RPC method

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

    pagination defines an optional pagination for the request.

  message QueryCodesResponse

  query.proto:203

  QueryCodesResponse is the response type for the Query/Codes RPC method

  • repeated CodeInfoResponse code_infos = 1

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

    pagination defines the pagination in the response.

• rpc ContractHistory (QueryContractHistoryRequest, QueryContractHistoryResponse)

  query.proto:21

  ContractHistory gets the contract code history

  message QueryContractHistoryRequest

  query.proto:85

  QueryContractHistoryRequest is the request type for the Query/ContractHistory RPC method

  • string address = 1

    address is the address of the contract to query

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

    pagination defines an optional pagination for the request.

  message QueryContractHistoryResponse

  query.proto:94

  QueryContractHistoryResponse is the response type for the Query/ContractHistory RPC method

  • repeated ContractCodeHistoryEntry entries = 1

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

    pagination defines the pagination in the response.

• rpc ContractInfo (QueryContractInfoRequest, QueryContractInfoResponse)

  query.proto:16

  ContractInfo gets the contract meta data

  message QueryContractInfoRequest

  query.proto:65

  QueryContractInfoRequest is the request type for the Query/ContractInfo RPC method

  • string address = 1

    address is the address of the contract to query

  message QueryContractInfoResponse

  query.proto:71

  QueryContractInfoResponse is the response type for the Query/ContractInfo RPC method

  • string address = 1

    address is the address of the contract

  • optional ContractInfo contract_info = 2

• rpc ContractsByCode (QueryContractsByCodeRequest, QueryContractsByCodeResponse)

  query.proto:27

  ContractsByCode lists all smart contracts for a code id

  message QueryContractsByCodeRequest

  query.proto:103

  QueryContractsByCodeRequest is the request type for the Query/ContractsByCode RPC method

  • uint64 code_id = 1

    grpc-gateway_out does not support Go style CodID

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

    pagination defines an optional pagination for the request.

  message QueryContractsByCodeResponse

  query.proto:111

  QueryContractsByCodeResponse is the response type for the Query/ContractsByCode RPC method

  • repeated string contracts = 1

    contracts are a set of contract addresses

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

    pagination defines the pagination in the response.

• rpc PinnedCodes (QueryPinnedCodesRequest, QueryPinnedCodesResponse)

  query.proto:58

  PinnedCodes gets the pinned code ids

  message QueryPinnedCodesRequest

  query.proto:211

  QueryPinnedCodesRequest is the request type for the Query/PinnedCodes RPC method

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

    pagination defines an optional pagination for the request.

  message QueryPinnedCodesResponse

  query.proto:218

  QueryPinnedCodesResponse is the response type for the Query/PinnedCodes RPC method

  • repeated uint64 code_ids = 1

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

    pagination defines the pagination in the response.

• rpc RawContractState (QueryRawContractStateRequest, QueryRawContractStateResponse)

  query.proto:37

  RawContractState gets single key from the raw store data of a contract

  message QueryRawContractStateRequest

  query.proto:138

  QueryRawContractStateRequest is the request type for the Query/RawContractState RPC method

  • string address = 1

    address is the address of the contract

  • bytes query_data = 2

  message QueryRawContractStateResponse

  query.proto:146

  QueryRawContractStateResponse is the response type for the Query/RawContractState RPC method

  • bytes data = 1

    Data contains the raw store data

• rpc SmartContractState (QuerySmartContractStateRequest, QuerySmartContractStateResponse)

  query.proto:43

  SmartContractState get smart query result from the contract

  message QuerySmartContractStateRequest

  query.proto:153

  QuerySmartContractStateRequest is the request type for the Query/SmartContractState RPC method

  • string address = 1

    address is the address of the contract

  • bytes query_data = 2

    QueryData contains the query data passed to the contract

  message QuerySmartContractStateResponse

  query.proto:162

  QuerySmartContractStateResponse is the response type for the Query/SmartContractState RPC method

  • bytes data = 1

    Data contains the json data returned from the smart contract

AbsoluteTxPosition is a unique transaction position that allows for global ordering of transactions.

Used in: ContractCodeHistoryEntry, ContractInfo

• uint64 block_height = 1

  BlockHeight is the block the contract was created at

• uint64 tx_index = 2

  TxIndex is a monotonic counter within the block (actual transaction index, or gas consumed)

AccessConfig access control type.

Used in: CodeInfo, MsgStoreCode, Params, StoreCodeProposal

• AccessType permission = 1

• string address = 2

AccessType permission types

Used in: AccessConfig, AccessTypeParam, Params

• ACCESS_TYPE_UNSPECIFIED = 0

  AccessTypeUnspecified placeholder for empty value

• ACCESS_TYPE_NOBODY = 1

  AccessTypeNobody forbidden

• ACCESS_TYPE_ONLY_ADDRESS = 2

  AccessTypeOnlyAddress restricted to an address

• ACCESS_TYPE_EVERYBODY = 3

  AccessTypeEverybody unrestricted

AccessTypeParam

• AccessType value = 1

ClearAdminProposal gov proposal content type to clear the admin of a contract.

• string title = 1

  Title is a short summary

• string description = 2

  Description is a human readable text

• string contract = 3

  Contract is the address of the smart contract

Code struct encompasses CodeInfo and CodeBytes

Used in: GenesisState

• uint64 code_id = 1

• optional CodeInfo code_info = 2

• bytes code_bytes = 3

• bool pinned = 4

  Pinned to wasmvm cache

CodeInfo is data for the uploaded contract WASM code

Used in: Code

• bytes code_hash = 1

  CodeHash is the unique identifier created by wasmvm

• string creator = 2

  Creator address who initially stored the code

• optional AccessConfig instantiate_config = 5

  InstantiateConfig access control to apply on contract creation, optional

CodeInfoResponse contains code meta data from CodeInfo

Used in: QueryCodeResponse, QueryCodesResponse

• uint64 code_id = 1

  id for legacy support

• string creator = 2

• bytes data_hash = 3

Contract struct encompasses ContractAddress, ContractInfo, and ContractState

Used in: GenesisState

• string contract_address = 1

• optional ContractInfo contract_info = 2

• repeated Model contract_state = 3

ContractCodeHistoryEntry metadata to a contract.

Used in: QueryContractHistoryResponse

• ContractCodeHistoryOperationType operation = 1

• uint64 code_id = 2

  CodeID is the reference to the stored WASM code

• optional AbsoluteTxPosition updated = 3

  Updated Tx position when the operation was executed.

• bytes msg = 4

ContractCodeHistoryOperationType actions that caused a code change

Used in: ContractCodeHistoryEntry

• CONTRACT_CODE_HISTORY_OPERATION_TYPE_UNSPECIFIED = 0

  ContractCodeHistoryOperationTypeUnspecified placeholder for empty value

• CONTRACT_CODE_HISTORY_OPERATION_TYPE_INIT = 1

  ContractCodeHistoryOperationTypeInit on chain contract instantiation

• CONTRACT_CODE_HISTORY_OPERATION_TYPE_MIGRATE = 2

  ContractCodeHistoryOperationTypeMigrate code migration

• CONTRACT_CODE_HISTORY_OPERATION_TYPE_GENESIS = 3

  ContractCodeHistoryOperationTypeGenesis based on genesis data

ContractInfo stores a WASM contract instance

Used in: Contract, QueryContractInfoResponse

• uint64 code_id = 1

  CodeID is the reference to the stored Wasm code

• string creator = 2

  Creator address who initially instantiated the contract

• string admin = 3

  Admin is an optional address that can execute migrations

• string label = 4

  Label is optional metadata to be stored with a contract instance.

• optional AbsoluteTxPosition created = 5

  Created Tx position when the contract was instantiated. This data should kept internal and not be exposed via query results. Just use for sorting

• string ibc_port_id = 6

• optional google.protobuf.Any extension = 7

  Extension is an extension point to store custom metadata within the persistence model.

ExecuteContractProposal gov proposal content type to call execute on a contract.

• string title = 1

  Title is a short summary

• string description = 2

  Description is a human readable text

• string run_as = 3

  RunAs is the address that is passed to the contract's environment as sender

• string contract = 4

  Contract is the address of the smart contract

• bytes msg = 5

  Msg json encoded message to be passed to the contract as execute

• repeated cosmos.base.v1beta1.Coin funds = 6

  Funds coins that are transferred to the contract on instantiation

GenesisState - genesis state of x/wasm

• optional Params params = 1

• repeated Code codes = 2

• repeated Contract contracts = 3

• repeated Sequence sequences = 4

• repeated GenesisState.GenMsgs gen_msgs = 5

GenMsgs define the messages that can be executed during genesis phase in order. The intention is to have more human readable data that is auditable.

Used in: GenesisState

• oneof sum

  sum is a single message

  • MsgStoreCode store_code = 1

  • MsgInstantiateContract instantiate_contract = 2

  • MsgExecuteContract execute_contract = 3

InstantiateContractProposal gov proposal content type to instantiate a contract.

• string title = 1

  Title is a short summary

• string description = 2

  Description is a human readable text

• string run_as = 3

  RunAs is the address that is passed to the contract's environment as sender

• string admin = 4

  Admin is an optional address that can execute migrations

• uint64 code_id = 5

  CodeID is the reference to the stored WASM code

• string label = 6

  Label is optional metadata to be stored with a constract instance.

• bytes msg = 7

  Msg json encoded message to be passed to the contract on instantiation

• repeated cosmos.base.v1beta1.Coin funds = 8

  Funds coins that are transferred to the contract on instantiation

MigrateContractProposal gov proposal content type to migrate a contract.

• string title = 1

  Title is a short summary

• string description = 2

  Description is a human readable text

  Note: skipping 3 as this was previously used for unneeded run_as

• string contract = 4

  Contract is the address of the smart contract

• uint64 code_id = 5

  CodeID references the new WASM codesudo

• bytes msg = 6

  Msg json encoded message to be passed to the contract on migration

Model is a struct that holds a KV pair

Used in: Contract, QueryAllContractStateResponse

• bytes key = 1

  hex-encode key to read it better (this is often ascii)

• bytes value = 2

  base64-encode raw value

MsgExecuteContract submits the given message data to a smart contract

Used as request type in: Msg.ExecuteContract

Used as field type in: GenesisState.GenMsgs

• string sender = 1

  Sender is the that actor that signed the messages

• string contract = 2

  Contract is the address of the smart contract

• bytes msg = 3

  Msg json encoded message to be passed to the contract

• repeated cosmos.base.v1beta1.Coin funds = 5

  Funds coins that are transferred to the contract on execution

MsgIBCCloseChannel port and channel need to be owned by the contract

• string channel = 2

MsgIBCSend

• string channel = 2

  the channel by which the packet will be sent

• uint64 timeout_height = 4

  Timeout height relative to the current block height. The timeout is disabled when set to 0.

• uint64 timeout_timestamp = 5

  Timeout timestamp (in nanoseconds) relative to the current block timestamp. The timeout is disabled when set to 0.

• bytes data = 6

  Data is the payload to transfer. We must not make assumption what format or content is in here.

MsgInstantiateContract create a new smart contract instance for the given code id.

Used as request type in: Msg.InstantiateContract

Used as field type in: GenesisState.GenMsgs

• string sender = 1

  Sender is the that actor that signed the messages

• string admin = 2

  Admin is an optional address that can execute migrations

• uint64 code_id = 3

  CodeID is the reference to the stored WASM code

• string label = 4

  Label is optional metadata to be stored with a contract instance.

• bytes msg = 5

  Msg json encoded message to be passed to the contract on instantiation

• repeated cosmos.base.v1beta1.Coin funds = 6

  Funds coins that are transferred to the contract on instantiation

MsgStoreCode submit Wasm code to the system

Used as request type in: Msg.StoreCode

Used as field type in: GenesisState.GenMsgs

• string sender = 1

  Sender is the that actor that signed the messages

• bytes wasm_byte_code = 2

  WASMByteCode can be raw or gzip compressed

• optional AccessConfig instantiate_permission = 5

  InstantiatePermission access control to apply on contract creation, optional

Params defines the set of wasm parameters.

Used in: GenesisState

• optional AccessConfig code_upload_access = 1

• AccessType instantiate_default_permission = 2

• uint64 max_wasm_code_size = 3

PinCodesProposal gov proposal content type to pin a set of code ids in the wasmvm cache.

• string title = 1

  Title is a short summary

• string description = 2

  Description is a human readable text

• repeated uint64 code_ids = 3

  CodeIDs references the new WASM codes

Sequence key and value of an id generation counter

Used in: GenesisState

• bytes id_key = 1

• uint64 value = 2

StoreCodeProposal gov proposal content type to submit WASM code to the system

• string title = 1

  Title is a short summary

• string description = 2

  Description is a human readable text

• string run_as = 3

  RunAs is the address that is passed to the contract's environment as sender

• bytes wasm_byte_code = 4

  WASMByteCode can be raw or gzip compressed

• optional AccessConfig instantiate_permission = 7

  InstantiatePermission to apply on contract creation, optional

SudoContractProposal gov proposal content type to call sudo on a contract.

• string title = 1

  Title is a short summary

• string description = 2

  Description is a human readable text

• string contract = 3

  Contract is the address of the smart contract

• bytes msg = 4

  Msg json encoded message to be passed to the contract as sudo

UnpinCodesProposal gov proposal content type to unpin a set of code ids in the wasmvm cache.

• string title = 1

  Title is a short summary

• string description = 2

  Description is a human readable text

• repeated uint64 code_ids = 3

  CodeIDs references the WASM codes

UpdateAdminProposal gov proposal content type to set an admin for a contract.

• string title = 1

  Title is a short summary

• string description = 2

  Description is a human readable text

• string new_admin = 3

  NewAdmin address to be set

• string contract = 4

  Contract is the address of the smart contract