Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

tutorial dApp: Escrow's lifecycle #98

Open
JoelVR17 opened this issue Jan 22, 2025 · 13 comments
Open

tutorial dApp: Escrow's lifecycle #98

JoelVR17 opened this issue Jan 22, 2025 · 13 comments
Labels
documentation Improvements or additions to documentation external-contributors Exclusively for contributors Maintainer - Joel Vargas

Comments

@JoelVR17
Copy link
Contributor

Issue - tutorial dApp: Escrow's lifecycle

You must apply through OnlyDust. If not, you'll be ignored.


Description:

The goal of this issue is to create a comprehensive tutorial explaining the two lifecycle flows of an escrow on the dApp: Trustless Work. The tutorial should cover both a successful escrow lifecycle and an escrow dispute lifecycle.

Scope of the Tutorial:

Successful Escrow Lifecycle:

  1. Initialization: Demonstrate how to initialize an escrow.
  2. Funding: Show how to fund the escrow using USDC.
  3. Milestone Completion: Explain how milestones are completed.
  4. Milestone Approval: Describe the process of approving milestones.
  5. Release of Funds: Illustrate the final step of releasing funds and verifying wallet balances:
    • 0.3% allocated to TrustlessWork.
    • Platform fee as defined in the escrow.
    • Remaining funds allocated to the service provider.

Escrow Dispute Lifecycle:

  1. Initialization: Demonstrate how to initialize an escrow.
  2. Funding: Show how to fund the escrow using USDC.
  3. Milestone Completion: Explain how milestones are completed.
  4. Milestone Approval: Describe the process of approving milestones.
  5. Raising a Dispute: Walk through the steps to raise a dispute.
  6. Resolving a Dispute: Explain the dispute resolution process.
  7. Fund Allocation: Verify wallet balances based on the dispute resolver's decision.

Requirements:

  1. The tutorial should be detailed, easy to follow, and demonstrate both escrow lifecycle scenarios.
  2. Include explanations of wallet setup and USDC funding:
    • Use Freighter to create wallets for different roles (e.g., Service Provider, Platform, Dispute Resolver).
    • Add the USDC token to the wallet and use the Circle Testnet Faucet to obtain USDC for testing.
  3. Reference the product documentation if needed: Trustless Work Docs.

Deliverables:

  1. Record a Loom video for the tutorial, explaining all steps clearly.

    • Provide a detailed walkthrough for both the successful escrow lifecycle and the dispute lifecycle.
    • Highlight key points like wallet setup, funding, milestone management, and dispute resolution.
  2. Submit the Loom link in the pull request description.


Validations:

  1. Ensure the tutorial covers all essential steps and provides clear explanations for each.
  2. Verify that the tutorial demonstrates the correct wallet balance updates after actions:
    • 0.3% fee for TrustlessWork.
    • Platform fees as defined in the escrow.
    • Remaining funds allocated to the service provider or dispute resolution outcome.
  3. Use examples to clarify potential questions, referencing the provided product documentation when needed.

⚠️ Please follow the guidelines for requesting an issue, launching commits, and describing PRs. Otherwise, they will be ignored. ⚠️

@JoelVR17 JoelVR17 added external-contributors Exclusively for contributors Maintainer - Joel Vargas ODBoost Issues for the ODBoost event documentation Improvements or additions to documentation labels Jan 22, 2025
@mexes20
Copy link

mexes20 commented Jan 22, 2025

Hello, I'd like to work on this.

I’m a developer with over three years of experience.

ETA: 24 hours

@Joewizy
Copy link

Joewizy commented Jan 22, 2025

Let me try this one!

@zleypner
Copy link
Contributor

Hello there! Im a Full Stack Developer +4 exp

I’d like to help with to create an escrow lifecycle tutorial dApp, I would first create a Loom video demonstrating wallet setup with Freighter and USDC funding via Circle Testnet Faucet. Then show successful flow (escrow initialization, funding, milestone completion/approval, fund release with fee verification) followed by dispute flow (same initial steps plus dispute raising/resolution process).

Thank you for reading my application.

@Iwueseiter
Copy link

Iwueseiter commented Jan 22, 2025

Please can I work on this?
I'm atechnical writer with 2yrs experience. I have experience of vocs, draw.io for diagrams and video recordings with loom ETC. I will create a comprehensive tutorial that will serve as a guide for both technical and non-technical users.
I will explore the project and also make research to get necessary informations for this tutorial
Here are links to comprehensive docs I've written and have been merged Flex-NFT-Marketplace/Flex-Marketplace-Contract#107, sivicstudio/starkludo#102, horuslabsio/tokenbound-contract-docs#12.

ETA: 3days

@Nityam573
Copy link

Can I get assigned to this task
I have contributed in Technical documentation of Starknet and Dojo
View my Profile:
https://app.onlydust.com/u/Nityam573

@mimisavage
Copy link

May I try my hand at this?

@salazarsebas
Copy link

My background

I'm a software engineer and passionate about solving problems, I've been contributing to open source software for a few months and it's an experience that has taught me a lot and I really like to contribute to other projects. I am a member of the Dojo Coding community⛩️. I will dedicate all my effort to complete this issue in the best way.

@nottherealalanturing
Copy link

I'd be happy to do this.

@Jagadeeshftw
Copy link

Proposal to Work on the Issue

I am eager to contribute to this issue and believe I am well-suited for the task, given my extensive experience in Cairo programming and building decentralized applications on StarkNet. My expertise spans across multiple domains crucial for this implementation:

  • Smart Contracts & Blockchain Development: Proven expertise in StarkNet, Stellar, and Rust, with hands-on experience in developing secure and efficient smart contracts, blockchain integrations, and high-performance backend systems.
  • Backend Engineering: Strong background in designing and managing scalable APIs, handling server-side operations, and ensuring robust backend performance for blockchain applications.
  • Frontend Development: Proficient in building intuitive and responsive frontend interfaces using React and Next.js, ensuring seamless interaction between users and blockchain-based applications.

Why Assign This to Me?

I have a track record of delivering high-quality solutions efficiently, with a deep understanding of smart contract security, decentralized architectures, and full-stack development. My ability to bridge frontend, backend, and blockchain components ensures a well-rounded, optimized solution.

Estimated Timeline

I anticipate delivering a fully functional solution within 2 days. Please let me know if I can proceed.

I am excited about the opportunity to contribute and look forward to collaborating!

Best regards,
Jagadeesh B

@Wendyalbert
Copy link

May I take care of this?

@hrishique
Copy link

@JoelVR17 GM ser,
I have worked previously on taking technical workshops IRL and online explaining devs about multiple dapps and also walkthrough of Dapps .I would Like to take this up and help even larger audience to explore about Escrow lifecycle on Trustless work.

@1nonlypiece
Copy link

Application for Contribution

I am excited about the opportunity to contribute to this issue and am confident that my expertise aligns well with the requirements. With a strong background in Cairo programming and decentralized application development on StarkNet, I bring a well-rounded skill set to deliver an effective solution.

Relevant Expertise

  • Blockchain & Smart Contracts: Extensive experience with StarkNet, Stellar, and Rust, specializing in developing secure and optimized smart contracts, blockchain integrations, and high-performance backend infrastructure.
  • Backend Development: Well-versed in API design, server-side logic, and scalable system architecture, ensuring efficient and seamless backend performance.
  • Frontend Engineering: Skilled in crafting interactive and responsive UI components using React and Next.js, enhancing the user experience for blockchain-based platforms.

Why Consider My Application?

My proven track record of delivering high-quality, optimized solutions in blockchain and full-stack development sets me apart. I have a deep understanding of smart contract security, decentralized architectures, and the synergy between frontend, backend, and blockchain layers—ensuring a seamless and efficient implementation.

ETA

I expect to have a working solution ready within 48 hours. Please let me know if I can proceed with the implementation.

@JoelVR17
Copy link
Contributor Author

This issue is for you @zleypner! 🚀
Remember to follow all the guidelines, both the ones inside the repository and the guideline to perform the PR.

Many thanks to all the other dev's who sent in their application.

@JoelVR17 JoelVR17 removed the ODBoost Issues for the ODBoost event label Jan 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation external-contributors Exclusively for contributors Maintainer - Joel Vargas
Projects
None yet
Development

No branches or pull requests