| ics | title | stage | category | kind | implements | author | created | modified |
|---|---|---|---|---|---|---|---|---|
8 |
Wasm Client |
draft |
IBC/TAO |
instantiation |
2 |
Parth Desai <[email protected]>, Mateusz Kaczanowski <[email protected]>, Blas Rodriguez Irizar <[email protected]>, Steve Miskovetz <[email protected]> |
2020-10-13 |
2024-03-22 |
This specification document describes an interface to a light client stored as a Wasm bytecode for a blockchain.
Currently, adding a new client implementation or upgrading an existing one requires a hard upgrade because the client implementations are part of the static chain binary. Any change to the on-chain light client code depends on chain governance approving an upgrade before it can be deployed.
This may be acceptable when adding new client types since the number of unique consensus algorithms that need to be supported is currently small. However, this process will become very tedious when it comes to upgrading light clients.
Without dynamically upgradable light clients, a chain that wishes to upgrade its consensus algorithm (and thus break existing light clients) must wait for all counterparty chains to perform a hard upgrade that adds support for the upgraded light client before it can perform an upgrade on its chain. Examples of a consensus-breaking upgrade would be an upgrade from Tendermint v1 to a light-client breaking Tendermint v2 or switching from Tendermint consensus to Honeybadger. Changes to the internal state-machine logic will not affect consensus. E.g., changes to the staking module do not require an IBC upgrade.
Requiring all counterparties to add statically new client implementations to their binaries will inevitably slow the pace of upgrades in the IBC network since the deployment of an upgrade on even a very experimental, fast-moving chain will be blocked by an upgrade to a high-value chain that will be inherently more conservative.
Once the IBC network broadly adopts dynamically upgradable clients, a chain may upgrade its consensus algorithm whenever it wishes, and relayers may upgrade the client code of all counterparty chains without requiring the counterparty chains to perform an upgrade themselves. This prevents a dependency on counterparty chains when considering upgrading one's consensus algorithm.
Another reason why this interface is beneficial is that it removes the dependency between Light clients and the Go programming language. Using Wasm as a compilation target, light clients can be written in any programming language whose toolchain includes Wasm as a compilation target. Examples of these are Go, Rust, C, and C++.
Functions & terms are as defined in ICS 2.
currentTimestamp is as defined in ICS 24.
Wasm VM refers to a virtual machine capable of executing valid Wasm bytecode.
Wasm Contract refers to Wasm bytecode stored in the Wasm VM, which provides a target blockchain specific implementation of ICS 2.
Wasm Client Proxy refers to an implementation of ICS 8 that acts as a pass-through to the Wasm client.
Wasm Client refers to a particular instance of Wasm Contract defined as a tuple (Wasm Contract, ClientID).
This specification must satisfy the client interface defined in ICS 2..
This specification depends on the correct instantiation of the Wasm client and is decoupled from any specific implementation of the target blockchain consensus algorithm.
Light client operations defined in ICS 2 can be stateful; they may modify the state kept in storage. For that, there is a need to allow the underlying Wasm light client implementation to access client and consensus data structures and, after performing certain computations, to update the storage with the new versions of them.
For this reason, the implementation in ibc-go chooses to share the Wasm client store between the 02-client module (for reading), 08-wasm module (for instantiation), and Wasm contract. Other than instantiation, the Wasm contract is responsible for updating state.
The purpose of this module is to delegate light client logic to a module written in Wasm. For that,
the Wasm client proxy needs a reference (or a handler) to a Wasm VM. The Wasm client proxy can then directly call the wasmvm to interact with the VM with less overhead, fewer dependencies, and finer grain control over the Wasm client store than if using an intermediary module such as x/wasm.
wasmd has thoroughly benchmarked gas adjustments for CosmWasm and the same values are being applied in the Wasm VM used in ibc-go's implementation of ICS 8.
const (
DefaultGasMultiplier uint64 = 140_000_000
DefaultInstanceCost uint64 = 60_000
DefaultCompileCost uint64 = 3
DefaultContractMessageDataCost uint64 = 0
DefaultDeserializationCostPerByte = 1
)The Wasm client state tracks the location of the Wasm bytecode via checksum. Binary data represented by the data field is opaque and only interpreted by the Wasm contract.
interface ClientState {
data: []byte
checksum: []byte
latestHeight: Height
}The Wasm consensus state tracks the consensus state of the Wasm client. Binary data represented by the data field is opaque and only interpreted by the Wasm contract.
interface ConsensusState {
data: []byte
}The height of a Wasm light client instance consists of two uint64s: the revision number and the height in the revision.
interface Height {
revisionNumber: uint64
revisionHeight: uint64
}Contents of Wasm client headers depend upon Wasm contract. Binary data represented by the data field is opaque and only interpreted by the Wasm contract, and will consist either of a valid header or of two conflicting headers, both of which the Wasm contract would have considered valid. In the latter case, the contract will update the consensus state with the valid header; in the former case, the light client may detect misbehaviour and freeze the client (thus preventing further packet flow).
interface Header {
data: []byte
}Wasm client initialization requires a (subjectively chosen) latest consensus state and corresponding client state, interpretable by the Wasm contract.
interface InstantiateMessage {
consensusState: ConsensusState
}function initialise(
identifier: Identifier,
data: []byte,
checksum: []byte,
consensusState: ConsensusState,
height: Height
): ClientState {
// bytes of encoded consensus state of base light
// client are passed in the message
payload = InstantiateMessage{consensusState.data}
// retrieve client identifier-prefixed store
clientStore = provableStore.prefixStore("clients/{identifier}")
// initialize wasm contract for a previously stored contract identified by checksum
initContract(checksum, clientStore, marshalJSON(payload))
return ClientState{
data,
checksum,
latestHeight: height
}
}The Wasm client proxy performs calls to the Wasm client via the Wasm VM. The calls require as input payload messages that are categorized on two discriminated union types: one for payload messages used in calls that perform only reads, and one for payload messages used in calls that perform state-changing writes.
type QueryMsg =
| Status
| TimestampAtHeight
| VerifyClientMessage
| CheckForMisbehaviour;type SudoMsg =
| UpdateState
| UpdateStateOnMisbehaviour
| VerifyMembership
| VerifyNonMembership
| VerifyUpgradeAndUpdateState
| CheckSubstituteAndUpdateStateWasm client validity checking uses underlying Wasm contract. If the provided client message is valid, the client state will proceed to checking for misbehaviour (call to checkForMisbehaviour) and updating state (call to either updateStateOnMisbehaviour or updateState depending on whether misbehaviour was detected in the client message).
interface VerifyClientMessageMsg {
clientMessage: bytes
}function verifyClientMessage(clientMsg: ClientMessage) {
// bytes of encoded client message of base light
// client are passed in the message
payload = verifyClientMessageMsg{clientMsg.data}
clientState = provableStore.get("clients/{clientMsg.identifier}/clientState")
// retrieve client identifier-prefixed store
clientStore = provableStore.prefixStore("clients/{clientMsg.identifier}")
// use underlying wasm contract to verify client message
assert(callContract(clientStore, clientState, marshalJSON(payload)))
}Function checkForMisbehaviour will check if an update contains evidence of misbehaviour. Wasm client misbehaviour checking determines whether or not two conflicting headers at the same height would have convinced the light client.
interface CheckForMisbehaviourMsg {
clientMessage: bytes
}function checkForMisbehaviour(clientMsg: ClientMessage): boolean {
// bytes of encoded client message of base light
// client are passed in the message
payload = checkForMisbehaviourMsg{clientMsg.data}
clientState = provableStore.get("clients/{clientMsg.identifier}/clientState")
// retrieve client identifier-prefixed store
clientStore = provableStore.prefixStore("clients/{clientMsg.identifier}")
// use underlying wasm contract to check for misbehaviour
result = callContract(clientStore, clientState, marshalJSON(payload))
return result.foundMisbehaviour
}Function updateState will perform a regular update for the Wasm client. It will add a consensus state to the client store. If the header is higher than the latest height on the clientState, then the clientState will be updated.
interface UpdateStateMsg {
clientMessage: bytes
}function updateState(clientMsg: ClientMessage) {
// bytes of encoded client message of base light
// client are passed in the message
payload = UpdateStateMsg{clientMsg.data}
clientState = provableStore.get("clients/{clientMsg.identifier}/clientState")
// retrieve client identifier-prefixed store
clientStore = provableStore.prefixStore("clients/{clientMsg.identifier}")
// use underlying wasm contract to update client state and store new consensus state
callContract(clientStore, clientState, marshalJSON(payload))
}Function updateStateOnMisbehaviour will set the frozen height to a non-zero height to freeze the entire client.
interface UpdateStateOnMisbehaviourMsg {
clientMessage: bytes
}function updateStateOnMisbehaviour(clientMsg: clientMessage) {
// bytes of encoded client message of base light
// client are passed in the message
payload = UpdateStateOnMisbehaviourMsg{clientMsg.data}
clientState = provableStore.get("clients/{clientMsg.identifier}/clientState")
// retrieve client identifier-prefixed store
clientStore = provableStore.prefixStore("clients/{clientMsg.identifier}")
// use underlying wasm contract to update client state
callContract(clientStore, clientState, marshalJSON(payload))
}The chain which this light client is tracking can elect to write a special pre-determined key in state to allow the light client to update its client state (e.g. with a new chain ID or revision) in preparation for an upgrade.
As the client state change will be performed immediately, once the new client state information is written to the pre-determined key, the client will no longer be able to follow blocks on the old chain, so it must upgrade promptly.
function upgradeClientState(
clientState: ClientState,
newClientState: ClientState,
height: Height,
proof: CommitmentProof
) {
// Use the underlying wasm contract to verify the upgrade and
// update the client state. The contract is passed a
// client identifier-prefixed store so that all state read/write
// operations are for the client in question.
}If a Wasm light client becomes frozen, a governance proposal can be submitted to update the state of the frozen light client (the subject) with the state of an active light client (the substitute). The substitute client MUST be of the same type as the subject client. Depending on the exact type of the underlying light client type, all or a subset of parameters of the subject and substitute client states MUST match.
function checkSubstituteAndUpdateState(
subjectClientState: ClientState,
substituteClientState: ClientState,
subjectClientStore: KVStore,
substituteClientStore: KVStore
) {
// Use the underlying wasm contract to update the subject
// client with the state of the substitute. The contract is
// passed a client identifier-prefixed store so that all
// state read/write operations are for the client in question.
}Wasm client state verification functions check a proof against a previously validated commitment root.
interface verifyMembershipMsg {
height: Height
delayTimePeriod: uint64
delayBlockPeriod: uint64
proof: CommitmentProof
path: CommitmentPath
value: []byte
}
interface verifyNonMembershipMsg {
height: Height
DelayTimePeriod: uint64
DelayBlockPeriod: uint64
Proof: CommitmentProof
Path: CommitmentPath
}function verifyMembership(
clientState: ClientState,
height: Height,
delayTimePeriod: uint64,
delayBlockPeriod: uint64,
proof: CommitmentProof,
path: CommitmentPath,
value: []byte
): Error {
// check that the client is at a sufficient height
assert(clientState.latestHeight >= height)
payload = VerifyMembershipMsg{
height,
delayTimePeriod,
delayBlockPeriod,
proof,
path,
value
}
// retrieve client identifier-prefixed store
clientStore = provableStore.prefixStore("clients/{clientIdentifier}")
// use underlying wasm contract to verify that <path, value> has been stored
result = callContract(clientStore, clientState, marshalJSON(payload))
return result.error
}
function verifyNonMembership(
clientState: ClientState,
height: Height,
delayTimePeriod: uint64,
delayBlockPeriod: uint64,
proof: CommitmentProof,
path: CommitmentPath
): Error {
// check that the client is at a sufficient height
assert(clientState.latestHeight >= height)
payload = verifyNonMembershipMsg{
height,
delayTimePeriod,
delayBlockPeriod,
proof,
path
}
// retrieve client identifier-prefixed store
clientStore = provableStore.prefixStore("clients/{clientIdentifier}")
// use underlying wasm contract to verify that nothing has been stored at path
result = callContract(clientStore, clientState, marshalJSON(payload))
return result.error
}When an instruction needs to be executed in Wasm code, functions are executed using a wasmvm.
This VM is sandboxed, hence isolated from other operations.
The process requires packaging all the arguments to be executed by a specific function (including
pointers to KVStores if needed), pointing to a checksum, and a sdk.GasMeter to properly account
for gas usage during the execution of the function.
Instantiation of a contract is minimal. No data is passed in the message for the contract call, but the Wasm client store is passed. This allows for a Wasm contract to initialize any metadata that they need such as processed height and/or processed time.
Every Wasm contract must support these query messages:
#[cw_serde]
pub struct StatusMsg {}
#[cw_serde]
pub struct TimestampAtHeightMsg {
pub height: Height,
}
#[cw_serde]
pub struct VerifyClientMessage {
#[schemars(with = "String")]
#[serde(with = "Base64", default)]
pub client_message: Bytes,
}
pub struct CheckForMisbehaviourMsgRaw {
#[schemars(with = "String")]
#[serde(with = "Base64", default)]
pub client_message: Bytes,
}The response for queries is as follows:
#[cw_serde]
pub struct QueryResponse {
pub is_valid: bool,
#[serde(skip_serializing_if = "Option::is_none")]
pub status: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pub genesis_metadata: Option<Vec<GenesisMetadata>>, // metadata KV pairs
#[serde(skip_serializing_if = "Option::is_none")]
// boolean set by contract's implementation of checkForMisbehaviour
pub found_misbehaviour: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
// timestamp set by contracts implementation of getTimestampAtHeight
pub timestamp: Option<u64>,
}
#[cw_serde]
pub struct GenesisMetadata {
pub key: Vec<u8>,
pub value: Vec<u8>,
}Every Wasm contract must support these sudo messages:
#[cw_serde]
pub struct VerifyMembershipMsg {
#[schemars(with = "String")]
#[serde(with = "Base64", default)]
pub proof: Bytes,
pub path: MerklePath,
#[schemars(with = "String")]
#[serde(with = "Base64", default)]
pub value: Bytes,
pub height: Height,
pub delay_block_period: u64,
pub delay_time_period: u64,
}
#[cw_serde]
pub struct VerifyNonMembershipMsg {
#[schemars(with = "String")]
#[serde(with = "Base64", default)]
pub proof: Bytes,
pub path: MerklePath,
pub height: Height,
pub delay_block_period: u64,
pub delay_time_period: u64,
}
#[cw_serde]
pub struct UpdateStateOnMisbehaviourMsg {
#[schemars(with = "String")]
#[serde(with = "Base64", default)]
pub client_message: Bytes,
}
#[cw_serde]
pub struct UpdateStateMsg {
#[schemars(with = "String")]
#[serde(with = "Base64", default)]
pub client_message: Bytes,
}
#[cw_serde]
pub struct CheckSubstituteAndUpdateStateMsg {
substitute_client_msg: Vec<u8>,
}
#[cw_serde]
pub struct MigrateClientStoreMsg {}
#[cw_serde]
pub struct VerifyUpgradeAndUpdateStateMsgRaw {
pub upgrade_client_state: Bytes,
pub upgrade_consensus_state: Bytes,
#[schemars(with = "String")]
#[serde(with = "Base64", default)]
pub proof_upgrade_client: Vec<u8>,
#[schemars(with = "String")]
#[serde(with = "Base64", default)]
pub proof_upgrade_consensus_state: Vec<u8>,
}The response for sudo is as follows:
#[cw_serde]
pub struct ContractResult {
#[serde(skip_serializing_if = "Option::is_none")]
// heights set by contract's implementation of updateState
pub heights: Option<Vec<Height>>,
}Correctness guarantees as provided by the underlying algorithm implemented by Wasm contract.
Not applicable.
As long as Wasm contract keeps its interface consistent with ICS 02 it should be forward compatible
Implementation of ICS 08 in Go can be found in ibc-go PR.
Oct 8, 2021 - Final first draft
Mar 15th, 2022 - Update for 02-client refactor
Sep 7th, 2023 - Update for changes during implementation
Mar 22th, 2024 - Update for changes after release of ibc-go's 08-wasm module
All content herein is licensed under Apache 2.0.