@bananapus/core-v6 0.0.73 → 0.0.75
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -7
- package/package.json +1 -1
- package/src/JBChainlinkV3SequencerPriceFeed.sol +1 -1
package/README.md
CHANGED
|
@@ -2,13 +2,22 @@
|
|
|
2
2
|
|
|
3
3
|
`@bananapus/core-v6` is the base protocol package for Juicebox on EVM chains. It defines projects, rulesets, terminals, permissions, token issuance, cash outs, splits, price feeds, and the accounting that the rest of the V6 ecosystem builds on.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
5
|
+
|
|
6
|
+
## Documentation
|
|
7
|
+
|
|
8
|
+
In-repo docs (entry points for this repo):
|
|
9
|
+
|
|
10
|
+
- [ARCHITECTURE.md](./ARCHITECTURE.md) — module layout, data flow, critical-flow diagrams, and accounting model.
|
|
11
|
+
- [INVARIANTS.md](./INVARIANTS.md) — per-contract operation inventory and the guarantees core makes to users, owners, and integrators.
|
|
12
|
+
- [ADMINISTRATION.md](./ADMINISTRATION.md) — admin surfaces, role matrix, immutable decisions, and recovery posture.
|
|
13
|
+
- [RISKS.md](./RISKS.md) — threat model, accepted risks, and invariants to verify.
|
|
14
|
+
- [USER_JOURNEYS.md](./USER_JOURNEYS.md) — example end-to-end flows (launch, pay, cash out, payout, migrate, delegate).
|
|
15
|
+
- [AUDIT_INSTRUCTIONS.md](./AUDIT_INSTRUCTIONS.md) — what to focus on for a security audit and how to start.
|
|
16
|
+
- [SKILLS.md](./SKILLS.md) — implementation nuances, gotchas, and reading order for working on this codebase.
|
|
17
|
+
- [STYLE_GUIDE.md](./STYLE_GUIDE.md) — Solidity conventions and repo layout used across the V6 ecosystem.
|
|
18
|
+
- [CHANGELOG.md](./CHANGELOG.md) — v5 → v6 ABI and behavior deltas.
|
|
19
|
+
- [references/entrypoints.md](./references/entrypoints.md) — callable entrypoints by contract.
|
|
20
|
+
- [references/types-errors-events.md](./references/types-errors-events.md) — packed metadata, errors, events, and hook return shapes.
|
|
12
21
|
|
|
13
22
|
## Overview
|
|
14
23
|
|
|
@@ -134,6 +143,8 @@ script/
|
|
|
134
143
|
|
|
135
144
|
## Risks And Notes
|
|
136
145
|
|
|
146
|
+
See [RISKS.md](./RISKS.md) for the full risk register. In short:
|
|
147
|
+
|
|
137
148
|
- Hooks can materially change payment and cash-out behavior.
|
|
138
149
|
- Permissions are flexible, which makes broad or wildcard grants risky.
|
|
139
150
|
- Multi-terminal and multi-token accounting is powerful, but it is easy to misuse if an integration assumes a single-terminal model.
|
package/package.json
CHANGED
|
@@ -8,7 +8,7 @@ import {JBChainlinkV3PriceFeed} from "./JBChainlinkV3PriceFeed.sol";
|
|
|
8
8
|
|
|
9
9
|
/// @notice Extends `JBChainlinkV3PriceFeed` with L2 sequencer uptime checks (for Optimism, Arbitrum, etc.). Reverts if
|
|
10
10
|
/// the sequencer is down or has not been back online for at least `GRACE_PERIOD_TIME` seconds — preventing stale
|
|
11
|
-
/// prices from
|
|
11
|
+
/// prices from being used immediately after an outage.
|
|
12
12
|
contract JBChainlinkV3SequencerPriceFeed is JBChainlinkV3PriceFeed {
|
|
13
13
|
//*********************************************************************//
|
|
14
14
|
// --------------------------- custom errors ------------------------- //
|