IOTA Bounties - Update Docs Examples for Trade & Supply Chain

[richardmands]

Please read the README first.

Summary

Update the IOTA Docs code examples for Trade & Supply Chain use-cases

This issue is a base for adding a your work, please open a new issue referencing it.
Feel free to use this issue to discuss ideas before opening a proposal.

Estimated Size

Large

Estimated duration

One Week

Details & acceptance criteria

• Update All IOTA Docs Examples

Pull request required?

Yes

[Geremech20261993]

Hello @richardmands, I am a software developer with experience in Python and Java. I am very interested in this bounty. I have reviewed the requirements and I can complete the update for the Trade & Supply Chain code examples within 48 hours. Please let me know if I can proceed with the proposal.

[aliraza556]

@richardmands Please assign me?

Proposal: Update IOTA Docs Examples for Trade & Supply Chain

Bounty Reference: IOTA Bounties - Update Docs Examples for Trade & Supply Chain
Estimated Duration: One Week

---

Summary

I will audit and update all code examples across the IOTA Documentation to use consistent, trade & supply chain scenarios instead of the current generic/abstract examples. Each Trust Framework component's docs will be rewritten around a unified cargo shipping & trade narrative -- making the examples immediately practical for the primary audience IOTA targets.

---

Problem

The current IOTA docs examples are functional but disconnected:

• Notarization examples use abstract "data" without a real-world context
• Hierarchies examples create generic federations with placeholder actors
• Gas Station examples call a generic free_trial function
• Identity examples show DIDs without tying them to a business scenario
• Asset Tokenization examples demonstrate mechanics but not industry application

A developer exploring the docs has to mentally bridge the gap between these abstract snippets and a real supply chain use-case. This update eliminates that gap.

---

Approach

Unified Scenario: International Cargo Trade

Every updated example will follow a single end-to-end scenario:

A Customs Authority (root) authorizes an Exporter who ships goods to an Importer, with a Freight Forwarder handling logistics and a Customs Broker clearing shipments.

This scenario naturally exercises every Trust Framework component:

Docs Section	Current State	Updated Example
IOTA Identity	Generic DID creation	Exporter creates a DID, issues a Verifiable Credential for trade license
IOTA Hierarchies	Abstract federation	Customs Authority → Exporter → Freight Forwarder → Importer authorization chain
IOTA Notarization	Generic data hash	Notarize a Bill of Lading, Certificate of Origin, and customs clearance events
IOTA Gas Station	free_trial function call	Freight Forwarder submits tracking updates via sponsored transactions
Asset Tokenization	Abstract NFT minting	Tokenize a shipping container as a tracked on-chain asset with metadata

Scope of Work

1. Audit all existing doc examples -- catalog every code snippet across Notarization, Hierarchies, Gas Station, Identity, and Tokenization docs (both Rust and TypeScript variants)
2. Rewrite examples with trade & supply chain context while preserving the same API patterns and teaching objectives
3. Update companion text -- adjust the surrounding explanations, comments, and "Key Points" sections to reference the trade scenario
4. Ensure examples compile and run -- verify every Rust and TypeScript snippet against the current SDK versions on testnet
5. Update GitHub example repos -- if examples are sourced from external repos (e.g., iota-community/sponsored-transactions-demo), submit PRs there too

---

Deliverables & Timeline

Day	Deliverable
Day 1	Full audit of all existing doc examples. Catalog with file paths, languages, and current scenario descriptions.
Day 2	Rewrite Identity + Hierarchies examples (Rust & TypeScript) with trade actors and authorization chains.
Day 3	Rewrite Notarization examples -- Bill of Lading, Certificate of Origin, customs events (Dynamic + Locked).
Day 4	Rewrite Gas Station + Asset Tokenization examples with freight and container scenarios.
Day 5	Verify all examples compile and run on testnet. Fix any SDK version issues.
Day 6	Update surrounding docs text, comments, and cross-references for consistency.
Day 7	Final review, cleanup, and PR submission.

---

What You Can Expect

• A single pull request updating all trade & supply chain doc examples
• Both Rust and TypeScript variants updated consistently
• Every example tested against current SDK versions on testnet
• No breaking changes to doc structure -- same pages, same teaching flow, better examples
• Responsive to review feedback with fast iteration

---

Relevant Background

• Experience with TypeScript and Rust -- the two languages used across all IOTA doc examples
• Familiar with the IOTA Trust Framework components and the DPP Demonstrator codebase
• Active open-source contributor with clean, well-documented PRs
• Strong technical writing skills -- examples will be clear, commented, and follow existing doc conventions

---

Ready to start immediately. Happy to discuss the scenario choice or scope adjustments before beginning.

[Geremech20261993]

Proposal: Fast-Track Documentation Update (Python/Java Focus) ​Hello @richardmands, ​I have carefully reviewed the proposal from @aliraza556. While their plan is comprehensive, I am offering a more accelerated timeline (2-3 days) specifically focused on the Python and Java/Android ecosystem, which are critical for many mobile and enterprise developers. ​Why my proposal is more efficient: ​Unified Scenario: I will follow the "International Cargo Trade" narrative, but I will deliver the Python and Java snippets simultaneously to ensure cross-language consistency within 48 hours. ​Ready-to-Run Code: My focus isn't just on writing; I will ensure every snippet is tested against the current IOTA SDK on the testnet before submission. ​Technical Writing: I will simplify complex concepts like Verifiable Credentials and Asset Tokenization into 3-step actionable guides within the documentation. ​My Accelerated Timeline: ​Day 1: Audit all current examples and create the "Cargo Shipping" narrative logic. ​Day 2: Rewrite and test all Python and Java code snippets (Identity, Notarization, and Tokenization). ​Day 3: Final review, companion text updates, and PR submission. ​I am ready to start immediately and can provide a faster turnaround than the 7-day estimate. Please assign me this task if you prioritize speed and quality for these specific languages.

…

On Mon, 23 Feb 2026, 7:43 pm Ali Raza, ***@***.***> wrote: *aliraza556* left a comment (iotaledger/devx#596) <#596 (comment)> @richardmands <https://github.com/richardmands> Please assign me? Proposal: Update IOTA Docs Examples for Trade & Supply Chain *Bounty Reference:* IOTA Bounties - Update Docs Examples for Trade & Supply Chain *Estimated Duration:* One Week ------------------------------ Summary I will audit and update *all* code examples across the IOTA Documentation to use consistent, trade & supply chain scenarios instead of the current generic/abstract examples. Each Trust Framework component's docs will be rewritten around a unified *cargo shipping & trade* narrative -- making the examples immediately practical for the primary audience IOTA targets. ------------------------------ Problem The current IOTA docs examples are functional but disconnected: - *Notarization* examples use abstract "data" without a real-world context - *Hierarchies* examples create generic federations with placeholder actors - *Gas Station* examples call a generic free_trial function - *Identity* examples show DIDs without tying them to a business scenario - *Asset Tokenization* examples demonstrate mechanics but not industry application A developer exploring the docs has to mentally bridge the gap between these abstract snippets and a real supply chain use-case. This update eliminates that gap. ------------------------------ Approach Unified Scenario: International Cargo Trade Every updated example will follow a single end-to-end scenario: A *Customs Authority* (root) authorizes an *Exporter* who ships goods to an *Importer*, with a *Freight Forwarder* handling logistics and a *Customs Broker* clearing shipments. This scenario naturally exercises every Trust Framework component: Docs Section Current State Updated Example *IOTA Identity* Generic DID creation Exporter creates a DID, issues a Verifiable Credential for trade license *IOTA Hierarchies* Abstract federation Customs Authority → Exporter → Freight Forwarder → Importer authorization chain *IOTA Notarization* Generic data hash Notarize a Bill of Lading, Certificate of Origin, and customs clearance events *IOTA Gas Station* free_trial function call Freight Forwarder submits tracking updates via sponsored transactions *Asset Tokenization* Abstract NFT minting Tokenize a shipping container as a tracked on-chain asset with metadata Scope of Work 1. *Audit all existing doc examples* -- catalog every code snippet across Notarization, Hierarchies, Gas Station, Identity, and Tokenization docs (both Rust and TypeScript variants) 2. *Rewrite examples* with trade & supply chain context while preserving the same API patterns and teaching objectives 3. *Update companion text* -- adjust the surrounding explanations, comments, and "Key Points" sections to reference the trade scenario 4. *Ensure examples compile and run* -- verify every Rust and TypeScript snippet against the current SDK versions on testnet 5. *Update GitHub example repos* -- if examples are sourced from external repos (e.g., iota-community/sponsored-transactions-demo), submit PRs there too ------------------------------ Deliverables & Timeline Day Deliverable *Day 1* Full audit of all existing doc examples. Catalog with file paths, languages, and current scenario descriptions. *Day 2* Rewrite Identity + Hierarchies examples (Rust & TypeScript) with trade actors and authorization chains. *Day 3* Rewrite Notarization examples -- Bill of Lading, Certificate of Origin, customs events (Dynamic + Locked). *Day 4* Rewrite Gas Station + Asset Tokenization examples with freight and container scenarios. *Day 5* Verify all examples compile and run on testnet. Fix any SDK version issues. *Day 6* Update surrounding docs text, comments, and cross-references for consistency. *Day 7* Final review, cleanup, and PR submission. ------------------------------ What You Can Expect - A single *pull request* updating all trade & supply chain doc examples - Both *Rust and TypeScript* variants updated consistently - Every example *tested against current SDK versions* on testnet - *No breaking changes* to doc structure -- same pages, same teaching flow, better examples - Responsive to review feedback with fast iteration ------------------------------ Relevant Background - Experience with *TypeScript* and *Rust* -- the two languages used across all IOTA doc examples - Familiar with the IOTA Trust Framework components and the DPP Demonstrator codebase - Active open-source contributor with clean, well-documented PRs - Strong technical writing skills -- examples will be clear, commented, and follow existing doc conventions ------------------------------ Ready to start immediately. Happy to discuss the scenario choice or scope adjustments before beginning. — Reply to this email directly, view it on GitHub <#596 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/B6ESW3TXQVAKJHXXXTUSRW34NMU25AVCNFSM6AAAAACV4XIZV6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTSNBVHEZDGOBXHE> . You are receiving this because you commented.Message ID: ***@***.***>