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.

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

refactor: MsgUpdateCrosschainFlags into MsgEnableCCTXFlags, MsgDisableCCTXFlags and MsgUpdateGasPriceIncreaseFlags #2269

Merged
merged 19 commits into from
May 29, 2024
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
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
2 changes: 2 additions & 0 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@
* [2210](https://github.com/zeta-chain/node/pull/2210) - removed uncessary panics in the zetaclientd process
* [2205](https://github.com/zeta-chain/node/pull/2205) - remove deprecated variables pre-v17
* [2226](https://github.com/zeta-chain/node/pull/2226) - improve Go formatting with imports standardization and max line length to 120
* [2269](https://github.com/zeta-chain/node/pull/2269) - refactor MsgUpdateCrosschainFlags into MsgEnableCCTXFlags, MsgDisableCCTXFlags and MsgUpdateGasPriceIncreaseFlags


### Tests

Expand Down
4 changes: 3 additions & 1 deletion docs/cli/zetacored/zetacored_tx_observer.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,13 @@ zetacored tx observer [flags]
* [zetacored tx](zetacored_tx.md) - Transactions subcommands
* [zetacored tx observer add-blame-vote](zetacored_tx_observer_add-blame-vote.md) - Broadcast message add-blame-vote
* [zetacored tx observer add-observer](zetacored_tx_observer_add-observer.md) - Broadcast message add-observer
* [zetacored tx observer disable-cctx-flags](zetacored_tx_observer_disable-cctx-flags.md) - Disable inbound and outbound cross-chain flags
* [zetacored tx observer enable-cctx-flags](zetacored_tx_observer_enable-cctx-flags.md) - Enable inbound and outbound cross-chain flags
* [zetacored tx observer encode](zetacored_tx_observer_encode.md) - Encode a json string into hex
* [zetacored tx observer remove-chain-params](zetacored_tx_observer_remove-chain-params.md) - Broadcast message to remove chain params
* [zetacored tx observer reset-chain-nonces](zetacored_tx_observer_reset-chain-nonces.md) - Broadcast message to reset chain nonces
* [zetacored tx observer update-chain-params](zetacored_tx_observer_update-chain-params.md) - Broadcast message updateChainParams
* [zetacored tx observer update-crosschain-flags](zetacored_tx_observer_update-crosschain-flags.md) - Update crosschain flags
* [zetacored tx observer update-gas-price-increase-flags](zetacored_tx_observer_update-gas-price-increase-flags.md) - Update the gas price increase flags
* [zetacored tx observer update-keygen](zetacored_tx_observer_update-keygen.md) - command to update the keygen block via a group proposal
* [zetacored tx observer update-observer](zetacored_tx_observer_update-observer.md) - Broadcast message add-observer
* [zetacored tx observer vote-tss](zetacored_tx_observer_vote-tss.md) - Vote for a new TSS creation
Expand Down
53 changes: 53 additions & 0 deletions docs/cli/zetacored/zetacored_tx_observer_disable-cctx-flags.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# tx observer disable-cctx-flags

Disable inbound and outbound cross-chain flags

```
zetacored tx observer disable-cctx-flags [disable-inbound] [disable-outbound] [flags]
```

### Options

```
-a, --account-number uint The account number of the signing account (offline mode only)
--aux Generate aux signer data instead of sending a tx
-b, --broadcast-mode string Transaction broadcasting mode (sync|async)
--chain-id string The network chain ID
--dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it (when enabled, the local Keybase is not accessible)
--fee-granter string Fee granter grants fees for the transaction
--fee-payer string Fee payer pays fees for the transaction instead of deducting from the signer
--fees string Fees to pay along with transaction; eg: 10uatom
--from string Name or address of private key with which to sign
--gas string gas limit to set per-transaction; set to "auto" to calculate sufficient gas automatically. Note: "auto" option doesn't always report accurate results. Set a valid coin value to adjust the result. Can be used instead of "fees". (default 200000)
--gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1)
--gas-prices string Gas prices in decimal format to determine the transaction fee (e.g. 0.1uatom)
--generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase only accessed when providing a key name)
-h, --help help for disable-cctx-flags
--keyring-backend string Select keyring's backend (os|file|kwallet|pass|test|memory)
--keyring-dir string The client Keyring directory; if omitted, the default 'home' directory will be used
--ledger Use a connected Ledger device
--node string [host]:[port] to tendermint rpc interface for this chain
--note string Note to add a description to the transaction (previously --memo)
--offline Offline mode (does not allow any online functionality)
-o, --output string Output format (text|json)
-s, --sequence uint The sequence number of the signing account (offline mode only)
--sign-mode string Choose sign mode (direct|amino-json|direct-aux), this is an advanced feature
--timeout-height uint Set a block timeout height to prevent the tx from being committed past a certain height
--tip string Tip is the amount that is going to be transferred to the fee payer on the target chain. This flag is only valid when used with --aux, and is ignored if the target chain didn't enable the TipDecorator
-y, --yes Skip tx broadcasting prompt confirmation
```

### Options inherited from parent commands

```
--home string directory for config and data
--log_format string The logging format (json|plain)
--log_level string The logging level (trace|debug|info|warn|error|fatal|panic)
--log_no_color Disable colored logs
--trace print out full stack trace on errors
```

### SEE ALSO

* [zetacored tx observer](zetacored_tx_observer.md) - observer transactions subcommands

Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# tx observer update-crosschain-flags
# tx observer enable-cctx-flags

Update crosschain flags
Enable inbound and outbound cross-chain flags

```
zetacored tx observer update-crosschain-flags [is-inbound-enabled] [is-outbound-enabled] [flags]
zetacored tx observer enable-cctx-flags [enable-inbound] [enable-outbound] [flags]
```

### Options
Expand All @@ -22,7 +22,7 @@ zetacored tx observer update-crosschain-flags [is-inbound-enabled] [is-outbound-
--gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1)
--gas-prices string Gas prices in decimal format to determine the transaction fee (e.g. 0.1uatom)
--generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase only accessed when providing a key name)
-h, --help help for update-crosschain-flags
-h, --help help for enable-cctx-flags
--keyring-backend string Select keyring's backend (os|file|kwallet|pass|test|memory)
--keyring-dir string The client Keyring directory; if omitted, the default 'home' directory will be used
--ledger Use a connected Ledger device
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# tx observer update-gas-price-increase-flags

Update the gas price increase flags

```
zetacored tx observer update-gas-price-increase-flags [epochLength] [retryInterval] [gasPriceIncreasePercent] [gasPriceIncreaseMax] [maxPendingCctxs] [flags]
```

### Options

```
-a, --account-number uint The account number of the signing account (offline mode only)
--aux Generate aux signer data instead of sending a tx
-b, --broadcast-mode string Transaction broadcasting mode (sync|async)
--chain-id string The network chain ID
--dry-run ignore the --gas flag and perform a simulation of a transaction, but don't broadcast it (when enabled, the local Keybase is not accessible)
--fee-granter string Fee granter grants fees for the transaction
--fee-payer string Fee payer pays fees for the transaction instead of deducting from the signer
--fees string Fees to pay along with transaction; eg: 10uatom
--from string Name or address of private key with which to sign
--gas string gas limit to set per-transaction; set to "auto" to calculate sufficient gas automatically. Note: "auto" option doesn't always report accurate results. Set a valid coin value to adjust the result. Can be used instead of "fees". (default 200000)
--gas-adjustment float adjustment factor to be multiplied against the estimate returned by the tx simulation; if the gas limit is set manually this flag is ignored (default 1)
--gas-prices string Gas prices in decimal format to determine the transaction fee (e.g. 0.1uatom)
--generate-only Build an unsigned transaction and write it to STDOUT (when enabled, the local Keybase only accessed when providing a key name)
-h, --help help for update-gas-price-increase-flags
--keyring-backend string Select keyring's backend (os|file|kwallet|pass|test|memory)
--keyring-dir string The client Keyring directory; if omitted, the default 'home' directory will be used
--ledger Use a connected Ledger device
--node string [host]:[port] to tendermint rpc interface for this chain
--note string Note to add a description to the transaction (previously --memo)
--offline Offline mode (does not allow any online functionality)
-o, --output string Output format (text|json)
-s, --sequence uint The sequence number of the signing account (offline mode only)
--sign-mode string Choose sign mode (direct|amino-json|direct-aux), this is an advanced feature
--timeout-height uint Set a block timeout height to prevent the tx from being committed past a certain height
--tip string Tip is the amount that is going to be transferred to the fee payer on the target chain. This flag is only valid when used with --aux, and is ignored if the target chain didn't enable the TipDecorator
-y, --yes Skip tx broadcasting prompt confirmation
```

### Options inherited from parent commands

```
--home string directory for config and data
--log_format string The logging format (json|plain)
--log_level string The logging level (trace|debug|info|warn|error|fatal|panic)
--log_no_color Disable colored logs
--trace print out full stack trace on errors
```

### SEE ALSO

* [zetacored tx observer](zetacored_tx_observer.md) - observer transactions subcommands

6 changes: 5 additions & 1 deletion docs/openapi/openapi.swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -57712,13 +57712,17 @@ definitions:
type: object
observerMsgAddObserverResponse:
type: object
observerMsgDisableCCTXFlagsResponse:
type: object
observerMsgEnableCCTXFlagsResponse:
type: object
observerMsgRemoveChainParamsResponse:
type: object
observerMsgResetChainNoncesResponse:
type: object
observerMsgUpdateChainParamsResponse:
type: object
observerMsgUpdateCrosschainFlagsResponse:
observerMsgUpdateGasPriceIncreaseFlagsResponse:
type: object
observerMsgUpdateKeygenResponse:
type: object
Expand Down
4 changes: 4 additions & 0 deletions docs/releases/v17_breaking_changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
* `MsgUpdateVerificationFlags` has been removed, and replaced with `MsgEnableHeaderVerification` and `MsgDisableHeaderVerification` messages.
* `MsgEnableHeaderVerification` message enables block header verification for a list of chains and can be triggered via `PolicyType_groupOperational`
* `MsgDisableHeaderVerification` message disables block header verification for a list of chains and can be triggered via `PolicyType_emergency`
* `MsgUpdateCrosschainFlags` has been removed,and replaced with `MsgEnableCCTXFlags`, `MsgDisableCCTXFlags` and `MsgUpdateGasPriceIncreaseFlags` messages.
* `MsgEnableCCTXFlags` message enables either the IsInboundEnabled flag, or the IsOutboundEnabled flag or both `PolicyType_groupOperational`
* `MsgDisableCCTXFlags` message disables either the IsInboundEnabled flag, or the IsOutboundEnabled flag or both `PolicyType_emergency`
* `MsgUpdateGasPriceIncreaseFlags` message updates the gas price increase flags and can be triggered via `PolicyType_groupOperational`

### `BallotMaturityBlocks` moved to `emissions` module

Expand Down
54 changes: 38 additions & 16 deletions docs/spec/observer/messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,22 +63,6 @@ message MsgAddBlameVote {
}
```

## MsgUpdateCrosschainFlags

UpdateCrosschainFlags updates the crosschain related flags.

Aurthorized: admin policy group 1 (except enabling/disabled
inbounds/outbounds and gas price increase), admin policy group 2 (all).

```proto
message MsgUpdateCrosschainFlags {
string creator = 1;
bool isInboundEnabled = 3;
bool isOutboundEnabled = 4;
GasPriceIncreaseFlags gasPriceIncreaseFlags = 5;
}
```

## MsgUpdateKeygen

UpdateKeygen updates the block height of the keygen and sets the status to
Expand Down Expand Up @@ -142,3 +126,41 @@ message MsgVoteTSS {
}
```

## MsgEnableCCTXFlags

EnableCCTXFlags enables the IsInboundEnabled and IsOutboundEnabled flags.These flags control the creation of inbounds and outbounds.
The flags are enabled by the policy account with the groupOperational policy type.

```proto
message MsgEnableCCTXFlags {
string creator = 1;
bool enableInbound = 2;
bool enableOutbound = 3;
}
```

## MsgDisableCCTXFlags

DisableCCTXFlags disables the IsInboundEnabled and IsOutboundEnabled flags. These flags control the creation of inbounds and outbounds.
The flags are disabled by the policy account with the groupEmergency policy type.

```proto
message MsgDisableCCTXFlags {
string creator = 1;
bool disableInbound = 2;
bool disableOutbound = 3;
}
```

## MsgUpdateGasPriceIncreaseFlags

UpdateGasPriceIncreaseFlags updates the GasPriceIncreaseFlags. These flags control the increase of gas prices.
The flags are updated by the policy account with the groupOperational policy type.

```proto
message MsgUpdateGasPriceIncreaseFlags {
string creator = 1;
GasPriceIncreaseFlags gasPriceIncreaseFlags = 2;
}
```

15 changes: 12 additions & 3 deletions proto/zetachain/zetacore/observer/events.proto
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,19 @@ message EventNewObserverAdded {
uint64 observer_last_block_count = 5;
}

message EventCrosschainFlagsUpdated {
message EventCCTXFlagsDisabled {
string msg_type_url = 1;
bool isInboundEnabled = 2;
bool isOutboundEnabled = 3;
GasPriceIncreaseFlags gasPriceIncreaseFlags = 4;
string signer = 5;
}

message EventCCTXFlagsEnabled {
string msg_type_url = 1;
bool isInboundEnabled = 2;
bool isOutboundEnabled = 3;
}

message EventGasPriceIncreaseFlagsUpdated {
string msg_type_url = 1;
GasPriceIncreaseFlags gasPriceIncreaseFlags = 2;
}
40 changes: 29 additions & 11 deletions proto/zetachain/zetacore/observer/tx.proto
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,16 @@ service Msg {
rpc RemoveChainParams(MsgRemoveChainParams)
returns (MsgRemoveChainParamsResponse);
rpc AddBlameVote(MsgAddBlameVote) returns (MsgAddBlameVoteResponse);
rpc UpdateCrosschainFlags(MsgUpdateCrosschainFlags)
returns (MsgUpdateCrosschainFlagsResponse);
rpc UpdateKeygen(MsgUpdateKeygen) returns (MsgUpdateKeygenResponse);
rpc VoteBlockHeader(MsgVoteBlockHeader) returns (MsgVoteBlockHeaderResponse);
rpc ResetChainNonces(MsgResetChainNonces)
returns (MsgResetChainNoncesResponse);
rpc VoteTSS(MsgVoteTSS) returns (MsgVoteTSSResponse);
rpc EnableCCTXFlags(MsgEnableCCTXFlags) returns (MsgEnableCCTXFlagsResponse);
rpc DisableCCTXFlags(MsgDisableCCTXFlags)
returns (MsgDisableCCTXFlagsResponse);
rpc UpdateGasPriceIncreaseFlags(MsgUpdateGasPriceIncreaseFlags)
returns (MsgUpdateGasPriceIncreaseFlagsResponse);
}

message MsgUpdateObserver {
Expand Down Expand Up @@ -83,15 +86,6 @@ message MsgAddBlameVote {

message MsgAddBlameVoteResponse {}

message MsgUpdateCrosschainFlags {
string creator = 1;
bool isInboundEnabled = 3;
bool isOutboundEnabled = 4;
GasPriceIncreaseFlags gasPriceIncreaseFlags = 5;
}

message MsgUpdateCrosschainFlagsResponse {}

message MsgUpdateKeygen {
string creator = 1;
int64 block = 2;
Expand Down Expand Up @@ -120,3 +114,27 @@ message MsgVoteTSSResponse {
bool vote_finalized = 2;
bool keygen_success = 3;
}

message MsgEnableCCTXFlags {
string creator = 1;
bool enableInbound = 2;
bool enableOutbound = 3;
}

message MsgEnableCCTXFlagsResponse {}

message MsgDisableCCTXFlags {
string creator = 1;
bool disableInbound = 2;
bool disableOutbound = 3;
}

message MsgDisableCCTXFlagsResponse {}

message MsgUpdateGasPriceIncreaseFlags {
string creator = 1;
GasPriceIncreaseFlags gasPriceIncreaseFlags = 2
[ (gogoproto.nullable) = false ];
}

message MsgUpdateGasPriceIncreaseFlagsResponse {}
9 changes: 9 additions & 0 deletions testutil/sample/observer.go
Original file line number Diff line number Diff line change
Expand Up @@ -255,3 +255,12 @@ func NonceToCCTX(t *testing.T, seed string) types.NonceToCctx {
Tss: Tss().TssPubkey,
}
}

func GasPriceIncreaseFlags() types.GasPriceIncreaseFlags {
return types.GasPriceIncreaseFlags{
EpochLength: 1,
RetryInterval: 1,
GasPriceIncreasePercent: 1,
MaxPendingCctxs: 100,
}
}
Loading
Loading