Skip to content

Vault: read-only API completeness (get_meta, balance, get_max_deduct, etc.) #112

@greatest0fallt1me

Description

@greatest0fallt1me

Description

Ensure documented view functions exist, return stable types for SDK consumers, and fail consistently if uninitialized.

Requirements and context

  • Views must not mutate storage.
  • Align naming with README and backend expectations.

Suggested execution

  • Fork the repo and create a branch: git checkout -b chore/vault-read-api
  • Implement changes in the Callora-Contracts Soroban workspace (contracts/*/src/).
  • Run cargo fmt, cargo clippy --all-targets --all-features -- -D warnings, and cargo test from the workspace root.
  • For WASM release builds: cargo build --target wasm32-unknown-unknown --release -p callora-vault (adjust -p if the crate name differs).

Deliverables

  • lib.rs + test.rs per view.
  • README "What's included" sync.

Test and commit

  • Run tests and ./scripts/coverage.sh (or cargo tarpaulin per tarpaulin.toml).
  • Cover edge cases; include summarized test output and brief security notes in the PR description.

Example commit message

docs(vault): align read-only API surface

Guidelines

  • Minimum 95% line coverage for touched crates (workspace policy).
  • Clear documentation (Rust /// on public items where applicable; repo markdown as needed).
  • Timeframe: 96 hours from assignment unless agreed otherwise.

Metadata

Metadata

Assignees

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions