feat: new set of scripts that use relayer group

Author: Andres Adjimann

packages/deploy/package.json

@@ -53,12 +53,16 @@
   },
   "devDependencies": {
     "@ethersproject/abi": "^5.7.0",
+    "@ethersproject/abstract-signer": "^5.8.0",
     "@ethersproject/bignumber": "^5.7.0",
+    "@ethersproject/hash": "^5.8.0",
     "@ethersproject/providers": "^5.7.2",
     "@nomicfoundation/hardhat-chai-matchers": "^2.0.3",
     "@nomicfoundation/hardhat-ethers": "^3.0.5",
     "@nomicfoundation/hardhat-network-helpers": "^1.0.8",
     "@nomicfoundation/hardhat-verify": "^2.0.0",
+    "@openzeppelin/defender-sdk": "^2.5.0",
+    "@openzeppelin/defender-sdk-relay-signer-client": "^2.5.0",
     "@openzeppelin/hardhat-upgrades": "^2.5.0",
     "@openzeppelin/upgrades-core": "^1.32.3",
     "@typechain/ethers-v5": "^11.0.0",
@@ -73,6 +77,7 @@
     "chai": "^4.3.7",
     "child_process": "^1.0.2",
     "cross-env": "^7.0.3",
+    "csv-parser": "^3.2.0",
     "dotenv": "^16.4.5",
     "dotenv-cli": "^7.2.1",
     "eslint": "^8.43.0",

packages/deploy/scripts/claimRevoke/.gitignore

@@ -0,0 +1,4 @@
+chunks
+done_chunks
+enabled_claims_denied_users.csv
+txs_data.json

packages/deploy/scripts/claimRevoke/README.md

@@ -0,0 +1,15 @@
+# How to run the transactions.
+
+- Save the list in `enabled_claims_denied_users.csv` must have the column: `blockchainclaimid`
+- Run `yarn ts-node scripts/claimRevoke/split.ts`
+- Run `yarn hardhat run --network <NETWORK> scripts/claimRevoke/claimRevoke.ts`
+
+  This script needs the `RELAYER_API_KEY` and `RELAYER_API_SECRET` `.env` vars
+
+# Verification
+
+- Run `yarn ts-node scripts/claimRevoke/saveTxs.ts` to get the txs from defender
+
+  This script needs the `RELAYER_API_KEY` and `RELAYER_API_SECRET` `.env` vars
+- Run `yarn hardhat run --network <NETWORK> scripts/claimRevoke/parseTxs.ts` to verify, expect an empty array as
+  response

packages/deploy/scripts/claimRevoke/check.ts

@@ -1,76 +1,86 @@
 /**
  * How to use:
+ *  create the chunks and done_chunks directories
+ *  call split to split the chunks
  *  - yarn hardhat run --network <NETWORK> scripts/claimRevoke/claimRevoke.ts
  * This script always use: ./enabled_claims_denied_users.csv
  * This script needs: RELAYER_API_KEY and RELAYER_API_SECRET
  */
-import {ethers} from 'hardhat';
-import csv from 'csv-parser';
-import * as fs from 'fs';
+import {RelayerGroupStatus} from '@openzeppelin/defender-sdk-relay-signer-client';
+import {configDotenv} from 'dotenv';
+import {Defender} from '@openzeppelin/defender-sdk';
 import {
   DefenderRelayProvider,
   DefenderRelaySigner,
 } from '@openzeppelin/defender-sdk-relay-signer-client/lib/ethers';
-import * as path from 'path';
+import {ApiRelayerParams} from '@openzeppelin/defender-sdk-relay-signer-client/lib/models/relayer';
+// @ts-ignore
+import {deployments, ethers} from 'hardhat';
+import * as fs from 'node:fs';
+// @ts-ignore
+import path from 'path';
 
-const CHUNK_SIZE = 1000;
+async function getChunks() {
+  const regexp = /^chunk_([0-9]+)\.json$/g;
+  const files = fs.readdirSync(path.join(__dirname, 'chunks'));
+  return files
+    .map((x) => Array.from(x.matchAll(regexp)))
+    .filter((x) => x.length > 0)
+    .map((x) => x[0][1]);
+}
 
-async function main(filename: string) {
-  if (
-    !process.env.RELAYER_API_KEY ||
-    !process.env.RELAYER_API_SECRET ||
-    !process.env.RELAYER_ADDRESS
-  ) {
-    throw new Error(
-      'Missing env vars RELAYER_API_KEY, RELAYER_API_SECRET and RELAYER_ADDRESS'
-    );
+async function main() {
+  configDotenv();
+  if (!process.env.RELAYER_API_KEY || !process.env.RELAYER_API_SECRET) {
+    throw new Error('Missing env vars RELAYER_API_KEY, RELAYER_API_SECRET');
   }
+  console.log('using ethers version ', ethers.version);
+  const chunks = await getChunks();
+
+  const defender = new Defender({
+    relayerApiKey: process.env.RELAYER_API_KEY,
+    relayerApiSecret: process.env.RELAYER_API_SECRET,
+  });
+  const relayerStatus =
+    (await defender.relaySigner.getRelayerStatus()) as RelayerGroupStatus;
+  const rAddresses = relayerStatus.relayers.map((x) => x.address);
+  console.log('relayer addresses', rAddresses);
 
-  const ids: BitInt[] = ([] = await new Promise((resolve) => {
-    const ret: {user_id: string; claim_id: string}[] = [];
-    fs.createReadStream(filename)
-      .pipe(csv())
-      .on('data', (data) => {
-        ret.push(BigInt(data.claim_id));
-      })
-      .on('end', () => {
-        resolve(ret);
-      });
-  }));
-  const chunks = [];
-  for (let i = 0; i < ids.length; i += CHUNK_SIZE) {
-    chunks.push(ids.slice(i, i + CHUNK_SIZE));
-  }
   const credentials = {
     apiKey: process.env.RELAYER_API_KEY,
     apiSecret: process.env.RELAYER_API_SECRET,
-    authConfig: undefined,
-  };
+  } as ApiRelayerParams;
   const provider = new DefenderRelayProvider(credentials);
-  const signer = new DefenderRelaySigner(
-    credentials,
-    provider,
-    process.env.RELAYER_ADDRESS,
-    {speed: 'fast', ethersVersion: 'v6'}
-  );
-  const signedMultiGiveaway = await ethers.getContract(
-    'SignedMultiGiveaway',
-    signer
+  const signedMultiGiveaway = await deployments.get('SignedMultiGiveaway');
+  console.log('signedMultiGiveaway.address', signedMultiGiveaway.address);
+
+  await Promise.allSettled(
+    rAddresses.map(async (rAddress, rIdx) => {
+      const signer = new DefenderRelaySigner(credentials, provider, rAddress, {
+        speed: 'fast',
+        ethersVersion: 'v6',
+      });
+      const contract = await ethers.getContract('SignedMultiGiveaway', signer);
+      while (chunks.length > 0) {
+        const idx = chunks.shift();
+
+        const fileName = `chunk_${idx}.json`;
+        const src = path.join(__dirname, 'chunks', fileName);
+        const chunk = JSON.parse(fs.readFileSync(src, 'utf-8'));
+        console.log(
+          `sending tx for chunk ${idx}, chunk len ${chunk.length}, using contract ${rIdx}`
+        );
+        const tx = await contract.revokeClaims(chunk);
+        const receipt = await tx.wait();
+        console.log('contract', rIdx, receipt.blockNumber, receipt.hash);
+        fs.renameSync(src, path.join(__dirname, 'done_chunks', fileName));
+        // const status =
+        //   (await defender.relaySigner.getRelayerStatus()) as RelayerGroupStatus;
+        // const myStatus = status.relayers.filter((x) => x.address == rAddress);
+        // console.log(rIdx, myStatus);
+      }
+    })
   );
-  for (const [i, c] of chunks.entries()) {
-    // if (i > 1) {
-    //   console.log(`skip tx for chunk ${i} of ${chunks.length}`);
-    //   continue;
-    // }
-    console.log(
-      `sending tx for chunk ${i} of ${chunks.length}, len ${c.length}`
-    );
-    const tx = await signedMultiGiveaway.revokeClaims(c);
-    const receipt = await tx.wait();
-    console.log(receipt);
-  }
 }
 
-main(path.join(__dirname, 'enabled_claims_denied_users.csv')).catch((err) =>
-  console.error(err)
-);
+main().catch((err) => console.error(err));

packages/deploy/scripts/claimRevoke/claimRevoke.ts

@@ -0,0 +1,53 @@
+/**
+ * Get the transactions from the tx group
+ * How to use:
+ *  - yarn hardhat run --network <NETWORK> scripts/claimRevoke/parseTxs.ts
+ */
+import * as fs from 'node:fs';
+// @ts-ignore
+import path from 'path';
+import {RelayerTransaction} from '@openzeppelin/defender-sdk-relay-signer-client/lib/models/transactions';
+// @ts-ignore
+import {deployments, ethers} from 'hardhat';
+// @ts-ignore
+import csv from 'csv-parser';
+
+async function getIds(): Promise<bigint[]> {
+  const filename = path.join(__dirname, 'enabled_claims_denied_users.csv');
+  return await new Promise((resolve) => {
+    const ret: bigint[] = [];
+    fs.createReadStream(filename)
+      .pipe(csv())
+      .on('data', (data) => {
+        ret.push(BigInt(data.blockchainclaimid));
+      })
+      .on('end', () => {
+        resolve(ret);
+      });
+  });
+}
+
+async function main() {
+  const txs = JSON.parse(
+    fs.readFileSync(path.join(__dirname, 'txs_data.json'), 'utf-8')
+  ) as RelayerTransaction[];
+  console.log(
+    txs.filter((x) => x.to != '0x3d49b60783dB5FA4341355f31e4D9CBa63E53035')
+  );
+  const ids = await getIds();
+  const signedMultiGiveaway = await deployments.get('SignedMultiGiveaway');
+  const iface = new ethers.Interface(signedMultiGiveaway.abi);
+  const decodedIds = new Set<BigInt>();
+  for (const t of txs) {
+    const decoded = iface.decodeFunctionData('revokeClaims', t.data);
+    decoded[0].forEach((x) => decodedIds.add(x));
+  }
+  const vals = Array.from(decodedIds.values());
+  console.log(ids.length, vals.length);
+  console.log(
+    'diff',
+    ids.filter((x) => !decodedIds.has(x))
+  );
+}
+
+main().catch((err) => console.error(err));

packages/deploy/scripts/claimRevoke/event_data.csv

@@ -0,0 +1,45 @@
+/**
+ * Get the transactions from the tx group
+ * How to use:
+ *  - yarn ts-node scripts/claimRevoke/saveTxs.ts
+ */
+import {configDotenv} from 'dotenv';
+import {Defender} from '@openzeppelin/defender-sdk';
+import {PaginatedTransactionResponse} from '@openzeppelin/defender-sdk-relay-signer-client/lib/models/transactions';
+import * as fs from 'node:fs';
+// @ts-ignore
+import path from 'path';
+
+async function main() {
+  configDotenv();
+  if (!process.env.RELAYER_API_KEY || !process.env.RELAYER_API_SECRET) {
+    throw new Error('Missing env vars RELAYER_API_KEY, RELAYER_API_SECRET');
+  }
+  const defender = new Defender({
+    relayerApiKey: process.env.RELAYER_API_KEY,
+    relayerApiSecret: process.env.RELAYER_API_SECRET,
+  });
+  const LIMIT = 30;
+  const txs = [];
+  let status = await defender.relaySigner.listTransactions({limit: LIMIT});
+  for (let i = 0; ; i++) {
+    const t = status as PaginatedTransactionResponse;
+    console.log(i, t.items.length);
+    txs.push(...t.items);
+    if (!t.next) {
+      console.log('done');
+      break;
+    }
+    status = await defender.relaySigner.listTransactions({
+      next: t.next,
+      limit: LIMIT,
+    });
+  }
+  console.log('TOTAL', txs.length);
+  fs.writeFileSync(
+    path.join(__dirname, 'txs_data.json'),
+    JSON.stringify(txs, null, 4)
+  );
+}
+
+main().catch((err) => console.error(err));

packages/deploy/scripts/claimRevoke/parseTxs.ts

@@ -0,0 +1,37 @@
+/**
+ * How to use:
+ *  - yarn ts-node scripts/claimRevoke/split.ts
+ */
+// @ts-ignore
+import csv from 'csv-parser';
+import * as fs from 'fs';
+import * as path from 'path';
+
+const CHUNK_SIZE = 1000;
+
+async function main() {
+  const filename = path.join(__dirname, 'enabled_claims_denied_users.csv');
+  const ids: string[] = await new Promise((resolve) => {
+    const ret: string[] = [];
+    fs.createReadStream(filename)
+      .pipe(csv())
+      .on('data', (data) => {
+        ret.push(BigInt(data.blockchainclaimid).toString());
+      })
+      .on('end', () => {
+        resolve(ret);
+      });
+  });
+  fs.mkdirSync(path.join(__dirname, 'chunks'));
+  fs.mkdirSync(path.join(__dirname, 'done_chunks'));
+  const chunks = [];
+  let j = 0;
+  for (let i = 0; i < ids.length; i += CHUNK_SIZE) {
+    fs.writeFileSync(
+      path.join(__dirname, 'chunks', `chunk_${j++}.json`),
+      JSON.stringify(ids.slice(i, i + CHUNK_SIZE), null, 4)
+    );
+  }
+}
+
+main().catch((err) => console.error(err));