debridge-finance · artyukh · Dec 2, 2021 · Dec 2, 2021 · Dec 2, 2021 · Dec 2, 2021
diff --git a/.gitbook.yaml b/.gitbook.yaml
@@ -0,0 +1,4 @@
+root: ./docs/
+structure:
+    readme: README.md
+    summary: SUMMARY.md
diff --git a/.gitbook/assets/27 (1).jpg b/.gitbook/assets/27 (1).jpg
diff --git a/.gitbook/assets/27.jpg b/.gitbook/assets/27.jpg
diff --git a/.gitbook/assets/3_v2.png b/.gitbook/assets/3_v2.png
diff --git a/.gitbook/assets/A.png b/.gitbook/assets/A.png
diff --git a/.gitbook/assets/B.png b/.gitbook/assets/B.png
diff --git a/.gitbook/assets/Bg1 (1).png b/.gitbook/assets/Bg1 (1).png
diff --git a/.gitbook/assets/Bg1 (2).png b/.gitbook/assets/Bg1 (2).png
diff --git a/.gitbook/assets/Bg1 (3).png b/.gitbook/assets/Bg1 (3).png
diff --git a/.gitbook/assets/C.png b/.gitbook/assets/C.png
diff --git a/.gitbook/assets/Cross-chain.jpg b/.gitbook/assets/Cross-chain.jpg
diff --git a/.gitbook/assets/OracledeBridge (1).png b/.gitbook/assets/OracledeBridge (1).png
diff --git a/.gitbook/assets/OracledeBridge.png b/.gitbook/assets/OracledeBridge.png
diff --git a/.gitbook/assets/TransfersdeBridge (1).png b/.gitbook/assets/TransfersdeBridge (1).png
diff --git a/.gitbook/assets/TransfersdeBridge (2).png b/.gitbook/assets/TransfersdeBridge (2).png
diff --git a/.gitbook/assets/TransfersdeBridge-Copy of Copy of Copy of Page-1 (1).png b/.gitbook/assets/TransfersdeBridge-Copy of Copy of Copy of Page-1 (1).png
diff --git a/.gitbook/assets/TransfersdeBridge-Copy of Copy of Copy of Page-1 (2).png b/.gitbook/assets/TransfersdeBridge-Copy of Copy of Copy of Page-1 (2).png
diff --git a/.gitbook/assets/TransfersdeBridge-Copy of Copy of Copy of Page-1.png b/.gitbook/assets/TransfersdeBridge-Copy of Copy of Copy of Page-1.png
diff --git a/.gitbook/assets/TransfersdeBridge-Copy of Copy of Page-1 (1).png b/.gitbook/assets/TransfersdeBridge-Copy of Copy of Page-1 (1).png
diff --git a/.gitbook/assets/TransfersdeBridge-Copy of Copy of Page-1 (2).png b/.gitbook/assets/TransfersdeBridge-Copy of Copy of Page-1 (2).png
diff --git a/.gitbook/assets/TransfersdeBridge-Copy of Copy of Page-1 (3).png b/.gitbook/assets/TransfersdeBridge-Copy of Copy of Page-1 (3).png
diff --git a/.gitbook/assets/TransfersdeBridge-Copy of Copy of Page-1 (4).png b/.gitbook/assets/TransfersdeBridge-Copy of Copy of Page-1 (4).png
diff --git a/.gitbook/assets/TransfersdeBridge-Copy of Copy of Page-1 (5).png b/.gitbook/assets/TransfersdeBridge-Copy of Copy of Page-1 (5).png
diff --git a/.gitbook/assets/TransfersdeBridge-Copy of Copy of Page-1.png b/.gitbook/assets/TransfersdeBridge-Copy of Copy of Page-1.png
diff --git a/.gitbook/assets/TransfersdeBridge-Copy of Page-1 (1).png b/.gitbook/assets/TransfersdeBridge-Copy of Page-1 (1).png
diff --git a/.gitbook/assets/TransfersdeBridge-Copy of Page-1 (2).png b/.gitbook/assets/TransfersdeBridge-Copy of Page-1 (2).png
diff --git a/.gitbook/assets/TransfersdeBridge-Copy of Page-1.png b/.gitbook/assets/TransfersdeBridge-Copy of Page-1.png
diff --git a/.gitbook/assets/TransfersdeBridge.png b/.gitbook/assets/TransfersdeBridge.png
diff --git a/.gitbook/assets/Untitled Diagram-Fees (1).png b/.gitbook/assets/Untitled Diagram-Fees (1).png
diff --git a/.gitbook/assets/Untitled Diagram-Fees (2).png b/.gitbook/assets/Untitled Diagram-Fees (2).png
diff --git a/.gitbook/assets/Untitled Diagram-Fees.png b/.gitbook/assets/Untitled Diagram-Fees.png
diff --git a/.gitbook/assets/Untitled Diagram-Page-2 (1).png b/.gitbook/assets/Untitled Diagram-Page-2 (1).png
diff --git a/.gitbook/assets/Untitled Diagram-Page-2 (2).png b/.gitbook/assets/Untitled Diagram-Page-2 (2).png
diff --git a/.gitbook/assets/Untitled Diagram-Page-2.png b/.gitbook/assets/Untitled Diagram-Page-2.png
diff --git a/.gitbook/assets/deBridge (1).png b/.gitbook/assets/deBridge (1).png
diff --git a/.gitbook/assets/deBridge.png b/.gitbook/assets/deBridge.png
diff --git a/.gitbook/assets/image (1).png b/.gitbook/assets/image (1).png
diff --git a/.gitbook/assets/image (2).png b/.gitbook/assets/image (2).png
diff --git a/.gitbook/assets/image (3).png b/.gitbook/assets/image (3).png
diff --git a/.gitbook/assets/image (4).png b/.gitbook/assets/image (4).png
diff --git a/.gitbook/assets/image (5).png b/.gitbook/assets/image (5).png
diff --git a/.gitbook/assets/image (6).png b/.gitbook/assets/image (6).png
diff --git a/.gitbook/assets/image (7) (1).png b/.gitbook/assets/image (7) (1).png
diff --git a/.gitbook/assets/image (7).png b/.gitbook/assets/image (7).png
diff --git a/.gitbook/assets/image (8).png b/.gitbook/assets/image (8).png
diff --git a/.gitbook/assets/image.png b/.gitbook/assets/image.png
diff --git a/.gitbook/assets/token2.jpg b/.gitbook/assets/token2.jpg
diff --git a/.github/workflows/pipeline.yml b/.github/workflows/pipeline.yml
@@ -4,9 +4,9 @@ name: Pipeline
 on:
   # Triggers the workflow on push or pull request events but only for the master branch
   push:
-    branches: [ develop ]
+    branches: [ develop, main ]
   pull_request:
-    branches: [ develop ]
+    branches: [ develop, main ]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -59,33 +59,15 @@ jobs:
         steps.cache-yarn-cache.outputs.cache-hit != 'true' ||
         steps.cache-node-modules.outputs.cache-hit != 'true'
 
+   # - name: Check docs are in sync
+   #   run: yarn docs:assert-in-sync
+
     - name: Lint (prettier)
       run: yarn lint:check
       continue-on-error: true
 
-    - name: Test CallProxy
-      run: yarn run hardhat test test/00_CallProxy.test.js
-
-    - name: Test Aggregator
-      run: yarn test test/00_Aggregator.test.js
-
-    - name: Test DeBridge Light
-      run: yarn test test/02_LightDebridge.test.js
-
-    - name: Test DeBridge real transfer pipeline
-      run: yarn test test/05_DebridgePipeline.test.js
-
-    - name: Test PriceConsumer
-      run: yarn test test/06_PriceConsumer.test.js
-
-    - name: Test SignatureAggregator
-      run: yarn test test/07_SignatureAggregator.test.js
-
-    # - name: Test DefiController
-    #   run: yarn test test/DefiController.test.js
-
-    # - name: Test AaveController (AaveInteractor)
-    #   run: yarn test test/AaveController.test.js
+    - name: Test
+      run: yarn test:ci
 
     - name: Tests coverage
       run: yarn coverage

diff --git a/.gitignore b/.gitignore
@@ -12,4 +12,6 @@ coverage/
 yarn-error.log
 /deployments/
 /scripts/proxies.json
-typechain-types/
+typechain-types/
+typechain-types-web3/
+tmp/
diff --git a/LICENSE b/LICENSE
@@ -7,15 +7,15 @@ License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
 
 Parameters
 
-Licensor:             Mongoose Orchestra Limited (BVI Co. No: 2067815)
+Licensor:             DxTech Inc. (Company No.155728732)
 
 Licensed Work:        deBridge V1
-                      The Licensed Work is (c) 2021 Mongoose Orchestra Limited
+                      The Licensed Work is (c) 2021 DxTech Inc.
 
 Additional Use Grant: Any uses listed and defined at
                       v1-license-grants.dbr.eth
 
-Change Date:          The earlier of 31 December 2022 or a date specified at
+Change Date:          The earlier of 31 December 2025 or a date specified at
                       v1-license-date.dbr.eth
 
 Change License:       GNU General Public License v2.0 or later

diff --git a/README.md b/README.md
@@ -1,93 +1,69 @@
-# Debridge Smart Contracts
+<br/>
+<p align="center">
+<a href="https://debridge.finance/" target="_blank">
+<img src="https://github.com/user-attachments/assets/01c30bd5-2a18-470f-9df8-c9ac77a2a4c4" width="225" alt="logo">
+</a>
+</p>
+<br/>
+
+[deBridge](https://debridge.finance/) — cross-chain interoperability
+ and liquidity transfer protocol that allows the truly decentralized transfer of data and assets between various blockchains. deBridge protocol is an infrastructure platform and a hooking service which aims to become a standard for:
+- cross-chain composability of smart contracts
+- cross-chain swaps
+- bridging of any arbitrary asset
+- interoperability and bridging of NFTs
+
+More information about the project can be also found in the [documentation portal](https://docs.debridge.finance/)
+<br/>
+UI deployed on [app.debridge.finance](https://app.debridge.finance/)
 
-# [Complete Documentation https://docs.debridge.finance/](https://docs.debridge.finance/)
+# Debridge Smart Contracts
 
-UI deployed on [testv2.debridge.finance](https://testv2.debridge.finance/)
 
-The contracts directory contains the following subfolders:
+The contracts' directory contains the following subfolders:
 
 ```
 contracts/
-	chainlink/ - related to chainlink integration
 	interfaces/ - contains interfaces of the project contracts
+	libraries/ - libraries created for the project
 	mock/ - contracts for tests
-	oracles/ - related to oracle's stake management
 	periphery/ - periphery contracts
 	transfers/ - related to core cross-chain functionality
 ```
+The detailed methods' description can be found in the contracts themselves or in the [documentation](https://docs.debridge.finance/).
 
-A detailed description of each method of the smart contracts can be found in [documentation portal](https://docs.debridge.finance/smart-contracts/whitedebridge)
-
-The full list of contracts:
-
-- DeBridgeGate
-- AggregatorBase
-- SignatureAggregator
-- ConfirmationAggregator
-- SignatureVerifier
-- DelegatedStaking
-- CallProxy
-- FeeProxy
-- WrappedAsset
-- DefiController
-- Pausable
-
-## Transfers
-
-**DeBridgeGate**
-
-Contract for assets transfers. The user can transfer the asset to any of the approved chains. The admin manages the assets, fees and other important protocol parameters.
-
-The detailed methods description can be found in the contracts themselves.
-
-## Chainlink
-
-**AggregatorBase**
-
-The base contract for Chainlink oracles management. Allows to add/remove oracles, manage the minimal required amount of confirmations and assign oracle admins.
-
-**ConfirmationAggregator**
-
-Extends the **AggregatorBase** with confirmation-related methods; is deployed to the chain with low fees and is used to collect confirmations from oracles.
-
-**SignatureAggregator**
-
-Extends the **AggregatorBase** with confirmation-related methods; is deployed to the chain with low fees and is used to collect signatures from oracles that confirm the transfers.
-
-**SignatureVerifier.sol**
-
-Is deployed to the chain with high fees and is used to verify the transfer by oracles signatures.
-
-## Oracles
-
-Contains variety of the contracts interfaces.
-
-**DelegatedStaking**
-
-Manages oracle and delegator stakes. Oracles are required to stake LINK token to be accepted as an oracle on aggregators.
-
+<!-- Part between CONTRACTS_AUTOGENERATED_DESCRIPTION* is autogenerated. Do no remove CONTRACTS_AUTOGENERATED_DESCRIPTION* -->
+<!-- CONTRACTS_AUTOGENERATED_DESCRIPTION_START -->
 ## Periphery
-
-**WrappedAsset**
-
+### CallProxy
+Proxy to execute the other contract calls.
+This contract is used when a user requests transfer with specific call of other contract.
+### DeBridgeToken
 ERC20 token that is used as wrapped asset to represent the native token value on the other chains.
-
-**DefiController**
-
-Mock contract responsible for using the asset from the Debridge contracts in other DeFi protocols to earn extra reward.
-
-**FeeProxy**
-
-Helper to swap any token to Link. \*\*\*\*
-
-**CallProxy**
-
-Proxy to execute the other contract calls. This contract is used when the user requests transfer with specific call of other contract.
-
-**Pausable**
-
-Helper for pausable contracts.
-
+### DeBridgeTokenProxy
+This contract implements a proxy that gets the implementation address for each call
+from DeBridgeTokenDeployer. It's deployed by DeBridgeTokenDeployer.
+Implementation is DeBridgeToken.
+### SimpleFeeProxy
+Helper to withdraw fees from DeBridgeGate and transfer them to a treasury.
+## Transfers
+### DeBridgeGate
+Contract for assets transfers. The user can transfer the asset to any of the approved chains.
+The admin manages the assets, fees and other important protocol parameters.
+### DeBridgeTokenDeployer
+Deploys a deToken(DeBridgeTokenProxy) for an asset.
+### OraclesManager
+The base contract for oracles management. Allows adding/removing oracles,
+managing the minimal required amount of confirmations.
+### SignatureVerifier
+It's used to verify that a transfer is signed by oracles.
+### WethGate
+Upgradable contracts cannot receive ether via `transfer` because of increased SLOAD gas cost.
+We use this non-upgradeable contract as the recipient and then immediately transfer to an upgradable contract.
+More details about this issue can be found
+[here](https://forum.openzeppelin.com/t/openzeppelin-upgradeable-contracts-affected-by-istanbul-hardfork/1616).
+
+<!-- CONTRACTS_AUTOGENERATED_DESCRIPTION_END -->
 
 ## [How Transfers Works](https://docs.debridge.finance/the-core-protocol/transfers)
 
@@ -104,9 +80,17 @@ INFURA_ID=xxx # Change to your infura id
 ```
 then run `yarn test`
 
+## Docs generation
+`yarn docs`
+
 ## Troubleshooting
 ###  Cannot find module '../typechain-types' or its corresponding type declarations.
 `hardhat clean`
 >> https://github.com/dethcrypto/TypeChain/tree/master/packages/hardhat#installation
 > 
->Warning: before running it for the first time you need to do hardhat clean, otherwise TypeChain will think that there is no need to generate any typings. This is because this plugin will attempt to do incremental generation and generate typings only for changed contracts. You should also do hardhat clean if you change any TypeChain related config option.
+>Warning: before running it for the first time you need to do hardhat clean, otherwise TypeChain will think that there is no need to generate any typings. This is because this plugin will attempt to do incremental generation and generate typings only for changed contracts. You should also do hardhat clean if you change any TypeChain related config option.
+
+
+## Verify contract
+
+Add ETHERSCAN_API_KEY variable to your .env file before running `npx hardhat verify ...`