feat: flow examples

[andreivladbrg]

Closes #36

Note: this PR merge must be synchronized with docs reference changes due to v2 rename to lockup (e.g. this one). Will work on that once you finish with your refactor @smol-ninja.

---

The flow example contracts are represented by these 4:

1. FlowBatchable
   • different functions (adjustRatePerSecondAndDeposit, createMultiple, createAndDepositViaBroker etc.) to declare the calldata as bytes for multiple function calls into a single tx
2. FlowManager
   • Manager contract that calls function to manage streams (basically mirror functions)
3. FlowStreamCreator
   • Contract for creating 2 streams with different rates
4. FlowUtilities
   • A library (used in the stream creator contract) with a series of utility functions for calculating the rps using a desired amount and duration.

@sablier-labs/solidity lmk if you have anything else in mind, or if the current ones should suffice

[smol-ninja]

@andreivladbrg this might need some refactor with the deposit function

[andreivladbrg]

@andreivladbrg this might need some refactor with the deposit function

indeed it needs, will updated it

also, since the repo is public now, it can be removed via package.json file so the gitmodules can be removed

[smol-ninja]

Nice work on Flow examples especially FlowUtilities library. I have an idea for an example:

• An example to salaries to multiple people through a single contract.

Let me know what you think if it would be useful or an overkill for this repo? I was thinking of examples from the use case point of view. And this may be a useful for users.

[smol-ninja]

Adding a note that after merging this PR, the links should be updated in sablier-labs/docs#186

[andreivladbrg]

Adding a note that after merging this PR, the links should be updated in sablier-labs/docs#186

yes, we should update them, also mentioned in the OP:

[andreivladbrg]

• An example to salaries to multiple people through a single contract

well, the stream creator can be used for this case. e.g. createStream_1K_PerMonth can be a salary.

[smol-ninja]

Fair point about using stream creator for salary example. But see my comment here.

[smol-ninja]

Should we merge it @andreivladbrg given we are going live in a few hours?

[andreivladbrg]

we will need to update the links in docs#docs/flow-protocol from feat/flow to main

[smol-ninja]

Yes. We can do that after this is merged.