Skip to content

docs: harmonise paused event payload documentation across event_schema.rs and lib.rs #43

Description

@Icahbod

The paused event is described in apexchainx_calculator/src/lib.rs and event_schema.rs as having a (true,) payload, while the on-chain PauseInfo struct contains reason, paused_at, and paused_by. The discrepancy makes it unclear whether the reason string is part of the emitted event payload (good for forensics) or only available via get_pause_info(). Align the documentation in both files — explicitly state whether the paused payload is (true,) only (the contract-level signal that mutating operations are now rejected), or whether the full PauseInfo struct is serialised into the event payload alongside (true,). Update event_schema.rs to match the truth and add a test asserting that the event payload matches the doc-comment claim.

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial CampaignCampaign: Official CampaigndocumentationImprovements or additions to documentation

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions