Skip to content

EVENTS.md omits roughly ten events actually emitted by project_registry #330

Description

@abayomicornelius

Area

Project Registry / Documentation

Complexity

Easy

File(s)

EVENTS.md vs. project_registry/src/events.rs

Problem

EVENTS.md's Project Registry section documents 8 events. src/events.rs actually publishes at least these additional events with no EVENTS.md entry: CollateralLiquidated, RateUpdated, WhitelistSet, ProjectCertified, ProposalCreated, VoteCast, ProposalExecuted, CreditQualityUpdated, ReputationUpdated, RegistryPaused/RegistryUnpaused, EmergencyAdminChanged, WhitelisterChanged, OwnershipTransferred. Off-chain indexers built strictly from EVENTS.md will silently miss all governance, multisig, and admin-role-change activity. Separately, EVENTS.md documents project_created's data field as creator: Address while the actual struct field is named owner.

Scope

In:

  • Add entries for each missing event (topics, data shape, emitting function) to EVENTS.md; fix the creator/owner field-name mismatch.

Out:

  • Changing event schemas/topics themselves.

Acceptance Criteria

  • Every #[contractevent] struct and every env.events().publish(...) call site in events.rs has a corresponding EVENTS.md entry
  • Field names in EVENTS.md match the actual struct field names

Metadata

Metadata

Assignees

No one assigned

    Labels

    Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions