Skip to content

[Docs] Replace README security/address placeholders with real process #37

@Jayrodri088

Description

@Jayrodri088

Complexity / points: Medium (150 points) - maintainer label: points-150-medium

PR must include:

  • Closes #37 in the PR description
  • Tests added or updated where behavior changes
  • Docs updated if public API, lifecycle, or deploy steps change
  • No unwrap() in production Soroban contract paths (project convention)
  • cargo test passes locally; match CI (cargo fmt, cargo clippy -D warnings) when touching Rust

Problem

Readme.md contains multiple placeholders that reduce trust and make onboarding harder:

  • Γò¼├┤Γö£ΓòóΓö¼├║╬ô├╢┬ú╬ô├╢├⌐╬ô├▓┬╝Γö£Γöñ╬ô├╢┬ú╬ô├«├ë╬ô├╢┬╝╬ô├▓┬ÑΓò¼├┤Γö£Γòó╬ô├▓┬Ñ╬ô├╢┬ú╬ô├╢├▒Smart contracts audited by [Audit Firm] (pending)Γò¼├┤Γö£ΓòóΓö¼├║╬ô├╢┬ú╬ô├╢├⌐╬ô├▓┬╝Γö£Γöñ╬ô├╢┬ú╬ô├«├ë╬ô├╢┬╝╬ô├▓┬Ñ^]
  • Γò¼├┤Γö£ΓòóΓö¼├║╬ô├╢┬ú╬ô├╢├⌐╬ô├▓┬╝Γö£Γöñ╬ô├╢┬ú╬ô├«├ë╬ô├╢┬╝╬ô├▓┬ÑΓò¼├┤Γö£Γòó╬ô├▓┬Ñ╬ô├╢┬ú╬ô├╢├▒Bug bounty program: [Link] (coming soon)Γò¼├┤Γö£ΓòóΓö¼├║╬ô├╢┬ú╬ô├╢├⌐╬ô├▓┬╝Γö£Γöñ╬ô├╢┬ú╬ô├«├ë╬ô├╢┬╝╬ô├▓┬Ñ^]
  • Contract IDs are hardcoded as CXXXXXXXX... placeholders

As the project transitions from prototype to completion, these should be handled either by:

  • providing real information, or
  • replacing placeholders with clear instructions on how to obtain current deployment data.

Proposed change

Update README security + contract address sections:

  • Remove or reword Γò¼├┤Γö£ΓòóΓö¼├║╬ô├╢┬ú╬ô├╢├⌐╬ô├▓┬╝Γö£Γöñ╬ô├╢┬ú╬ô├«├ë╬ô├╢┬╝╬ô├▓┬ÑΓò¼├┤Γö£Γòó╬ô├▓┬Ñ╬ô├╢┬ú╬ô├╢├▒pending/coming soonΓò¼├┤Γö£ΓòóΓö¼├║╬ô├╢┬ú╬ô├╢├⌐╬ô├▓┬╝Γö£Γöñ╬ô├╢┬ú╬ô├«├ë╬ô├╢┬╝╬ô├▓┬Ñ^] placeholders once decisions are made
  • Replace testnet/mainnet contract ID placeholders with a reference to the new deployment manifest (Issue 30) and/or scripts that print IDs after deploy.

Acceptance criteria

  • README no longer shows CXXXXXXXXXXXXXXXX... hardcoded IDs without explanation
  • Security placeholders are either filled with real links or rewritten as Γò¼├┤Γö£ΓòóΓö¼├║╬ô├╢┬ú╬ô├╢├⌐╬ô├▓┬╝Γö£Γöñ╬ô├╢┬ú╬ô├«├ë╬ô├╢┬╝╬ô├▓┬ÑΓò¼├┤Γö£Γòó╬ô├▓┬Ñ╬ô├╢┬ú╬ô├╢├▒not available yetΓò¼├┤Γö£ΓòóΓö¼├║╬ô├╢┬ú╬ô├╢├⌐╬ô├▓┬╝Γö£Γöñ╬ô├╢┬ú╬ô├«├ë╬ô├╢┬╝╬ô├▓┬Ñ^] with a clear timeline or link to roadmap
  • README points to deployment manifest and/or script output
  • Documentation updates are consistent with .env.example and the deployment scripts from Issue 11

Dependencies

  • Depends on Issue 30 (deployment manifests)
  • Depends on Issue 11 (deployment scripts)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions