Merge pull request #367 from web3well/contract-updates

Contract Updates & Client Integration
getwax · Nov 15, 2022 · ccc8a59 · ccc8a59
2 parents 771de1f + 57e7ec3
commit ccc8a59
Show file tree

Hide file tree

Showing 44 changed files with 4,860 additions and 4,079 deletions.
diff --git a/.github/workflows/aggregator-proxy.yml b/.github/workflows/aggregator-proxy.yml
@@ -7,8 +7,6 @@ on:
     paths:
       - 'aggregator-proxy/**'
   pull_request:
-    branches:
-      - 'main'
     paths:
       - 'aggregator-proxy/**'
 

diff --git a/.github/workflows/aggregator.yml b/.github/workflows/aggregator.yml
@@ -6,13 +6,19 @@ on:
       - 'main'
     paths:
       - 'aggregator/**'
+      # Check for breaking changes from contracts
+      - 'contracts/**'
       - '.github/workflows/aggregator.yml'
   pull_request:
-    branches:
-      - 'main'
     paths:
       - 'aggregator/**'
+      # Check for breaking changes from contracts
+      - 'contracts/**'
       - '.github/workflows/aggregator.yml'
+    branches-ignore:
+      # Changes targeting this branch should be tested+fixed when being merged
+      # into main
+      - contract-updates
 
 defaults:
   run:

diff --git a/.github/workflows/clients.yml b/.github/workflows/clients.yml
@@ -7,8 +7,6 @@ on:
     paths:
       - 'contracts/clients/**'
   pull_request:
-    branches:
-      - 'main'
     paths:
       - 'contracts/clients/**'
 
@@ -17,6 +15,14 @@ defaults:
     working-directory: ./contracts/clients
 
 jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ./.github/actions/setup-contracts-clients
+    - run: yarn build
+
   test:
     runs-on: ubuntu-latest
 

diff --git a/.github/workflows/contracts.yml b/.github/workflows/contracts.yml
@@ -8,8 +8,6 @@ on:
       - 'contracts/**'
       - '!contracts/clients/**'
   pull_request:
-    branches:
-      - 'main'
     paths:
       - 'contracts/**'
       - '!contracts/clients/**'

diff --git a/.github/workflows/extension.yml b/.github/workflows/extension.yml
@@ -7,8 +7,6 @@ on:
     paths:
       - 'extension/**'
   pull_request:
-    branches:
-      - 'main'
     paths:
       - 'extension/**'
 

diff --git a/aggregator-proxy/package.json b/aggregator-proxy/package.json
@@ -21,7 +21,7 @@
     "@types/koa__cors": "^3.3.0",
     "@types/koa__router": "^8.0.11",
     "@types/node-fetch": "^2.6.1",
-    "bls-wallet-clients": "^0.7.3",
+    "bls-wallet-clients": "0.8.0-940dd11",
     "fp-ts": "^2.12.1",
     "io-ts": "^2.2.16",
     "io-ts-reporters": "^2.0.1",

diff --git a/aggregator-proxy/yarn.lock b/aggregator-proxy/yarn.lock
@@ -885,10 +885,10 @@ bech32@1.1.4:
   resolved "https://registry.yarnpkg.com/bech32/-/bech32-1.1.4.tgz#e38c9f37bf179b8eb16ae3a772b40c356d4832e9"
   integrity sha512-s0IrSOzLlbvX7yp4WBfPITzpAU8sqQcpsmwXDiKwrG4r491vwCO/XpejasRNl0piBMe/DvP4Tz0mIS/X1DPJBQ==
 
-bls-wallet-clients@^0.7.3:
-  version "0.7.3"
-  resolved "https://registry.yarnpkg.com/bls-wallet-clients/-/bls-wallet-clients-0.7.3.tgz#22fae2434c67b642d172023f259131233e396eb7"
-  integrity sha512-u2mwyf5+1KHYCyeutfl4jhEDCmsW/C+S54QKbicUkU26MvAGJ76/TxSOOIBiWTjzVDdDUBdJ/zQRoRd35GSGcQ==
+bls-wallet-clients@0.8.0-940dd11:
+  version "0.8.0-940dd11"
+  resolved "https://registry.yarnpkg.com/bls-wallet-clients/-/bls-wallet-clients-0.8.0-940dd11.tgz#6488e58b1fad12e577ec06d10a3c4f9763c1e395"
+  integrity sha512-f5zqGf5dAq7IPXbrsNLdvEX0lJx2/7DBOqbkvHABGEWEKnHd32tMKDZxUeGt/cPV+2W0nKmQk3uYPNGCEuC6EA==
   dependencies:
     "@thehubbleproject/bls" "^0.5.1"
     ethers "5.5.4"

diff --git a/aggregator/deps.ts b/aggregator/deps.ts
@@ -49,7 +49,7 @@ export type {
   PublicKey,
   Signature,
   VerificationGateway,
-} from "https://esm.sh/bls-wallet-clients@0.7.3";
+} from "https://esm.sh/bls-wallet-clients@0.8.0-940dd11";
 
 export {
   Aggregator as AggregatorClient,
@@ -59,10 +59,10 @@ export {
   getConfig,
   MockERC20__factory,
   VerificationGateway__factory,
-} from "https://esm.sh/bls-wallet-clients@0.7.3";
+} from "https://esm.sh/bls-wallet-clients@0.8.0-940dd11";
 
 // Workaround for esbuild's export-star bug
-import blsWalletClients from "https://esm.sh/bls-wallet-clients@0.7.3";
+import blsWalletClients from "https://esm.sh/bls-wallet-clients@0.8.0-940dd11";
 const {
   bundleFromDto,
   bundleToDto,

diff --git a/aggregator/src/app/BundleService.ts b/aggregator/src/app/BundleService.ts
@@ -1,6 +1,7 @@
 import {
   BigNumber,
   BlsWalletSigner,
+  BlsWalletWrapper,
   Bundle,
   delay,
   ethers,
@@ -151,15 +152,22 @@ export default class BundleService {
       };
     }
 
-    const signedCorrectly = this.blsWalletSigner.verify(bundle);
+    const walletAddresses = await Promise.all(bundle.senderPublicKeys.map(
+      (pubKey) => BlsWalletWrapper.AddressFromPublicKey(
+        pubKey, this.ethereumService.verificationGateway
+      )
+    ));
 
     const failures: TransactionFailure[] = [];
 
-    if (signedCorrectly === false) {
-      failures.push({
+    for (const walletAddr of walletAddresses) {
+      const signedCorrectly = this.blsWalletSigner.verify(bundle, walletAddr);
+      if (!signedCorrectly) {
+        failures.push({
         type: "invalid-signature",
-        description: "invalid signature",
-      });
+          description: `invalid signature for wallet address ${walletAddr}`,
+        });
+      }
     }
 
     failures.push(...await this.ethereumService.checkNonces(bundle));

diff --git a/aggregator/test/deps.ts b/aggregator/test/deps.ts
@@ -15,7 +15,7 @@ export function assertEquals<L, R extends L>(left: L, right: R) {
 
 export function assertBundleSucceeds(res: AddBundleResponse) {
   if ("failures" in res) {
-    throw new AssertionError("expected bundle to succeed");
+    throw new AssertionError(`expected bundle to succeed. failures: ${JSON.stringify(res.failures)}`);
   }
 }
 

diff --git a/contracts/.gitignore b/contracts/.gitignore
@@ -4,7 +4,7 @@
 node_modules
 coverage
 coverage.json
-/typechain
+/typechain-types
 networks/local.json
 
 #Hardhat files

diff --git a/contracts/clients/.npmignore b/contracts/clients/.npmignore
@@ -1,6 +1,6 @@
 *
 !/dist/src/**/*
-!/dist/typechain/**/*
+!/dist/typechain-types/**/*
 !/src/**/*
 !/package.json
 !/README.md
diff --git a/contracts/clients/README.md b/contracts/clients/README.md
@@ -80,6 +80,24 @@ const verificationGateway = VerificationGateway__factory.connect(
 await verificationGateway.processBundle(bundle);
 ```
 
+You can get the results of the operations in a bundle using `getOperationResults`.
+
+```ts
+import { getOperationResults } from 'bls-wallet-clients';
+
+...
+
+const txn = await verificationGateway.processBundle(bundle);
+const txnReceipt = txn.wait();
+const opResults = getOperationResults(txnReceipt);
+
+// Includes data from WalletOperationProcessed event,
+// as well as parsed errors with action index
+const { error } = opResults[0];
+console.log(error?.actionIndex); // ex. 0 (as BigNumber)
+console.log(error?.message); // ex. "some require failure message"
+```
+
 ## Signer
 
 Utilities for signing, aggregating and verifying transaction bundles using the

diff --git a/contracts/clients/package.json b/contracts/clients/package.json
@@ -1,6 +1,6 @@
 {
   "name": "bls-wallet-clients",
-  "version": "0.7.3",
+  "version": "0.8.0",
   "description": "Client libraries for interacting with BLS Wallet components",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
@@ -13,7 +13,7 @@
     "yarn": ">=1.0.0"
   },
   "scripts": {
-    "build": "rm -rf dist && mkdir dist && cp -rH typechain dist/typechain && find ./dist/typechain -type f \\! -name '*.d.ts' -name '*.ts' -delete && tsc",
+    "build": "rm -rf dist && mkdir dist && cp -rH typechain-types dist/typechain-types && find ./dist/typechain-types -type f \\! -name '*.d.ts' -name '*.ts' -delete && tsc",
     "watch": "tsc -w",
     "test": "mocha --require ts-node/register --require source-map-support/register --require ./test/init.ts **/*.test.ts",
     "premerge": "yarn test",
@@ -27,12 +27,12 @@
   "devDependencies": {
     "@types/chai": "^4.3.3",
     "@types/chai-as-promised": "^7.1.5",
-    "@types/mocha": "^9.1.1",
+    "@types/mocha": "^10.0.0",
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
-    "mocha": "^10.0.0",
+    "mocha": "^10.1.0",
     "source-map-support": "^0.5.21",
     "ts-node": "^10.9.1",
-    "typescript": "^4.8.2"
+    "typescript": "^4.8.4"
   }
 }