refactor(core)!: deprecate the default gasPrice on SigningArchwayClie…

…nt (#86) **BREAKING CHANGE:** modified the response of `getEstimateTxFees` to change the `estimatedFee` type from `Coin[]` to `StdFee` and moved the `gasLimit` into `estimatedFee.gas`.
archway-network · May 26, 2023 · b1c72cf · b1c72cf
1 parent 2b57a4d
commit b1c72cf
Show file tree

Hide file tree

Showing 14 changed files with 479 additions and 101 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -128,6 +128,7 @@ module.exports = {
     '@typescript-eslint/ban-types': 'warn',
     '@typescript-eslint/explicit-function-return-type': ['error', { allowExpressions: true }],
     '@typescript-eslint/explicit-member-accessibility': 'error',
+    '@typescript-eslint/no-inferrable-types': 'off',
     '@typescript-eslint/naming-convention': [
       'error',
       {

diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,5 @@
+{
+  "editorconfig": true,
+  "arrowParens": "avoid",
+  "printWidth": 120
+}
diff --git a/.yarn/versions/4d4c6e79.yml b/.yarn/versions/4d4c6e79.yml
@@ -0,0 +1,6 @@
+releases:
+  "@archwayhq/arch3-core": minor
+  "@archwayhq/arch3.js": minor
+
+declined:
+  - "@archwayhq/arch3-proto"
diff --git a/changelog.md b/changelog.md
@@ -5,6 +5,26 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## Unreleased
+
+### New feature
+
+#### **arch3-core**
+
+- method to `calculateFees` for multiple messages on `SigningArchwayClient` (#86)
+
+### Changes
+
+#### **arch3-core**
+
+- deprecated the default `gasPrice` option on `SigningArchwayClient` (#86)
+
+### BREAKING CHANGES
+
+- modified the response of `ArchwayCLient.getEstimateTxFees` to change the
+  `estimatedFee` type from `Coin[]` to `StdFee` and moved the `gasLimit`
+  into `estimatedFee.gas`
+
 ## v0.2.0 (2023-05-17)
 
 ### New feature

diff --git a/package.json b/package.json
@@ -89,6 +89,7 @@
     "@microsoft/eslint-formatter-sarif": "^3.0",
     "@types/jest": "^29.5.1",
     "@types/node": "^18.15.13",
+    "@types/prettier": "^2",
     "@typescript-eslint/eslint-plugin": "^5.59.1",
     "@typescript-eslint/parser": "^5.59.1",
     "@yarnpkg/sdks": "^2.7.0",
@@ -105,6 +106,8 @@
     "jest": "^29.5.0",
     "lint-staged": "^13.2.1",
     "pinst": "^3.0.0",
+    "prettier": "^2.8.8",
+    "prettier-eslint": "^15.0.1",
     "rimraf": "^3.0.2",
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",

diff --git a/packages/arch3-core/package.json b/packages/arch3-core/package.json
@@ -67,6 +67,7 @@
     "@microsoft/eslint-formatter-sarif": "^3.0",
     "@types/jest": "^29.5.1",
     "@types/node": "^18.15.13",
+    "@types/prettier": "^2",
     "@typescript-eslint/eslint-plugin": "^5.59.1",
     "@typescript-eslint/parser": "^5.59.1",
     "dotenv": "^16.0.3",
@@ -78,6 +79,8 @@
     "eslint-plugin-jsdoc": "^43.1.1",
     "eslint-plugin-node": "^11.1.0",
     "jest": "^29.5.0",
+    "prettier": "^2.8.8",
+    "prettier-eslint": "^15.0.1",
     "rimraf": "^3.0.2",
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",

diff --git a/packages/arch3-core/src/archwayclient.spec.ts b/packages/arch3-core/src/archwayclient.spec.ts
@@ -55,13 +55,18 @@ describe('ArchwayClient', () => {
       const client = await ArchwayClient.connect(archwayd.endpoint);
       const response = await client.getEstimateTxFees();
 
-      expect(response.gasLimit).toBeUndefined();
       expect(response.gasUnitPrice).toMatchObject({
         denom: archwayd.denom,
         amount: expect.any(Decimal),
       });
       expect(response.contractAddress).toBeUndefined();
-      expect(response.estimatedFee).toHaveLength(0);
+      expect(response.estimatedFee).toMatchObject({
+        gas: '1',
+        amount: expect.objectContaining([{
+          denom: archwayd.denom,
+          amount: expect.stringMatching(/^\d+$/),
+        }])
+      });
 
       client.disconnect();
     });
@@ -70,15 +75,17 @@ describe('ArchwayClient', () => {
       const client = await ArchwayClient.connect(archwayd.endpoint);
       const response = await client.getEstimateTxFees(1, contractAddress);
 
-      expect(response.gasLimit).toBe(1);
       expect(response.gasUnitPrice).toMatchObject({
         denom: archwayd.denom,
         amount: expect.any(Decimal),
       });
       expect(response.contractAddress).toBe(contractAddress);
-      expect(response.estimatedFee).toContainEqual({
-        denom: archwayd.denom,
-        amount: expect.stringMatching(/^\d+$/),
+      expect(response.estimatedFee).toMatchObject({
+        gas: '1',
+        amount: expect.objectContaining([{
+          denom: archwayd.denom,
+          amount: expect.stringMatching(/^\d+$/),
+        }])
       });
 
       client.disconnect();

diff --git a/packages/arch3-core/src/index.ts b/packages/arch3-core/src/index.ts
@@ -14,6 +14,7 @@ export {
   SetContractMetadataResult,
   SetContractPremiumResult,
   SigningArchwayClient,
+  SigningArchwayClientOptions,
   TxResult,
   WithdrawContractRewardsResult,
 } from './signingarchwayclient';

diff --git a/packages/arch3-core/src/queryclient.ts b/packages/arch3-core/src/queryclient.ts
@@ -167,25 +167,27 @@ class ArchwayQueryClientImpl implements IArchwayQueryClient {
     }
   }
 
-  public async getEstimateTxFees(gasLimit?: number, contractAddress?: string): Promise<EstimateTxFees> {
+  public async getEstimateTxFees(gasLimit: number = 1, contractAddress?: string): Promise<EstimateTxFees> {
     const client = this.forceGetQueryClient();
     const {
       estimatedFee,
-      gasUnitPrice: { amount: gasAmount, denom: gasDenom }
-    } = await client.rewards.estimateTxFees(gasLimit ?? 0, contractAddress ?? '');
+      gasUnitPrice: { amount: gasPriceAmount, denom: gasPriceDenom }
+    } = await client.rewards.estimateTxFees(gasLimit, contractAddress ?? '');
 
     // The RPC queries do not include the decimal precision fot types.Dec,
     // so we need to manually decode the gas amount from the proto, as suggested in
     // https://github.com/osmosis-labs/telescope/issues/247#issuecomment-1292407464
     // See also: https://github.com/cosmos/cosmos-sdk/issues/10863
-    const gasUnitPriceAmount = decodeCosmosSdkDecFromProto(gasAmount);
-    const gasUnitPrice = new GasPrice(gasUnitPriceAmount, gasDenom);
+    const gasUnitPriceAmount = decodeCosmosSdkDecFromProto(gasPriceAmount);
+    const gasUnitPrice = new GasPrice(gasUnitPriceAmount, gasPriceDenom);
 
     return {
-      gasLimit,
       contractAddress,
-      estimatedFee,
       gasUnitPrice,
+      estimatedFee: {
+        amount: estimatedFee,
+        gas: gasLimit.toString(),
+      }
     };
   }
 

diff --git a/packages/arch3-core/src/signingarchwayclient.spec.ts b/packages/arch3-core/src/signingarchwayclient.spec.ts
@@ -34,10 +34,9 @@ async function getWalletWithAccounts(): Promise<[DirectSecp256k1HdWallet, readon
 
 const flatFee = coin(1000, archwayd.denom);
 
-const defaultSigningClientOptions: SigningCosmWasmClientOptions = {
+const clientOptions: SigningCosmWasmClientOptions = {
   broadcastPollIntervalMs: 200,
   broadcastTimeoutMs: 8_000,
-  gasPrice: GasPrice.fromString(`900${archwayd.denom}`),
 };
 
 async function assertGasPriceEstimation(
@@ -63,7 +62,7 @@ describe('SigningArchwayClient', () => {
   describe('connectWithSigner', () => {
     it('can be constructed', async () => {
       const wallet = await DirectSecp256k1HdWallet.generate(12, { prefix: archwayd.prefix });
-      const client = await SigningArchwayClient.connectWithSigner(archwayd.endpoint, wallet, defaultSigningClientOptions);
+      const client = await SigningArchwayClient.connectWithSigner(archwayd.endpoint, wallet, clientOptions);
       expect(client).toBeDefined();
       client.disconnect();
     });
@@ -72,18 +71,13 @@ describe('SigningArchwayClient', () => {
   describe('offline', () => {
     it('can be constructed', async () => {
       const wallet = await DirectSecp256k1HdWallet.generate(12, { prefix: archwayd.prefix });
-      const client = await SigningArchwayClient.offline(wallet, defaultSigningClientOptions);
+      const client = await SigningArchwayClient.offline(wallet, clientOptions);
       expect(client).toBeDefined();
       client.disconnect();
     });
   });
 
   describe('minimum gas fee estimation', () => {
-    const clientOptions: SigningCosmWasmClientOptions = {
-      broadcastPollIntervalMs: 200,
-      broadcastTimeoutMs: 8_000,
-    };
-
     it('works for base transactions', async () => {
       const [wallet, accounts] = await getWalletWithAccounts();
       const client = await SigningArchwayClient.connectWithSigner(archwayd.endpoint, wallet, clientOptions);
@@ -231,7 +225,7 @@ describe('SigningArchwayClient', () => {
     describe('contract metadata', () => {
       it('sets both owner and rewards', async () => {
         const [wallet, accounts] = await getWalletWithAccounts();
-        const client = await SigningArchwayClient.connectWithSigner(archwayd.endpoint, wallet, defaultSigningClientOptions);
+        const client = await SigningArchwayClient.connectWithSigner(archwayd.endpoint, wallet, clientOptions);
 
         const contractAddress = contracts.voter.addresses[1];
         const ownerAddress = accounts[1].address;
@@ -259,7 +253,7 @@ describe('SigningArchwayClient', () => {
 
       it('do not modify the metadata when both owner and rewards are empty', async () => {
         const [wallet, accounts] = await getWalletWithAccounts();
-        const client = await SigningArchwayClient.connectWithSigner(archwayd.endpoint, wallet, defaultSigningClientOptions);
+        const client = await SigningArchwayClient.connectWithSigner(archwayd.endpoint, wallet, clientOptions);
 
         const contractAddress = contracts.voter.addresses[1];
         const ownerAddress = accounts[1].address;
@@ -288,7 +282,7 @@ describe('SigningArchwayClient', () => {
     describe('contract premium', () => {
       it('sets the contract premium', async () => {
         const [wallet, accounts] = await getWalletWithAccounts();
-        const client = await SigningArchwayClient.connectWithSigner(archwayd.endpoint, wallet, defaultSigningClientOptions);
+        const client = await SigningArchwayClient.connectWithSigner(archwayd.endpoint, wallet, clientOptions);
 
         const ownerAddress = accounts[1].address;
         const contractAddress = contracts.voter.addresses[1];
@@ -318,7 +312,7 @@ describe('SigningArchwayClient', () => {
 
       it('disables the contract premium', async () => {
         const [wallet, accounts] = await getWalletWithAccounts();
-        const client = await SigningArchwayClient.connectWithSigner(archwayd.endpoint, wallet, defaultSigningClientOptions);
+        const client = await SigningArchwayClient.connectWithSigner(archwayd.endpoint, wallet, clientOptions);
 
         const contractAddress = contracts.voter.addresses[2];
         const ownerAddress = accounts[2].address;
@@ -350,7 +344,7 @@ describe('SigningArchwayClient', () => {
     describe('withdraw', () => {
       it('withdraws rewards by limit', async () => {
         const [wallet, accounts] = await getWalletWithAccounts();
-        const client = await SigningArchwayClient.connectWithSigner(archwayd.endpoint, wallet, defaultSigningClientOptions);
+        const client = await SigningArchwayClient.connectWithSigner(archwayd.endpoint, wallet, clientOptions);
 
         const contractAddress = contracts.voter.addresses[3];
         const rewardsAddress = accounts[3].address;