[FEAT] Bumps to web3 v6, adds linters, adds tests (pending upstream merge)

.github/workflows/common_check.yaml

@@ -0,0 +1,57 @@
+name: Code Quality
+# Controls when the action will run.
+on:
+  # Triggers the workflow on push or pull request events but only for the master branch
+  push:
+    branches: [ master, main ]
+  pull_request:
+    branches: [ master, main ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  check:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11",]
+        poetry-version: ["2.0.1"]
+        os: [ubuntu-24.04,]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install and configure Poetry
+        uses: snok/install-poetry@v1
+        with:
+          version: ${{ matrix.poetry-version }}
+          virtualenvs-create: true
+          installer-parallel: true
+      - name: Install
+        run: |
+          poetry install
+
+      - name: Format
+        run: |
+          make fmt
+
+      - name: Lint
+        run: |
+            make lint
+
+      - name: Tests
+        run: |
+            make test
+
+      - name: Lock
+        run: |
+            poetry lock
+
+      - name: Ensure lockfile is up to date
+        run: |
+            git diff --exit-code
+

.github/workflows/release.yaml

@@ -0,0 +1,66 @@
+# Publish package on main branch if it's tagged with 'v*'
+
+name: release & publish workflow
+
+# Controls when the action will run.
+on:
+  # Triggers the workflow on push events but only for the master branch
+  push:
+    tags:
+      - 'v*'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "release"
+  release:
+    name: Create Release
+    runs-on: ubuntu-22.04
+
+    strategy:
+      matrix:
+        python-versions: ["3.11"]
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      - name: Get version from tag
+        id: tag_name
+        run: |
+          echo ::set-output name=current_version::${GITHUB_REF#refs/tags/v}
+        shell: bash
+
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-versions }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install poetry
+
+      - name: Build wheels and source tarball
+        run: >-
+          poetry build
+
+      - name: create github release
+        id: create_release
+        uses: softprops/action-gh-release@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+        with:
+          body: ${{ steps.changelog_reader.outputs.changes }}
+          files: dist/*.whl
+          draft: false
+          prerelease: false
+
+      - name: publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          skip_existing: true

.gitignore

@@ -1,3 +1,4 @@
+.nix-venv
 # Taken from https://github.com/github/gitignore/blob/dd9c41b6088bb200e53d4c4ba4d72f8218b2e898/Python.gitignore
 
 # Byte-compiled / optimized / DLL files
@@ -154,4 +155,4 @@ cython_debug/
 #.idea/
 
 # MacOS
-.DS_Store
+.DS_Store

README.md

@@ -30,6 +30,9 @@ See release on PyPI: https://pypi.org/project/balpy/
 ```bash
 # Install in virtual environment using poetry
 git clone https://github.com/balancer-labs/balpy.git
+# checkout submodules
+git submodule update --init --recursive
+
 cd balpy
 poetry install # Install dependencies and package
 # You can enter the virtual environment using
@@ -62,3 +65,32 @@ You also must set AT LEAST one of these environment variables to connect to the
 
 ## Samples
 See README.md in samples/ for more information.
+
+## DEV
+
+# Formatting
+
+```bash
+make fmt
+```
+
+## Linting
+
+```bash
+make lint
+```
+
+Check all linters and formaters and tests.
+
+## Tests
+
+A small number of tests are included for functionaly demonstration.
+
+```bash
+make test
+```
+
+
+
+```bash
+make all

balpy/__init__.py

@@ -1,3 +0,0 @@
-from .balancerErrors import handleException
-from balpy import balpy
-

balpy/balancer-deployments/.eslintignore

@@ -0,0 +1,2 @@
+node_modules
+dist

balpy/balancer-deployments/.eslintrc.js

@@ -0,0 +1,11 @@
+module.exports = {
+  root: true,
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint", "prettier", "mocha-no-only"],
+  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  rules: {
+    "comma-spacing": ["error", {before: false, after: true}],
+    "prettier/prettier": "error",
+    "mocha-no-only/mocha-no-only": ["error"],
+  },
+};

balpy/balancer-deployments/.github/PULL_REQUEST_TEMPLATE/deployment-preparation-template.md

@@ -0,0 +1,29 @@
+# Deployment preparation: <!-- Deployment title: contract or feature (e.g. `ManagedPool`) -->
+
+<!-- Specify commit at which `build-info` was generated for this deployment -->
+
+## Deployment preparation tasks checklist:
+
+- [ ] Deployments `README` is updated with the new task name and link
+- [ ] Task `README` has a description and links to the artifacts
+- [ ] `build-info` is updated with artifacts compiled at the specified commit
+- [ ] Artifacts are generated from `build-info`
+- [ ] New task has a working fork test <!-- This implies index and input scripts are correct -->
+
+## Deprecating old tasks checklist: <!-- Only if applicable -->
+
+- [ ] Old task was moved to `deprecated/` directory
+- [ ] Deployments `README` is updated: old task is moved to the 'deprecated' section, and links are updated with the `deprecated/` prefix
+- [ ] Old task imports in `index.ts`, `input.ts` and fork tests are updated
+- [ ] Old task `README` is updated with a warning sign, a link to the replacement task and a short description <!-- Explain why it was deprecated -->
+
+## Code checklist:
+
+- [ ] The diff is legible and has no extraneous changes <!-- There shouldn't be any changes to code outside of the deployment task in this PR -->
+- [ ] Complex code has been commented in tests and scripts
+- [ ] Fork test block number and test cases are appropriate for this deployment
+- [ ] The base branch is either `master`, or there's a description of how to merge
+
+## Issue Resolution
+
+<!-- If this PR addresses an issue, note that here: e.g., Closes/Fixes/Resolves #1346. -->

balpy/balancer-deployments/.github/PULL_REQUEST_TEMPLATE/deployment-template.md

@@ -0,0 +1,16 @@
+# Deployment: <!-- Deployment title: contract or feature (e.g. `ManagedPool`) -->
+
+## Deployment tasks checklist:
+
+- [ ] Contract(s) deployed to all target networks / testnets
+- [ ] TX IDs are properly generated
+- [ ] Action IDs are generated after deployment (if applicable) <!-- This includes contracts deployed by contracts (e.g. mock pools deployed by factories) -->
+- [ ] Outputs for all target networks are generated, and linked in the task `readme`
+- [ ] Addresses files are up to date with the new deployment <!-- yarn build-address-lookup -->
+- [ ] Contracts are verified in every network <!-- This includes contracts deployed by contracts (e.g. mock pools deployed by factories) -->
+- [ ] Deployments `CHANGELOG` is updated
+- [ ] There are no code changes of any kind
+
+## Issue Resolution
+
+<!-- If this PR addresses an issue, note that here: e.g., Closes/Fixes/Resolves #1346. -->

balpy/balancer-deployments/.github/actions/check-network-action-ids/action.yml

@@ -0,0 +1,16 @@
+name: 'Check Action IDs'
+inputs:
+  network-name:
+    required: true
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/checkout@v3
+    - name: Set up environment
+      uses: ./.github/actions/setup
+    - name: Prepare Config
+      run: yarn ci:prepare-config
+      shell: bash
+    - name: Check Action IDs
+      run: yarn check-network-action-ids ${{ inputs.network-name }}
+      shell: bash

balpy/balancer-deployments/.github/actions/check-network-deployments/action.yml

@@ -0,0 +1,16 @@
+name: 'Check Deployment Addresses'
+inputs:
+  network-name:
+    required: true
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/checkout@v3
+    - name: Set up environment
+      uses: ./.github/actions/setup
+    - name: Prepare Config
+      run: yarn ci:prepare-config
+      shell: bash
+    - name: Check Deployment Addresses
+      run: yarn check-network-deployments ${{ inputs.network-name }}
+      shell: bash

balpy/balancer-deployments/.github/actions/setup/action.yml

@@ -0,0 +1,19 @@
+name: Setup
+
+runs:
+  using: composite
+  steps:
+    - name: Install node
+      uses: actions/setup-node@v3
+      with:
+        node-version: 18.15
+    - name: Cache
+      uses: actions/cache@v3
+      id: cache
+      with:
+        path: '**/node_modules'
+        key: yarn-v1-${{ hashFiles('**/yarn.lock') }}
+    - name: Install
+      run: yarn --immutable
+      shell: bash
+      if: steps.cache.outputs.cache-hit != 'true'

balpy/balancer-deployments/.github/pull_request_template.md

@@ -0,0 +1,31 @@
+<!-- If this is deployment-related, please go the the Preview tab and select the appropriate sub-template. -->
+<!-- Otherwise, delete everything before #Description -->
+
+* [Deployment preparation template](?expand=1&template=deployment-preparation-template.md)
+* [Deployment template](?expand=1&template=deployment-template.md)
+
+# Description
+
+<!-- Describe the changes introduced in this pull request. -->
+<!-- Include any context necessary for understanding the PR's purpose. -->
+
+## Type of change
+
+- [ ] Bug fix <!-- (non-breaking change which fixes an issue) -->
+- [ ] New feature <!-- (non-breaking change which adds functionality) -->
+- [ ] Breaking change <!-- (would cause existing functionality to not work as expected) -->
+- [ ] Dependency changes
+- [ ] Code refactor / cleanup
+- [ ] Documentation or wording changes
+- [ ] Other
+
+## Checklist:
+
+- [ ] The diff is legible and has no extraneous changes
+- [ ] Complex code has been commented, including external interfaces
+- [ ] Tests are included for all code paths
+- [ ] The base branch is either `master`, or there's a description of how to merge
+
+## Issue Resolution
+
+<!-- If this PR addresses an issue, note that here: e.g., Closes/Fixes/Resolves #1346. -->