package gravity.v1
Get desktop application:
View/edit binary Protocol Buffers messages
service Msg
msgs.proto:14Msg defines the state transitions possible within gravity
rpc SendToEthereum (, )
msgs.proto:15option (google.api.http).post = "/gravity/v1/send_to_ethereum";
message
msgs.proto:41MsgSendToEthereum submits a SendToEthereum attempt to bridge an asset over to Ethereum. The SendToEthereum will be stored and then included in a batch and then submitted to Ethereum.
string sender = 1
string ethereum_recipient = 2
optional amount = 3
optional bridge_fee = 4
message
msgs.proto:50MsgSendToEthereumResponse returns the SendToEthereum transaction ID which will be included in the batch tx.
uint64 id = 1
rpc CancelSendToEthereum (, )
msgs.proto:18option (google.api.http).post = "/gravity/v1/send_to_ethereum/cancel";
message
msgs.proto:56MsgCancelSendToEthereum allows the sender to cancel its own outgoing SendToEthereum tx and recieve a refund of the tokens and bridge fees. This tx will only succeed if the SendToEthereum tx hasn't been batched to be processed and relayed to Ethereum.
uint64 id = 1
string sender = 2
message
msgs.proto:61(message has no fields)
rpc RequestBatchTx (, )
msgs.proto:22option (google.api.http).post = "/gravity/v1/batchtx/request";
message
msgs.proto:65MsgRequestBatchTx requests a batch of transactions with a given coin denomination to send across the bridge to Ethereum.
string denom = 1
string signer = 2
message
msgs.proto:70(message has no fields)
option (google.api.http).post = "/gravity/v1/ethereum_signature";
message
msgs.proto:74MsgSubmitEthereumTxConfirmation submits an ethereum signature for a given validator
optional confirmation = 1
TODO: can we make this take an array?
string signer = 2
message
msgs.proto:108(message has no fields)
rpc SubmitEthereumEvent (, )
msgs.proto:29option (google.api.http).post = "/gravity/v1/ethereum_event";
message
msgs.proto:111MsgSubmitEthereumEvent
optional event = 1
string signer = 2
message
msgs.proto:120(message has no fields)
rpc SetDelegateKeys (, )
msgs.proto:33option (google.api.http).post = "/gravity/v1/delegate_keys";
message
msgs.proto:132(message has no fields)
service Query
query.proto:15Query defines the gRPC querier service
rpc Params (, )
query.proto:18Module parameters query
option (google.api.http).get = "/gravity/v1/params";
message
query.proto:153rpc Params
(message has no fields)
message
query.proto:154optional params = 1
rpc SignerSetTx (, )
query.proto:23get info on individual outgoing data
option (google.api.http).get = "/gravity/v1/signer_set";
message
query.proto:157rpc SignerSetTx
uint64 signer_set_nonce = 1
rpc LatestSignerSetTx (, )
query.proto:26option (google.api.http).get = "/gravity/v1/signer_set/latest";
message
query.proto:158(message has no fields)
rpc BatchTx (, )
query.proto:30option (google.api.http).get = "/gravity/v1/batch_txs/{token_contract}/{nonce}";
message
query.proto:162rpc BatchTx
string token_contract = 1
uint64 batch_nonce = 2
message
query.proto:166optional batch = 1
rpc ContractCallTx (, )
query.proto:34option (google.api.http).get = "/gravity/v1/contract_call_txs/{invalidation_id}/{invalidation_nonce}";
message
query.proto:169rpc ContractCallTx
bytes invalidation_scope = 1
uint64 invalidation_nonce = 2
message
query.proto:173optional logic_call = 1
rpc SignerSetTxs (, )
query.proto:40get collections of outgoing traffic from the bridge
option (google.api.http).get = "/gravity/v1/signer_sets";
message
query.proto:182rpc SignerSetTxs
optional pagination = 1
message
query.proto:185repeated signer_sets = 1
optional pagination = 2
rpc BatchTxs (, )
query.proto:43option (google.api.http).get = "/gravity/v1/batch/batch_txs";
message
query.proto:191rpc BatchTxs
optional pagination = 1
message
query.proto:194repeated batches = 1
optional pagination = 2
rpc ContractCallTxs (, )
query.proto:46option (google.api.http).get = "/gravity/v1/batch/contract_call_txs";
message
query.proto:200rpc ContractCallTxs
optional pagination = 1
message
query.proto:203repeated calls = 1
optional pagination = 2
TODO: can/should we group these into one endpoint?
option (google.api.http).get = "/gravity/v1/signer_sets/ethereum_signatures";
message
query.proto:176rpc SignerSetTxConfirmations
uint64 signer_set_nonce = 1
message
query.proto:177repeated signatures = 1
rpc BatchTxConfirmations (, )
query.proto:60option (google.api.http).get = "/gravity/v1/batch_txs/ethereum_signatures";
message
query.proto:250uint64 batch_nonce = 1
string token_contract = 2
message
query.proto:254repeated signatures = 1
option (google.api.http).get = "/gravity/v1/logic_calls/ethereum_signatures";
message
query.proto:242bytes invalidation_scope = 1
uint64 invalidation_nonce = 2
message
query.proto:246repeated signatures = 1
rpc UnsignedSignerSetTxs (, )
query.proto:76pending ethereum signature queries for orchestrators to figure out which signatures they are missing TODO: can/should we group this into one endpoint?
option (google.api.http).get = "/gravity/v1/SignerSetTxs/{address}/pending";
message
query.proto:213rpc UnsignedSignerSetTxs
string address = 1
NOTE: this is an sdk.AccAddress and can represent either the orchestartor address or the cooresponding validator address
message
query.proto:218repeated signer_sets = 1
rpc UnsignedBatchTxs (, )
query.proto:81option (google.api.http).get = "/gravity/v1/batches/{address}/pending";
message
query.proto:220string address = 1
NOTE: this is an sdk.AccAddress and can represent either the orchestrator address or the cooresponding validator address
message
query.proto:225repeated batches = 1
Note these are returned with the signature empty
option (google.api.http).get = "/gravity/v1/ContractCallTxs/{address}/pending";
message
query.proto:231rpc UnsignedContractCallTxs
string address = 1
message
query.proto:232repeated calls = 1
option (google.api.http).get = "/gravity/v1/oracle/event_nonce/{address}";
message
query.proto:258string address = 1
message
query.proto:259uint64 event_nonce = 1
rpc BatchTxFees (, )
query.proto:99Queries the fees for all pending batches, results are returned in sdk.Coin (fee_amount_int)(contract_address) style
option (google.api.http).get = "/gravity/v1/batches/fees";
message
query.proto:234(message has no fields)
message
query.proto:235repeated fees = 1
rpc ERC20ToDenom (, )
query.proto:104Query for info about denoms tracked by gravity
option (google.api.http).get = "/gravity/v1/cosmos_originated/erc20_to_denom";
message
query.proto:261string erc20 = 1
message
query.proto:262string denom = 1
bool cosmos_originated = 2
rpc DenomToERC20Params (, )
query.proto:111DenomToERC20Params implements a query that allows ERC-20 parameter information to be retrieved by a Cosmos base denomination.
message
query.proto:267string denom = 1
message
query.proto:268string base_denom = 1
string erc20_name = 2
string erc20_symbol = 3
uint64 erc20_decimals = 4
rpc DenomToERC20 (, )
query.proto:114Query for info about denoms tracked by gravity
option (google.api.http).get = "/gravity/v1/cosmos_originated/denom_to_erc20";
message
query.proto:275string denom = 1
message
query.proto:276string erc20 = 1
bool cosmos_originated = 2
Query for batch send to ethereums
option (google.api.http).get = "/gravity/v1/query_batched_send_to_eth";
message
query.proto:303NOTE: if there is no sender address, return all
string sender_address = 1
todo: figure out how to paginate given n Batches with m Send To Ethereums cosmos.base.query.v1beta1.PageRequest pagination = 2;
message
query.proto:308repeated send_to_ethereums = 1
cosmos.base.query.v1beta1.PageResponse pagination = 2;
Query for unbatched send to ethereums
option (google.api.http).get = "/gravity/v1/query_unbatched_send_to_eth";
message
query.proto:313string sender_address = 1
optional pagination = 2
message
query.proto:317repeated send_to_ethereums = 1
optional pagination = 2
delegate keys
option (google.api.http).get = "/gravity/v1/delegate_keys/validator/{validator}";
message
query.proto:281string validator_address = 1
message
query.proto:282string eth_address = 1
string orchestrator_address = 2
option (google.api.http).get = "/gravity/v1/delegate_keys/ethereum/{ethereum_signer}";
message
query.proto:287string ethereum_signer = 1
message
query.proto:288string validator_address = 1
string orchestrator_address = 2
option (google.api.http).get = "/gravity/v1/delegate_keys/orchestrator/{orchestrator}";
message
query.proto:293string orchestrator_address = 1
message
query.proto:294string validator_address = 1
string ethereum_signer = 2
rpc DelegateKeys (, )
query.proto:146option (google.api.http).get = "/gravity/v1/delegate_keys";
message
query.proto:299(message has no fields)
message
query.proto:300repeated delegate_keys = 1
message
msgs.proto:165BatchExecutedEvent claims that a batch of BatchTxExecutedal operations on the bridge contract was executed successfully on ETH
string token_contract = 1
uint64 event_nonce = 2
uint64 ethereum_height = 3
uint64 batch_nonce = 4
message
gravity.proto:50BatchTx represents a batch of transactions going from Cosmos to Ethereum. Batch txs are are identified by a unique hash and the token contract that is shared by all the SendToEthereum
Used in: , ,
uint64 batch_nonce = 1
uint64 timeout = 2
repeated transactions = 3
string token_contract = 4
uint64 height = 5
message
msgs.proto:93BatchTxConfirmation is a signature on behalf of a validator for a BatchTx.
Used in:
string token_contract = 1
uint64 batch_nonce = 2
string ethereum_signer = 3
bytes signature = 4
message
msgs.proto:177NOTE: bytes.HexBytes is supposed to "help" with json encoding/decoding investigate?
uint64 event_nonce = 1
bytes invalidation_scope = 2
uint64 invalidation_nonce = 3
uint64 ethereum_height = 4
message
gravity.proto:70ContractCallTx represents an individual arbitrary logic call transaction from Cosmos to Ethereum.
Used in: , ,
uint64 invalidation_nonce = 1
bytes invalidation_scope = 2
string address = 3
bytes payload = 4
uint64 timeout = 5
repeated tokens = 6
repeated fees = 7
uint64 height = 8
message
msgs.proto:85ContractCallTxConfirmation is a signature on behalf of a validator for a ContractCallTx.
Used in:
bytes invalidation_scope = 1
uint64 invalidation_nonce = 2
string ethereum_signer = 3
bytes signature = 4
message
msgs.proto:137DelegateKeysSignMsg defines the message structure an operator is expected to sign when submitting a MsgDelegateKeys message. The resulting signature should populate the eth_signature field.
string validator_address = 1
uint64 nonce = 2
message
msgs.proto:188ERC20DeployedEvent is submitted when an ERC20 contract for a Cosmos SDK coin has been deployed on Ethereum.
uint64 event_nonce = 1
string cosmos_denom = 2
string token_contract = 3
string erc20_name = 4
string erc20_symbol = 5
uint64 erc20_decimals = 6
uint64 ethereum_height = 7
message
genesis.proto:121This records the relationship between an ERC20 token and the denom of the corresponding Cosmos originated asset
Used in:
string erc20 = 1
string denom = 2
message
gravity.proto:83Used in: ,
string contract = 1
string amount = 2
message
gravity.proto:15EthereumEventVoteRecord is an event that is pending of confirmation by 2/3 of the signer set. The event is then attested and executed in the state machine once the required threshold is met.
Used in:
optional event = 1
repeated string votes = 2
bool accepted = 3
message
gravity.proto:31EthereumSigner represents a cosmos validator with its corresponding bridge operator ethereum address and its staking consensus power.
Used in: ,
uint64 power = 1
string ethereum_address = 2
message
genesis.proto:108GenesisState struct TODO: this need to be audited and potentially simplified using the new interfaces
optional params = 1
uint64 last_observed_event_nonce = 2
repeated outgoing_txs = 3
repeated confirmations = 4
repeated ethereum_event_vote_records = 9
repeated delegate_keys = 10
repeated erc20_to_denoms = 11
repeated unbatched_send_to_ethereum_txs = 12
message
gravity.proto:91repeated uint64 ids = 1
message
gravity.proto:24LatestEthereumBlockHeight defines the latest observed ethereum block height and the corresponding timestamp value in nanoseconds.
uint64 ethereum_height = 1
uint64 cosmos_height = 2
message
msgs.proto:125MsgDelegateKey allows validators to delegate their voting responsibilities to a given orchestrator address. This key is then used as an optional authentication method for attesting events from Ethereum.
Used as request type in: Msg.SetDelegateKeys
Used as field type in: ,
string validator_address = 1
string orchestrator_address = 2
string ethereum_address = 3
bytes eth_signature = 4
message
genesis.proto:72Params represent the Gravity genesis and store parameters gravity_id: a random 32 byte value to prevent signature reuse, for example if the cosmos validators decided to use the same Ethereum keys for another chain also running Gravity we would not want it to be possible to play a deposit from chain A back on chain B's Gravity. This value IS USED ON ETHEREUM so it must be set in your genesis.json before launch and not changed after deploying Gravity contract_hash: the code hash of a known good version of the Gravity contract solidity code. This can be used to verify the correct version of the contract has been deployed. This is a reference value for goernance action only it is never read by any Gravity code bridge_ethereum_address: is address of the bridge contract on the Ethereum side, this is a reference value for governance only and is not actually used by any Gravity code bridge_chain_id: the unique identifier of the Ethereum chain, this is a reference value only and is not actually used by any Gravity code These reference values may be used by future Gravity client implemetnations to allow for saftey features or convenience features like the Gravity address in your relayer. A relayer would require a configured Gravity address if governance had not set the address on the chain it was relaying for. signed_signer_set_txs_window signed_batches_window signed_ethereum_signatures_window These values represent the time in blocks that a validator has to submit a signature for a batch or valset, or to submit a ethereum_signature for a particular attestation nonce. In the case of attestations this clock starts when the attestation is created, but only allows for slashing once the event has passed target_eth_tx_timeout: This is the 'target' value for when ethereum transactions time out, this is a target because Ethereum is a probabilistic chain and you can't say for sure what the block frequency is ahead of time. average_block_time average_ethereum_block_time These values are the average Cosmos block time and Ethereum block time respectively and they are used to compute what the target batch timeout is. It is important that governance updates these in case of any major, prolonged change in the time it takes to produce a block slash_fraction_signer_set_tx slash_fraction_batch slash_fraction_ethereum_signature slash_fraction_conflicting_ethereum_signature The slashing fractions for the various gravity related slashing conditions. The first three refer to not submitting a particular message, the third for submitting a different ethereum_signature for the same Ethereum event
Used in: ,
string gravity_id = 1
string contract_source_hash = 2
string bridge_ethereum_address = 4
uint64 bridge_chain_id = 5
uint64 signed_signer_set_txs_window = 6
uint64 signed_batches_window = 7
uint64 ethereum_signatures_window = 8
uint64 target_eth_tx_timeout = 10
uint64 average_block_time = 11
uint64 average_ethereum_block_time = 12
bytes slash_fraction_signer_set_tx = 13
TODO: slash fraction for contract call txs too
bytes slash_fraction_batch = 14
bytes slash_fraction_ethereum_signature = 15
bytes slash_fraction_conflicting_ethereum_signature = 16
uint64 unbond_slashing_signer_set_txs_window = 17
message
msgs.proto:149SendToCosmosEvent is submitted when the SendToCosmosEvent is emitted by they gravity contract. ERC20 representation coins are minted to the cosmosreceiver address.
uint64 event_nonce = 1
string token_contract = 2
string amount = 3
string ethereum_sender = 4
string cosmos_receiver = 5
uint64 ethereum_height = 6
message
gravity.proto:60SendToEthereum represents an individual SendToEthereum from Cosmos to Ethereum
Used in: , , ,
uint64 id = 1
string sender = 2
string ethereum_recipient = 3
optional erc20_token = 4
optional erc20_fee = 5
message
gravity.proto:40SignerSetTx is the Ethereum Bridge multisig set that relays transactions the two chains. The staking validators keep ethereum keys which are used to check signatures on Ethereum in order to get significant gas savings.
Used in: , ,
uint64 nonce = 1
uint64 height = 2
repeated signers = 3
message
msgs.proto:102SignerSetTxConfirmation is a signature on behalf of a validator for a SignerSetTx
Used in:
uint64 signer_set_nonce = 1
string ethereum_signer = 2
bytes signature = 3
message
msgs.proto:200This informs the Cosmos module that a validator set has been updated.
uint64 event_nonce = 1
uint64 signer_set_tx_nonce = 2
uint64 ethereum_height = 3
repeated members = 4
message
query.proto:159Used as response type in: Query.LatestSignerSetTx, Query.SignerSetTx
optional signer_set = 1