feat: vault bridge v1.1.0

.env.example

@@ -1,5 +1 @@
-API_KEY=
-INFURA_KEY=
-POLYGONSCAN_API_KEY=
-TATARA_TOKEN=
-KATANA_TOKEN=
+ETHERSCAN_API_KEY=

.github/workflows/certora.yml → .github/workflows/certora.yml.outdated

@@ -19,7 +19,7 @@ env:
     certora/confs/GenericVaultBridgeToken.conf --verify GenericVaultBridgeToken:certora/specs/GVBTBalances.spec
     certora/confs/GenericVaultBridgeToken.conf --verify GenericVaultBridgeToken:certora/specs/tokenMockBalances.spec
     certora/confs/GenericNativeConverter.conf
-    certora/confs/MigrationManager-generic.conf --rule onMsgReceived_doesntAlwaysRevert
+    certora/confs/base/MigrationManager.conf --rule onMsgReceived_doesntAlwaysRevert
 jobs:
   check:
     runs-on: ubuntu-latest
@@ -52,6 +52,9 @@ jobs:
           git checkout v10.1.0-rc.1
           npm install
 
+      - name: Certora munge
+        run: ./certora/scripts/munge.sh
+
       - name: run configs
         uses: Certora/certora-run-action@v2
         with:

.github/workflows/test.yml

@@ -29,14 +29,13 @@ jobs:
         run: |
           forge --version
 
-      - name: Run Forge fmt
-        run: |
-          forge fmt --check
-        id: fmt
+      # - name: Run Forge fmt
+      #   run: |
+      #     forge fmt --check
+      #   id: fmt
 
       - name: Run Forge build
         run: |
-          forge --version
           forge soldeer install
           forge build --sizes
         id: build
@@ -54,6 +53,4 @@ jobs:
         run: |
           npm install
           forge test --no-match-contract "Generic" -vvv
-        env:
-          TATARA_TOKEN: ${{ secrets.TATARA_TOKEN }}
         id: test

README.md

@@ -1,89 +1,142 @@
-> [!IMPORTANT]
-> You are viewing a development version of the codebase.
+<div align="center">
 
 # Vault Bridge
 
-Vault Bridge Token is the core of the Vault Bridge protocol. Built from the ground up to be reusable, it offers full Vault Bridge functionality out of the box, allowing you to create vbTokens in just a few lines of code.
+**[⛓️ Deployments](#deployments)**
+**&nbsp;&nbsp; [📙 Documentation](#documentation)**
+**&nbsp;&nbsp; [🧭 Website](https://www.agglayer.dev/agglayer-vaultbridge)**
+**&nbsp;&nbsp; [🦙 DefiLlama](https://defillama.com/protocol/vault-bridge)**
+
+</div>
+
+## Contents
+
+- [Contents](#contents)
+- [Overview](#overview)
+  - [TL;DR](#tldr)
+  - [Vault Bridge Token](#vault-bridge-token)
+  - [Migration Manager](#migration-manager)
+  - [Custom Token](#custom-token)
+  - [Native Converter](#native-converter)
+- [Get Started](#get-started)
+- [Documentation](#documentation)
+- [Deployments](#deployments)
+- [Usage](#usage)
+- [License](#license)
 
 ## Overview
 
-The Vault Bridge protocol is comprised of:
+> [!NOTE]
+> This section should be updated, as Vault Bridge has evolved into a larger protocol.
+
+Vault Bridge enables chains and apps to generate native yield on TVL by putting bridged assets to work.
+
+The protocol is comprised of:
+
+- One Primary Chain
+  - [Vault Bridge Token](#vault-bridge-token)
+  - [Migration Manager](#migration-manager)
+- Many Secondary Chains
+  - [Custom Token](#custom-token)
+  - [Native Converter](#native-converter)
+
+### TL;DR
+
+Select assets are bridged from Primary Chain to Secondary Chain. These assets are deposited into Vault Bridge Token contract on Primary Chain, which mints and bridges vbToken to Secondary Chain. Deposited assets are used to generate yield on Primary Chain, while bridged vbTokens are used in DeFi on Secondary Chain. Generated yield gets distributed to chains and apps participating in the revenue sharing program.
 
-- Layer X (the main network)
-  - [Vault Bridge Token](#vault-bridge-token-)
-  - [Migration Manager (singleton)](#migration-manager-singleton-)
-- Layer Y (other networks)
-  - [Custom Token](#custom-token-)
-  - [Native Converter](#native-converter-)
+Native Converter contract can be deployed on Secondary Chain to enable acquisition of vbToken on Secondary Chain without having to bridge from Primary Chain. Accumulated backing in Native Converter on Secondary Chain gets migrated to Primary Chain and deposited into Vault Bridge Token contract.
 
-### Vault Bridge Token [↗](src/VaultBridgeToken.sol)
+### Vault Bridge Token
 
-A Vault Bridge Token is an
+A Vault Bridge Token is:
 
 - [ERC-20](https://eips.ethereum.org/EIPS/eip-20) token
 - [ERC-4626](https://eips.ethereum.org/EIPS/eip-4626) vault
-- [LxLy Bridge](https://github.com/0xPolygonHermez/zkevm-contracts) extension
+- [Agglayer Bridge](https://github.com/agglayer/agglayer-contracts) extension
 
-enabling bridging of select assets, such as WBTC, WETH, USDT, USDC, and USDS, while producing yield.
+Assets in high demand with available yield strategies, such as WETH and USDC, can get their versions of vbTokens. The underlying asset is deposited into Vault Bridge Token contract, and vbToken is minted in a 1:1 ratio. The same can be withdrawn by burning vbToken. Vault Bridge Token contract doubles a pseudo bridge, so vbToken can be minted and bridged, or claimed and redeemed, in a single call. Deposited underlying assets are put into an external, ERC-4626 compatible vault ("yield vault") where they generate yield. Yield is distributed to chains and apps that participate in the revenue sharing program. Vault Bridge Token contracts also includes functionality that enables minting of vbToken directly on Secondary Chain via Native Converter, with backing migration to Primary Chain via Migration Manager.
 
-### Migration Manager (singleton) [↗](src/MigrationManager.sol)
+### Migration Manager
 
-The Migration Manager is a
+The Migration Manager is:
 
-- [Vault Bridge Token](#vault-bridge-token-) dependency
+- [Vault Bridge Token](#vault-bridge-token) dependency
 
-handling migration of backing from Native Converters.
+vbTokens can be minted directly on Secondary Chain. In order for an underlying asset that backs vbToken minted on Secondary Chain to be deposited in Vault Bridge Token contract on Primary Chain, backing is migrated to Primary Chain via Native Converter and Migration Manager. Migration Manager completes migrations by interacting with Vault Bridge Token contract. All vbTokens share the same Migration Manager contract.
 
-### Custom Token [↗](src/CustomToken.sol)
+### Custom Token
 
-A Custom Token is an
+A Custom Token is:
 
 - [ERC-20](https://eips.ethereum.org/EIPS/eip-20) token
 
-an upgrade for [LxLy Bridge](https://github.com/0xPolygonHermez/zkevm-contracts)'s generic wrapped token.
+Bridged vbToken can be upgraded to Custom Token on Secondary Chain. This enables custom behavior, such as bridged vbETH to integrate WETH9 interface, replacing WETH on Secondary Chain.
 
-### Native Converter [↗](src/NativeConverter.sol)
+### Native Converter
 
-A Native Converter is a
+A Native Converter is:
 
-- pseudo [ERC-4626](https://eips.ethereum.org/EIPS/eip-4626) vault
-- [LxLy Bridge](https://github.com/0xPolygonHermez/zkevm-contracts) extension
+- [Vault Bridge Token](#vault-bridge-token) extension
+- [Agglayer Bridge](https://github.com/agglayer/agglayer-contracts) extension
 
-allowing conversion to, and deconversion of, Custom Token, as well as migration of backing to Vault Bridge Token.
+Native Converter can be deployed on Secondary Chain to enable minting of vbToken directly on Secondary Chain by converting the bridged underlying asset, in a 1:1 ratio. The same can be deconverted to by burning bridged vbToken. Accumulated backing in Native Converter on Secondary Chain can be migrated to Primary Chain to be deposited into Vault Bridge Token contract via Migration Manger. For this reason, liqudity for deconverting to the bridged underlying token on Secondary Chain is guaranteed only up to a certain percentage. Native Converter doubles a bridge extension, so vbToken can be deconverted and bridged in a single call.
+
+## Get Started
+
+> [!NOTE]
+> This section needs to be updated, as the official support for several third-party bridges has been added!
+
+Getting started should be easy as Vault Bridge Token contracts follow the ERC-4626 interface. Variants of the standard ERC-4626 functions include `depositAndBridge` and `claimAndRedeem`. Please see [Documentation](#documentation) for more information.
+
+If your chain is part of Agglayer, you can start using the official vbTokens immediately. Please note that you will get vbToken when bridging, not the underlying token, therefore activity should be incentivized in vbToken. You must participate in the revenue sharing program in order to receive yield. [Contact our team](https://info.polygon.technology/vaultbridge-intake-form) if interested in revenue sharing.
+
+If your chain is not part of Agglayer, you can start using the official vbTokens immediately. Please note that you will need to use a third-party bridge to bridge vbTokens to your chain, and Native Converter functionality will not be supported. You must participate in the revenue sharing program in order to receive yield. [Contact our team](https://info.polygon.technology/vaultbridge-intake-form) if interested in revenue sharing.
+
+Full support for non-Agglayer chains, third-party bridges, as well as non-EVM chains is coming soon. [Contact our team](https://info.polygon.technology/vaultbridge-intake-form) to register interest.
 
 ## Documentation
 
-Please see NatSpec documentation inside of the files.
+> [!NOTE]
+> This section needs to be updated, as some NatSpec is outdated and/or missing.
+
+- [General Documentation](https://docs.agglayer.dev/vault-bridge/get-started/overview/)
+- [Source Code](./src/): The Source Code is 100% documented and you are encouraged to take a reference it.
+  - Pay attention to the following bookmarks:
+    - `@note CAUTION!`
+    - `@note IMPORTANT:`
+    - `@note (ATTENTION)`
+
+## Deployments
 
-Please see `@note` documentation for important information.
+See [`broadcast/README.md`](./broadcast/README.md).
 
 ## Usage
 
-#### Prerequisite
+Clone:
 
 ```
-foundryup
+git clone git@github.com:agglayer/vault-bridge.git
 ```
 
-#### Install
+Install:
 
 ```
 forge soldeer install & npm install
 ```
 
-#### Build
+Build:
 
 ```
 forge build
 ```
 
-#### Test
+Test:
 
 ```
 forge test
 ```
 
-#### Coverage
+Coverage:
 
 ```
 forge coverage --ir-minimum --report lcov && genhtml -o coverage lcov.info
@@ -93,6 +146,6 @@ forge coverage --ir-minimum --report lcov && genhtml -o coverage lcov.info
 
 This codebase is licensed under Source Available License.
 
-See [`LICENSE-SOURCE-AVAILABLE`](https://github.com/agglayer/vault-bridge/blob/main/LICENSE-SOURCE-AVAILABLE).
+See [`LICENSE-SOURCE-AVAILABLE`](./LICENSE-SOURCE-AVAILABLE).
 
 Your use of this software constitutes acceptance of these license terms.