Bump apollo-server-core from 3.6.4 to 3.11.1

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,39 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'bug'
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser: [e.g. Chrome, Safari]
+ - Version: [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser: [e.g. Chrome, Safari]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,10 @@
+---
+name: Custom issue template
+about: Describe the purpose of this custom issue here.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: 'enhancement'
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/jekyll-gh-pages.yml

@@ -0,0 +1,51 @@
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll with GitHub Pages dependencies preinstalled
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["router"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/techdocs.yaml

@@ -0,0 +1,70 @@
+name: Publish Docs
+
+permissions:
+  contents: read
+
+on:
+  push:
+    branches:
+      - master
+      - add-docs
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+
+jobs:
+  publish-techdocs-site:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    env:
+      TECHDOCS_S3_BUCKET_NAME: ${{ secrets.TECHDOCS_S3_BUCKET_NAME }}
+      PUBLIC_S3_BUCKET_NAME: ${{ secrets.PUBLIC_S3_BUCKET_NAME }}
+      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+      AWS_REGION: ${{ secrets.AWS_REGION }}
+      ENTITY_NAMESPACE: 'default'
+      ENTITY_KIND: 'Domain'
+      ENTITY_NAME: 'defi-sdk'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v2
+      - uses: actions/setup-python@v2
+
+      - name: setup java
+        uses: actions/setup-java@v2
+        with:
+          distribution: 'zulu'
+          java-version: '11'
+      - name: download, validate, install plantuml and its dependencies
+        run: |
+          curl -o plantuml.jar -L http://sourceforge.net/projects/plantuml/files/plantuml.1.2021.4.jar/download
+          echo "be498123d20eaea95a94b174d770ef94adfdca18  plantuml.jar" | sha1sum -c -
+          mv plantuml.jar /opt/plantuml.jar
+          mkdir -p "$HOME/.local/bin"
+          echo $'#!/bin/sh\n\njava -jar '/opt/plantuml.jar' ${@}' >> "$HOME/.local/bin/plantuml"
+          chmod +x "$HOME/.local/bin/plantuml"
+          echo "$HOME/.local/bin" >> $GITHUB_PATH
+          sudo apt-get install -y graphviz
+
+      - name: Install techdocs-cli
+        run: sudo npm install -g @techdocs/cli
+
+      - name: Install mkdocs and mkdocs plugins
+        run: python -m pip install mkdocs-techdocs-core==0.*
+
+      - name: Generate docs site
+        run: techdocs-cli generate --no-docker --verbose
+
+      - name: Upload public docs
+        run:
+          aws s3 rm s3://$PUBLIC_S3_BUCKET_NAME/defi-sdk --recursive && aws s3 cp site/ s3://$PUBLIC_S3_BUCKET_NAME/defi-sdk --recursive
+
+      - name: Upload techdocs
+        run:
+          techdocs-cli publish --publisher-type=awsS3 --storage-name=$TECHDOCS_S3_BUCKET_NAME --entity=$ENTITY_NAMESPACE/$ENTITY_KIND/$ENTITY_NAME
+

.github/workflows/test.yml

@@ -5,6 +5,8 @@ jobs:
   coverage:
     name: test
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
     steps:
       - name: checkout
         uses: actions/checkout@v3

README.md

@@ -1,23 +1,20 @@
 ![](https://i.ibb.co/7QCQKPD/MEDIUM-FINAL.png)
-[![Build status](https://github.com/zeriontech/defi-sdk/workflows/build/badge.svg)](https://github.com/zeriontech/defi-sdk/actions?query=workflow:build)
-[![Test status](https://github.com/zeriontech/defi-sdk/workflows/test/badge.svg)](https://github.com/zeriontech/defi-sdk/actions?query=workflow:test)
-[![Coverage status](https://github.com/zeriontech/defi-sdk/workflows/coverage/badge.svg)](https://github.com/zeriontech/defi-sdk/actions?query=workflow:coverage)
-[![Lint status](https://github.com/zeriontech/defi-sdk/workflows/lint/badge.svg)](https://github.com/zeriontech/defi-sdk/actions?query=workflow:lint)
+[![Build status](https://github.com/zeriontech/protocol-wrappers/workflows/build/badge.svg)](https://github.com/zeriontech/defi-sdk/actions?query=workflow:build)
+[![Test status](https://github.com/zeriontech/protocol-wrappers/workflows/test/badge.svg)](https://github.com/zeriontech/defi-sdk/actions?query=workflow:test)
+[![Coverage status](https://github.com/zeriontech/protocol-wrappers/workflows/coverage/badge.svg)](https://github.com/zeriontech/defi-sdk/actions?query=workflow:coverage)
+[![Lint status](https://github.com/zeriontech/protocol-wrappers/workflows/lint/badge.svg)](https://github.com/zeriontech/defi-sdk/actions?query=workflow:lint)
 [![License](https://badgen.net/github/license/zeriontech/defi-sdk)](https://www.gnu.org/licenses/lgpl-3.0.en.html)
-[![Discord](https://badgen.net/badge/zerion/Zerion?icon=discord&label=discord)](https://zerion.io/discord)
-[![Twitter Follow](https://img.shields.io/twitter/follow/zerion?style=social)](https://x.com/intent/follow?screen_name=zerion)
+[![Discord](https://badgen.net/badge/zerion/Zerion?icon=discord&label=discord)](https://go.zerion.io/discord)
+[![Twitter Follow](https://badgen.net/twitter/follow/zerion_io?icon=twitter)](https://twitter.com/intent/follow?screen_name=zerion_io)
 
-**DeFi SDK** is an open-source system of smart contracts that allows you to execute trades with ERC20 tokens and track balances on different protocols.
+**DeFi SDK** is an open-source system of smart contracts designed for precise DeFi portfolio accounting. To put it simply, DeFi SDK is the on-chain *balanceOf* for DeFi protocols.
 
-If you have any questions about DeFi SDK, feel free to reach out to us on our [Discord server](https://zerion.io/discord).
+If you have any questions about DeFi SDK, feel free to reach out to us on our [Discord server](https://go.zerion.io/discord).
 
 ![](https://i.ibb.co/RC54SjL/defisdk.png)
 
 ## Features
 
-**💸Trade any ERC20 tokens on L2 chains using single Router contract**
-> See [How to swap ERC20 tokens using DeFi SDK Router](docs/router.md)
-
 **💥Query user assets and debt deposited in DeFi protocols like *Maker, Aave, dYdX*, etc.**
 > How much debt does `0xdead..beef` have on Compound?
 
@@ -27,83 +24,64 @@ If you have any questions about DeFi SDK, feel free to reach out to us on our [D
 **✨Interact with multiple DeFi protocols in a unified way**
 > See [How to interact with DeFi SDK contracts](docs/interacting.md)
 
-## Trading Features
+## Addresses
 
-* Trade any ERC20 token
-* Two types of amounts: absolute (usual amount) and relative (percentage of balance)
-* Three types of `permit()` functions for approving tokens in the same transaction (EIP2612, DAI-like, Yearn-like)
-* Two types of swaps: with fixed input amount or fixed output amount
-* Two types of fees:
-  * **protocol fee** managed by the **Router** contract owner with possibility of one-time discounts requiring signature of an address with the special role
-  * **marketplace fee** managed by the transaction creator
-* Relayed transactions requiring just an EIP712 signature of the user
+**AdapterRegistry** contract is deployed to the mainnet and its source code is verified on [etherscan](https://etherscan.io/address/0x06fe76b2f432fdfecaef1a7d4f6c3d41b5861672#code).
 
-## How to Add Your Adapter
+All the deployed contracts' addresses are available [here](docs/addresses.md).
 
-> Read-only and interactive adapters are maintained in [`master`](https://github.com/zeriontech/defi-sdk/tree/master) and [`interactive-updates`](https://github.com/zeriontech/defi-sdk/tree/interactive-updates) branches of **defi-sdk** repo respectively.
 
-The full instructions on how to add a custom adapters may be found in our [docs](docs/creating-your-adapters/index.md).
+## How to Add Your Adapter
 
-If you have questions and/or want to add your adapter to Zerion reach out to us on our [Discord server](https://zerion.io/discord).
+The full instructions on how to add a custom adapter to the **AdapterRegistry** contract may be found in our [docs](docs/creating-your-adapters/index.md).
 
-## Addresses
+If you have questions and/or want to add your adapter to Zerion reach out to us on our [Discord server](https://go.zerion.io/discord).
 
-All the deployed contracts' addresses are available [here](docs/addresses.md).
 
 ## Security Vulnerabilities 🛡
 
-If you discover a security vulnerability within DeFi SDK, please send us an e-mail at inbox@zerion.io.
-All security vulnerabilities will be promptly addressed.
-
-The project uses [Slither](https://github.com/crytic/slither) for security analysis.
-It should be previously installed (e.g. via [pip](https://pypi.org/project/pip/)).
-
-Run `npm run slither` to run security checks.
+If you discover a security vulnerability within DeFi SDK, please send us an e-mail at inbox@zerion.io. All security vulnerabilities will be promptly addressed.
 
 ## Dev Notes
 
-We use [Hardhat](https://github.com/NomicFoundation/hardhat), which runs tests extremely fast!
-
-Also, we use [Truffle Dashboard](https://trufflesuite.com/docs/truffle/getting-started/using-the-truffle-dashboard/) for secure deployment.
-
-### Installation
+This project uses Truffle and web3js for all Ethereum interactions and testing.
 
-Run `npm install` to install all the dependencies.
+### Set environment
+Rename `.env.sample` file to `.env`, and fill in the env variables. 
 
-### Deployment
+`MNEMONIC` and `INFURA_API_KEY` are required for `core` and `adapters` tests. 
+`PRIVATE_KEY` is required for `interactiveAdapters` tests.
 
-Run `npm run truffle-dashboard` to start the Truffle Dashboard.
+### Compile contracts
 
-Run `npm run deploy:router:truffle-dashboard` to deploy the **Router** contract.
-Sign deployment transaction in your browser at `http://localhost:24012/`.
+`npm run compile`
 
-Fill in address of newly deployed contract to `scripts/deployment.js`.
+### Run tests
 
-The same instruction applies to the **SimpleCaller** contract with `deploy:sc:truffle-dashboard` command.
+`npm run test:core` for `core` tests.
+`npm run test:adapters` for `adapters` tests.
+`npm run test:interactiveAdapters` for `interactiveAdapters` tests.
 
-After filling in fee beneficiary for the chosen network in `scripts/deployment.js`, `initialize:router:truffle-dashboard` command may be run.
+### Run Solidity code coverage
 
-Run `npm run verify` to verify contract on any block explorer.
-The respective `<BLOCK_EXPLORER>_API_KEY` filled in `.env` file is required for this step.
-See the `hardhat.config.ts` file for the details (`etherscan` field of `config` variable uses these API keys).
+`npm run coverage`
 
-### Testing & Coverage
+Currently, unsupported files are ignored.
 
-The **Router** contract and its dependencies is fully covered with tests.
+### Run Solidity and JS linters
 
-Run `npm run test` and `npm run coverage` to run tests or coverage respectively.
-`REPORT_GAS` filled in `.env` file enables/disables gas reports during tests.
+`npm run lint`
 
-### Linting
+Currently, unsupported files are ignored.
 
-Run `npm run lint` for both JS and Solidity linters.
+### Run all the migrations scripts
 
-Run `npm run lint:eslint` and `npm run lint:solhint` to run linter for JS and Solidity separately.
+`npm run deploy:network`, `network` is either `development` or `mainnet`.
 
 ### Serve docs
 
 `npm run docs:serve`
 
 ## License
 
-All smart contracts are released under GNU LGPLv3 license.
+All smart contracts are released under GNU LGPLv3.

SECURITY.md

@@ -0,0 +1,19 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 5.1.x   | :white_check_mark: |
+| 5.0.x   | :x:                |
+| 4.0.x   | :white_check_mark: |
+| < 4.0   | :x:                |
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability within DeFi SDK, please send us an e-mail at inbox@zerion.io.
+
+All security vulnerabilities will be promptly addressed.