feat(js) add ability to get GasInfo after gas calculation (#745)

gear-tech · Dec 22, 2024 · ee8781a · ee8781a
1 parent 896a081
commit ee8781a
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 4 deletions.
diff --git a/js/src/transaction-builder.ts b/js/src/transaction-builder.ts
@@ -1,4 +1,4 @@
-import { GearApi, HexString, ICallOptions, MessageQueuedData, decodeAddress } from '@gear-js/api';
+import { GasInfo, GearApi, HexString, ICallOptions, MessageQueuedData, decodeAddress } from '@gear-js/api';
 import { SignerOptions, SubmittableExtrinsic } from '@polkadot/api/types';
 import { IKeyringPair, ISubmittableResult } from '@polkadot/types/types';
 import { TypeRegistry, u128, u64 } from '@polkadot/types';
@@ -34,6 +34,7 @@ export class TransactionBuilder<ResponseType> {
   private _signerOptions: Partial<SignerOptions>;
   private _tx: SubmittableExtrinsic<'promise', ISubmittableResult>;
   private _voucher: string;
+  private _gasInfo: GasInfo;
   public readonly programId: HexString;
 
   constructor(
@@ -159,9 +160,11 @@ export class TransactionBuilder<ResponseType> {
       ? decodeAddress(typeof this._account === 'string' ? this._account : this._account.address)
       : ZERO_ADDRESS;
 
+    let gas: GasInfo;
+
     switch (this._tx.method.method) {
       case 'uploadProgram': {
-        const gas = await this._api.program.calculateGas.initUpload(
+        gas = await this._api.program.calculateGas.initUpload(
           source,
           this._tx.args[0].toHex(),
           this._tx.args[2].toHex(),
@@ -174,7 +177,7 @@ export class TransactionBuilder<ResponseType> {
         break;
       }
       case 'createProgram': {
-        const gas = await this._api.program.calculateGas.initCreate(
+        gas = await this._api.program.calculateGas.initCreate(
           source,
           this._tx.args[0].toHex(),
           this._tx.args[2].toHex(),
@@ -187,7 +190,7 @@ export class TransactionBuilder<ResponseType> {
         break;
       }
       case 'sendMessage': {
-        const gas = await this._api.program.calculateGas.handle(
+        gas = await this._api.program.calculateGas.handle(
           source,
           this._tx.args[0].toHex(),
           this._tx.args[1].toHex(),
@@ -204,6 +207,8 @@ export class TransactionBuilder<ResponseType> {
       }
     }
 
+    this._gasInfo = gas;
+
     return this;
   }
 
@@ -357,4 +362,8 @@ export class TransactionBuilder<ResponseType> {
       },
     };
   }
+
+  get gasInfo() {
+    return this._gasInfo;
+  }
 }
diff --git a/js/test/demo.test.ts b/js/test/demo.test.ts
@@ -50,6 +50,7 @@ describe('Ping', () => {
 
     const { msgId, blockHash, response } = await transaction.signAndSend();
 
+    expect(transaction.gasInfo).toBeDefined();
     expect(msgId).toBeDefined();
     expect(blockHash).toBeDefined();
 
@@ -62,6 +63,7 @@ describe('Ping', () => {
 
     const { msgId, blockHash, response } = await transaction.signAndSend();
 
+    expect(transaction.gasInfo).toBeDefined();
     expect(msgId).toBeDefined();
     expect(blockHash).toBeDefined();
 
@@ -91,6 +93,7 @@ describe('Ping', () => {
 
     const result = await response();
 
+    expect(transaction.gasInfo).toBeDefined();
     expect(result).toHaveProperty('ok', 'pong');
   });
 });
@@ -104,6 +107,7 @@ describe('Counter', () => {
 
     const { msgId, blockHash, response } = await transaction.signAndSend();
 
+    expect(transaction.gasInfo).toBeDefined();
     expect(msgId).toBeDefined();
     expect(blockHash).toBeDefined();
 
@@ -121,6 +125,7 @@ describe('Counter', () => {
 
     const { msgId, blockHash, response } = await transaction.signAndSend();
 
+    expect(transaction.gasInfo).toBeDefined();
     expect(msgId).toBeDefined();
     expect(blockHash).toBeDefined();
 
@@ -143,6 +148,7 @@ describe('Counter', () => {
 
     const { msgId, blockHash, response } = await transaction.signAndSend();
 
+    expect(transaction.gasInfo).toBeDefined();
     expect(msgId).toBeDefined();
     expect(blockHash).toBeDefined();
 
@@ -171,6 +177,7 @@ describe('Dog', () => {
 
     const { msgId, blockHash, response } = await transaction.signAndSend();
 
+    expect(transaction.gasInfo).toBeDefined();
     expect(msgId).toBeDefined();
     expect(blockHash).toBeDefined();
 
@@ -188,6 +195,7 @@ describe('Dog', () => {
 
     const { msgId, blockHash, response } = await transaction.signAndSend();
 
+    expect(transaction.gasInfo).toBeDefined();
     expect(msgId).toBeDefined();
     expect(blockHash).toBeDefined();
 
@@ -212,6 +220,7 @@ describe('Dog', () => {
 
     const { msgId, blockHash, response } = await transaction.signAndSend();
 
+    expect(transaction.gasInfo).toBeDefined();
     expect(msgId).toBeDefined();
     expect(blockHash).toBeDefined();
 
@@ -242,6 +251,7 @@ describe('ThisThat', () => {
 
     const { msgId, blockHash, response } = await transaction.signAndSend();
 
+    expect(transaction.gasInfo).toBeDefined();
     expect(msgId).toBeDefined();
     expect(blockHash).toBeDefined();
 
@@ -256,6 +266,7 @@ describe('ThisThat', () => {
 
     const { msgId, blockHash, response } = await tx.signAndSend();
 
+    expect(tx.gasInfo).toBeDefined();
     expect(msgId).toBeDefined();
     expect(blockHash).toBeDefined();
 
@@ -272,6 +283,7 @@ describe('ThisThat', () => {
 
     const { msgId, blockHash, response } = await tx.signAndSend();
 
+    expect(tx.gasInfo).toBeDefined();
     expect(msgId).toBeDefined();
     expect(blockHash).toBeDefined();