package proofapi

Get desktop application:
View/edit binary Protocol Buffers messages

The proof API service definition. Each proof API service is defined between two chains. One chain is the source chain, and the other chain is the target chain.

• rpc CreateClient (CreateClientRequest, CreateClientResponse)

  proofapi.proto:14

  Create a new ibc client on the target (destination) chain

  message CreateClientRequest

  proofapi.proto:106

  The create client request message

  • string src_chain = 1

    The source chain identifier

  • string dst_chain = 2

    The target chain identifier

  • map<string, string> parameters = 3

    Optional genesis parameters

  message CreateClientResponse

  proofapi.proto:116

  The create client response message

  • bytes tx = 1

    The transaction to be submitted by caller

  • string address = 2

    The contract address to submit the transaction, if applicable

• rpc Info (InfoRequest, InfoResponse)

  proofapi.proto:18

  Request proof API information

  message InfoRequest

  proofapi.proto:144

  Information request message

  • string src_chain = 1

    The source chain identifier

  • string dst_chain = 2

    The target chain identifier

  message InfoResponse

  proofapi.proto:152

  Information response message

  • optional Chain target_chain = 1

    The target chain information

  • optional Chain source_chain = 2

    The source chain information

  • map<string, string> metadata = 3

    Metadata for the module

• rpc RelayByTx (RelayByTxRequest, RelayByTxResponse)

  proofapi.proto:12

  Relay the ibc packets produced by the results of transactions

  message RelayByTxRequest

  proofapi.proto:22

  The relay by tx request message

  • string src_chain = 1

    The source chain identifier

  • string dst_chain = 2

    The target chain identifier

  • repeated bytes source_tx_ids = 3

    The identifiers for the IBC transactions to be relayed This is usually the transaction hash

  • repeated bytes timeout_tx_ids = 4

    The identifiers for the IBC transactions on the target chain to be timed out

  • string src_client_id = 5

    The identifier for the source client Used for event filtering

  • string dst_client_id = 6

    The identifier for the destination client Used for event filtering

  • repeated uint64 src_packet_sequences = 7

    The optional source chain send packet sequences for recv packets Used for event filtering, no filtering if empty

  • repeated uint64 dst_packet_sequences = 8

    The optional destination chain send packet sequences for acks and timeouts Used for event filtering, no filtering if empty

  message RelayByTxResponse

  proofapi.proto:96

  The relay by tx response message

  • bytes tx = 1

    The multicall transaction to be submitted by caller For single transactions: contains the raw transaction bytes For multiple transactions (e.g. Solana chunks): contains serialized SolanaRelayPacketBatch

  • string address = 2

    The contract address to submit the transaction, if applicable

• rpc UpdateClient (UpdateClientRequest, UpdateClientResponse)

  proofapi.proto:16

  Update the ibc client on the target (destination) chain

  message UpdateClientRequest

  proofapi.proto:124

  The update client request message

  • string src_chain = 1

    The source chain identifier

  • string dst_chain = 2

    The target chain identifier

  • string dst_client_id = 3

    The identifier for the client on the destination chain

  message UpdateClientResponse

  proofapi.proto:134

  The update client response message

  • bytes tx = 1

    The transaction to be submitted by caller For single transactions: contains the raw transaction bytes For Solana: contains serialized SolanaUpdateClient

  • string address = 2

    The contract address to submit the transaction, if applicable

The chain definition

Used in: InfoResponse

• string chain_id = 1

  The chain id

• string ibc_version = 2

  The ibc version

• string ibc_contract = 3

  The ibc contract address

Transactions for a single packet (chunks + final instruction + cleanup) Submission order: alt_create_tx (if present) -> alt_extend_txs (sequential) -> chunks (parallel) -> final_tx -> cleanup_tx

Used in: SolanaRelayPacketBatch

• repeated bytes chunks = 1

  Chunk upload transactions (can be submitted in parallel)

• bytes final_tx = 2

  Final packet transaction (recv_packet, ack_packet, or timeout_packet)

• bytes cleanup_tx = 3

  Cleanup transaction (reclaims rent from chunks)

• bytes alt_create_tx = 4

  ALT creation transaction (optional, must be submitted first if present)

• repeated bytes alt_extend_txs = 5

  ALT extension transactions (optional, adds accounts to ALT in batches, submit sequentially after creation)

• bytes gmp_result_pda = 6

  GMP result PDA address (32 bytes) - present for ack/timeout packets on GMP port This PDA stores the acknowledgement or timeout result of a GMP call Seeds: ["gmp_result", source_client, sequence (little-endian u64)]

• bytes ift_finalize_transfer_tx = 7

  IFT finalize_transfer transaction (optional) - present for ack/timeout packets from IFT Submit AFTER final_tx is confirmed and gmp_result_pda is initialized This reclaims tokens for the sender on timeout/failed ack, or closes PendingTransfer on success

Batch of packet transactions for relay operations

• repeated SolanaPacketTxs packets = 1

  List of packet transactions

• optional SolanaUpdateClient update_client = 2

  Optional: update client transactions if client needs updating before relay Submission order: update_client first (if present), then packets

Solana-specific update client transactions with chunking and ALT support Submission order: alt_create_tx -> alt_extend_txs (sequential) -> [chunk_txs (parallel)] -> assembly_tx -> cleanup_tx

Used in: SolanaRelayPacketBatch

• repeated bytes chunk_txs = 1

  All preparatory transactions: signatures + chunks (submitted in parallel with ALT extensions)

• bytes alt_create_tx = 2

  ALT creation transaction (must be submitted first)

• repeated bytes alt_extend_txs = 3

  ALT extension transactions (adds chunk accounts to ALT in batches, submit sequentially after creation)

• bytes assembly_tx = 4

  Final assembly transaction (must be submitted last after ALT activation, uses ALT for compression)

• uint64 target_height = 5

  Target height being updated to

• bytes cleanup_tx = 6

  Cleanup transaction (reclaims rent from chunks and signatures after assembly)