Skip to content

docs: document vault lifecycle event schema - #366

Merged
El-swaggerito merged 1 commit into
Axionvera:mainfrom
edochieblessing09-max:docs/vault-event-schema
Aug 25, 2026
Merged

docs: document vault lifecycle event schema#366
El-swaggerito merged 1 commit into
Axionvera:mainfrom
edochieblessing09-max:docs/vault-event-schema

Conversation

@edochieblessing09-max

Copy link
Copy Markdown
Contributor

Closes #354

Description

This PR resolves the issue to document the vault lifecycle event schema used in the axionvera-network smart contract. The documentation is necessary before SDK and dashboard indexing work can rely on contract events.

Changes Included

  • Added docs/vault-events.md detailing the event topics, payload structures, and when each event is emitted.
  • Included payload examples for init, deposit, withdraw, and claim events.
  • Documented expected behavior for failed-call events.
  • Added a section on SDK indexing expectations (filtering, type handling, event ordering, and failures).

No smart contract behavior was modified in this PR.

Acceptance Criteria Met

  • Init event schema is documented.
  • Deposit event schema is documented.
  • Withdraw event schema is documented.
  • Claim event schema is documented.
  • Failed-call event behavior is documented.
  • SDK indexing expectations are included.

@El-swaggerito
El-swaggerito merged commit 58f862b into Axionvera:main Aug 25, 2026
2 checks passed
@grantfox-oss grantfox-oss Bot mentioned this pull request Aug 25, 2026
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document vault event schema

2 participants