Package halt provides functionality for managing protocol halt levels and operations.
Emergency pause mechanism for protocol safety.
Halt system provides granular control over protocol operations for emergency response and beta safety mode. The initial halt level is NONE; an authorized caller must explicitly select another level.
SetHaltLevelSets system-wide halt level.
SetOperationStatusControls individual operation types.
IsHaltedChecks if operation is halted.
1// Set system to safe mode explicitly when needed
2SetHaltLevel(cross(cur), HaltLevelSafeMode)
3
4// Enable emergency mode
5SetHaltLevel(cross(cur), HaltLevelEmergency)
6
7// Halt specific operation
8SetOperationStatus(cross(cur), OpTypeRouter, true)
9
10// Resume specific operation
11SetOperationStatus(cross(cur), OpTypeRouter, false)
12
13// Check before operation
14halted, err := IsHalted(OpTypeWithdraw)
15if err != nil {
16 panic(err)
17}
18if halted {
19 panic("withdrawals halted")
20}
NONE; SAFE_MODE is not enabled by defaultPackage halt provides functionality for managing protocol halt levels and operations.
1const (
2 HaltLevelNone HaltLevel = "NONE" // All operations enabled.
3 HaltLevelSafeMode HaltLevel = "SAFE_MODE" // All operations enabled except withdrawals.
4 HaltLevelEmergency HaltLevel = "EMERGENCY" // Only governance and withdrawal operations enabled.
5 HaltLevelComplete HaltLevel = "COMPLETE" // All operations disabled.
6)Halt levels define different states of system operation restriction.
1const (
2 OpTypePool OpType = "pool"
3 OpTypePosition OpType = "position"
4 OpTypeProtocolFee OpType = "protocol_fee"
5 OpTypeRouter OpType = "router"
6 OpTypeStaker OpType = "staker"
7 OpTypeLaunchpad OpType = "launchpad"
8 OpTypeGovernance OpType = "governance"
9 OpTypeGovStaker OpType = "gov_staker"
10 OpTypeXGns OpType = "xgns"
11 OpTypeCommunityPool OpType = "community_pool"
12 OpTypeEmission OpType = "emission"
13 OpTypeWithdraw OpType = "withdraw"
14)Operation types representing individual contracts.
AssertIsNotHaltedCommunityPool panics if community pool operations are halted.
AssertIsNotHaltedEmission panics if emission operations are halted.
AssertIsNotHaltedGovStaker panics if governance staker operations are halted.
AssertIsNotHaltedGovernance panics if governance operations are halted.
AssertIsNotHaltedLaunchpad panics if launchpad operations are halted.
AssertIsNotHaltedOperation panics if the specified operation type is halted. Panics with error details including operation type name.
Parameters:
AssertIsNotHaltedPool panics if pool operations are halted.
AssertIsNotHaltedPosition panics if position operations are halted.
AssertIsNotHaltedProtocolFee panics if protocol fee operations are halted.
AssertIsNotHaltedRouter panics if router operations are halted.
AssertIsNotHaltedStaker panics if staker operations are halted.
AssertIsNotHaltedWithdraw panics if withdraw operations are halted.
AssertIsNotHaltedXGns panics if xGNS operations are halted.
GetHaltConfigJson returns the halt configuration as a JSON string.
Returns:
IsHalted returns true if any of the specified operation types are halted. Returns error if any operation type is invalid.
Parameters:
Returns:
IsHaltedCommunityPool returns true if community pool operations are halted.
Returns:
IsHaltedEmission returns true if emission operations are halted.
Returns:
IsHaltedGovStaker returns true if governance staker operations are halted.
Returns:
IsHaltedGovernance returns true if governance operations are halted.
Returns:
IsHaltedLaunchpad returns true if launchpad operations are halted.
Returns:
IsHaltedPool returns true if pool operations are halted.
Returns:
IsHaltedPosition returns true if position operations are halted.
Returns:
IsHaltedProtocolFee returns true if protocol fee operations are halted.
Returns:
IsHaltedRouter returns true if router operations are halted.
Returns:
IsHaltedStaker returns true if staker operations are halted.
Returns:
IsHaltedWithdraw returns true if withdraw operations are halted.
Returns:
IsHaltedXGns returns true if xGNS operations are halted.
Returns:
Render returns the current halt status for every operation.
SetHaltLevel sets the global halt level.
Parameters:
Only callable by admin or governance.
SetOperationStatus sets the halt status for a specific operation.
Parameters:
Only callable by admin or governance.
GetHaltConfig returns a copy of the current halt configuration.
Returns:
OpTypes returns all operation types currently supported by the halt configuration.
Returns:
HaltConfig stores halt state for each operation type.
Clone creates a deep copy of the halt configuration and returns it.
Returns:
IsHalted returns true if the specified operation is halted, false otherwise. Returns false if operation type is not found in configuration.
Parameters:
Returns:
HaltLevel represents current system halt state.
Description returns a human-readable description of the halt level.
Returns:
IsValid returns true if the halt level is valid.
Returns:
String returns the string representation of the halt level.
Returns:
IsOperationHalted returns the halt state for an operation type.
Parameters:
Returns:
ToConfig converts the HaltStateManager to an independent HaltConfig copy.
Returns:
OpType represents operation types that can be controlled independently.
IsValid returns true if the operation type is valid.
Returns:
String returns the string representation of the operation type.
Returns: