@rev-net/core-v6 0.0.13 → 0.0.14

package/docs/book.css

@@ -1,13 +0,0 @@
-table {
-    margin: 0 auto;
-    border-collapse: collapse;
-    width: 100%;
-}
-
-table td:first-child {
-    width: 15%;
-}
-  
-table td:nth-child(2) {
-    width: 25%;
-}

package/docs/book.toml

@@ -1,13 +0,0 @@
-[book]
-src = "src"
-title = ""
-
-[output.html]
-no-section-label = true
-additional-js = ["solidity.min.js"]
-additional-css = ["book.css"]
-mathjax-support = true
-git-repository-url = "https://github.com/rev-net/revnet-core-v6"
-
-[output.html.fold]
-enable = true

package/docs/solidity.min.js

@@ -1,74 +0,0 @@
-hljs.registerLanguage("solidity",(()=>{"use strict";function e(){try{return!0
-}catch(e){return!1}}
-var a=/-?(\b0[xX]([a-fA-F0-9]_?)*[a-fA-F0-9]|(\b[1-9](_?\d)*(\.((\d_?)*\d)?)?|\.\d(_?\d)*)([eE][-+]?\d(_?\d)*)?|\b0)(?!\w|\$)/
-;e()&&(a=a.source.replace(/\\b/g,"(?<!\\$)\\b"));var s={className:"number",
-begin:a,relevance:0},n={
-keyword:"assembly let function if switch case default for leave break continue u256 jump jumpi stop return revert selfdestruct invalid",
-built_in:"add sub mul div sdiv mod smod exp not lt gt slt sgt eq iszero and or xor byte shl shr sar addmod mulmod signextend keccak256 pc pop dup1 dup2 dup3 dup4 dup5 dup6 dup7 dup8 dup9 dup10 dup11 dup12 dup13 dup14 dup15 dup16 swap1 swap2 swap3 swap4 swap5 swap6 swap7 swap8 swap9 swap10 swap11 swap12 swap13 swap14 swap15 swap16 mload mstore mstore8 sload sstore msize gas address balance selfbalance caller callvalue calldataload calldatasize calldatacopy codesize codecopy extcodesize extcodecopy returndatasize returndatacopy extcodehash create create2 call callcode delegatecall staticcall log0 log1 log2 log3 log4 chainid origin gasprice basefee blockhash coinbase timestamp number difficulty gaslimit",
-literal:"true false"},i={className:"string",
-begin:/\bhex'(([0-9a-fA-F]{2}_?)*[0-9a-fA-F]{2})?'/},t={className:"string",
-begin:/\bhex"(([0-9a-fA-F]{2}_?)*[0-9a-fA-F]{2})?"/};function r(e){
-return e.inherit(e.APOS_STRING_MODE,{begin:/(\bunicode)?'/})}function l(e){
-return e.inherit(e.QUOTE_STRING_MODE,{begin:/(\bunicode)?"/})}var o={
-SOL_ASSEMBLY_KEYWORDS:n,baseAssembly:e=>{
-var a=r(e),o=l(e),c=/[A-Za-z_$][A-Za-z_$0-9.]*/,d=e.inherit(e.TITLE_MODE,{
-begin:/[A-Za-z$_][0-9A-Za-z$_]*/,lexemes:c,keywords:n}),u={className:"params",
-begin:/\(/,end:/\)/,excludeBegin:!0,excludeEnd:!0,lexemes:c,keywords:n,
-contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,a,o,s]},_={
-className:"operator",begin:/:=|->/};return{keywords:n,lexemes:c,
-contains:[a,o,i,t,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,s,_,{
-className:"function",lexemes:c,beginKeywords:"function",end:"{",excludeEnd:!0,
-contains:[d,u,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,_]}]}},
-solAposStringMode:r,solQuoteStringMode:l,HEX_APOS_STRING_MODE:i,
-HEX_QUOTE_STRING_MODE:t,SOL_NUMBER:s,isNegativeLookbehindAvailable:e}
-;const{baseAssembly:c,solAposStringMode:d,solQuoteStringMode:u,HEX_APOS_STRING_MODE:_,HEX_QUOTE_STRING_MODE:m,SOL_NUMBER:b,isNegativeLookbehindAvailable:E}=o
-;return e=>{for(var a=d(e),s=u(e),n=[],i=0;i<32;i++)n[i]=i+1
-;var t=n.map((e=>8*e)),r=[];for(i=0;i<=80;i++)r[i]=i
-;var l=n.map((e=>"bytes"+e)).join(" ")+" ",o=t.map((e=>"uint"+e)).join(" ")+" ",g=t.map((e=>"int"+e)).join(" ")+" ",M=[].concat.apply([],t.map((e=>r.map((a=>e+"x"+a))))),p={
-keyword:"var bool string int uint "+g+o+"byte bytes "+l+"fixed ufixed "+M.map((e=>"fixed"+e)).join(" ")+" "+M.map((e=>"ufixed"+e)).join(" ")+" enum struct mapping address new delete if else for while continue break return throw emit try catch revert unchecked _ function modifier event constructor fallback receive error virtual override constant immutable anonymous indexed storage memory calldata external public internal payable pure view private returns import from as using pragma contract interface library is abstract type assembly",
-literal:"true false wei gwei szabo finney ether seconds minutes hours days weeks years",
-built_in:"self this super selfdestruct suicide now msg block tx abi blockhash gasleft assert require Error Panic sha3 sha256 keccak256 ripemd160 ecrecover addmod mulmod log0 log1 log2 log3 log4"
-},O={className:"operator",begin:/[+\-!~*\/%<>&^|=]/
-},C=/[A-Za-z_$][A-Za-z_$0-9]*/,N={className:"params",begin:/\(/,end:/\)/,
-excludeBegin:!0,excludeEnd:!0,lexemes:C,keywords:p,
-contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,a,s,b,"self"]},f={
-begin:/\.\s*/,end:/[^A-Za-z0-9$_\.]/,excludeBegin:!0,excludeEnd:!0,keywords:{
-built_in:"gas value selector address length push pop send transfer call callcode delegatecall staticcall balance code codehash wrap unwrap name creationCode runtimeCode interfaceId min max"
-},relevance:2},y=e.inherit(e.TITLE_MODE,{begin:/[A-Za-z$_][0-9A-Za-z$_]*/,
-lexemes:C,keywords:p}),w={className:"built_in",
-begin:(E()?"(?<!\\$)\\b":"\\b")+"(gas|value|salt)(?=:)"};function x(e,a){return{
-begin:(E()?"(?<!\\$)\\b":"\\b")+e+"\\.\\s*",end:/[^A-Za-z0-9$_\.]/,
-excludeBegin:!1,excludeEnd:!0,lexemes:C,keywords:{built_in:e+" "+a},
-contains:[f],relevance:10}}var h=c(e),v=e.inherit(h,{
-contains:h.contains.concat([{begin:/\./,end:/[^A-Za-z0-9$.]/,excludeBegin:!0,
-excludeEnd:!0,keywords:{built_in:"slot offset length address selector"},
-relevance:2},{begin:/_/,end:/[^A-Za-z0-9$.]/,excludeBegin:!0,excludeEnd:!0,
-keywords:{built_in:"slot offset"},relevance:2}])});return{aliases:["sol"],
-keywords:p,lexemes:C,
-contains:[a,s,_,m,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,b,w,O,{
-className:"function",lexemes:C,
-beginKeywords:"function modifier event constructor fallback receive error",
-end:/[{;]/,excludeEnd:!0,
-contains:[y,N,w,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE],illegal:/%/
-},x("msg","gas value data sender sig"),x("block","blockhash coinbase difficulty gaslimit basefee number timestamp chainid"),x("tx","gasprice origin"),x("abi","decode encode encodePacked encodeWithSelector encodeWithSignature encodeCall"),x("bytes","concat"),f,{
-className:"class",lexemes:C,beginKeywords:"contract interface library",end:"{",
-excludeEnd:!0,illegal:/[:"\[\]]/,contains:[{beginKeywords:"is",lexemes:C
-},y,N,w,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},{lexemes:C,
-beginKeywords:"struct enum",end:"{",excludeEnd:!0,illegal:/[:"\[\]]/,
-contains:[y,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE]},{
-beginKeywords:"import",end:";",lexemes:C,keywords:"import from as",
-contains:[y,a,s,_,m,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,O]},{
-beginKeywords:"using",end:";",lexemes:C,keywords:"using for",
-contains:[y,e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,O]},{className:"meta",
-beginKeywords:"pragma",end:";",lexemes:C,keywords:{
-keyword:"pragma solidity experimental abicoder",
-built_in:"ABIEncoderV2 SMTChecker v1 v2"},
-contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,e.inherit(a,{
-className:"meta-string"}),e.inherit(s,{className:"meta-string"})]},{
-beginKeywords:"assembly",end:/\b\B/,
-contains:[e.C_LINE_COMMENT_MODE,e.C_BLOCK_COMMENT_MODE,e.inherit(v,{begin:"{",
-end:"}",endsParent:!0,contains:v.contains.concat([e.inherit(v,{begin:"{",
-end:"}",contains:v.contains.concat(["self"])})])})]}],illegal:/#/}}})());
-
-// Ugly hack to reload HLJS
-hljs.initHighlightingOnLoad();

package/docs/src/README.md

@@ -1,185 +0,0 @@
-# Revnet Core
-
-Deploy and operate Revnets: unowned Juicebox projects that run autonomously according to predefined stages, with built-in token-collateralized loans.
-
-[Docs](https://docs.juicebox.money) | [Discord](https://discord.gg/nT3XqbzNEr)
-
-## What is a Revnet?
-
-A Revnet is a treasury-backed token that runs itself. No owners, no governors, no multisigs. Once deployed, a revnet follows its predefined stages forever, backed by the Juicebox and Uniswap protocols.
-
-## Conceptual Overview
-
-Revnets are autonomous Juicebox projects with predetermined economic stages. Each stage defines issuance rates, decay schedules, cash-out taxes, reserved splits, and auto-issuance allocations. Once deployed, these parameters cannot be changed -- the revnet operates on its own forever.
-
-### Stage-Based Lifecycle
-
-```
-1. Deploy revnet with stage configurations
-   → REVDeployer.deployFor(revnetId=0, config, terminals, ...)
-   → Creates Juicebox project owned by REVDeployer (permanently)
-   → Deploys ERC-20 token, configures buyback pools, deploys suckers
-   |
-2. Stage 1 begins (startsAtOrAfter or block.timestamp)
-   → Tokens issued at initialIssuance rate per unit of base currency
-   → Issuance decays by issuanceCutPercent every issuanceCutFrequency
-   → splitPercent of new tokens go to reserved splits
-   → Cash outs taxed at cashOutTaxRate (2.5% fee to fee revnet)
-   |
-3. Stage transitions happen automatically
-   → When startsAtOrAfter timestamp is reached for next stage
-   → New issuance rate, tax rate, splits, etc. take effect
-   → No governance, no votes, no owner action required
-   |
-4. Participants can borrow against their tokens
-   → REVLoans.borrowFrom(revnetId, source, collateral, ...)
-   → Collateral tokens are burned, funds pulled from treasury
-   → Loan is an ERC-721 NFT, liquidates after 10 years
-   |
-5. Ongoing operations (permissionless or split operator)
-   → Auto-issuance claims (permissionless)
-   → Buyback pool configuration (split operator)
-   → Sucker deployment (split operator, if ruleset allows)
-   → Split group updates (split operator)
-```
-
-### Token-Collateralized Loans
-
-`REVLoans` lets participants borrow against their revnet tokens. Unlike traditional lending:
-
-- **Collateral is burned, not held.** Tokens are destroyed on borrow and re-minted on repay. This keeps the token supply accurate -- collateral tokens don't exist during the loan.
-- **Borrowable amount = cash-out value.** The bonding curve determines how much you can borrow for a given amount of collateral.
-- **Prepaid fee model.** Borrowers choose a prepaid fee (2.5%-50%) that buys an interest-free window. After that window, a time-proportional source fee accrues.
-- **Each loan is an ERC-721 NFT.** Loans can be transferred, and expired loans (10 years) can be liquidated by anyone.
-
-### Deployer Variants
-
-- **Basic revnet** -- `deployFor` with stage configurations mapped to Juicebox rulesets.
-- **Tiered 721 revnet** -- `deployWith721sFor` adds a tiered 721 pay hook that mints NFTs as people pay.
-- **Croptop revnet** -- A tiered 721 revnet with Croptop posting criteria, allowing the public to post content.
-
-## Architecture
-
-| Contract | Description |
-|----------|-------------|
-| `REVDeployer` | Deploys revnets as Juicebox projects owned by the deployer contract itself (no human owner). Translates stage configurations into Juicebox rulesets, manages buyback hooks, tiered 721 hooks, suckers, split operators, auto-issuance, and cash-out fees. Acts as the ruleset data hook and cash-out hook for every revnet it deploys. |
-| `REVLoans` | Lets participants borrow against their revnet tokens. Collateral tokens are burned on borrow and re-minted on repayment. Each loan is an ERC-721 NFT. Charges a prepaid fee (2.5% min, 50% max) that determines the interest-free duration; after that window, a time-proportional source fee accrues. Loans liquidate after 10 years. |
-
-### How They Relate
-
-`REVDeployer` owns every revnet's Juicebox project NFT and holds all administrative permissions. During deployment it grants `REVLoans` the `USE_ALLOWANCE` permission so loans can pull funds from the revnet's terminal. `REVLoans` verifies that a revnet was deployed by its expected `REVDeployer` before issuing any loan.
-
-### Interfaces
-
-| Interface | Description |
-|-----------|-------------|
-| `IREVDeployer` | Deployment, data hooks, auto-issuance, split operator management, sucker deployment, plus events. |
-| `IREVLoans` | Borrow, repay, refinance, liquidate, views, plus events. |
-
-## Install
-
-```bash
-npm install @rev-net/core-v6
-```
-
-If using Forge directly:
-
-```bash
-npm install && forge install
-```
-
-If `forge install` has issues, try `git submodule update --init --recursive`.
-
-## Develop
-
-| Command | Description |
-|---------|-------------|
-| `forge build` | Compile contracts |
-| `forge test` | Run tests (20+ test files covering deployment, lifecycle, loans, attacks, invariants) |
-| `forge test -vvvv` | Run tests with full traces |
-
-## Repository Layout
-
-```
-src/
-  REVDeployer.sol                                # Revnet deployer + data hook (~1,256 lines)
-  REVLoans.sol                                   # Token-collateralized lending (~1,333 lines)
-  interfaces/
-    IREVDeployer.sol                             # Deployer interface + events
-    IREVLoans.sol                                # Loans interface + events
-  structs/
-    REVConfig.sol                                # Top-level deployment config
-    REVDescription.sol                           # ERC-20 metadata (name, ticker, uri, salt)
-    REVStageConfig.sol                           # Economic stage parameters
-    REVAutoIssuance.sol                          # Per-stage cross-chain premint
-    REVLoan.sol                                  # Loan state
-    REVLoanSource.sol                            # Terminal + token pair for loans
-    REVDeploy721TiersHookConfig.sol              # 721 hook deployment config
-    REVCroptopAllowedPost.sol                    # Croptop posting criteria
-    REVSuckerDeploymentConfig.sol                # Cross-chain sucker deployment
-test/
-  REV.integrations.t.sol                         # Deployment, payments, cash-outs
-  REVLifecycle.t.sol                             # Stage transitions, weight decay
-  REVAutoIssuanceFuzz.t.sol                      # Auto-issuance fuzz tests
-  REVInvincibility.t.sol                         # Economic property fuzzing
-  REVInvincibilityHandler.sol                    # Fuzz handler
-  REVDeployerRegressions.t.sol                   # Deployer regressions
-  REVLoansSourced.t.sol                          # Multi-source loan tests
-  REVLoansUnSourced.t.sol                        # Loan error cases
-  REVLoansFeeRecovery.t.sol                      # Fee calculation tests
-  REVLoansAttacks.t.sol                          # Flash loan, reentrancy scenarios
-  REVLoans.invariants.t.sol                      # Loan fuzzing invariants
-  REVLoansRegressions.t.sol                      # Loan regressions
-  TestPR09-32_*.t.sol                            # Per-PR regression tests
-  helpers/
-    MaliciousContracts.sol                       # Attack contract mocks
-  mock/
-    MockBuybackDataHook.sol                      # Mock for buyback hook tests
-script/
-  Deploy.s.sol                                   # Sphinx multi-chain deployment
-  helpers/
-    RevnetCoreDeploymentLib.sol                  # Deployment artifact reader
-```
-
-## Permissions
-
-### Split Operator (per-revnet)
-
-The split operator has these default permissions:
-
-| Permission | Purpose |
-|------------|---------|
-| `SET_SPLIT_GROUPS` | Change reserved token splits |
-| `SET_BUYBACK_POOL` | Configure Uniswap buyback pool |
-| `SET_BUYBACK_TWAP` | Adjust TWAP window for buyback |
-| `SET_PROJECT_URI` | Update project metadata |
-| `ADD_PRICE_FEED` | Add price oracle |
-| `SUCKER_SAFETY` | Emergency sucker functions |
-| `SET_BUYBACK_HOOK` | Swap buyback hook |
-| `SET_ROUTER_TERMINAL` | Swap terminal |
-
-Plus optional from 721 hook config: `ADJUST_721_TIERS`, `SET_721_METADATA`, `MINT_721`, `SET_721_DISCOUNT_PERCENT`.
-
-### Global Permissions
-
-| Grantee | Permission | Scope |
-|---------|------------|-------|
-| `SUCKER_REGISTRY` | `MAP_SUCKER_TOKEN` | All revnets (wildcard projectId=0) |
-| `REVLoans` | `USE_ALLOWANCE` | All revnets (wildcard projectId=0) |
-
-### Permissionless Operations
-
-- `autoIssueFor` -- claim auto-issuance tokens (anyone)
-- `burnHeldTokensOf` -- burn reserved tokens held by deployer (anyone)
-
-## Risks
-
-- **No human owner.** `REVDeployer` permanently holds the project NFT. There is no function to release it. This is by design -- revnets are ownerless. But it means bugs in stage configurations cannot be fixed after deployment.
-- **Loan flash-loan exposure.** `borrowableAmountFrom` reads live surplus, which can be inflated via flash loans. A borrower could temporarily inflate the treasury to borrow more than the sustained value would support.
-- **uint112 truncation.** `REVLoan.amount` and `REVLoan.collateral` are `uint112` -- values above ~5.19e33 truncate silently.
-- **Cash-out fee stacking.** Cash outs incur both the Juicebox terminal fee (2.5%) and the revnet cash-out fee (2.5% to fee revnet). These compound.
-- **Auto-issuance stage ID mismatch.** Stage IDs are computed as `block.timestamp + i` during deployment, but actual Juicebox ruleset IDs depend on queuing logic. If timestamps don't align, auto-issuance for later stages may be unclaimed.
-- **NATIVE_TOKEN on non-ETH chains.** Using `JBConstants.NATIVE_TOKEN` on Celo or Polygon means CELO/MATIC, not ETH. Use ERC-20 WETH instead. The matching hash does NOT catch this -- it covers economic parameters but NOT terminal configurations.
-- **30-day cash-out delay.** When deploying an existing revnet to a new chain where the first stage has already started, a 30-day delay is imposed before cash outs are allowed, preventing cross-chain liquidity arbitrage.
-- **Loan source array growth.** `_loanSourcesOf[revnetId]` is unbounded. If an attacker creates loans from many different terminals/tokens, the array grows without limit.
-- **10-year loan liquidation.** Expired loans (10+ years) can be liquidated by anyone. The burned collateral is permanently lost -- it was destroyed at borrow time.

package/docs/src/SUMMARY.md

@@ -1,18 +0,0 @@
-# Summary
-- [Home](README.md)
-# src
-  - [❱ interfaces](src/interfaces/README.md)
-    - [IREVDeployer](src/interfaces/IREVDeployer.sol/interface.IREVDeployer.md)
-    - [IREVLoans](src/interfaces/IREVLoans.sol/interface.IREVLoans.md)
-  - [❱ structs](src/structs/README.md)
-    - [REVAutoIssuance](src/structs/REVAutoIssuance.sol/struct.REVAutoIssuance.md)
-    - [REVConfig](src/structs/REVConfig.sol/struct.REVConfig.md)
-    - [REVCroptopAllowedPost](src/structs/REVCroptopAllowedPost.sol/struct.REVCroptopAllowedPost.md)
-    - [REVDeploy721TiersHookConfig](src/structs/REVDeploy721TiersHookConfig.sol/struct.REVDeploy721TiersHookConfig.md)
-    - [REVDescription](src/structs/REVDescription.sol/struct.REVDescription.md)
-    - [REVLoan](src/structs/REVLoan.sol/struct.REVLoan.md)
-    - [REVLoanSource](src/structs/REVLoanSource.sol/struct.REVLoanSource.md)
-    - [REVStageConfig](src/structs/REVStageConfig.sol/struct.REVStageConfig.md)
-    - [REVSuckerDeploymentConfig](src/structs/REVSuckerDeploymentConfig.sol/struct.REVSuckerDeploymentConfig.md)
-  - [REVDeployer](src/REVDeployer.sol/contract.REVDeployer.md)
-  - [REVLoans](src/REVLoans.sol/contract.REVLoans.md)

package/docs/src/src/README.md

@@ -1,7 +0,0 @@
-
-
-# Contents
-- [interfaces](/src/interfaces)
-- [structs](/src/structs)
-- [REVDeployer](REVDeployer.sol/contract.REVDeployer.md)
-- [REVLoans](REVLoans.sol/contract.REVLoans.md)