Skip to content

Commit

Permalink
docs: update module docs (#871)
Browse files Browse the repository at this point in the history
* make proto

* fixes from docs/pull/84

---------

Co-authored-by: Lucas Bertrand <[email protected]>
  • Loading branch information
fadeev and lumtis authored Aug 7, 2023
1 parent 6753c10 commit 9ebd8a3
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 46 deletions.
42 changes: 1 addition & 41 deletions docs/spec/crosschain/messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ created.

If the receiver chain is a ZetaChain, the EVM deposit is handled and the
status of CCTX is changed to "outbound mined". If EVM deposit handling fails,
the status of CCTX is changed to 'aborted'.
the status of CCTX is chagned to 'aborted'.

If the receiver chain is a connected chain, the inbound CCTX is finalized
(prices and nonce are updated) and status changes to "pending outbound". If
Expand All @@ -160,43 +160,3 @@ message MsgVoteOnObservedInboundTx {
}
```

## MsgSetNodeKeys

Not implemented yet.

```proto
message MsgSetNodeKeys {
string creator = 1;
common.PubKeySet pubkeySet = 2;
string tss_signer_Address = 3;
}
```

## MsgUpdatePermissionFlags

Updates permissions. Currently, this is only used to enable/disable the
inbound transactions.

Only the admin policy account is authorized to broadcast this message.

```proto
message MsgUpdatePermissionFlags {
string creator = 1;
bool isInboundEnabled = 3;
}
```

## MsgUpdateKeygen

Updates the block height of the keygen and sets the status to "pending
keygen".

Only the admin policy account is authorized to broadcast this message.

```proto
message MsgUpdateKeygen {
string creator = 1;
int64 block = 2;
}
```

4 changes: 0 additions & 4 deletions docs/spec/crosschain/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,6 @@ status is changed to final.
| MsgVoteOnObservedInboundTx | ||
| MsgAddToOutTxTracker |||
| MsgRemoveFromOutTxTracker || |
| MsgUpdatePermissionFlags || |
| MsgUpdateKeygenPermission || |

## State

Expand All @@ -83,8 +81,6 @@ The module stores the following information in the state:
- List of chain nonces
- List of last chain heights
- List of cross-chain transactions
- List of
- Mapping between inbound transactions and cross-chain transactions
- Keygen
- TSS key
- Gas prices on connected chains submitted by observers
2 changes: 1 addition & 1 deletion docs/spec/fungible/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Overview

The `fungible` facilitates the deployment of fungible tokens of connected
The `fungible` module facilitates the deployment of fungible tokens of connected
blockchains (called "foreign coins") on ZetaChain.

Foreign coins are represented as ZRC20 tokens on ZetaChain.
Expand Down
38 changes: 38 additions & 0 deletions docs/spec/observer/messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,41 @@ message MsgUpdateCoreParams {
}
```

## MsgAddBlameVote

```proto
message MsgAddBlameVote {
string creator = 1;
int64 chain_id = 2;
Blame blame_info = 3;
}
```

## MsgUpdatePermissionFlags

Updates permissions. Currently, this is only used to enable/disable the
inbound transactions.

Only the admin policy account is authorized to broadcast this message.

```proto
message MsgUpdatePermissionFlags {
string creator = 1;
bool isInboundEnabled = 3;
}
```

## MsgUpdateKeygen

Updates the block height of the keygen and sets the status to "pending
keygen".

Only the admin policy account is authorized to broadcast this message.

```proto
message MsgUpdateKeygen {
string creator = 1;
int64 block = 2;
}
```

0 comments on commit 9ebd8a3

Please sign in to comment.