A Standard Proposal for Extending Classic Asset's Behavior - Tutorial

Fifo — Sun, 18 Aug 2024 22:48:41 +0000

This is a submission for the Build Better on Stellar: Smart Contract Challenge : Create a Tutorial

The Team

Fabricius Zatti(Fifo): fazzatti
Victor Hugo Martins: victorhugo-pmartins

Your Tutorial

This submission is complementary to another demo submission in a separate category.

For this submission we decided to record a series of four videos covering a proposed standard for extending asset capabilities with classic wrappers. The proposal defines a structured approach to wrap classic assets with unique custom rules that can be either enforced by asset issuers or made option by any ecosystem builder.

Playlist link
Video #1 - Unlocking Stellar's Potential: A New Approach to Asset Wrapping: This video covers the overall concept and objective behind the proposed standard for the Classic Asset Wrappers.
Video #2 -Dynamic Asset Control with Enforced Wrappers on Stellar: This video covers entirely the hypothetical use case of an enforced wrapper with custom probation rules. It explains the overall concept of the prototype, performs a complete walkthrough the interactive demo and then covers the contracts implementation overview.
Video #3 -Gamify Your Assets: Optional Wrappers on Stellar: This video covers entirely the hypothetical use case of an optional wrapper with custom gamified campaign. It explains the overall concept of the prototype, performs a complete walkthrough the interactive demo and then covers the contracts implementation overview
Video #4 -Building a Counter Contract from Scratch with Wrappers: Covers a complete step-by-step building a Counter contract from scratch, leveraging the Wrapper standard, then utilizing the playground project to implement a client and run integration tests in Testnet.

What I Created

We believe the community can benefit in different ways from our submission and the proposed standard discussion:

Reference contract implementations to serve as reference and base for other use cases in the ecosystem.
Node project with common automation, typescript clients and a structured way for writting and testing complex contract use cases in Testnet with the Stellar Plus library.
Interactive live demos to experiment hand-on the use cases and instigate creative ways of innovating with use cases and user experience.

Journey

We had a blast! It's been a long time since we've been maturing the idea of a classic wrapper, but we didn't have the opportunity(and perhaps the initial "pushing" motivator) to try and validate the de approach. We took the opportunity to work on a standard proposal as we moved through the use cases implementation and a lot(for real, A LOT!) of testing! We kept going back, rethinking, prototyping, testing again, rinse and repeat.

In the past, we have experimented with Soroban in many ways, but we believe that a big key differentiator for Stellar is the ability to combine the best of both worlds(Soroban and classic) into hybrid assets. With that in mind, we wanted to explore structured approaches for extending classic assets' behavior in unique ways and also build something for the community's benefit.

The process was highly focused on prototyping and testing first-handed in testnet to get a feel for how well different designs would support different use cases as well as integration with the front end and wallets. Our approach was mainly around:

Implement quick rounds of the soroban contracts
Compile
Implementing/updating the typescript clients
Running integration tests for Testnet
Fail/find gaps
Repeat

We wanted to write more tests in Rust, but there was a limiting factor. Currently, there is no ready-to-use or simple way of simulating different control flags like auth_revocable in Rust tests(I think I opened an issue about it months ago). With this in mind, we decided to overcome this by quickly building and testing with the typescript clients and Stellar Plus (Shameless plug). This allowed us to get rapid feedback from the behavior in the testnet, which kept our feedback coming and allowed speedy prototyping and refinement.

We're looking forward to getting feedback from the devs and builders in the community!

A Standard Proposal for Extending Classic Asset's Behavior - Demos

Fifo — Sun, 18 Aug 2024 22:48:11 +0000

This is a submission for the Build Better on Stellar: Smart Contract Challenge : Build a dApp

The Team

Fabricius Zatti(Fifo): fazzatti
Victor Hugo Martins: victorhugo-pmartins

What We Built

This submission is complementary to another tutorial submission in a separate category.

This submission contains two different fully-interactive demos around a proposed standard for extending asset capabilities with classic wrappers. The proposal defines a structured approach to wrap classic assets with unique custom rules that can be either enforced by asset issuers or made option by any ecosystem builder.

#1 - Enforced Wrapper with Probation: This first demo covers the perspective of an asset issuer applying the wrapper approach to enforce custom granular probation rules for the classic asset behavior.
#2 - Optional Wrapper with Campaign: This second demo covers the perspective of an either an asset issuer or simply a builder in the ecosystem applying the wrapper approach to allow asset holder to opt-in and participate in a campaign, accumulating points and earning prizes as they transact with the classic asset.

Both implementations can be broken into two moments:

Setup phase: Allows the audience to navigate all steps of setup for the demo, since creating the admin account(or user freighter) to deploying and customizing the contract rules
Interactive Playground: Generate and control new users as well as the admin to interact with the contracts a observe the evolution of the use case as the transactions are executed and recorded in a timeline tree.

Demo

Both demos are also covered in the complementary submission to the tutorial category. The other submission covers a video series, including a deep dive and walkthrough these two demos and the contracts. The two specific videos that cover these demos are linked here as well.

My Code

The main repository with the core implementation is public under oi-fifo-soroban-demos and it contains a collection of different examples and assets. The relevant items for this submission are listed below:

Rust implementation:
- Standard Traits: A package containing default interfaces exemplifying the proposed standard and common functions.
- Classic Asset Wrapper(Enforced): A contract implementation for the Classic Asset Wrapper following the enforced approach.
- Classic Asset Wrapper (Optional): A contract implementation for the Classic Asset Wrapper following the optional approach.
- Probation: An Asset Controller implementation for enforced use cases applying custom granular limits around a probation period to asset holders.
- Campaign: An Asset Controller implementation for optional use cases enabling asset holders to opt-in and participate in a campaign to collect points and prizes.
- Counter: A simple Asset Controller implementation for optional use cases implementing a counter. (step-by-step tutorial recording)

Journey

Implement quick rounds of the soroban contracts
Compile
Implementing/updating the typescript clients
Running integration tests for Testnet
Fail/find gaps
Repeat

We're looking forward to getting feedback from the devs and builders in the community!

DEV Community: Fifo

A Standard Proposal for Extending Classic Asset's Behavior - Tutorial

The Team

Your Tutorial

What I Created

Journey

A Standard Proposal for Extending Classic Asset's Behavior - Demos

The Team

What We Built

Demo

My Code

Journey