Skip to content

Commit 392b74c

Browse files
Patrick-Ehimensmol-ninjaPaulRBerg
authored
docs: Add new config column for linear, dynamic and tranched streams benchmark tables. (#284)
* Add new config column for benchmark tables. "linear, dynamic and tranched streams" * docs: polish benchmark tables * refactor: say Configuration --------- Co-authored-by: smol-ninja <[email protected]> Co-authored-by: Paul Razvan Berg <[email protected]>
1 parent 4a04631 commit 392b74c

File tree

2 files changed

+89
-89
lines changed

2 files changed

+89
-89
lines changed

‎docs/guides/flow/04-gas-benchmarks.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,17 @@ that generates these benchmarks.
1717

1818
The following gas benchmarks are generated using a 6-decimal token.
1919

20-
| Function | Gas Usage |
21-
| ----------------------------- | --------- |
22-
| `adjustRatePerSecond` | 44,171 |
23-
| `create` | 113,681 |
24-
| `deposit` | 32,975 |
25-
| `depositViaBroker` | 22,732 |
26-
| `pause` | 7,522 |
27-
| `refund` | 11,939 |
28-
| `restart` | 7,036 |
29-
| `void (solvent stream)` | 10,060 |
30-
| `void (insolvent stream)` | 37,460 |
31-
| `withdraw (insolvent stream)` | 57,688 |
32-
| `withdraw (solvent stream)` | 38,156 |
33-
| `withdrawMax` | 51,988 |
20+
| Function | Stream Liquidity | Gas Usage |
21+
| --------------------- | ---------------- | --------- |
22+
| `adjustRatePerSecond` | N/A | 44,171 |
23+
| `create` | N/A | 113,681 |
24+
| `deposit` | N/A | 32,975 |
25+
| `depositViaBroker` | N/A | 22,732 |
26+
| `pause` | N/A | 7,522 |
27+
| `refund` | N/A | 11,939 |
28+
| `restart` | N/A | 7,036 |
29+
| `void` | Insolvent | 37,460 |
30+
| `void` | Solvent | 10,060 |
31+
| `withdraw` | Insolvent | 57,688 |
32+
| `withdraw` | Solvent | 38,156 |
33+
| `withdrawMax` | N/A | 51,988 |

‎docs/guides/lockup/04-gas-benchmarks.md

Lines changed: 75 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -52,84 +52,84 @@ that generates these benchmarks.
5252

5353
### Linear Stream
5454

55-
| Function | Gas Usage |
56-
| ------------------------------------------------------------- | --------- |
57-
| `burn` | 16,141 |
58-
| `cancel` | 65,381 |
59-
| `renounce` | 27,721 |
60-
| `createWithDurationsLL` (Broker fee set) (cliff not set) | 138,649 |
61-
| `createWithDurationsLL` (Broker fee not set) (cliff not set) | 122,287 |
62-
| `createWithDurationsLL` (Broker fee set) (cliff set) | 169,335 |
63-
| `createWithDurationsLL` (Broker fee not set) (cliff set) | 164,278 |
64-
| `createWithTimestampsLL` (Broker fee set) (cliff not set) | 125,100 |
65-
| `createWithTimestampsLL` (Broker fee not set) (cliff not set) | 120,038 |
66-
| `createWithTimestampsLL` (Broker fee set) (cliff set) | 169,682 |
67-
| `createWithTimestampsLL` (Broker fee not set) (cliff set) | 164,614 |
68-
| `withdraw` (After End Time) (by Recipient) | 33,179 |
69-
| `withdraw` (Before End Time) (by Recipient) | 23,303 |
70-
| `withdraw` (After End Time) (by Anyone) | 29,561 |
71-
| `withdraw` (Before End Time) (by Anyone) | 22,815 |
55+
| Function | Configuration | Gas Usage |
56+
| ------------------------ | -------------------------------------------- | --------- |
57+
| `burn` | N/A | 16,141 |
58+
| `cancel` | N/A | 65,381 |
59+
| `renounce` | N/A | 27,721 |
60+
| `createWithDurationsLL` | broker = 0 & cliff = 0 | 122,287 |
61+
| `createWithDurationsLL` | broker > 0 & cliff = 0 | 138,649 |
62+
| `createWithDurationsLL` | broker = 0 & cliff > 0 | 164,278 |
63+
| `createWithDurationsLL` | broker > 0 & cliff > 0 | 169,335 |
64+
| `createWithTimestampsLL` | broker = 0 & cliff = 0 | 120,038 |
65+
| `createWithTimestampsLL` | broker > 0 & cliff = 0 | 125,100 |
66+
| `createWithTimestampsLL` | broker = 0 & cliff > 0 | 164,614 |
67+
| `createWithTimestampsLL` | broker > 0 & cliff > 0 | 169,682 |
68+
| `withdraw` | endTime < blockTime & msgSender = recipient | 33,179 |
69+
| `withdraw` | endTime > blockTime & msgSender = recipient | 23,303 |
70+
| `withdraw` | endTime < blockTime & msgSender != recipient | 29,561 |
71+
| `withdraw` | endTime > blockTime & msgSender != recipient | 22,815 |
7272

7373
### Dynamic Stream
7474

75-
| Function | Gas Usage |
76-
| ------------------------------------------------------------ | --------- |
77-
| `burn` | 16,141 |
78-
| `cancel` | 65,381 |
79-
| `renounce` | 27,721 |
80-
| `createWithDurationsLD` (2 segments) (Broker fee set) | 216,788 |
81-
| `createWithDurationsLD` (2 segments) (Broker fee not set) | 200,461 |
82-
| `createWithTimestampsLD` (2 segments) (Broker fee set) | 197,652 |
83-
| `createWithTimestampsLD` (2 segments) (Broker fee not set) | 192,627 |
84-
| `withdraw` (2 segments) (After End Time) (by Recipient) | 23,885 |
85-
| `withdraw` (2 segments) (Before End Time) (by Recipient) | 29,903 |
86-
| `withdraw` (2 segments) (After End Time) (by Anyone) | 19,175 |
87-
| `withdraw` (2 segments) (Before End Time) (by Anyone) | 29,992 |
88-
| `createWithDurationsLD` (10 segments) (Broker fee set) | 422,199 |
89-
| `createWithDurationsLD` (10 segments) (Broker fee not set) | 417,189 |
90-
| `createWithTimestampsLD` (10 segments) (Broker fee set) | 402,125 |
91-
| `createWithTimestampsLD` (10 segments) (Broker fee not set) | 397,126 |
92-
| `withdraw` (10 segments) (After End Time) (by Recipient) | 24,167 |
93-
| `withdraw` (10 segments) (Before End Time) (by Recipient) | 37,190 |
94-
| `withdraw` (10 segments) (After End Time) (by Anyone) | 24,278 |
95-
| `withdraw` (10 segments) (Before End Time) (by Anyone) | 37,279 |
96-
| `createWithDurationsLD` (100 segments) (Broker fee set) | 2,898,563 |
97-
| `createWithDurationsLD` (100 segments) (Broker fee not set) | 2,894,573 |
98-
| `createWithTimestampsLD` (100 segments) (Broker fee set) | 2,706,641 |
99-
| `createWithTimestampsLD` (100 segments) (Broker fee not set) | 2,702,660 |
100-
| `withdraw` (100 segments) (After End Time) (by Recipient) | 81,920 |
101-
| `withdraw` (100 segments) (Before End Time) (by Recipient) | 119,603 |
102-
| `withdraw` (100 segments) (After End Time) (by Anyone) | 82,009 |
103-
| `withdraw` (100 segments) (Before End Time) (by Anyone) | 119,692 |
75+
| Function | Segments | Configuration | Gas Usage |
76+
| ------------------------ | -------- | -------------------------------------------- | --------- |
77+
| `burn` | N/A | N/A | 16,141 |
78+
| `cancel` | N/A | N/A | 65,381 |
79+
| `renounce` | N/A | N/A | 27,721 |
80+
| `createWithDurationsLD` | 2 | broker = 0 | 200,461 |
81+
| `createWithDurationsLD` | 2 | broker > 0 | 216,788 |
82+
| `createWithTimestampsLD` | 2 | broker = 0 | 192,627 |
83+
| `createWithTimestampsLD` | 2 | broker > 0 | 197,652 |
84+
| `withdraw` | 2 | endTime < blockTime & msgSender = recipient | 23,885 |
85+
| `withdraw` | 2 | endTime > blockTime & msgSender = recipient | 29,903 |
86+
| `withdraw` | 2 | endTime < blockTime & msgSender != recipient | 19,175 |
87+
| `withdraw` | 2 | endTime > blockTime & msgSender != recipient | 29,992 |
88+
| `createWithDurationsLD` | 10 | broker = 0 | 417,189 |
89+
| `createWithDurationsLD` | 10 | broker > 0 | 422,199 |
90+
| `createWithTimestampsLD` | 10 | broker = 0 | 397,126 |
91+
| `createWithTimestampsLD` | 10 | broker > 0 | 402,125 |
92+
| `withdraw` | 10 | endTime < blockTime & msgSender = recipient | 24,167 |
93+
| `withdraw` | 10 | endTime > blockTime & msgSender = recipient | 37,190 |
94+
| `withdraw` | 10 | endTime < blockTime & msgSender != recipient | 24,278 |
95+
| `withdraw` | 10 | endTime > blockTime & msgSender != recipient | 37,279 |
96+
| `createWithDurationsLD` | 100 | broker = 0 | 2,894,573 |
97+
| `createWithDurationsLD` | 100 | broker > 0 | 2,898,563 |
98+
| `createWithTimestampsLD` | 100 | broker = 0 | 2,702,660 |
99+
| `createWithTimestampsLD` | 100 | broker > 0 | 2,706,641 |
100+
| `withdraw` | 100 | endTime < blockTime & msgSender = recipient | 81,920 |
101+
| `withdraw` | 100 | endTime > blockTime & msgSender = recipient | 119,603 |
102+
| `withdraw` | 100 | endTime < blockTime & msgSender != recipient | 82,009 |
103+
| `withdraw` | 100 | endTime > blockTime & msgSender != recipient | 119,692 |
104104

105105
### Tranched Stream
106106

107-
| Function | Gas Usage |
108-
| ------------------------------------------------------------ | --------- |
109-
| `burn` | 16,141 |
110-
| `cancel` | 65,381 |
111-
| `renounce` | 27,721 |
112-
| `createWithDurationsLT` (2 tranches) (Broker fee set) | 215,994 |
113-
| `createWithDurationsLT` (2 tranches) (Broker fee not set) | 199,665 |
114-
| `createWithTimestampsLT` (2 tranches) (Broker fee set) | 196,988 |
115-
| `createWithTimestampsLT` (2 tranches) (Broker fee not set) | 191,964 |
116-
| `withdraw` (2 tranches) (After End Time) (by Recipient) | 23,599 |
117-
| `withdraw` (2 tranches) (Before End Time) (by Recipient) | 18,503 |
118-
| `withdraw` (2 tranches) (After End Time) (by Anyone) | 18,889 |
119-
| `withdraw` (2 tranches) (Before End Time) (by Anyone) | 18,592 |
120-
| `createWithDurationsLT` (10 tranches) (Broker fee set) | 414,411 |
121-
| `createWithDurationsLT` (10 tranches) (Broker fee not set) | 409,394 |
122-
| `createWithTimestampsLT` (10 tranches) (Broker fee set) | 397,045 |
123-
| `createWithTimestampsLT` (10 tranches) (Broker fee not set) | 392,026 |
124-
| `withdraw` (10 tranches) (After End Time) (by Recipient) | 23,318 |
125-
| `withdraw` (10 tranches) (Before End Time) (by Recipient) | 25,403 |
126-
| `withdraw` (10 tranches) (After End Time) (by Anyone) | 23,427 |
127-
| `withdraw` (10 tranches) (Before End Time) (by Anyone) | 25,492 |
128-
| `createWithDurationsLT` (100 tranches) (Broker fee set) | 2,808,652 |
129-
| `createWithDurationsLT` (100 tranches) (Broker fee not set) | 2,804,166 |
130-
| `createWithTimestampsLT` (100 tranches) (Broker fee set) | 2,649,659 |
131-
| `createWithTimestampsLT` (100 tranches) (Broker fee not set) | 2,645,177 |
132-
| `withdraw` (100 tranches) (After End Time) (by Recipient) | 74,530 |
133-
| `withdraw` (100 tranches) (Before End Time) (by Recipient) | 103,255 |
134-
| `withdraw` (100 tranches) (After End Time) (by Anyone) | 74,619 |
135-
| `withdraw` (100 tranches) (Before End Time) (by Anyone) | 103,344 |
107+
| Function | Tranches | Configuration | Gas Usage |
108+
| ------------------------ | -------- | -------------------------------------------- | --------- |
109+
| `burn` | N/A | N/A | 16,141 |
110+
| `cancel` | N/A | N/A | 65,381 |
111+
| `renounce` | N/A | N/A | 27,721 |
112+
| `createWithDurationsLT` | 2 | broker = 0 | 199,665 |
113+
| `createWithDurationsLT` | 2 | broker > 0 | 215,994 |
114+
| `createWithTimestampsLT` | 2 | broker = 0 | 191,964 |
115+
| `createWithTimestampsLT` | 2 | broker > 0 | 196,988 |
116+
| `withdraw` | 2 | endTime < blockTime & msgSender = recipient | 23,599 |
117+
| `withdraw` | 2 | endTime > blockTime & msgSender = recipient | 18,503 |
118+
| `withdraw` | 2 | endTime < blockTime & msgSender != recipient | 18,889 |
119+
| `withdraw` | 2 | endTime > blockTime & msgSender != recipient | 18,592 |
120+
| `createWithDurationsLT` | 10 | broker = 0 | 409,394 |
121+
| `createWithDurationsLT` | 10 | broker > 0 | 414,411 |
122+
| `createWithTimestampsLT` | 10 | broker = 0 | 392,026 |
123+
| `createWithTimestampsLT` | 10 | broker > 0 | 397,045 |
124+
| `withdraw` | 10 | endTime < blockTime & msgSender = recipient | 23,318 |
125+
| `withdraw` | 10 | endTime > blockTime & msgSender = recipient | 25,403 |
126+
| `withdraw` | 10 | endTime < blockTime & msgSender != recipient | 23,427 |
127+
| `withdraw` | 10 | endTime > blockTime & msgSender != recipient | 25,492 |
128+
| `createWithDurationsLT` | 100 | broker = 0 | 2,804,166 |
129+
| `createWithDurationsLT` | 100 | broker > 0 | 2,808,652 |
130+
| `createWithTimestampsLT` | 100 | broker = 0 | 2,645,177 |
131+
| `createWithTimestampsLT` | 100 | broker > 0 | 2,649,659 |
132+
| `withdraw` | 100 | endTime < blockTime & msgSender = recipient | 74,530 |
133+
| `withdraw` | 100 | endTime > blockTime & msgSender = recipient | 103,255 |
134+
| `withdraw` | 100 | endTime < blockTime & msgSender != recipient | 74,619 |
135+
| `withdraw` | 100 | endTime > blockTime & msgSender != recipient | 103,344 |

0 commit comments

Comments
 (0)