package cosmwasm.wasm.v1beta1

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:119

  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:127

  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 MsgExecuteContract

  tx.proto:69

  MsgExecuteContract submits the given message data to 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

  • bytes msg = 3

    Msg json encoded message to be passed to the contract

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

    SentFunds coins that are transferred to the contract on execution

  message MsgExecuteContractResponse

  tx.proto:81

  MsgExecuteContractResponse returns execution result data.

  • bytes data = 1

    Data contains base64-encoded bytes to returned from the contract

• rpc InstantiateContract (MsgInstantiateContract, MsgInstantiateContractResponse)

  tx.proto:17

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

  message MsgInstantiateContract

  tx.proto:48

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

  • 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 init_msg = 5

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

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

    InitFunds coins that are transferred to the contract on instantiation

  message MsgInstantiateContractResponse

  tx.proto:63

  MsgInstantiateContractResponse return instantiation result data

  • string address = 1

    Address is the bech32 address of the new contract instance.

• rpc MigrateContract (MsgMigrateContract, MsgMigrateContractResponse)

  tx.proto:21

  Migrate runs a code upgrade/ downgrade for a smart contract

  message MsgMigrateContract

  tx.proto:87

  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 migrate_msg = 4

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

  message MsgMigrateContractResponse

  tx.proto:99

  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:15

  StoreCode to submit Wasm code to the system

  message MsgStoreCode

  tx.proto:29

  MsgStoreCode submit Wasm code to the system

  • string sender = 1

    Sender is the that actor that signed the messages

  • bytes wasm_byte_code = 2

    WASMByteCode can be raw or gzip compressed

  • string source = 3

    Source is a valid absolute HTTPS URI to the contract's source code, optional

  • string builder = 4

    Builder is a valid docker image name with tag, optional

  • optional AccessConfig instantiate_permission = 5

    InstantiatePermission access control to apply on contract creation, optional

  message MsgStoreCodeResponse

  tx.proto:42

  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:106

  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:116

  MsgUpdateAdminResponse returns empty data

  (message has no fields)

Query provides defines the gRPC querier service

• rpc AllContractState (QueryAllContractStateRequest, QueryAllContractStateResponse)

  query.proto:28

  AllContractState gets all raw store data for a single contract

  message QueryAllContractStateRequest

  query.proto:100

  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:108

  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:40

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

  message QueryCodeRequest

  query.proto:142

  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:158

  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:44

  Codes gets the metadata for all stored wasm codes

  message QueryCodesRequest

  query.proto:165

  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:171

  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:20

  ContractHistory gets the contract code history

  message QueryContractHistoryRequest

  query.proto:64

  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:72

  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:50

  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:55

  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:24

  ContractsByCode lists all smart contracts for a code id

  message QueryContractsByCodeRequest

  query.proto:79

  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:93

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

  • repeated ContractInfoWithAddress contract_infos = 1

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

    pagination defines the pagination in the response.

• rpc RawContractState (QueryRawContractStateRequest, QueryRawContractStateResponse)

  query.proto:32

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

  message QueryRawContractStateRequest

  query.proto:115

  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:122

  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:36

  SmartContractState get smart query result from the contract

  message QuerySmartContractStateRequest

  query.proto:128

  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:136

  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

• 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

CodeInfo is data for the uploaded contract WASM code

• bytes code_hash = 1

  CodeHash is the unique CodeID

• string creator = 2

  Creator address who initially stored the code

• string source = 3

  Source is a valid absolute HTTPS URI to the contract's source code, optional

• string builder = 4

  Builder is a valid docker image name with tag, optional

• 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

• string source = 4

• string builder = 5

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: ContractInfoWithAddress, 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

ContractInfoWithAddress adds the address (key) to the ContractInfo representation

Used in: QueryContractsByCodeResponse

• string address = 1

• optional ContractInfo contract_info = 2

Model is a struct that holds a KV pair

Used in: QueryAllContractStateResponse

• bytes key = 1

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

• bytes value = 2

  base64-encode raw value

Params defines the set of wasm parameters.

• optional AccessConfig code_upload_access = 1

• AccessType instantiate_default_permission = 2

• uint64 max_wasm_code_size = 3