Release 2.0: Major Feature Additions, Security Enhancements, and Infrastructure Improvements

.github/workflows/test.yml

@@ -34,12 +34,6 @@ jobs:
           ls -la
           cat foundry.toml
 
-      - name: Install dependencies
-        run: |
-          # Install OpenZeppelin contracts version 5.3.0
-          forge install OpenZeppelin/openzeppelin-contracts@v5.3.0
-          ls -la lib/
-
       - name: Run Forge build
         run: |
           forge remappings

.gitignore

@@ -1,4 +1,5 @@
 node_modules
+/lib
 .env
 .deps
 .temp

.gitmodules

@@ -4,3 +4,6 @@
 [submodule "lib/openzeppelin-contracts"]
 	path = lib/openzeppelin-contracts
 	url = https://github.com/OpenZeppelin/openzeppelin-contracts
+[submodule "lib/openzeppelin-contracts-upgradeable"]
+	path = lib/openzeppelin-contracts-upgradeable
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable

README.md

@@ -1,28 +1,32 @@
-# Creative Crowdfunding Protocol (CC Protocol) Smart Contracts
+# Oak Network Smart Contracts
 
 ## Overview
 
-CC Protocol is a decentralized crowdfunding protocol designed to help creators launch and manage campaigns across multiple platforms. By providing a standardized infrastructure, the protocol simplifies the process of creating, funding, and managing crowdfunding initiatives in web3 across different platforms.
+Oak Network is a decentralized crowdfunding protocol designed to help creators launch and manage campaigns across multiple platforms. By providing a standardized infrastructure, the protocol simplifies the process of creating, funding, and managing crowdfunding initiatives in web3 across different platforms.
 
 ## Features
 
 - Cross-listable campaign creation
 - Multiple treasury models
 - Secure fund management
 - Customizable protocol parameters
+- Currency-based multi-token campaigns
+- Campaign-level Pledge NFTs (one ERC721 collection per campaign)
+- ERC-2771 meta-transactions for platform admin operations using multisig wallets
+- UUPS upgradeability for core protocol contracts
 
 ## Prerequisites
 
 - [Foundry](https://book.getfoundry.sh/)
-- Solidity ^0.8.20
+- Solidity ^0.8.22
 
 ## Installation
 
 1. Clone the repository:
 
 ```bash
-git clone https://github.com/ccprotocol/ccprotocol-contracts.git
-cd ccprotocol-contracts
+git clone https://github.com/oak-network/contracts.git
+cd contracts
 ```
 
 2. Install dependencies:
@@ -94,6 +98,18 @@ forge script script/DeployAll.s.sol:DeployAll --rpc-url http://localhost:8545 --
 forge script script/DeployAll.s.sol:DeployAll --rpc-url $RPC_URL --private-key $PRIVATE_KEY --broadcast
 ```
 
+#### Deploy core + setup a specific treasury model
+
+If you want a one-shot script that deploys the protocol (UUPS proxies), configures `GlobalParams`, and registers + approves a treasury implementation for a platform, you can run one of the `DeployAllAndSetup*.s.sol` scripts.
+
+```bash
+# Example: deploy and setup PaymentTreasury
+forge script script/DeployAllAndSetupPaymentTreasury.s.sol:DeployAllAndSetupPaymentTreasury \
+  --rpc-url $RPC_URL --private-key $PRIVATE_KEY --broadcast
+```
+
+> These scripts read configuration from `.env` (e.g. `PLATFORM_NAME`, `PROTOCOL_FEE_PERCENT`, `PLATFORM_FEE_PERCENT`, `CURRENCIES`/`TOKENS_PER_CURRENCY`, and optional `PLATFORM_ADAPTER_ADDRESS` for meta-txs).
+
 ## Contract Architecture
 
 ### Core Contracts
@@ -105,6 +121,9 @@ forge script script/DeployAll.s.sol:DeployAll --rpc-url $RPC_URL --private-key $
 ### Treasury Models
 
 - `AllOrNothing`: Funds refunded if campaign goal not met
+- `KeepWhatsRaised`: Flexible treasury that keeps funds regardless of goal achievement (tips, configurable fees, withdrawal gating)
+- `PaymentTreasury`: Payment-style treasury (off-chain payment creation + on-chain confirmation, line items, optional NFT mint)
+- `TimeConstrainedPaymentTreasury`: PaymentTreasury variant gated by `launchTime → deadline + bufferTime`
 
 ### Notes on Mock Contracts
 
@@ -113,9 +132,13 @@ forge script script/DeployAll.s.sol:DeployAll --rpc-url $RPC_URL --private-key $
 
 ## Deployment Workflow
 
-1. Deploy `GlobalParams`
-2. Deploy `TreasuryFactory`
-3. Deploy `CampaignInfoFactory`
+At a high level:
+
+1. Deploy `GlobalParams` (UUPS proxy + implementation)
+2. Deploy `TreasuryFactory` (UUPS proxy + implementation)
+3. Deploy `CampaignInfoFactory` (UUPS proxy + implementation)
+4. Configure currencies/tokens + data registry keys + platforms (and optional platform adapters)
+5. Register and approve treasury implementations per platform, then deploy treasuries per campaign
 
 > For local testing or development, the `TestToken` mock token needs to be deployed before interacting with contracts requiring an ERC20 token.
 
@@ -130,6 +153,8 @@ Key environment variables to configure in `.env`:
 
 For a complete list of variables, refer to `.env.example`.
 
+> Tip: `script/` contains deployment, setup, and upgrade scripts for each treasury type (including UUPS upgrade scripts).
+
 ## Security
 
 ### Audits
@@ -138,7 +163,7 @@ Security audit reports can be found in the [`audits/`](./audits/) folder. We reg
 
 ## Contributing
 
-We welcome all contributions to the Creative Crowdfunding Protocol. If you're interested in helping, here's how you can contribute:
+We welcome all contributions to the Oak Network. If you're interested in helping, here's how you can contribute:
 
 - **Report bugs** by opening issues
 - **Suggest enhancements** or new features
@@ -154,18 +179,18 @@ Before contributing, please read our detailed [Contributing Guidelines](./CONTRI
 
 ### Community
 
-Join our community on [Discord](https://discord.gg/4tR9rWc3QE) for questions and discussions.
+Join our community on [Discord](https://discord.gg/tnBhVxSDDS) for questions and discussions.
 
 Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectful.
 
 ## Contributors
 
-<a href="https://github.com/ccprotocol/ccprotocol-contracts/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=ccprotocol/ccprotocol-contracts" />
+<a href="https://github.com/oak-network/contracts/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=oak-network/contracts" />
 </a>
 
 Made with [contrib.rocks](https://contrib.rocks).
 
 ## License
 
-This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
+This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).

docs/book.toml

@@ -7,7 +7,7 @@ no-section-label = true
 additional-js = ["solidity.min.js"]
 additional-css = ["book.css"]
 mathjax-support = true
-git-repository-url = "https://github.com/ccprotocol/ccprotocol-contracts"
+git-repository-url = "https://github.com/oak-network/contracts"
 
 [output.html.fold]
 enable = true

docs/src/README.md

@@ -1,8 +1,8 @@
-# Creative Crowdfunding Protocol (CC Protocol) Smart Contracts
+# Oak Network Smart Contracts
 
 ## Overview
 
-CC Protocol is a decentralized crowdfunding protocol designed to help creators launch and manage campaigns across multiple platforms. By providing a standardized infrastructure, the protocol simplifies the process of creating, funding, and managing crowdfunding initiatives in web3 across different platforms.
+Oak Network is a decentralized crowdfunding protocol designed to help creators launch and manage campaigns across multiple platforms. By providing a standardized infrastructure, the protocol simplifies the process of creating, funding, and managing crowdfunding initiatives in web3 across different platforms.
 
 ## Features
 
@@ -21,8 +21,8 @@ CC Protocol is a decentralized crowdfunding protocol designed to help creators l
 1. Clone the repository:
 
 ```bash
-git clone https://github.com/ccprotocol/ccprotocol-contracts.git
-cd ccprotocol-contracts
+git clone https://github.com/oak-network/contracts.git
+cd contracts
 ```
 
 2. Install dependencies:
@@ -138,7 +138,7 @@ Security audit reports can be found in the [`audits/`](./audits/) folder. We reg
 
 ## Contributing
 
-We welcome all contributions to the Creative Crowdfunding Protocol. If you're interested in helping, here's how you can contribute:
+We welcome all contributions to the Oak Network. If you're interested in helping, here's how you can contribute:
 
 - **Report bugs** by opening issues
 - **Suggest enhancements** or new features
@@ -154,18 +154,18 @@ Before contributing, please read our detailed [Contributing Guidelines](./CONTRI
 
 ### Community
 
-Join our community on [Discord](https://discord.gg/4tR9rWc3QE) for questions and discussions.
+Join our community on [Discord](https://discord.gg/tnBhVxSDDS) for questions and discussions.
 
 Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectful.
 
 ## Contributors
 
-<a href="https://github.com/ccprotocol/ccprotocol-contracts/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=ccprotocol/ccprotocol-contracts" />
+<a href="https://github.com/oak-network/contracts/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=oak-network/contracts" />
 </a>
 
 Made with [contrib.rocks](https://contrib.rocks).
 
 ## License
 
-This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
+This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).

docs/src/SUMMARY.md

@@ -1,25 +1,38 @@
 # Summary
 - [Home](README.md)
 # src
+  - [❱ constants](src/constants/README.md)
+    - [DataRegistryKeys](src/constants/DataRegistryKeys.sol/library.DataRegistryKeys.md)
   - [❱ interfaces](src/interfaces/README.md)
     - [ICampaignData](src/interfaces/ICampaignData.sol/interface.ICampaignData.md)
     - [ICampaignInfo](src/interfaces/ICampaignInfo.sol/interface.ICampaignInfo.md)
     - [ICampaignInfoFactory](src/interfaces/ICampaignInfoFactory.sol/interface.ICampaignInfoFactory.md)
+    - [ICampaignPaymentTreasury](src/interfaces/ICampaignPaymentTreasury.sol/interface.ICampaignPaymentTreasury.md)
     - [ICampaignTreasury](src/interfaces/ICampaignTreasury.sol/interface.ICampaignTreasury.md)
     - [IGlobalParams](src/interfaces/IGlobalParams.sol/interface.IGlobalParams.md)
     - [IItem](src/interfaces/IItem.sol/interface.IItem.md)
     - [IReward](src/interfaces/IReward.sol/interface.IReward.md)
     - [ITreasuryFactory](src/interfaces/ITreasuryFactory.sol/interface.ITreasuryFactory.md)
+  - [❱ storage](src/storage/README.md)
+    - [AdminAccessCheckerStorage](src/storage/AdminAccessCheckerStorage.sol/library.AdminAccessCheckerStorage.md)
+    - [CampaignInfoFactoryStorage](src/storage/CampaignInfoFactoryStorage.sol/library.CampaignInfoFactoryStorage.md)
+    - [GlobalParamsStorage](src/storage/GlobalParamsStorage.sol/library.GlobalParamsStorage.md)
+    - [TreasuryFactoryStorage](src/storage/TreasuryFactoryStorage.sol/library.TreasuryFactoryStorage.md)
   - [❱ treasuries](src/treasuries/README.md)
     - [AllOrNothing](src/treasuries/AllOrNothing.sol/contract.AllOrNothing.md)
+    - [KeepWhatsRaised](src/treasuries/KeepWhatsRaised.sol/contract.KeepWhatsRaised.md)
+    - [PaymentTreasury](src/treasuries/PaymentTreasury.sol/contract.PaymentTreasury.md)
+    - [TimeConstrainedPaymentTreasury](src/treasuries/TimeConstrainedPaymentTreasury.sol/contract.TimeConstrainedPaymentTreasury.md)
   - [❱ utils](src/utils/README.md)
     - [AdminAccessChecker](src/utils/AdminAccessChecker.sol/abstract.AdminAccessChecker.md)
+    - [BasePaymentTreasury](src/utils/BasePaymentTreasury.sol/abstract.BasePaymentTreasury.md)
     - [BaseTreasury](src/utils/BaseTreasury.sol/abstract.BaseTreasury.md)
     - [CampaignAccessChecker](src/utils/CampaignAccessChecker.sol/abstract.CampaignAccessChecker.md)
     - [Counters](src/utils/Counters.sol/library.Counters.md)
     - [FiatEnabled](src/utils/FiatEnabled.sol/abstract.FiatEnabled.md)
     - [ItemRegistry](src/utils/ItemRegistry.sol/contract.ItemRegistry.md)
     - [PausableCancellable](src/utils/PausableCancellable.sol/abstract.PausableCancellable.md)
+    - [PledgeNFT](src/utils/PledgeNFT.sol/abstract.PledgeNFT.md)
     - [TimestampChecker](src/utils/TimestampChecker.sol/abstract.TimestampChecker.md)
   - [CampaignInfo](src/CampaignInfo.sol/contract.CampaignInfo.md)
   - [CampaignInfoFactory](src/CampaignInfoFactory.sol/contract.CampaignInfoFactory.md)