cerc-io/laconicd
18
0
Fork 2
Code Issues 1 Pull Requests 1 Actions Packages Projects Releases 10 Wiki Activity
4202addde4
laconicd/docs/api/proto-docs.md
0xmuralik 56d59feaa0 update fork
2022-10-10 16:08:33 +05:30

103 KiB
Raw Blame History

Protobuf Documentation

Table of Contents

Top

ethermint/crypto/v1/ethsecp256k1/keys.proto

PrivKey

PrivKey defines a type alias for an ecdsa.PrivateKey that implements Tendermint's PrivateKey interface.

Field Type Label Description
key bytes

PubKey

PubKey defines a type alias for an ecdsa.PublicKey that implements Tendermint's PubKey interface. It represents the 33-byte compressed public key format.

Field Type Label Description
key bytes

Top

ethermint/evm/v1/evm.proto

AccessTuple

AccessTuple is the element type of an access list.

Field Type Label Description
address string hex formatted ethereum address
storage_keys string repeated hex formatted hashes of the storage keys

ChainConfig

ChainConfig defines the Ethereum ChainConfig parameters using *sdk.Int values instead of *big.Int.

Field Type Label Description
homestead_block string Homestead switch block (nil no fork, 0 = already homestead)
dao_fork_block string TheDAO hard-fork switch block (nil no fork)
dao_fork_support bool Whether the nodes supports or opposes the DAO hard-fork
eip150_block string EIP150 implements the Gas price changes (https://github.com/ethereum/EIPs/issues/150) EIP150 HF block (nil no fork)
eip150_hash string EIP150 HF hash (needed for header only clients as only gas pricing changed)
eip155_block string EIP155Block HF block
eip158_block string EIP158 HF block
byzantium_block string Byzantium switch block (nil no fork, 0 = already on byzantium)
constantinople_block string Constantinople switch block (nil no fork, 0 = already activated)
petersburg_block string Petersburg switch block (nil same as Constantinople)
istanbul_block string Istanbul switch block (nil no fork, 0 = already on istanbul)
muir_glacier_block string Eip-2384 (bomb delay) switch block (nil no fork, 0 = already activated)
berlin_block string Berlin switch block (nil = no fork, 0 = already on berlin)
london_block string London switch block (nil = no fork, 0 = already on london)
arrow_glacier_block string Eip-4345 (bomb delay) switch block (nil = no fork, 0 = already activated)
gray_glacier_block string EIP-5133 (bomb delay) switch block (nil = no fork, 0 = already activated)
merge_netsplit_block string Virtual fork after The Merge to use as a network splitter

Log

Log represents an protobuf compatible Ethereum Log that defines a contract log event. These events are generated by the LOG opcode and stored/indexed by the node.

Field Type Label Description
address string address of the contract that generated the event
topics string repeated list of topics provided by the contract.
data bytes supplied by the contract, usually ABI-encoded
block_number uint64 block in which the transaction was included
tx_hash string hash of the transaction
tx_index uint64 index of the transaction in the block
block_hash string hash of the block in which the transaction was included
index uint64 index of the log in the block
removed bool The Removed field is true if this log was reverted due to a chain reorganisation. You must pay attention to this field if you receive logs through a filter query.

Params

Params defines the EVM module parameters

Field Type Label Description
evm_denom string evm denom represents the token denomination used to run the EVM state transitions.
enable_create bool enable create toggles state transitions that use the vm.Create function
enable_call bool enable call toggles state transitions that use the vm.Call function
extra_eips int64 repeated extra eips defines the additional EIPs for the vm.Config
chain_config ChainConfig chain config defines the EVM chain configuration parameters
allow_unprotected_txs bool Allow unprotected transactions defines if replay-protected (i.e non EIP155 signed) transactions can be executed on the state machine.

State

State represents a single Storage key value pair item.

Field Type Label Description
key string
value string

TraceConfig

TraceConfig holds extra parameters to trace functions.

Field Type Label Description
tracer string custom javascript tracer
timeout string overrides the default timeout of 5 seconds for JavaScript-based tracing calls
reexec uint64 number of blocks the tracer is willing to go back
disable_stack bool disable stack capture
disable_storage bool disable storage capture
debug bool print output during capture end
limit int32 maximum length of output, but zero means unlimited
overrides ChainConfig Chain overrides, can be used to execute a trace using future fork rules
enable_memory bool enable memory capture
enable_return_data bool enable return data capture

TransactionLogs

TransactionLogs define the logs generated from a transaction execution with a given hash. It it used for import/export data as transactions are not persisted on blockchain state after an upgrade.

Field Type Label Description
hash string
logs Log repeated

TxResult

TxResult stores results of Tx execution.

Field Type Label Description
contract_address string contract_address contains the ethereum address of the created contract (if any). If the state transition is an evm.Call, the contract address will be empty.
bloom bytes bloom represents the bloom filter bytes
tx_logs TransactionLogs tx_logs contains the transaction hash and the proto-compatible ethereum logs.
ret bytes ret defines the bytes from the execution.
reverted bool reverted flag is set to true when the call has been reverted
gas_used uint64 gas_used notes the amount of gas consumed while execution

Top

ethermint/evm/v1/genesis.proto

GenesisAccount

GenesisAccount defines an account to be initialized in the genesis state. Its main difference between with Geth's GenesisAccount is that it uses a custom storage type and that it doesn't contain the private key field.

Field Type Label Description
address string address defines an ethereum hex formated address of an account
code string code defines the hex bytes of the account code.
storage State repeated storage defines the set of state key values for the account.

GenesisState

GenesisState defines the evm module's genesis state.

Field Type Label Description
accounts GenesisAccount repeated accounts is an array containing the ethereum genesis accounts.
params Params params defines all the parameters of the module.

Top

ethermint/evm/v1/tx.proto

AccessListTx

AccessListTx is the data of EIP-2930 access list transactions.

Field Type Label Description
chain_id string destination EVM chain ID
nonce uint64 nonce corresponds to the account nonce (transaction sequence).
gas_price string gas price defines the value for each gas unit
gas uint64 gas defines the gas limit defined for the transaction.
to string hex formatted address of the recipient
value string value defines the unsigned integer value of the transaction amount.
data bytes input defines the data payload bytes of the transaction.
accesses AccessTuple repeated
v bytes v defines the signature value
r bytes r defines the signature value
s bytes s define the signature value

DynamicFeeTx

DynamicFeeTx is the data of EIP-1559 dinamic fee transactions.

Field Type Label Description
chain_id string destination EVM chain ID
nonce uint64 nonce corresponds to the account nonce (transaction sequence).
gas_tip_cap string gas tip cap defines the max value for the gas tip
gas_fee_cap string gas fee cap defines the max value for the gas fee
gas uint64 gas defines the gas limit defined for the transaction.
to string hex formatted address of the recipient
value string value defines the the transaction amount.
data bytes input defines the data payload bytes of the transaction.
accesses AccessTuple repeated
v bytes v defines the signature value
r bytes r defines the signature value
s bytes s define the signature value

ExtensionOptionsEthereumTx

LegacyTx

LegacyTx is the transaction data of regular Ethereum transactions. NOTE: All non-protected transactions (i.e non EIP155 signed) will fail if the AllowUnprotectedTxs parameter is disabled.

Field Type Label Description
nonce uint64 nonce corresponds to the account nonce (transaction sequence).
gas_price string gas price defines the value for each gas unit
gas uint64 gas defines the gas limit defined for the transaction.
to string hex formatted address of the recipient
value string value defines the unsigned integer value of the transaction amount.
data bytes input defines the data payload bytes of the transaction.
v bytes v defines the signature value
r bytes r defines the signature value
s bytes s define the signature value

MsgEthereumTx

MsgEthereumTx encapsulates an Ethereum transaction as an SDK message.

Field Type Label Description
data google.protobuf.Any inner transaction data

caches | | size | double | | DEPRECATED: encoded storage size of the transaction | | hash | string | | transaction hash in hex format | | from | string | | ethereum signer address in hex format. This address value is checked against the address derived from the signature (V, R, S) using the secp256k1 elliptic curve |

MsgEthereumTxResponse

MsgEthereumTxResponse defines the Msg/EthereumTx response type.

Field Type Label Description
hash string ethereum transaction hash in hex format. This hash differs from the Tendermint sha256 hash of the transaction bytes. See https://github.com/tendermint/tendermint/issues/6539 for reference
logs Log repeated logs contains the transaction hash and the proto-compatible ethereum logs.
ret bytes returned data from evm function (result or data supplied with revert opcode)
vm_error string vm error is the error returned by vm execution
gas_used uint64 gas consumed by the transaction

Msg

Msg defines the evm Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
EthereumTx MsgEthereumTx MsgEthereumTxResponse EthereumTx defines a method submitting Ethereum transactions. POST /ethermint/evm/v1/ethereum_tx

Top

ethermint/evm/v1/query.proto

EstimateGasResponse

EstimateGasResponse defines EstimateGas response

Field Type Label Description
gas uint64 the estimated gas

EthCallRequest

EthCallRequest defines EthCall request

Field Type Label Description
args bytes same json format as the json rpc api.
gas_cap uint64 the default gas cap to be used

QueryAccountRequest

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

Field Type Label Description
address string address is the ethereum hex address to query the account for.

QueryAccountResponse

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

Field Type Label Description
balance string balance is the balance of the EVM denomination.
code_hash string code hash is the hex-formatted code bytes from the EOA.
nonce uint64 nonce is the account's sequence number.

QueryBalanceRequest

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

Field Type Label Description
address string address is the ethereum hex address to query the balance for.

QueryBalanceResponse

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

Field Type Label Description
balance string balance is the balance of the EVM denomination.

QueryBaseFeeRequest

QueryBaseFeeRequest defines the request type for querying the EIP1559 base fee.

QueryBaseFeeResponse

BaseFeeResponse returns the EIP1559 base fee.

Field Type Label Description
base_fee string

QueryCodeRequest

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

Field Type Label Description
address string address is the ethereum hex address to query the code for.

QueryCodeResponse

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

Field Type Label Description
code bytes code represents the code bytes from an ethereum address.

QueryCosmosAccountRequest

QueryCosmosAccountRequest is the request type for the Query/CosmosAccount RPC method.

Field Type Label Description
address string address is the ethereum hex address to query the account for.

QueryCosmosAccountResponse

QueryCosmosAccountResponse is the response type for the Query/CosmosAccount RPC method.

Field Type Label Description
cosmos_address string cosmos_address is the cosmos address of the account.
sequence uint64 sequence is the account's sequence number.
account_number uint64 account_number is the account numbert

QueryParamsRequest

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

QueryParamsResponse

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

Field Type Label Description
params Params params define the evm module parameters.

QueryStorageRequest

QueryStorageRequest is the request type for the Query/Storage RPC method.

Field Type Label Description
address string address is the ethereum hex address to query the storage state for.
key string key defines the key of the storage state

QueryStorageResponse

QueryStorageResponse is the response type for the Query/Storage RPC method.

Field Type Label Description
value string key defines the storage state value hash associated with the given key.

QueryTraceBlockRequest

QueryTraceBlockRequest defines TraceTx request

Field Type Label Description
txs MsgEthereumTx repeated txs messages in the block
trace_config TraceConfig TraceConfig holds extra parameters to trace functions.
block_number int64 block number
block_hash string block hex hash
block_time google.protobuf.Timestamp block time

QueryTraceBlockResponse

QueryTraceBlockResponse defines TraceBlock response

Field Type Label Description
data bytes

QueryTraceTxRequest

QueryTraceTxRequest defines TraceTx request

Field Type Label Description
msg MsgEthereumTx msgEthereumTx for the requested transaction
trace_config TraceConfig TraceConfig holds extra parameters to trace functions.
predecessors MsgEthereumTx repeated the predecessor transactions included in the same block need to be replayed first to get correct context for tracing.
block_number int64 block number of requested transaction
block_hash string block hex hash of requested transaction
block_time google.protobuf.Timestamp block time of requested transaction

QueryTraceTxResponse

QueryTraceTxResponse defines TraceTx response

Field Type Label Description
data bytes response serialized in bytes

QueryTxLogsRequest

QueryTxLogsRequest is the request type for the Query/TxLogs RPC method.

Field Type Label Description
hash string hash is the ethereum transaction hex hash to query the logs for.
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryTxLogsResponse

QueryTxLogs is the response type for the Query/TxLogs RPC method.

Field Type Label Description
logs Log repeated logs represents the ethereum logs generated from the given transaction.
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryValidatorAccountRequest

QueryValidatorAccountRequest is the request type for the Query/ValidatorAccount RPC method.

Field Type Label Description
cons_address string cons_address is the validator cons address to query the account for.

QueryValidatorAccountResponse

QueryValidatorAccountResponse is the response type for the Query/ValidatorAccount RPC method.

Field Type Label Description
account_address string account_address is the cosmos address of the account in bech32 format.
sequence uint64 sequence is the account's sequence number.
account_number uint64 account_number is the account number

Query

Query defines the gRPC querier service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Account QueryAccountRequest QueryAccountResponse Account queries an Ethereum account. GET /ethermint/evm/v1/account/{address}
CosmosAccount QueryCosmosAccountRequest QueryCosmosAccountResponse CosmosAccount queries an Ethereum account's Cosmos Address. GET /ethermint/evm/v1/cosmos_account/{address}
ValidatorAccount QueryValidatorAccountRequest QueryValidatorAccountResponse ValidatorAccount queries an Ethereum account's from a validator consensus Address. GET /ethermint/evm/v1/validator_account/{cons_address}
Balance QueryBalanceRequest QueryBalanceResponse Balance queries the balance of a the EVM denomination for a single EthAccount. GET /ethermint/evm/v1/balances/{address}
Storage QueryStorageRequest QueryStorageResponse Storage queries the balance of all coins for a single account. GET /ethermint/evm/v1/storage/{address}/{key}
Code QueryCodeRequest QueryCodeResponse Code queries the balance of all coins for a single account. GET /ethermint/evm/v1/codes/{address}
Params QueryParamsRequest QueryParamsResponse Params queries the parameters of x/evm module. GET /ethermint/evm/v1/params
EthCall EthCallRequest MsgEthereumTxResponse EthCall implements the eth_call rpc api GET /ethermint/evm/v1/eth_call
EstimateGas EthCallRequest EstimateGasResponse EstimateGas implements the eth_estimateGas rpc api GET /ethermint/evm/v1/estimate_gas
TraceTx QueryTraceTxRequest QueryTraceTxResponse TraceTx implements the debug_traceTransaction rpc api GET /ethermint/evm/v1/trace_tx
TraceBlock QueryTraceBlockRequest QueryTraceBlockResponse TraceBlock implements the debug_traceBlockByNumber and debug_traceBlockByHash rpc api GET /ethermint/evm/v1/trace_block
BaseFee QueryBaseFeeRequest QueryBaseFeeResponse BaseFee queries the base fee of the parent block of the current block, it's similar to feemarket module's method, but also checks london hardfork status. GET /ethermint/evm/v1/base_fee

Top

ethermint/feemarket/v1/feemarket.proto

Params

Params defines the EVM module parameters

Field Type Label Description
no_base_fee bool no base fee forces the EIP-1559 base fee to 0 (needed for 0 price calls)
base_fee_change_denominator uint32 base fee change denominator bounds the amount the base fee can change between blocks.
elasticity_multiplier uint32 elasticity multiplier bounds the maximum gas limit an EIP-1559 block may have.
enable_height int64 height at which the base fee calculation is enabled.
base_fee string base fee for EIP-1559 blocks.
min_gas_price string min_gas_price defines the minimum gas price value for cosmos and eth transactions
min_gas_multiplier string min gas denominator bounds the minimum gasUsed to be charged to senders based on GasLimit

Top

ethermint/feemarket/v1/genesis.proto

GenesisState

GenesisState defines the feemarket module's genesis state.

Field Type Label Description
params Params params defines all the paramaters of the module.
block_gas uint64 block gas is the amount of gas wanted on the last block before the upgrade. Zero by default.

Top

ethermint/feemarket/v1/query.proto

QueryBaseFeeRequest

QueryBaseFeeRequest defines the request type for querying the EIP1559 base fee.

QueryBaseFeeResponse

BaseFeeResponse returns the EIP1559 base fee.

Field Type Label Description
base_fee string

QueryBlockGasRequest

QueryBlockGasRequest defines the request type for querying the EIP1559 base fee.

QueryBlockGasResponse

QueryBlockGasResponse returns block gas used for a given height.

Field Type Label Description
gas int64

QueryParamsRequest

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

QueryParamsResponse

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

Field Type Label Description
params Params params define the evm module parameters.

Query

Query defines the gRPC querier service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
Params QueryParamsRequest QueryParamsResponse Params queries the parameters of x/feemarket module. GET /ethermint/feemarket/v1/params
BaseFee QueryBaseFeeRequest QueryBaseFeeResponse BaseFee queries the base fee of the parent block of the current block. GET /ethermint/feemarket/v1/base_fee
BlockGas QueryBlockGasRequest QueryBlockGasResponse BlockGas queries the gas used at a given block height GET /ethermint/feemarket/v1/block_gas

Top

ethermint/types/v1/account.proto

EthAccount

EthAccount implements the authtypes.AccountI interface and embeds an authtypes.BaseAccount type. It is compatible with the auth AccountKeeper.

Field Type Label Description
base_account cosmos.auth.v1beta1.BaseAccount
code_hash string

Top

ethermint/types/v1/dynamic_fee.proto

ExtensionOptionDynamicFeeTx

ExtensionOptionDynamicFeeTx is an extension option that specify the maxPrioPrice for cosmos tx

Field Type Label Description
max_priority_price string the same as max_priority_fee_per_gas in eip-1559 spec

Top

ethermint/types/v1/indexer.proto

TxResult

TxResult is the value stored in eth tx indexer

Field Type Label Description
height int64 the block height
tx_index uint32 cosmos tx index
msg_index uint32 the msg index in a batch tx
eth_tx_index int32 eth tx index, the index in the list of valid eth tx in the block, aka. the transaction list returned by eth_getBlock api.
failed bool if the eth tx is failed
gas_used uint64 gas used by tx, if exceeds block gas limit, it's set to gas limit which is what's actually deducted by ante handler.
cumulative_gas_used uint64 the cumulative gas used within current batch tx

Top

ethermint/types/v1/web3.proto

ExtensionOptionsWeb3Tx

Field Type Label Description
typed_data_chain_id uint64 typed data chain id used only in EIP712 Domain and should match Ethereum network ID in a Web3 provider (e.g. Metamask).
fee_payer string fee payer is an account address for the fee payer. It will be validated during EIP712 signature checking.
fee_payer_sig bytes fee payer sig is a signature data from the fee paying account, allows to perform fee delegation when using EIP712 Domain.

Top

vulcanize/auction/v1beta1/types.proto

Auction

Auction represents a sealed-bid on-chain auction

Field Type Label Description
id string
status string
owner_address string Address of the creator of the auction
create_time google.protobuf.Timestamp Timestamp at which the auction was created
commits_end_time google.protobuf.Timestamp Timestamp at which the commits phase concluded
reveals_end_time google.protobuf.Timestamp Timestamp at which the reveals phase concluded
commit_fee cosmos.base.v1beta1.Coin Commit and reveal fees must both be paid when committing a bid Reveal fee is returned only if the bid is revealed
reveal_fee cosmos.base.v1beta1.Coin
minimum_bid cosmos.base.v1beta1.Coin Minimum acceptable bid amount for a valid commit
winner_address string Address of the winner
winning_bid cosmos.base.v1beta1.Coin Winning bid, i.e., the highest bid
winning_price cosmos.base.v1beta1.Coin Amount the winner pays, i.e. the second highest auction

Auctions

Field Type Label Description
auctions Auction repeated

Bid

Bid represents a sealed bid (commit) made during the auction

Field Type Label Description
auction_id string
bidder_address string
status string
commit_hash string
commit_time google.protobuf.Timestamp
commit_fee cosmos.base.v1beta1.Coin
reveal_time google.protobuf.Timestamp
reveal_fee cosmos.base.v1beta1.Coin
bid_amount cosmos.base.v1beta1.Coin

Params

Params defines the auction module parameters

Field Type Label Description
commits_duration google.protobuf.Duration Duration of the commits phase in seconds
reveals_duration google.protobuf.Duration Duration of the reveals phase in seconds
commit_fee cosmos.base.v1beta1.Coin Commit fees
reveal_fee cosmos.base.v1beta1.Coin Reveal fees
minimum_bid cosmos.base.v1beta1.Coin Minimum acceptable bid amount

Top

vulcanize/auction/v1beta1/genesis.proto

GenesisState

GenesisState defines the genesis state of the auction module

Field Type Label Description
params Params
auctions Auction repeated

Top

vulcanize/auction/v1beta1/query.proto

AuctionRequest

AuctionRequest is the format for querying a specific auction

Field Type Label Description
id string Auction ID

AuctionResponse

AuctionResponse returns the details of the queried auction

Field Type Label Description
auction Auction Auction details

AuctionsByBidderRequest

AuctionsByBidderRequest is the format for querying all auctions containing a bidder address

Field Type Label Description
bidder_address string Address of the bidder

AuctionsByBidderResponse

AuctionsByBidderResponse returns all auctions containing a bidder

Field Type Label Description
auctions Auctions List of auctions

AuctionsByOwnerRequest

AuctionsByOwnerRequest is the format for querying all auctions created by an owner

Field Type Label Description
owner_address string Address of the owner

AuctionsByOwnerResponse

AuctionsByOwnerResponse returns all auctions created by an owner

Field Type Label Description
auctions Auctions List of auctions

AuctionsRequest

AuctionsRequest is the format for querying all the auctions

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

AuctionsResponse

AuctionsResponse returns the list of all auctions

Field Type Label Description
auctions Auctions List of auctions
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination info for the next request

BalanceRequest

BalanceRequest is the format to fetch all balances

BalanceResponse

Field Type Label Description
balance cosmos.base.v1beta1.Coin repeated Set of all balances within the auction

BidRequest

BidRequest is the format for querying a specific bid in an auction

Field Type Label Description
auction_id string Auction ID
bidder string Bidder address

BidResponse

BidResponse returns the details of the queried bid

Field Type Label Description
bid Bid Bid details

BidsRequest

BidsRequest is the format for querying all bids in an auction

Field Type Label Description
auction_id string Auction ID

BidsResponse

BidsResponse returns details of all bids in an auction

Field Type Label Description
bids Bid repeated List of bids in the auction

QueryParamsRequest

QueryParamsRequest is the format to query the parameters of the auction module

QueryParamsResponse

QueryParamsResponse returns parameters of the auction module

Field Type Label Description
params Params

Query

Query defines the gRPC querier interface for the auction module

Method Name Request Type Response Type Description HTTP Verb Endpoint
Auctions AuctionsRequest AuctionsResponse Auctions queries all auctions GET /vulcanize/auction/v1beta1/auctions
GetAuction AuctionRequest AuctionResponse GetAuction queries an auction GET /vulcanize/auction/v1beta1/auctions/{id}
GetBid BidRequest BidResponse GetBid queries an auction bid GET /vulcanize/auction/v1beta1/bids/{auction_id}/{bidder}
GetBids BidsRequest BidsResponse GetBids queries all auction bids GET /vulcanize/auction/v1beta1/bids/{auction_id}
AuctionsByBidder AuctionsByBidderRequest AuctionsByBidderResponse AuctionsByBidder queries auctions by bidder GET /vulcanize/auction/v1beta1/by-bidder/{bidder_address}
AuctionsByOwner AuctionsByOwnerRequest AuctionsByOwnerResponse AuctionsByOwner queries auctions by owner GET /vulcanize/auction/v1beta1/by-owner/{owner_address}
QueryParams QueryParamsRequest QueryParamsResponse QueryParams implements the params query command GET /vulcanize/auction/v1beta1/params
Balance BalanceRequest BalanceResponse Balance queries the auction module account balance GET /vulcanize/auction/v1beta1/balance

Top

vulcanize/auction/v1beta1/tx.proto

MsgCommitBid

CommitBid defines the message to commit a bid

Field Type Label Description
auction_id string Auction ID
commit_hash string Commit Hash
signer string Address of the signer

MsgCommitBidResponse

MsgCommitBidResponse returns the state of the auction after the bid creation

Field Type Label Description
bid Bid Auction details

MsgCreateAuction

MsgCreateAuction defines a create auction message

Field Type Label Description
commits_duration google.protobuf.Duration Duration of the commits phase in seconds
reveals_duration google.protobuf.Duration Duration of the reveals phase in seconds
commit_fee cosmos.base.v1beta1.Coin Commit fees
reveal_fee cosmos.base.v1beta1.Coin Reveal fees
minimum_bid cosmos.base.v1beta1.Coin Minimum acceptable bid amount
signer string Address of the signer

MsgCreateAuctionResponse

MsgCreateAuctionResponse returns the details of the created auction

Field Type Label Description
auction Auction Auction details

MsgRevealBid

RevealBid defines the message to reveal a bid

Field Type Label Description
auction_id string Auction ID
reveal string Commit Hash
signer string Address of the signer

MsgRevealBidResponse

MsgRevealBidResponse returns the state of the auction after the bid reveal

Field Type Label Description
auction Auction Auction details

Msg

Tx defines the gRPC tx interface

Method Name Request Type Response Type Description HTTP Verb Endpoint
CreateAuction MsgCreateAuction MsgCreateAuctionResponse CreateAuction is the command for creating an auction
CommitBid MsgCommitBid MsgCommitBidResponse CommitBid is the command for committing a bid
RevealBid MsgRevealBid MsgRevealBidResponse RevealBid is the command for revealing a bid

Top

vulcanize/bond/v1beta1/bond.proto

Bond

Bond represents funds deposited by an account for record rent payments.

Field Type Label Description
id string id is unique identifier of the bond
owner string owner of the bond
balance cosmos.base.v1beta1.Coin repeated balance of the bond

Params

Params defines the bond module parameters

Field Type Label Description
max_bond_amount cosmos.base.v1beta1.Coin max_bond_amount is maximum amount to bond

Top

vulcanize/bond/v1beta1/genesis.proto

GenesisState

GenesisState defines the bond module's genesis state.

Field Type Label Description
params Params params defines all the parameters of the module.
bonds Bond repeated bonds defines all the bonds

Top

vulcanize/bond/v1beta1/query.proto

QueryGetBondByIdRequest

QueryGetBondById

Field Type Label Description
id string

QueryGetBondByIdResponse

QueryGetBondByIdResponse returns QueryGetBondById query response

Field Type Label Description
bond Bond

QueryGetBondModuleBalanceRequest

QueryGetBondModuleBalanceRequest is request type for bond module balance rpc method

QueryGetBondModuleBalanceResponse

QueryGetBondModuleBalanceResponse is the response type for bond module balance rpc method

Field Type Label Description
balance cosmos.base.v1beta1.Coin repeated

QueryGetBondsByOwnerRequest

QueryGetBondsByOwnerRequest is request type for Query/GetBondsByOwner RPC Method

Field Type Label Description
owner string
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryGetBondsByOwnerResponse

QueryGetBondsByOwnerResponse is response type for Query/GetBondsByOwner RPC Method

Field Type Label Description
bonds Bond repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryGetBondsRequest

QueryGetBondById queries a bond by bond-id.

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

QueryGetBondsResponse

QueryGetBondsResponse is response type for get the bonds by bond-id

Field Type Label Description
bonds Bond repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryParamsRequest

QueryParamsRequest is request for query the bond module params

QueryParamsResponse

QueryParamsResponse returns response type of bond module params

Field Type Label Description
params Params

Query

Query defines the gRPC querier service for bond module

Method Name Request Type Response Type Description HTTP Verb Endpoint
Params QueryParamsRequest QueryParamsResponse Params queries bonds module params. GET /vulcanize/bond/v1beta1/params
Bonds QueryGetBondsRequest QueryGetBondsResponse Bonds queries bonds list. GET /vulcanize/bond/v1beta1/bonds
GetBondById QueryGetBondByIdRequest QueryGetBondByIdResponse GetBondById GET /vulcanize/bond/v1beta1/bonds/{id}
GetBondsByOwner QueryGetBondsByOwnerRequest QueryGetBondsByOwnerResponse Get Bonds List by Owner GET /vulcanize/bond/v1beta1/by-owner/{owner}
GetBondsModuleBalance QueryGetBondModuleBalanceRequest QueryGetBondModuleBalanceResponse Get Bonds module balance GET /vulcanize/bond/v1beta1/balance

Top

vulcanize/bond/v1beta1/tx.proto

MsgCancelBond

MsgCancelBond defines a SDK message for the cancel the bond.

Field Type Label Description
id string
signer string

MsgCancelBondResponse

MsgCancelBondResponse defines the Msg/CancelBond response type.

MsgCreateBond

MsgCreateBond defines a SDK message for creating a new bond.

Field Type Label Description
signer string
coins cosmos.base.v1beta1.Coin repeated

MsgCreateBondResponse

MsgCreateBondResponse defines the Msg/CreateBond response type.

Field Type Label Description
id string

MsgRefillBond

MsgRefillBond defines a SDK message for refill the amount for bond.

Field Type Label Description
id string
signer string
coins cosmos.base.v1beta1.Coin repeated

MsgRefillBondResponse

MsgRefillBondResponse defines the Msg/RefillBond response type.

MsgWithdrawBond

MsgWithdrawBond defines a SDK message for withdrawing amount from bond.

Field Type Label Description
id string
signer string
coins cosmos.base.v1beta1.Coin repeated

MsgWithdrawBondResponse

MsgWithdrawBondResponse defines the Msg/WithdrawBond response type.

Msg

Msg defines the bond Msg service.

Method Name Request Type Response Type Description HTTP Verb Endpoint
CreateBond MsgCreateBond MsgCreateBondResponse CreateBond defines a method for creating a new bond.
RefillBond MsgRefillBond MsgRefillBondResponse RefillBond defines a method for refilling amount for bond.
WithdrawBond MsgWithdrawBond MsgWithdrawBondResponse WithdrawBond defines a method for withdrawing amount from bond.
CancelBond MsgCancelBond MsgCancelBondResponse CancelBond defines a method for cancelling a bond.

Top

vulcanize/nameservice/v1beta1/nameservice.proto

AuctionBidInfo

AuctionBidInfo

Field Type Label Description
auction_id string
bidder_address string

AuthorityEntry

AuthorityEntry defines the nameservice module AuthorityEntries

Field Type Label Description
name string
entry NameAuthority

BlockChangeSet

BlockChangeSet

Field Type Label Description
height int64
records string repeated
auctions string repeated
auction_bids AuctionBidInfo repeated
authorities string repeated
names string repeated

NameAuthority

NameAuthority

Field Type Label Description
owner_public_key string Owner public key.
owner_address string Owner address.
height uint64 height at which name/authority was created.
status string
auction_id string
bond_id string
expiry_time google.protobuf.Timestamp

NameEntry

NameEntry

Field Type Label Description
name string
entry NameRecord

NameRecord

NameRecord

Field Type Label Description
latest NameRecordEntry
history NameRecordEntry repeated

NameRecordEntry

NameRecordEntry

Field Type Label Description
id string
height uint64

Params

Params defines the nameservice module parameters

Field Type Label Description
record_rent cosmos.base.v1beta1.Coin
record_rent_duration google.protobuf.Duration
authority_rent cosmos.base.v1beta1.Coin
authority_rent_duration google.protobuf.Duration
authority_grace_period google.protobuf.Duration
authority_auction_enabled bool
authority_auction_commits_duration google.protobuf.Duration
authority_auction_reveals_duration google.protobuf.Duration
authority_auction_commit_fee cosmos.base.v1beta1.Coin
authority_auction_reveal_fee cosmos.base.v1beta1.Coin
authority_auction_minimum_bid cosmos.base.v1beta1.Coin

Record

Params defines the nameservice module records

Field Type Label Description
id string
bond_id string
create_time string
expiry_time string
deleted bool
owners string repeated
attributes string
names string repeated

Signature

Signature

Field Type Label Description
sig string
pub_key string

Top

vulcanize/nameservice/v1beta1/genesis.proto

GenesisState

GenesisState defines the nameservice module's genesis state.

Field Type Label Description
params Params params defines all the params of nameservice module.
records Record repeated records
authorities AuthorityEntry repeated authorities
names NameEntry repeated names

Top

vulcanize/nameservice/v1beta1/query.proto

AccountBalance

AccountBalance is nameservice module account balance

Field Type Label Description
account_name string
balance cosmos.base.v1beta1.Coin repeated

ExpiryQueueRecord

ExpiryQueueRecord

Field Type Label Description
id string
value string repeated

GetNameServiceModuleBalanceRequest

GetNameServiceModuleBalanceRequest is request type for nameservice module accounts balance

GetNameServiceModuleBalanceResponse

GetNameServiceModuleBalanceResponse is response type for nameservice module accounts balance

Field Type Label Description
balances AccountBalance repeated

QueryGetAuthorityExpiryQueue

QueryGetAuthorityExpiryQueue

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

QueryGetAuthorityExpiryQueueResponse

QueryGetAuthorityExpiryQueueResponse

Field Type Label Description
authorities ExpiryQueueRecord repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryGetRecordExpiryQueue

QueryGetRecordExpiryQueue

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

QueryGetRecordExpiryQueueResponse

QueryGetRecordExpiryQueueResponse

Field Type Label Description
records ExpiryQueueRecord repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryListNameRecordsRequest

QueryListNameRecordsRequest is request type for nameservice names records

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

QueryListNameRecordsResponse

QueryListNameRecordsResponse is response type for nameservice names records

Field Type Label Description
names NameEntry repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryListRecordsRequest

QueryListRecordsRequest is request type for nameservice records list

Field Type Label Description
attributes QueryListRecordsRequest.KeyValueInput repeated
all bool
pagination cosmos.base.query.v1beta1.PageRequest pagination defines an optional pagination for the request.

QueryListRecordsRequest.KeyValueInput

Field Type Label Description
key string
value QueryListRecordsRequest.ValueInput

QueryListRecordsRequest.ReferenceInput

Field Type Label Description
id string

QueryListRecordsRequest.ValueInput

Field Type Label Description
type string
string string
int int64
float double
boolean bool
reference QueryListRecordsRequest.ReferenceInput
values QueryListRecordsRequest.ValueInput repeated

QueryListRecordsResponse

QueryListRecordsResponse is response type for nameservice records list

Field Type Label Description
records Record repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryLookupCrn

QueryLookupCrn is request type for LookupCrn

Field Type Label Description
crn string

QueryLookupCrnResponse

QueryLookupCrnResponse is response type for QueryLookupCrn

Field Type Label Description
name NameRecord

QueryParamsRequest

QueryParamsRequest is request type for nameservice params

QueryParamsResponse

QueryParamsResponse is response type for nameservice params

Field Type Label Description
params Params

QueryRecordByBondIdRequest

QueryRecordByBondIdRequest is request type for get the records by bond-id

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

QueryRecordByBondIdResponse

QueryRecordByBondIdResponse is response type for records list by bond-id

Field Type Label Description
records Record repeated
pagination cosmos.base.query.v1beta1.PageResponse pagination defines the pagination in the response.

QueryRecordByIdRequest

QueryRecordByIdRequest is request type for nameservice records by id

Field Type Label Description
id string

QueryRecordByIdResponse

QueryRecordByIdResponse is response type for nameservice records by id

Field Type Label Description
record Record

QueryResolveCrn

QueryResolveCrn is request type for ResolveCrn

Field Type Label Description
crn string

QueryResolveCrnResponse

QueryResolveCrnResponse is response type for QueryResolveCrn

Field Type Label Description
record Record

QueryWhoisRequest

QueryWhoisRequest is request type for Get NameAuthority

Field Type Label Description
name string

QueryWhoisResponse

QueryWhoisResponse is response type for whois request

Field Type Label Description
name_authority NameAuthority

Query

Query defines the gRPC querier service for nameservice module

Method Name Request Type Response Type Description HTTP Verb Endpoint
Params QueryParamsRequest QueryParamsResponse Params queries the nameservice module params. GET /vulcanize/nameservice/v1beta1/params
ListRecords QueryListRecordsRequest QueryListRecordsResponse List records GET /vulcanize/nameservice/v1beta1/records
GetRecord QueryRecordByIdRequest QueryRecordByIdResponse Get record by id GET /vulcanize/nameservice/v1beta1/records/{id}
GetRecordByBondId QueryRecordByBondIdRequest QueryRecordByBondIdResponse Get records by bond id GET /vulcanize/nameservice/v1beta1/records-by-bond-id/{id}
GetNameServiceModuleBalance GetNameServiceModuleBalanceRequest GetNameServiceModuleBalanceResponse Get nameservice module balance GET /vulcanize/nameservice/v1beta1/balance
ListNameRecords QueryListNameRecordsRequest QueryListNameRecordsResponse List name records GET /vulcanize/nameservice/v1beta1/names
Whois QueryWhoisRequest QueryWhoisResponse Whois method retrieve the name authority info GET /vulcanize/nameservice/v1beta1/whois/{name}
LookupCrn QueryLookupCrn QueryLookupCrnResponse LookupCrn GET /vulcanize/nameservice/v1beta1/lookup
ResolveCrn QueryResolveCrn QueryResolveCrnResponse ResolveCrn GET /vulcanize/nameservice/v1beta1/resolve
GetRecordExpiryQueue QueryGetRecordExpiryQueue QueryGetRecordExpiryQueueResponse GetRecordExpiryQueue GET /vulcanize/nameservice/v1beta1/record-expiry
GetAuthorityExpiryQueue QueryGetAuthorityExpiryQueue QueryGetAuthorityExpiryQueueResponse GetAuthorityExpiryQueue GET /vulcanize/nameservice/v1beta1/authority-expiry

Top

vulcanize/nameservice/v1beta1/tx.proto

MsgAssociateBond

MsgAssociateBond

Field Type Label Description
record_id string
bond_id string
signer string

MsgAssociateBondResponse

MsgAssociateBondResponse

MsgDeleteNameAuthority

MsgDeleteNameAuthority is SDK message for DeleteNameAuthority

Field Type Label Description
crn string
signer string

MsgDeleteNameAuthorityResponse

MsgDeleteNameAuthorityResponse

MsgDissociateBond

MsgDissociateBond is SDK message for Msg/DissociateBond

Field Type Label Description
record_id string
signer string

MsgDissociateBondResponse

MsgDissociateBondResponse is response type for MsgDissociateBond

MsgDissociateRecords

MsgDissociateRecords is SDK message for Msg/DissociateRecords

Field Type Label Description
bond_id string
signer string

MsgDissociateRecordsResponse

MsgDissociateRecordsResponse is response type for MsgDissociateRecords

MsgReAssociateRecords

MsgReAssociateRecords is SDK message for Msg/ReAssociateRecords

Field Type Label Description
new_bond_id string
old_bond_id string
signer string

MsgReAssociateRecordsResponse

MsgReAssociateRecordsResponse is response type for MsgReAssociateRecords

MsgRenewRecord

MsgRenewRecord is SDK message for Renew a record

Field Type Label Description
record_id string
signer string

MsgRenewRecordResponse

MsgRenewRecordResponse

MsgReserveAuthority

MsgReserveName

Field Type Label Description
name string
signer string
owner string if creating a sub-authority.

MsgReserveAuthorityResponse

MsgReserveNameResponse

MsgSetAuthorityBond

MsgSetAuthorityBond is SDK message for SetAuthorityBond

Field Type Label Description
name string
bond_id string
signer string

MsgSetAuthorityBondResponse

MsgSetAuthorityBondResponse

MsgSetName

MsgSetName

Field Type Label Description
crn string
cid string
signer string

MsgSetNameResponse

MsgSetNameResponse

MsgSetRecord

MsgSetRecord

Field Type Label Description
bond_id string
signer string
payload Payload

MsgSetRecordResponse

MsgSetRecordResponse

Field Type Label Description
id string

Payload

Payload

Field Type Label Description
record Record
signatures Signature repeated

Msg

Msg

Method Name Request Type Response Type Description HTTP Verb Endpoint
SetRecord MsgSetRecord MsgSetRecordResponse SetRecord will records a new record with given payload and bond id
RenewRecord MsgRenewRecord MsgRenewRecordResponse Renew Record will renew the expire record
AssociateBond MsgAssociateBond MsgAssociateBondResponse AssociateBond
DissociateBond MsgDissociateBond MsgDissociateBondResponse DissociateBond
DissociateRecords MsgDissociateRecords MsgDissociateRecordsResponse DissociateRecords
ReAssociateRecords MsgReAssociateRecords MsgReAssociateRecordsResponse ReAssociateRecords
SetName MsgSetName MsgSetNameResponse SetName will store the name with given crn and name
ReserveName MsgReserveAuthority MsgReserveAuthorityResponse Reserve name
DeleteName MsgDeleteNameAuthority MsgDeleteNameAuthorityResponse Delete Name method will remove authority name
SetAuthorityBond MsgSetAuthorityBond MsgSetAuthorityBondResponse SetAuthorityBond

Scalar Value Types

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 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. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)