docs icon indicating copy to clipboard operation
docs copied to clipboard

0xarthurxyz/escrow docs update

Open arthurgousset opened this issue 3 years ago • 1 comments

Updates Escrow docs

  • Adds detailed Mermaid diagrams that visualise
    1. the two payment flows (private key- and phone number-based)
    2. the revocation flow
    • I added support for Mermaid diagrams in the Celo docs with this separate PR: https://github.com/celo-org/docs/pull/331
  • Adds links to Valora implementation, ContractKit wrappers, and smart contract source code
  • Adds smart contract details such as emitted events, main mapping and attributes of escrowedPayment struct

👉 You can find the built Escrow page with diagrams and changes here 👈

arthurgousset avatar Jun 16 '22 10:06 arthurgousset

Deploy Preview for celo-docs ready!

Name Link
Latest commit a01c02b76465c4c6da46548be31f2ac56e1c9081
Latest deploy log https://app.netlify.com/sites/celo-docs/deploys/62ecfbcaa38c4100085b4739
Deploy Preview https://deploy-preview-334--celo-docs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

netlify[bot] avatar Jun 16 '22 10:06 netlify[bot]

In the efforts of getting this merged, I think it'd be sufficient to:

  • delete copied functions
  • delete unfinished/incorrect snippets

Once merged we can add new working snippets. @0xarthurxyz

eelanagaraj avatar Aug 09 '23 11:08 eelanagaraj

@arthurgousset any plans on reworking on this?

therealharpaljadeja avatar Feb 08 '24 17:02 therealharpaljadeja

@arthurgousset any plans on reworking on this?

Not personally, but someone else might use this PR for reference. I'm closing it on that basis.

arthurgousset avatar Feb 12 '24 11:02 arthurgousset