Decentralized sequencer support (#182)

* Introducing memo version enum * Extra data struct * Passing new tx fields * Parsing new calldata format * Calldata length reference * Introducing calldataVersion optional field into the Pool config object * Fee estimating routines (proxy + prover fees) * Exporting TxFee * Fix memo parsing * Publishing beta * Hardcoding prover fee and proxy address, updating wasm lib * Fix issues (testing) * Introducing Proxy service object * Introducing Sequencer abstraction (Relayer | Proxy) * Fix issues * Updated pool config interface * Calculating min tx amount (1/20 of token by default) * Fetching proxy address and prover fee * Increasing beta version * Fix exports * Increasing beta verion * Removing ExtraItem interface * Updating wasm lib * Code review fixes * Increasing beta ver * Best proxy selection (by fee) * Fix * Introducing prover fee * Prioritizing sequencers from the outside * Increasing beta: 6.0.0-beta6 * Job monitoring improvements * pendingDeltaIndex field processing (sequencer/info endpoint) * New dd abi * Moving DD decoding function [wip] * Decoding DD calldata * Fix typo --------- Co-authored-by: Alexander Filippov <[email protected]>
zkBob · Aug 30, 2024 · e074115 · e074115
1 parent 07b702f
commit e074115
Show file tree

Hide file tree

Showing 23 changed files with 1,158 additions and 573 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "zkbob-client-js",
-  "version": "5.5.3",
+  "version": "6.0.0",
   "description": "zkBob integration library",
   "repository": "[email protected]:zkBob/libzkbob-client-js.git",
   "author": "Dmitry Vdovin <[email protected]>",
@@ -30,8 +30,8 @@
     "graphql": "16.7.1",
     "hdwallet-babyjub": "^0.0.2",
     "idb": "^7.0.0",
-    "libzkbob-rs-wasm-web": "1.6.0",
-    "libzkbob-rs-wasm-web-mt": "1.6.0",
+    "libzkbob-rs-wasm-web": "1.7.0-beta5",
+    "libzkbob-rs-wasm-web-mt": "1.7.0-beta5",
     "promise-throttle": "^1.1.2",
     "regenerator-runtime": "^0.13.9",
     "tronweb": "^5.3.0",

diff --git a/src/address-prefixes.ts b/src/address-prefixes.ts
@@ -30,8 +30,8 @@ export const hardcodedPrefixes: ZkAddressPrefix[] = [
     // Staging address prefixes
     {
         poolId: 0x000000,
-        prefix: 'zkbob_sepolia',
-        name: 'BOB on Sepolia testnet'
+        prefix: 'zkbob_sepold',
+        name: 'BOB on Sepolia testnet [the first dev pool, deprecated]'
     },
     {
         poolId: 0xffff02,

diff --git a/src/client-provider.ts b/src/client-provider.ts
diff --git a/src/client.ts b/src/client.ts
diff --git a/src/config.ts b/src/config.ts
@@ -1,3 +1,4 @@
+import { TxCalldataVersion } from "./tx";
 import { bufToHex } from "./utils";
 import { hash } from 'tweetnacl';
 
@@ -27,16 +28,17 @@ export enum DepositType {
   SaltedPermit = 'permit',  // based on EIP-2612 (salt was added to the signing message)
   PermitV2 = 'permit2',   // Uniswap Permit2 scheme (used for WETH)
   AuthUSDC = 'usdc',   // EIP-3009 (for most of USDC deployments)
-  AuthPolygonUSDC = 'usdc-polygon',  // EIP-3009 (used by USDC token on Polygon)
+  AuthPolygonUSDC = 'usdc-polygon',  // EIP-3009 (used by USDC.e token on Polygon)
 }
 
 export interface Pool {
   chainId: number;
   poolAddress: string;
   tokenAddress: string,
-  relayerUrls: string[];
-  delegatedProverUrls: string[];
   depositScheme: DepositType;
+  relayerUrls?: string[];
+  proxyUrls?: string[];
+  delegatedProverUrls?: string[];
   coldStorageConfigPath?: string;
   minTxAmount?: bigint;
   feeDecimals?: number;

diff --git a/src/emergency.ts b/src/emergency.ts
@@ -151,10 +151,14 @@ export class ForcedExitProcessor {
       // create regular withdraw tx
       const oneTx: IWithdrawData = {
           amount: requestedAmount.toString(),
-          fee: '0',
           to: this.network.addressToBytes(toAddress),
           native_amount: '0',
           energy_amount: '0',
+          proxy: this.network.addressToBytes(''),
+          prover: this.network.addressToBytes(''),
+          proxy_fee: '0',
+          prover_fee: '0',
+          data: [],
       };
       const oneTxData = await this.state.createWithdrawalOptimistic(oneTx, ZERO_OPTIMISTIC_STATE);
 

diff --git a/src/errors.ts b/src/errors.ts
@@ -1,4 +1,5 @@
 import { ServiceType } from "./services/common";
+import { SequencerJob } from "./services/relayer";
 
 export class BobError extends Error {
     constructor(message: string) {
@@ -101,14 +102,14 @@ export class NetworkError extends BobError {
 }
 
 export class RelayerJobError extends BobError {
-    constructor(public jobId: number, public reason: string) {
-        super(`Job ${jobId} failed with reason: ${reason}`);
+    constructor(public job: SequencerJob, public reason: string) {
+        super(`Job ${job.toString()} failed with reason: ${reason}`);
     }
 }
 
 export class PoolJobError extends BobError {
-    constructor(public jobId: number, public txHash: string, public reason: string) {
-        super(`Tx ${txHash} (job ${jobId}) was reverted on the contract with reason: ${reason}`);
+    constructor(public job: SequencerJob, public txHash: string, public reason: string) {
+        super(`Tx ${txHash} (job ${job.toString()}) was reverted on the contract with reason: ${reason}`);
     }
 }