Skip to content

Add IPFS invoice metadata pinning with CID verification #848

Closed

Description

@Kingsman-99

Overview

Allow invoice creators to attach structured metadata stored on IPFS. The CID is stored in the contract memo field. The SDK should pin metadata to IPFS, verify the CID matches the content, and enrich invoice reads with the resolved metadata.

Requirements

  • pinInvoiceMetadata(metadata: InvoiceMetadata): Promise — pins JSON to IPFS, returns CID
  • InvoiceMetadata { title, description, lineItems: LineItem[], attachmentCIDs: string[] }
  • verifyCID(cid, content): Promise — fetches and checks content hash
  • enrichInvoice(invoiceId): Promise — merges on-chain + IPFS data
  • Support IPFS HTTP gateway and kubo RPC backends (configurable)
  • Tests with mock IPFS server; CID mismatch handled gracefully

Acceptance Criteria

  • Metadata pinned and CID returned
  • CID verification detects tampering
  • enrichInvoice merges data correctly
  • Both gateway and kubo backends work
  • npm test passes with zero failures
  • TypeScript compiles with zero errors
  • ESLint passes with zero errors

Definition of Done

All CI checks must pass before the PR is reviewed.

Activity

  1. Alimzy commented on Sep 24, 2026

    @Alimzy

    @Alimzy has applied to work on this issue as part of the Stellar Wave Program's 9th wave.

    Hi! I'd like to work on this issue.

    I'm a software engineer with hands-on experience in testing, debugging, and building reliable features across the stack. I'm confident I can take this on and deliver a solid, well-tested solution that follows the project's existing conventions.

    I'll make sure to cover the core functionality as well as relevant edge cases to keep things reliable and regression-resistant.

    Let me know if I can get started, and I'll provide updates as I progress.

    ℹ️ Repo Maintainers: To accept this application, review their application or assign @Alimzy to this issue.

  2. Cherry-Olaa commented on Sep 24, 2026

    @Cherry-Olaa

    @Cherry-Olaa has applied to work on this issue as part of the Stellar Wave Program's 9th wave.

    Please Can I be assign this task I will love to work on it
    I understand what’s stated and how to resolve it

    ℹ️ Repo Maintainers: To accept this application, review their application or assign @Cherry-Olaa to this issue.

  3. maztah1 commented on Sep 24, 2026

    @maztah1
    Contributor

    @maztah1 has applied to work on this issue as part of the Stellar Wave Program's 9th wave.

    can i work on this issue please

    ℹ️ Repo Maintainers: To accept this application, review their application or assign @maztah1 to this issue.

  4. drips-wave commented on Sep 24, 2026

    @drips-wave

    Congratulations, @maztah1! 🎉 Your application was accepted by the repo's maintainers, and the issue is due on September 30, 2026.

    🧑‍💻 @maztah1: Please resolve the issue such that the repo's maintainers have enough time to review your contribution before the due date. You'll earn Points for completing the issue on-time, which will make you eligible for a share of the Stellar Wave Program's reward pool.

    Warning

    When opening a PR, please link it to this issue to ensure it gets tracked accurately. Points are awarded when this issue is marked as completed by the maintainer.

    🤠 Repo maintainers: Please keep an eye on the contributor's progress and review their work before the due date. You can manage this issue, including adjusting its complexity and points, here.

    🌊 Happy Wave 🌊

  5. added a commit that references this issue on Sep 28, 2026
    5c20613
  6. grantfox-oss commented on Sep 28, 2026

    @grantfox-oss

    🎉 This issue has been marked as completed on GrantFox!

    @maztah1's PR #948 was approved and merged by @Kingsman-99.

    🏆 @maztah1: You earned 35 FoxPoints for this contribution! Your current tier: Explorer (920 total points). Track your full progress on GrantFox.

    👏 Great work, @maztah1! Keep contributing to Stellar-split.

  7. drips-wave commented on Sep 28, 2026

    @drips-wave

    This issue has been completed by @maztah1 as part of the Stellar Wave Program's 9th Wave 🥳

    😎 @maztah1: You earned 200 Points for completing this issue! After the current Wave ends, you'll be eligible for a percentage of the Wave's reward pool based on the percentage of total points you've earned. Learn more here. You can also Leave a review to share your experience working on this issue.

    🧑‍💻 Repo maintainers: How'd the contributor do? Leave a review to share your experience working with them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions