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

Update examples for Q1 2025 release #42

Open
4 tasks done
smol-ninja opened this issue Jan 14, 2025 · 4 comments · May be fixed by #43
Open
4 tasks done

Update examples for Q1 2025 release #42

smol-ninja opened this issue Jan 14, 2025 · 4 comments · May be fixed by #43
Assignees
Labels
effort: medium Default level of effort. priority: 1 This is important. It should be dealt with shortly. type: refactor Change that neither fixes a bug nor adds a feature. work: clear Sense-categorize-respond. The relationship between cause and effect is clear.

Comments

@smol-ninja
Copy link
Member

smol-ninja commented Jan 14, 2025

Tasks

  • Add airdrops dir and move the Airstream files from lockup
  • Update examples for the new releases
  • Update foundry.toml
  • Update package.json
@smol-ninja smol-ninja added effort: medium Default level of effort. priority: 1 This is important. It should be dealt with shortly. type: refactor Change that neither fixes a bug nor adds a feature. work: clear Sense-categorize-respond. The relationship between cause and effect is clear. labels Jan 14, 2025
@andreivladbrg
Copy link
Member

@smol-ninja I’ve started working on this issue, but I’m unsure about the best approach regarding the stream creator examples in lockup.

Currently, we have a separate file for each model example:

lockup
├── BatchLDStreamCreator.sol
├── BatchLLStreamCreator.sol
├── BatchLTStreamCreator.sol
├── LockupDynamicCurvesCreator.sol
├── LockupDynamicStreamCreator.sol
├── LockupLinearStreamCreator.sol
└── LockupTranchedStreamCreator.sol

With the new singleton approach, we could technically move everything into a single file, but IMO, we should keep the current structure. I believe it is better organized to have a dedicated example page in the docs for each model.
wdyt?

@smol-ninja
Copy link
Member Author

we should keep the current structure

Yes. The user would know which lockup model to use so it makes sense to have one example contract per model to make it less complicated to read.

In Airdrops dir, we would also need createLTAirstream contract since we only have createLLAirstream right now.

  • Should we add separate examples with how to create Linear stream with start unlock, cliff unlock etc?
  • Should we add more examples of batch?

@andreivladbrg
Copy link
Member

andreivladbrg commented Jan 15, 2025

In Airdrops dir, we would also need createLTAirstream contract since we only have createLLAirstream right now.

agree

Should we add separate examples with how to create Linear stream with start unlock, cliff unlock etc?

yeah, i was thinking of editing the current LockupLinearStreamCreator to be similar to LockupDynamicCurvesCreator, but with all possible shapes (from the PR OP).
wdyt?

Should we add more examples of batch?

if we decide to remove the BatchLockup, IMO we should have something like we do for flow

@smol-ninja
Copy link
Member Author

Sounds good,

if we decide to remove the BatchLockup, IMO we should

I think regardless of that, one or two examples with batch would be useful. We don't need that many, as once a user understands how to use batch, he can do whatever he wants with it.

@andreivladbrg andreivladbrg linked a pull request Jan 15, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort: medium Default level of effort. priority: 1 This is important. It should be dealt with shortly. type: refactor Change that neither fixes a bug nor adds a feature. work: clear Sense-categorize-respond. The relationship between cause and effect is clear.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants