Skip to content

docs: document staking position data model and stake ID assignment#544

Open
Godfrey-Delight wants to merge 1 commit into
accesslayerorg:mainfrom
Godfrey-Delight:docs/staking-position-data-model
Open

docs: document staking position data model and stake ID assignment#544
Godfrey-Delight wants to merge 1 commit into
accesslayerorg:mainfrom
Godfrey-Delight:docs/staking-position-data-model

Conversation

@Godfrey-Delight

Copy link
Copy Markdown

Summary

Testing

  • cargo fmt --all -- --check
  • cargo clippy --workspace --all-targets -- -D warnings
  • cargo test --workspace

Checklist

  • Linked issue or backlog item
  • Added or updated creator-keys unit/integration tests for every changed contract behavior, including failure paths for new or reachable ContractError variants
  • Ran cargo fmt --all -- --check, cargo clippy --workspace --all-targets -- -D warnings, and cargo test --workspace, or explained exactly why a command was not run
  • Reviewed persistent storage changes against docs/storage-key-invariants.md; any storage layout change includes a migration/backward-compatibility note
  • Confirmed event names, topic order, payload field order, and field meanings remain compatible with docs/contract-event-conventions.md, or documented the breaking change and versioning plan
  • Updated docs for any changed public contract interface, read-only method, event schema, storage behavior, fee logic, or deployment workflow
  • Scope stays limited to one contract concern and does not include unrelated formatting, lockfile, generated artifact, or dependency changes

Adds docs/key-staking-storage.md documenting the StakePosition data model, stake ID assignment, and storage key structure for the key staking feature, so contributors implementing or integrating with it have a single reference instead of reverse-engineering it from the contract code.
Closed accesslayerorg#540
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.

Add docs for staking position data model and how stake IDs are assigned

1 participant