Closed kamescg closed 1 year ago
Typo: "The form-delete-flow.tsx component should wrap the createFlow method." Should say: "The form-delete-flow.tsx component should wrap the deleteFlow method."
@sunnyjaycer great catch π thank you. fixed.
interested
interested
Hey, there! I've started working on this. Can anyone please confirm it's not assigned to anyone else?
Hello,
I am interested in working on this, I have worked on many Superfluid related projects, and contributed to the Superfluid Console as well, from what I see in the specification you have done a good amount of research and everything makes sense.
@sunnyjaycer is a good reference, and you can check my Github.
@sunnyjaycer @kamescg
============
I was reading through the spec, and noticed that you guys are missing a few things that are necessary for this to be a smooth complete experience.
@marthendalnunes is there a PR for this? I don't see the feature live
π¨βπ» User Story
As a Web3 developer I want to include "streaming" money features in my Web3 applications.
More specifically I want to use SuperFluid to easily send, delete and unwrap payments using the Super Token standard. The Super Token standard can wrap an existing ERC20 token or as a standalone ERC20 token with the Super Token enhancements.
π Disclaimer
To be eligible for the payout you must first get approval to work on the bounty.
general
channelbounty
channelIt's recommended to share a link to your personal Github account.
𧱠Project
Create a SuperFluid SDK integration for TurboETH. The SuperFluid integration should allow developers to easily start, claim and stop money flows.
Required Functionality:
Developer Tasks:
The SuperFluid integration requires both adding the core integration files and updating the demo application to showcase the SuperFluid features.
Integration
superlfuid/hooks/use-superfluid-with-wagmi-provider.ts
superlfuid/components/form-send-flow.tsx
superlfuid/components/form-delete-flow.tsx
superlfuid/components/form-unwrap-super-token.tsx
The
form-send-flow.tsx
component should wrap thecreateFlow
method.https://docs.superfluid.finance/superfluid/developers/constant-flow-agreement-cfa/cfa-operations/write-methods/createflow
The
form-delete-flow.tsx
component should stop the flow using thedeleteFlow
method.https://docs.superfluid.finance/superfluid/developers/constant-flow-agreement-cfa/cfa-operations/write-methods/deleteflow
The
form-unwrap-super-token.tsx
component should unwrap the Super Token for the underlying asset.https://docs.superfluid.finance/superfluid/developers/super-tokens/using-super-tokens#unwrapping-downgrading-a-super-token-to-the-underlying-asset
Application
app/(general)/integrations/superfluid/send/page.tsx
app/(general)/integrations/superfluid/delete/page.tsx
app/(general)/integrations/superfluid/balance/page.tsx
Developer Instructions
Form components should use
react-hook-form
andzod
for form submission management and creating the component Typescript interfaces and types.Reference of what the form should use: https://ui.shadcn.com/docs/forms/react-hook-form
SuperFluid documentation uses
Web3Modal
andethers
packages in the "Initialization" section.https://docs.superfluid.finance/superfluid/developers/sdk-core/sdk-core-initialization#operations
When integrating SuperFluid in TurboETH use the primary wallet connection manager and utility library:
wagmi
andviem
.A hook should be created to integrate SuperFluid with
wagmi
.The hook should look something like the code snippet below.
Potential File Structure
Integration
The [SuperFluid]() integration should be added to the
integrations/superfluid
folder.Application
The application pages should be added to the
app/(general)/integrations/superfluid
folder.π° Bounty Reward
The bounty reward is 225 OP tokens and TurboETH DevPass digital collectible.
TurboETH is the recipient of 18,271.88 OP Tokens from Optimism Retroactive Public Goods Funding. OP tokens earned from RPGF are helping fund TurboETH bounties.
Bonus: 50 OP will be awarded if flux.paradigm.xyz is used to help generate the template code in a meaningful way. Exported conversations must be made available to be eligible for the bonus reward.
Notice
The final integration may not resemble the proposed integration - that's O.K - a natural part of software development.
During development you might discover an original hypothesis doesn't make sense. No problem. Make a comment and clearly explain why a new approach is better than old one. Get rewarded for thinking out of the box.
The final bounty reward can be increased to match new bounty tasks.
Resources