Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update ibc wasm client storage #3

Merged
merged 3 commits into from
Sep 10, 2021
Merged

Update ibc wasm client storage #3

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5750485
remove proof verification on the Go side
mkaczanowski Sep 7, 2021
ecb602f
rename epoch{number,height} to revision{number, height}
mkaczanowski Sep 9, 2021
ae1fdad
rephrase misbehaviour description
mkaczanowski Sep 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 22 additions & 60 deletions spec/client/ics-008-wasm-client/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,31 +68,31 @@ interface ConsensusState {

### Height

The height of a Wasm light client instance consists of two `uint64`s: the epoch number, and the height in the epoch.
The height of a Wasm light client instance consists of two `uint64`s: the revision number, and the height in the revision.

```typescript
interface Height {
epochNumber: uint64
epochHeight: uint64
revisionNumber: uint64
revisionHeight: uint64
}
```

Comparison between heights is implemented as follows:

```typescript
function compare(a: Height, b: Height): Ord {
if (a.epochNumber < b.epochNumber)
if (a.revisionNumber < b.revisionNumber)
return LT
else if (a.epochNumber === b.epochNumber)
if (a.epochHeight < b.epochHeight)
else if (a.revisionNumber === b.revisionNumber)
if (a.revisionHeight < b.revisionHeight)
return LT
else if (a.epochHeight === b.epochHeight)
else if (a.revisionHeight === b.revisionHeight)
return EQ
return GT
}
```

This is designed to allow the height to reset to `0` while the epoch number increases by one in order to preserve timeouts through zero-height upgrades.
This is designed to allow the height to reset to `0` while the revision number increases by one in order to preserve timeouts through zero-height upgrades.

### Headers

Expand All @@ -108,7 +108,7 @@ interface Header {
### Misbehaviour

The `Misbehaviour` type is used for detecting misbehaviour and freezing the client - to prevent further packet flow - if applicable.
Wasm client `Misbehaviour` consists of two headers at the same height both of which the light client would have considered valid.
Wasm client `Misbehaviour` consists of two conflicting headers both of which the light client would have considered valid.

```typescript
interface Misbehaviour {
Expand Down Expand Up @@ -152,13 +152,13 @@ Wasm client validity checking uses underlying Wasm Client code. If the provided
```typescript
function checkValidityAndUpdateState(
clientState: ClientState,
epoch: uint64,
revision: uint64,
header: Header) {
store = getStore("clients/{identifier}")
codeHandle = clientState.codeHandle()

// verify that provided header is valid and state is saved
assert(codeHandle.validateHeaderAndCreateConsensusState(store, clientState, header, epoch))
assert(codeHandle.validateHeaderAndCreateConsensusState(store, clientState, header, revision))
}
```

Expand All @@ -178,7 +178,7 @@ function checkMisbehaviourAndUpdateState(

### Upgrades

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 epoch) in preparation for an upgrade.
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 predetermined key, the client will no longer be able to follow blocks on the old chain, so it must upgrade promptly.

Expand All @@ -189,11 +189,8 @@ function upgradeClientState(
height: Height,
proof: CommitmentPrefix) {
codeHandle = clientState.codeHandle()
codeHandle.verifyNewClientState(oldClientState, newClientState, height)
// fetch the previously verified commitment root & verify membership
root = get("clients/{identifier}/consensusStates/{height}")
// verify that the provided consensus state has been stored
assert(root.verifyMembership(path, newClientState, proof))
assert(codeHandle.verifyNewClientState(clientState, newClientState, height, proof))

// update client state
clientState = newClientState
set("clients/{identifier}", clientState)
Expand All @@ -215,13 +212,8 @@ function verifyClientConsensusState(
clientIdentifier: Identifier,
consensusStateHeight: Height,
consensusState: ConsensusState) {
path = applyPrefix(prefix, "clients/{clientIdentifier}/consensusState/{consensusStateHeight}")
codeHandle = getCodeHandleFromClientID(clientIdentifier)
assert(codeHandle.isValidClientState(clientState, height))
// fetch the previously verified commitment root & verify membership
root = get("clients/{identifier}/consensusStates/{height}")
// verify that the provided consensus state has been stored
assert(root.verifyMembership(path, consensusState, proof))
assert(codeHandle.isValidClientState(clientState, height, prefix, clientIdentifier, proof, consensusStateHeight, consensusState))
}

function verifyConnectionState(
Expand All @@ -231,13 +223,8 @@ function verifyConnectionState(
proof: CommitmentProof,
connectionIdentifier: Identifier,
connectionEnd: ConnectionEnd) {
path = applyPrefix(prefix, "connections/{connectionIdentifier}")
codeHandle = clientState.codeHandle()
assert(codeHandle.isValidClientState(clientState, height))
// fetch the previously verified commitment root & verify membership
root = get("clients/{identifier}/consensusStates/{height}")
// verify that the provided connection end has been stored
assert(root.verifyMembership(path, connectionEnd, proof))
assert(codeHandle.verifyConnectionState(clientState, height, prefix, proof, connectionIdentifier, connectionEnd))
}

function verifyChannelState(
Expand All @@ -248,13 +235,8 @@ function verifyChannelState(
portIdentifier: Identifier,
channelIdentifier: Identifier,
channelEnd: ChannelEnd) {
path = applyPrefix(prefix, "ports/{portIdentifier}/channels/{channelIdentifier}")
codeHandle = clientState.codeHandle()
assert(codeHandle.isValidClientState(clientState, height))
// fetch the previously verified commitment root & verify membership
root = get("clients/{identifier}/consensusStates/{height}")
// verify that the provided channel end has been stored
assert(root.verifyMembership(codeHandle.getProofSpec(clientState), path, channelEnd, proof))
assert(codeHandle.verifyChannelState(clientState, height, prefix, proof, porttIdentifier, channelIdentifier, channelEnd))
}

function verifyPacketData(
Expand All @@ -266,13 +248,8 @@ function verifyPacketData(
channelIdentifier: Identifier,
sequence: uint64,
data: bytes) {
path = applyPrefix(prefix, "ports/{portIdentifier}/channels/{channelIdentifier}/packets/{sequence}")
codeHandle = clientState.codeHandle()
assert(codeHandle.isValidClientState(clientState, height))
// fetch the previously verified commitment root & verify membership
root = get("clients/{identifier}/consensusStates/{height}")
// verify that the provided commitment has been stored
assert(root.verifyMembership(codeHandle.getProofSpec(clientState), path, hash(data), proof))
assert(codeHandle.verifyPacketData(clientState, height, prefix, proof, portportIdentifier, channelIdentifier, sequence, data))
}

function verifyPacketAcknowledgement(
Expand All @@ -284,13 +261,8 @@ function verifyPacketAcknowledgement(
channelIdentifier: Identifier,
sequence: uint64,
acknowledgement: bytes) {
path = applyPrefix(prefix, "ports/{portIdentifier}/channels/{channelIdentifier}/acknowledgements/{sequence}")
codeHandle = clientState.codeHandle()
assert(codeHandle.isValidClientState(clientState, height))
// fetch the previously verified commitment root & verify membership
root = get("clients/{identifier}/consensusStates/{height}")
// verify that the provided acknowledgement has been stored
assert(root.verifyMembership(codeHandle.getProofSpec(clientState), path, hash(acknowledgement), proof))
assert(codeHandle.verifyPacketAcknowledgement(clientState, height, prefix, proof, portportIdentifier, channelIdentifier, sequence, acknowledgement))
}

function verifyPacketReceiptAbsence(
Expand All @@ -301,13 +273,8 @@ function verifyPacketReceiptAbsence(
portIdentifier: Identifier,
channelIdentifier: Identifier,
sequence: uint64) {
path = applyPrefix(prefix, "ports/{portIdentifier}/channels/{channelIdentifier}/receipts/{sequence}")
codeHandle = clientState.codeHandle()
assert(codeHandle.isValidClientState(clientState, height))
// fetch the previously verified commitment root & verify membership
root = get("clients/{identifier}/consensusStates/{height}")
// verify that no acknowledgement has been stored
assert(root.verifyNonMembership(codeHandle.getProofSpec(clientState), path, proof))
assert(codeHandle.verifyPacketReceiptAbsence(clientState, height, prefix, proof, portIdentifier, channelIdentifier, sequence))
}

function verifyNextSequenceRecv(
Expand All @@ -318,13 +285,8 @@ function verifyNextSequenceRecv(
portIdentifier: Identifier,
channelIdentifier: Identifier,
nextSequenceRecv: uint64) {
path = applyPrefix(prefix, "ports/{portIdentifier}/channels/{channelIdentifier}/nextSequenceRecv")
codeHandle = clientState.codeHandle()
assert(codeHandle.isValidClientState(clientState, height))
// fetch the previously verified commitment root & verify membership
root = get("clients/{identifier}/consensusStates/{height}")
// verify that the nextSequenceRecv is as claimed
assert(root.verifyMembership(codeHandle.getProofSpec(clientState), path, nextSequenceRecv, proof))
assert(codeHandle.verifyNextSequenceRecv(clientState, height, prefix, proof, portIdentifier, channelIdentifier, nextSequenceRecv))
}
```

Expand Down Expand Up @@ -359,7 +321,7 @@ pub struct MisbehaviourMessage {
#[serde(rename_all = "snake_case")]
pub struct CreateConsensusMessage {
pub client_state: Vec<byte>,
pub epoch: u64,
pub revision: u64,
pub height: u64
}

Expand Down