Skip to content

Revamp Build Sections: FairyRing modules, point to design-pattern repos, and more #45

@hashedtitan

Description

@hashedtitan

Scope

  • Setup new docs structure for Build sections (see outline in details)
  • Revise previous sections to respect this new setup
  • Add typical integrations sections for FairyRing integration for native cApps without smart contracts (see Osmosis docs as an example where they simply outline details of the messages to be sent and processed by the module)
  • Continue working on design-patterns repo

Details and Context

Previous docs are written where tutorials are combinations of setup and interaction with the respective FairyRing features: encrypted messages, private decryption, unique ID requests (and thus general conditions), and auctions. It is easier for a reader to understand the setup and the interaction with FairyRing separately. Therefore the restructuring of the docs "Build" related sections will look like:

  1. Build a cApp in 5 minutes
    • Just quick examples of FairyRing cApp and EVM cApp. Showcasing that with chain setup, deploying cApp and using FairyRing is easy.
  2. Build on FR and other chains
  • FairyRing

    • Encrypted Txs
    • Auctions
    • Smart Contracts: There are many ways to build advanced cApps using smart contracts. Some typical design patterns can be found here.
      •  FRC: General conditions with Public Decryption
        
      •  FRC: General conditions with Private Decryption
        
      •  FRC: Fixed-Rate Lending with Leaderless-Auctions
        
      •  FRC: Dynamic Price Discovery in Intent Protocols
        
  • EVMs (precompiles)

    •  Highlight at beginning of page that smart contracts is found in the design patterns repo if their chain is already setup, otherwise follow this to setup your chain. 
      
  • Cosmos (chain integrations)

    •   Highlight at beginning of page that smart contracts is found in the design patterns repo if their chain is already setup, otherwise follow this to setup your chain. Point to rust build patterns otherwise if working with cosm wasm. If working with native fuctions of fairyring, then point to message details within earlier section for x/pep, x/auction modules?
      
  • Stylus (RustVM)

    •   Highlight at beginning of page that smart contracts is found in the design patterns repo if their chain is already setup, otherwise follow this to setup your chain. 
      
    •  Smart Contracts - point to design patterns repo but instead of rust it's solidity... hmm. Keep it in one repo for now, but maybe have several repos for different languages.
      

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions