Add guarded tx in a batch (#180)

* add guarded tx in a batch

* add guarded property in submitGateway function

* update @etherspot/contracts

package.json

@@ -1,6 +1,6 @@
 {
   "name": "etherspot",
-  "version": "1.38.1",
+  "version": "1.38.2",
   "description": "Etherspot SDK",
   "keywords": [
     "ether",
@@ -41,7 +41,7 @@
   },
   "dependencies": {
     "@apollo/client": "3.4.0",
-    "@etherspot/contracts": "1.9.0",
+    "@etherspot/contracts": "1.9.3",
     "@lifi/sdk": "1.6.0",
     "@nerdwallet/apollo-cache-policies": "1.2.1",
     "class-transformer": "0.4.0",

src/sdk/context.ts

@@ -23,6 +23,7 @@ import {
   ENSReverseRegistrarContract,
   ERC20TokenContract,
   GatewayContract,
+  GatewayV2Contract,
   PaymentRegistryContract,
   PersonalAccountRegistryContract,
 } from './contract';
@@ -40,6 +41,7 @@ export class Context {
       gatewayContract: GatewayContract;
       paymentRegistryContract: PaymentRegistryContract;
       personalAccountRegistryContract: PersonalAccountRegistryContract;
+      gatewayV2Contract: GatewayV2Contract,
     },
     readonly services: {
       accountService: AccountService;

src/sdk/contract/internal/__mocks__/gatewayV2.contract.ts

@@ -0,0 +1,8 @@
+import { ContractNames } from '@etherspot/contracts';
+import { mockContract } from '../../../../testing';
+
+export const GatewayV2Contract = mockContract(ContractNames.GatewayV2, {
+  encodeSendBatchFromAccount: jest.fn(),
+  encodeDelegateBatch: jest.fn(),
+  buildDelegatedBatchTypedData: jest.fn(),
+});

src/sdk/contract/internal/gatewayV2.contract.ts

@@ -0,0 +1,43 @@
+import { ContractNames } from '@etherspot/contracts';
+import { TransactionRequest } from '../../common';
+import { InternalContract } from './internal.contract';
+
+export class GatewayV2Contract extends InternalContract {
+  constructor() {
+    super(ContractNames.GatewayV2);
+  }
+
+  encodeSendBatchFromAccount?(account: string, to: string[], data: string[]): TransactionRequest;
+
+  encodeDelegateBatch?(
+    account: string,
+    nonce: number,
+    to: string[],
+    data: string[],
+    senderSignature: string,
+  ): TransactionRequest;
+
+  encodeSendBatchFromAccountGuarded?(
+    account: string,
+    to: string[],
+    data: string[],
+  ): TransactionRequest;
+
+  hashDelegatedBatch(account: string, nonce: number, to: string[], data: string[]): Buffer {
+    return this.hashMessagePayload(
+      'DelegatedBatch',
+      [
+        { name: 'account', type: 'address' }, //
+        { name: 'nonce', type: 'uint256' },
+        { name: 'to', type: 'address[]' },
+        { name: 'data', type: 'bytes[]' },
+      ],
+      {
+        account, //
+        nonce,
+        to,
+        data,
+      },
+    );
+  }
+}

src/sdk/contract/internal/index.ts

@@ -5,3 +5,4 @@ export * from './gateway.contract';
 export * from './internal.contract';
 export * from './payment-registry.contract';
 export * from './personal-account-registry.contract';
+export * from './gatewayV2.contract';

src/sdk/contract/internal/personal-account-registry.contract.ts

@@ -23,6 +23,19 @@ export class PersonalAccountRegistryContract extends InternalContract {
     data: BytesLike,
   ): TransactionRequest;
 
+  encodeIsAccountDeployed(
+    account: string
+  ): TransactionRequest {
+    const data = this.interface.encodeFunctionData(
+      'isAccountDeployed',
+      [account]
+    );
+    return {
+      to: this.address,
+      data
+    }
+  };
+
   computeAccountAddress(saltOwner: string): string {
     let result: string = null;
 

src/sdk/dto/custom-project-metadata.dto.ts

@@ -4,4 +4,7 @@ export class CustomProjectMetadataDto {
   @IsOptional()
   @MaxLength(128)
   customProjectMetadata?: string = null;
+
+  @IsOptional()
+  guarded?: boolean = false;
 }

src/sdk/gateway/gateway.service.ts

@@ -482,7 +482,7 @@ export class GatewayService extends Service {
       throw new Exception('Can not submit empty batch');
     }
 
-    const { estimation } = statelessBatch || this.gatewayBatch;
+    const { estimation } = statelessBatch?.estimation ? statelessBatch : this.gatewayBatch;
 
     if (!estimation || estimation.expiredAt.getTime() < estimation.createdAt.getTime()) {
       throw new Exception('Can not submit not estimated batch');
@@ -501,7 +501,12 @@ export class GatewayService extends Service {
     const { nonce, feeToken } = this.estimationOptions;
 
     const { accountService, walletService, apiService } = this.services;
-    const { gatewayContract, personalAccountRegistryContract, erc20TokenContract } = this.internalContracts;
+    const {
+      gatewayContract,
+      personalAccountRegistryContract,
+      erc20TokenContract,
+      gatewayV2Contract,
+    } = this.internalContracts;
 
     const account = accountService.accountAddress;
 
@@ -520,12 +525,20 @@ export class GatewayService extends Service {
       feeTransactionRequest = personalAccountRegistryContract.encodeRefundAccountCall(account, null, feeAmount);
     }
 
-    const messageHash = gatewayContract.hashDelegatedBatch(
-      account,
-      nonce,
-      [...to, feeTransactionRequest.to],
-      [...data, feeTransactionRequest.data],
-    );
+    let guardedTx: TransactionRequest = null;
+    if (statelessBatch.guarded) {
+      const guardedTxContent = personalAccountRegistryContract.encodeIsAccountDeployed(gatewayContract.address);
+      guardedTx = gatewayV2Contract.encodeSendBatchFromAccountGuarded(
+        gatewayContract.address,
+        [guardedTxContent.to],
+        [guardedTxContent.data],
+      );
+    }
+
+    const destinations = [guardedTx && guardedTx.to, ...to, feeTransactionRequest.to].filter((addr) => !!addr);
+    const datas = [guardedTx && guardedTx.data, ...data, feeTransactionRequest.data].filter((data) => !!data);
+    const messageHash = gatewayContract.hashDelegatedBatch(account, nonce, destinations, datas);
+
     const senderSignature = await walletService.signMessage(messageHash);
 
     const { result } = await apiService.mutate<{
@@ -545,6 +558,7 @@ export class GatewayService extends Service {
           $estimatedGasPrice: BigNumber!
           $estimationExpiredAt: DateTime!
           $estimationSignature: String!
+          $guarded: Boolean,
         ) {
           result: submitGatewayBatch(
             chainId: $chainId
@@ -559,6 +573,7 @@ export class GatewayService extends Service {
             estimatedGasPrice: $estimatedGasPrice
             estimationExpiredAt: $estimationExpiredAt
             estimationSignature: $estimationSignature
+            guarded: $guarded
           ) {
             transaction {
               hash
@@ -604,11 +619,12 @@ export class GatewayService extends Service {
           estimatedGasPrice,
           estimationExpiredAt,
           estimationSignature,
+          guarded: statelessBatch.guarded,
         },
       },
     );
 
-    if (!statelessBatch) {
+    if (!statelessBatch || (!statelessBatch.requests && !statelessBatch.estimation)) {
       this.clearGatewayBatch();
     }
 
@@ -732,7 +748,7 @@ export class GatewayService extends Service {
   }
 
   private extractToAndData(statelessBatch?: GatewayBatch): { to: string[]; data: string[] } {
-    return (statelessBatch || this.gatewayBatch).requests.reduce(
+    return (statelessBatch?.requests ? statelessBatch : this.gatewayBatch).requests.reduce(
       (result, { to, data }) => {
         result.to.push(to);
         result.data.push(data);

src/sdk/gateway/interfaces.ts

@@ -6,4 +6,5 @@ export interface GatewayBatch {
     data: string;
   }[];
   estimation: GatewayEstimatedBatch;
+  guarded?: boolean;
 }

src/sdk/sdk.ts

@@ -24,6 +24,7 @@ import {
   ENSReverseRegistrarContract,
   ERC20TokenContract,
   GatewayContract,
+  GatewayV2Contract,
   PaymentRegistryContract,
   PersonalAccountRegistryContract,
 } from './contract';
@@ -213,6 +214,7 @@ export class Sdk {
       gatewayContract: new GatewayContract(),
       paymentRegistryContract: new PaymentRegistryContract(),
       personalAccountRegistryContract: new PersonalAccountRegistryContract(),
+      gatewayV2Contract: new GatewayV2Contract(),
     };
 
     this.services = {
@@ -507,7 +509,11 @@ export class Sdk {
 
     return projectService.withCustomProjectMetadata(
       customProjectMetadata, //
-      () => gatewayService.submitGatewayBatch(),
+      () => gatewayService.submitGatewayBatch({
+        requests: null,
+        estimation: null,
+        guarded: dto.guarded
+      }),
     );
   }