package althea.nativedex.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Msg defines the Msg service.

(no methods)

Query defines the gRPC querier service.

• rpc Params (QueryParamsRequest, QueryParamsResponse)

  query.proto:14

  Parameters queries the parameters of the module.

  message QueryParamsRequest

  query.proto:20

  QueryParamsRequest is request type for the Query/Params RPC method.

  (message has no fields)

  message QueryParamsResponse

  query.proto:23

  QueryParamsResponse is response type for the Query/Params RPC method.

  • optional Params params = 1

    params holds all the parameters of this module.

Used in: AuthorityTransferProposal

• string auth_address = 1

  the address to set `authority_` to

AuthorityTransferProposal will change the `authority_` address, which can be used to upgrade or remove the CrocPolicy contract (and therefore this module must be upgraded to work with the replacement, and configured as the new authority) If passes, calls CrocPolicy.treasuryResolution(CrocSwapDex, 3, <ABI Encoded Bytes(20, <auth_address>)>) BE VERY CAREFUL EXECUTING THIS PROPOSAL, AS IT CAN COMPLETELY DISABLE THE NATIVEDEX MODULE AND REMOVE STAKER AUTHORITY OVER THE DEX CONTRACT

• string title = 1

• string description = 2

• optional AuthorityTransferMetadata metadata = 3

• bool in_safe_mode = 4

  must be true if the DEX is in safe mode, false otherwise

Used in: CollectTreasuryProposal

• string token_address = 1

  the ERC20 address to collect into the `treasury_` account, (0x0 for the native token)

CollectTreasuryProposal will pay out protocol fees to the registered (and timelocked) `treasury_` account If passes, calls CrocPolicy.treasuryResolution(CrocSwapDex, 3, <ABI Encoded Bytes(40, <token_address>)>) Note that by default the protocol fees will be set to zero, see the governance history or use CrocQuery with a pool to determine the current protocol take

• string title = 1

• string description = 2

• optional CollectTreasuryMetadata metadata = 3

• bool in_safe_mode = 4

  must be true if the DEX is in safe mode, false otherwise

Used in: ExecuteContractProposal

• string contract_address = 1

  The contract address to call (must be whitelisted in module params)

• string data = 2

  Hex-encoded calldata to send to the contract

ExecuteContractProposal will execute an arbitrary contract call from the nativedex module account. This allows governance to manage contracts owned by the nativedex module, but is restricted to whitelisted contract addresses to prevent abuse. If passes, calls the specified contract with the provided data from the nativedex module account. BE VERY CAREFUL EXECUTING THIS PROPOSAL, AS IT CAN MODIFY CONTRACTS OWNED BY THE NATIVEDEX MODULE

• string title = 1

• string description = 2

• optional ExecuteContractMetadata metadata = 3

GenesisState defines the nativedex module's genesis state.

• optional Params params = 1

Used in: HotPathOpenProposal

• bool open = 1

  If true, users can call swap directly on the dex contract. If false, they must call CrocSwapDex.userCmd(1, <ABI Encoded Args>)

HotPathOpenProposal will change the `hotPathOpen_` flag, which controls if users are able to call swap directly on the dex contract The primary purpose of this seems to be enabling upgradeability of the HotProxy contract, which would require users to switch to calling CrocSwapDex.userCmd(1, <ABI Encoded Args>) instead of CrocSwapDex.swap(<args>) so that they call the new code. If passes, calls CrocPolicy.treasuryResolution(CrocSwapDex, 3, <ABI Encoded Bytes(22, <open>)>) BE VERY CAREFUL EXECUTING THIS PROPOSAL, AS IT CAN BREAK INFLEXIBLE DEX USER INTERFACES

• string title = 1

• string description = 2

• optional HotPathOpenMetadata metadata = 3

• bool in_safe_mode = 4

  must be true if the DEX is in safe mode, false otherwise

Used in: OpsProposal

• uint64 callpath = 1

  The callpath index to use, see solidity-dex/contracts/mixins/StorageLayout.sol for the default values

• bytes cmd_args = 2

  The ABI encoded bytes to pass to the opsResolution() call

OpsProposal will execute a non-sudo `protocolCmd()` call on the DEX via CrocPolicy. If passes, calls CrocPolicy.opsResolution (CrocSwapDex, <callpath>, <ABI Encoded Bytes(<cmd args>)>) This proposal enables nativedex governance to perform everyday Ops functions on the DEX, and so the Ops or Emergency addresses could override any decisions made by this proposal.

• string title = 1

• string description = 2

• optional OpsMetadata metadata = 3

Params defines the parameters for the module.

Used in: GenesisState, QueryParamsResponse

• string verified_native_dex_address = 1

• string verified_croc_policy_address = 2

• repeated string whitelisted_contract_addresses = 3

  Addresses that can be called via ExecuteContractProposal

Used in: SetSafeModeProposal

• bool lock_dex = 1

  If true, the DEX will be disabled

SetSafeModeProposal will lock down the DEX for emergency changes. This can also be used by the emergency multisig to halt the DEX more quickly. When the DEX is in safe mode only a UpgradeProxy, CollectTreasury, SetTreasury, AuthorityTransfer, HotPathOpen, or SetSafeMode Proposal can be executed, and these proposals can only be executed under the SafeMode or Boot Proxy callpaths. If passes, calls CrocPolicy.treasuryResolution(CrocSwapDex, 3, <ABI Encoded Bytes(23, <lock_dex>)>) BE VERY CAREFUL EXECUTING THIS PROPOSAL, IT SHOULD ONLY BE USED TO DISABLE THE DEX OR RECOVER FROM DISABLES

• string title = 1

• string description = 2

• optional SetSafeModeMetadata metadata = 3

• bool in_safe_mode = 4

  must be true if the DEX is already in safe mode, false otherwise

Used in: SetTreasuryProposal

• string treasury_address = 1

  the address to set `treasury_` to

SetTreasuryProposal will change the `treasury_` address the treasury_ address will be restricted from receiving protocol fees for a period of time (stored in treasuryStartTime_) If passes, calls CrocPolicy.treasuryResolution(CrocSwapDex, 3, <ABI Encoded Bytes(41, <treasury_address>)>) Note that by default the protocol fees will be set to zero, see the governance history or use CrocQuery with a pool to determine the current protocol take

• string title = 1

• string description = 2

• optional SetTreasuryMetadata metadata = 3

• bool in_safe_mode = 4

  must be true if the DEX is in safe mode, false otherwise

Used in: TransferGovernanceProposal

• string ops = 1

  The address to use for the Ops governance role, the least privileged role

• string emergency = 2

  The address to use for the Emergency governance role, which can halt the DEX or perform Ops functions

TransferGovernanceProposal will update the governance role addresses on CrocPolicy. If passes, calls CrocPolicy.transferGovernance(<ops>, <nativedex module address>, <emergency>) BE VERY CAREFUL EXECUTING THIS PROPOSAL, THE OPS AND EMERGENCY ADDRESSES SHOULD BE CAREFULLY CHOSEN MULTISIGS

• string title = 1

• string description = 2

• optional TransferGovernanceMetadata metadata = 3

Used in: UpgradeProxyProposal

• string callpath_address = 1

  the address of the contract to install

• uint64 callpath_index = 2

  the callpath index to write to, see solidity-dex/contracts/mixins/StorageLayout.sol for the default values

UpgradeProxyProposal will replace one of the nativedex callpath contracts (or install a new one) if passes, calls CrocPolicy.treasuryResolution(CrocSwapDex, 0, <ABI Encoded Bytes(21, <callpath_address>, <callpath_index>)>) BE VERY CAREFUL EXECUTING THIS PROPOSAL, AS IT CAN COMPLETELY BREAK THE DEX CONTRACT

• string title = 1

• string description = 2

• optional UpgradeProxyMetadata metadata = 3