Standardise the symbol_short event topic naming convention across all emitters

[mikewheeleer]

Refactor event topics into named constants with a consistent scheme

Description

Event topics in contracts/escrow/src/lib.rs are scattered inline symbol_short! literals — "usage", "settled", "price_set", "price_rm", "paused", "svc_reg", "owner_chg", "meta_clr" — with no central registry. The abbreviation style is inconsistent (price_rm vs price_set, meta_clr vs owner_chg), some are truncated to fit the 9-char limit in ad-hoc ways, and a typo in one literal would silently emit an undiscoverable topic. This issue centralises every topic into named constants so the scheme is consistent, auditable, and reused.

Requirements and context

• Repository scope: Agentpay-Org/Agentpay-contracts only.
• Define a module-level set of topic constants (e.g. const TOPIC_USAGE: Symbol = symbol_short!("usage");) for every emitted event and route all env.events().publish calls through them.
• This is a pure refactor — the emitted topics and payloads must be byte-for-byte identical to today so existing indexers are unaffected; only the source representation changes.
• Add a comment block documenting the topic scheme and the 9-char symbol_short! constraint so future events follow it.
• The existing test suite must pass unchanged; add a regression test asserting a representative event still publishes the exact same topic.

Suggested execution

• Fork the repo and create a branch
• git checkout -b refactor/contracts-event-topic-constants
• Implement changes
  • Write code in: contracts/escrow/src/lib.rs — topic constants + replace inline literals.
  • Write comprehensive tests in: contracts/escrow/src/test.rs — existing tests pass; assert one event's topic is unchanged after the refactor.
  • Add documentation: note the topic-constant convention in a module comment.
  • Include NatSpec-style doc comments (///) on the constants block.
  • Validate security: no topic or payload changed; no silent typo introduced.
• Test and commit

Test and commit

• Run cargo fmt --all -- --check, cargo build, and cargo test.
• Cover edge cases: every existing event topic matches its prior literal exactly.
• Include the full cargo test output and a short security notes section in the PR description.

Example commit message

refactor: centralise event topics into named symbol constants

Guidelines

• Minimum 95 percent test coverage for impacted modules.
• Clear, reviewer-focused documentation.
• Timeframe: 96 hours.

Community & contribution rewards

• 💬 Join the AgentPay community on Discord for questions, reviews, and faster merges: https://discord.gg/eXvRKkgcv
• ⭐ This is a GrantFox OSS / Official Campaign task and may be rewarded. When your PR is merged you'll be prompted to rate the project — if this issue and the maintainers helped you ship, we'd be grateful for a 5-star rating. Clear questions in Discord and tidy, well-tested PRs are the fastest path to a merge and a reward.

[gloskull]

Hello, I have 4 years of experience delivering solutions for projects like this, covering backend, frontend, and smart contract development. After carefully reviewing your requirements, I have a clear understanding of the task and am confident in my ability to deliver a clean, efficient, and thoroughly tested solution on time. I prioritize code quality, maintainability, and industry best practices throughout the development process.
My PR will be submitted in under 10hours.

[GBOYEE]

Hi maintainers! Standardize symbol_short event topic naming. Plan: ensure all event topics for a given contract use a consistent symbol_short naming convention, rename any that deviate, add a test asserting the expected event topic format. Clean consistency fix. Ready.

[GBOYEE]

Hey! Event topics in contracts/escrow/src/lib.rs are scattered inline symbol_short! literals — 'usage', 'settled', 'price_set', 'price_rm', 'paused', 'svc_reg', 'owner_chg', 'meta_clr' — no central registry, inconsistent abbreviations (price_rm vs price_set, meta_clr vs owner_chg), and a typo would silently emit a bad topic. Fix: define a TOPICS struct or const block at the top of the contract — const USAGE: Symbol = symbol_short!(usage); etc — then replace every inline literal with the named constant. Consistent naming, auditable, typo-proof. Test that each event still emits the expected topic.