feat: added deleteFile() method to delete files from the network (#2243)

* feat: added deleteFile() method to delete files from the network

Signed-off-by: Logan Nguyen <[email protected]>

* fix: inited a fileId variable and pass along

Signed-off-by: Logan Nguyen <[email protected]>

* fix: set a reasonable max transaction fee

Signed-off-by: Logan Nguyen <[email protected]>

* fix: replaced throwing exception with warnings

Signed-off-by: Logan Nguyen <[email protected]>

* fix: assert fileId is a valid entity

Signed-off-by: Logan Nguyen <[email protected]>

* test: added an acceptance test to test the deleteFile()

Signed-off-by: Logan Nguyen <[email protected]>

---------

Signed-off-by: Logan Nguyen <[email protected]>

Author: quiet-node

packages/relay/src/lib/clients/sdkClient.ts

@@ -48,6 +48,8 @@ import {
   PrecheckStatusError,
   TransactionRecordQuery,
   Hbar,
+  FileId,
+  FileDeleteTransaction,
 } from '@hashgraph/sdk';
 import { BigNumber } from '@hashgraph/sdk/lib/Transfer';
 import { Logger } from 'pino';
@@ -192,7 +194,6 @@ export class SDKClient {
 
   async getFeeSchedule(callerName: string, requestId?: string): Promise<FeeSchedules> {
     const feeSchedulesFileBytes = await this.getFileIdBytes(constants.FEE_SCHEDULE_FILE_ID, callerName, requestId);
-
     return FeeSchedules.fromBytes(feeSchedulesFileBytes);
   }
 
@@ -247,11 +248,12 @@ export class SDKClient {
     const ethereumTransactionData: EthereumTransactionData = EthereumTransactionData.fromBytes(transactionBuffer);
     const ethereumTransaction = new EthereumTransaction();
     const interactingEntity = ethereumTransactionData.toJSON()['to'].toString();
+    let fileId: FileId | null = null;
 
     if (ethereumTransactionData.toBytes().length <= 5120) {
       ethereumTransaction.setEthereumData(ethereumTransactionData.toBytes());
     } else {
-      const fileId = await this.createFile(
+      fileId = await this.createFile(
         ethereumTransactionData.callData,
         this.clientMain,
         requestId,
@@ -269,7 +271,7 @@ export class SDKClient {
     const tinybarsGasFee = await this.getTinyBarGasFee('eth_sendRawTransaction');
     ethereumTransaction.setMaxTransactionFee(Hbar.fromTinybars(Math.floor(tinybarsGasFee * constants.BLOCK_GAS_LIMIT)));
 
-    return this.executeTransaction(ethereumTransaction, callerName, interactingEntity, requestId);
+    return this.executeTransaction(ethereumTransaction, fileId, callerName, interactingEntity, requestId);
   }
 
   async submitContractCallQuery(
@@ -455,6 +457,7 @@ export class SDKClient {
 
   private executeTransaction = async (
     transaction: Transaction,
+    fileId,
     callerName: string,
     interactingEntity: string,
     requestId?: string,
@@ -515,6 +518,14 @@ export class SDKClient {
         throw predefined.HBAR_RATE_LIMIT_EXCEEDED;
       }
       throw sdkClientError;
+    } finally {
+      /**
+       *  For transactions of type CONTRACT_CREATE, if the contract's bytecode (calldata) exceeds 5120 bytes, HFS is employed to temporarily store the bytecode on the network.
+       *  After transaction execution, whether successful or not, any entity associated with the 'fileId' should be removed from the Hedera network.
+       */
+      if (fileId) {
+        await this.deleteFile(this.clientMain, fileId, requestId, callerName, interactingEntity);
+      }
     }
   };
 
@@ -692,4 +703,60 @@ export class SDKClient {
 
     return fileId;
   };
+
+  /**
+   * @dev Deletes `fileId` file from the Hedera Network utilizing Hashgraph SDK client
+   * @param client
+   * @param fileId
+   * @param requestId
+   * @param callerName
+   * @param interactingEntity
+   */
+  private deleteFile = async (
+    client: Client,
+    fileId: FileId,
+    requestId?: string,
+    callerName?: string,
+    interactingEntity?: string,
+  ) => {
+    // format request ID msg
+    const requestIdPrefix = formatRequestIdMessage(requestId);
+
+    try {
+      // Create fileDeleteTx
+      const fileDeleteTx = await new FileDeleteTransaction()
+        .setFileId(fileId)
+        .setMaxTransactionFee(new Hbar(2))
+        .freezeWith(client);
+
+      // execute fileDeleteTx
+      const fileDeleteTxResponse = await fileDeleteTx.execute(client);
+
+      // get fileDeleteTx's record
+      const deleteFileRecord = await fileDeleteTxResponse.getRecord(this.clientMain);
+
+      // capture metrics
+      this.captureMetrics(
+        SDKClient.transactionMode,
+        fileDeleteTx.constructor.name,
+        Status.Success,
+        deleteFileRecord.transactionFee.toTinybars().toNumber(),
+        deleteFileRecord?.contractFunctionResult?.gasUsed,
+        callerName,
+        interactingEntity,
+      );
+
+      // ensure the file is deleted
+      const receipt = deleteFileRecord.receipt;
+      const fileInfo = await new FileInfoQuery().setFileId(fileId).execute(client);
+
+      if (receipt.status === Status.Success && fileInfo.isDeleted) {
+        this.logger.trace(`${requestIdPrefix} Deleted file with fileId: ${fileId}`);
+      } else {
+        this.logger.warn(`${requestIdPrefix} Fail to delete file with fileId: ${fileId} `);
+      }
+    } catch (error: any) {
+      this.logger.warn(`${requestIdPrefix} ${error['message']} `);
+    }
+  };
 }

packages/relay/tests/lib/sdkClient.spec.ts

@@ -26,12 +26,29 @@ import { Registry } from 'prom-client';
 dotenv.config({ path: path.resolve(__dirname, '../test.env') });
 const registry = new Registry();
 import pino from 'pino';
-import { AccountId, Client, ContractCallQuery, PrivateKey, TransactionId, Hbar, Status } from '@hashgraph/sdk';
+import {
+  AccountId,
+  Client,
+  ContractCallQuery,
+  PrivateKey,
+  TransactionId,
+  Hbar,
+  Status,
+  FileId,
+  EthereumTransactionData,
+  FileInfoQuery,
+  FileInfo,
+  FileDeleteTransaction,
+  TransactionRecord,
+} from '@hashgraph/sdk';
 const logger = pino();
 import constants from '../../src/lib/constants';
 import HbarLimit from '../../src/lib/hbarlimiter';
 import { SDKClient } from '../../src/lib/clients';
 import { CacheService } from '../../src/lib/services/cacheService/cacheService';
+import { MAX_GAS_LIMIT_HEX } from './eth/eth-config';
+import { getRequestId, signTransaction } from '../helpers';
+import { TransactionReceipt } from 'ethers';
 
 describe('SdkClient', async function () {
   this.timeout(20000);
@@ -157,4 +174,56 @@ describe('SdkClient', async function () {
       sinon.assert.calledOnce(convertGasPriceToTinyBarsStub);
     });
   });
+
+  describe('deleteFile', () => {
+    // states
+    const gasPrice = '0xad78ebc5ac620000';
+    const callerName = 'eth_sendRawTransaction';
+    const requestId = getRequestId();
+    const transaction = {
+      type: 1,
+      value: 0,
+      chainId: 0x12a,
+      gasPrice,
+      gasLimit: MAX_GAS_LIMIT_HEX,
+      data: '0x' + '00'.repeat(5121), // large contract
+    };
+
+    before(() => {
+      // mock captureMetrics
+      sinon.stub(sdkClient, 'captureMetrics').callsFake(() => {});
+    });
+
+    it('should execute deleteFile', async () => {
+      // prepare fileId
+      const signedTx = await signTransaction(transaction);
+      const transactionBuffer = Buffer.from(signedTx.substring(2), 'hex');
+      const ethereumTransactionData: EthereumTransactionData = EthereumTransactionData.fromBytes(transactionBuffer);
+      const fileId = await sdkClient.createFile(ethereumTransactionData.callData, client, requestId, callerName, '');
+
+      const fileInfoPreDelete = await new FileInfoQuery().setFileId(fileId).execute(client);
+      expect(fileInfoPreDelete.fileId).to.deep.eq(fileId);
+      expect(fileInfoPreDelete.isDeleted).to.be.false;
+      expect(fileInfoPreDelete.size.toNumber()).to.not.eq(0);
+
+      // delete a file
+      await sdkClient.deleteFile(client, fileId, requestId, callerName, '');
+      const fileInfoPostDelete = await new FileInfoQuery().setFileId(fileId).execute(client);
+      expect(fileInfoPostDelete.fileId).to.deep.eq(fileId);
+      expect(fileInfoPostDelete.isDeleted).to.be.true;
+      expect(fileInfoPostDelete.size.toNumber()).to.eq(0);
+    });
+
+    it('should print a `warn` log when delete file with invalid fileId', async () => {
+      // random fileId
+      const fileId = new FileId(0, 0, 369);
+
+      // spy on warn logs
+      const warnLoggerStub = sinon.stub(sdkClient.logger, 'warn');
+
+      // delete a file
+      await sdkClient.deleteFile(client, fileId, requestId, callerName, '');
+      expect(warnLoggerStub.calledWithMatch('ENTITY_NOT_ALLOWED_TO_DELETE')).to.be.true;
+    });
+  });
 });

packages/server/tests/acceptance/rpc_batch1.spec.ts

@@ -24,7 +24,7 @@ import { ethers } from 'ethers';
 import { AliasAccount } from '../clients/servicesClient';
 import Assertions from '../helpers/assertions';
 import { Utils } from '../helpers/utils';
-import { ContractFunctionParameters, TransferTransaction } from '@hashgraph/sdk';
+import { ContractFunctionParameters, FileInfo, FileInfoQuery, TransferTransaction } from '@hashgraph/sdk';
 
 // local resources
 import parentContractJson from '../contracts/Parent.json';
@@ -1006,6 +1006,30 @@ describe('@api-batch-1 RPC Server Acceptance Tests', function () {
         expect(info.created_contract_ids.length).to.be.equal(1);
       });
 
+      it('should delete the file created while execute "eth_sendRawTransaction" to deploy a large contract', async function () {
+        const gasPrice = await relay.gasPrice(requestId);
+        const transaction = {
+          type: 2,
+          chainId: Number(CHAIN_ID),
+          nonce: await relay.getAccountNonce(accounts[2].address, requestId),
+          maxPriorityFeePerGas: gasPrice,
+          maxFeePerGas: gasPrice,
+          gasLimit: defaultGasLimit,
+          data: '0x' + '00'.repeat(5121),
+        };
+
+        const signedTx = await accounts[2].wallet.signTransaction(transaction);
+        const transactionHash = await relay.sendRawTransaction(signedTx, requestId);
+        const txInfo = await mirrorNode.get(`/contracts/results/${transactionHash}`, requestId);
+
+        const contractResult = await mirrorNode.get(`/contracts/${txInfo.contract_id}`);
+        const fileInfo = await new FileInfoQuery().setFileId(contractResult.file_id).execute(servicesNode.client);
+        expect(fileInfo).to.exist;
+        expect(fileInfo instanceof FileInfo).to.be.true;
+        expect(fileInfo.isDeleted).to.be.true;
+        expect(fileInfo.size.toNumber()).to.eq(0);
+      });
+
       it('should execute "eth_sendRawTransaction" and fail when deploying too large contract', async function () {
         const gasPrice = await relay.gasPrice(requestId);
         const transaction = {