Merge branch 'dev' into refactor/esm-build-and-deprecating-packages

Author: ThomasRalee

.gitbook/core-modules/token-factory.md

@@ -6,7 +6,7 @@ This `tokenfactory` module allows any account to create a new token with the nam
 
 _Note: If you want your denom to be visible on products like Helix, Hub, Explorer, etc, it's important to add token metadata information using the `MsgSetDenomMetadata` message as explained below._
 
-_Note #2: It's recommended to change your admin to the zero address for safety and preventing supply manipulation._ 
+_Note #2: It's recommended to change your admin to the zero address for safety and preventing supply manipulation._
 
 #### Messages
 
@@ -78,7 +78,7 @@ console.log(txHash)
 
 #### MsgBurn
 
-Burning of a specific denom is only allowed for the current admin. Note, the current admin is defaulted to the creator of the denom.
+The admin can burn the supply of the token factory. Everyone else can use this message to burn their funds only. 
 
 ```ts
 import { MsgBurn } from '@injectivelabs/sdk-ts'

deprecated/packages/wallet-ts/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@injectivelabs/wallet-ts",
   "description": "A convenient way to use and interact with different types of wallets on Injective.",
-  "version": "1.14.34-beta.5",
+  "version": "1.14.34-beta.22",
   "sideEffects": false,
   "author": {
     "name": "InjectiveLabs",
@@ -81,11 +81,11 @@
     "@cosmostation/extension-client": "^0.1.15",
     "@ethereumjs/common": "^3.1.1",
     "@ethereumjs/tx": "^4.1.1",
-    "@injectivelabs/exceptions": "^1.14.34-beta.0",
-    "@injectivelabs/networks": "^1.14.34-beta.0",
-    "@injectivelabs/sdk-ts": "^1.14.34-beta.5",
-    "@injectivelabs/ts-types": "^1.14.33",
-    "@injectivelabs/utils": "^1.14.34-beta.0",
+    "@injectivelabs/exceptions": "^1.14.34-beta.5",
+    "@injectivelabs/networks": "^1.14.34-beta.5",
+    "@injectivelabs/sdk-ts": "^1.14.34-beta.22",
+    "@injectivelabs/ts-types": "^1.14.34-beta.2",
+    "@injectivelabs/utils": "^1.14.34-beta.5",
     "@keplr-wallet/cosmos": "^0.12.71",
     "@keplr-wallet/types": "^0.12.71",
     "@ledgerhq/hw-app-cosmos": "^6.29.5",

deprecated/packages/wallet-ts/src/broadcaster/MsgBroadcaster.ts

@@ -29,10 +29,14 @@ import {
   getStdFee,
   BigNumberInBase,
   DEFAULT_BLOCK_TIMEOUT_HEIGHT,
+  sleep,
 } from '@injectivelabs/utils'
 import {
-  GeneralException,
+  ThrownException,
   isThrownException,
+  GeneralException,
+  ChainCosmosErrorCode,
+  TransactionChainErrorModule,
   TransactionException,
   UnspecifiedErrorCode,
 } from '@injectivelabs/exceptions'
@@ -56,7 +60,10 @@ import {
   isEip712V2OnlyWallet,
 } from '../strategies/wallet-strategy/utils.js'
 import { Wallet, WalletDeviceType } from '../types/index.js'
-import { createEip712StdSignDoc, KeplrWallet } from '../utils/wallets/keplr/index.js'
+import {
+  createEip712StdSignDoc,
+  KeplrWallet,
+} from '../utils/wallets/keplr/index.js'
 import { isCosmosAminoOnlyWallet } from '../utils/index.js'
 import { LeapWallet } from '../utils/wallets/index.js'
 import { checkIfTxRunOutOfGas } from './helper.js'
@@ -77,6 +84,15 @@ const getEthereumWalletPubKey = <T>({
   return hexToBase64(recoverTypedSignaturePubKey(eip712TypedData, signature))
 }
 
+const defaultRetriesConfig = () => ({
+  [`${TransactionChainErrorModule.CosmosSdk}-${ChainCosmosErrorCode.ErrMempoolIsFull}`]:
+    {
+      retries: 0,
+      maxRetries: 10,
+      timeout: 1000,
+    },
+})
+
 /**
  * This class is used to broadcast transactions
  * using the WalletStrategy as a handler
@@ -101,6 +117,8 @@ export class MsgBroadcaster {
 
   public gasBufferCoefficient: number = 1.2
 
+  public retriesOnError = defaultRetriesConfig()
+
   constructor(options: MsgBroadcasterOptions) {
     const networkInfo = getNetworkInfo(options.network)
 
@@ -154,10 +172,10 @@ export class MsgBroadcaster {
 
     try {
       return isCosmosWallet(walletStrategy.wallet)
-        ? this.broadcastCosmos(txWithAddresses)
+        ? await this.broadcastCosmos(txWithAddresses)
         : isEip712V2OnlyWallet(walletStrategy.wallet)
-        ? this.broadcastWeb3V2(txWithAddresses)
-        : this.broadcastWeb3(txWithAddresses)
+        ? await this.broadcastWeb3V2(txWithAddresses)
+        : await this.broadcastWeb3(txWithAddresses)
     } catch (e) {
       const error = e as any
 
@@ -198,8 +216,8 @@ export class MsgBroadcaster {
 
     try {
       return isCosmosWallet(walletStrategy.wallet)
-        ? this.broadcastCosmos(txWithAddresses)
-        : this.broadcastWeb3V2(txWithAddresses)
+        ? await this.broadcastCosmos(txWithAddresses)
+        : await this.broadcastWeb3V2(txWithAddresses)
     } catch (e) {
       const error = e as any
 
@@ -241,18 +259,20 @@ export class MsgBroadcaster {
     }
 
     return isCosmosWallet(walletStrategy.wallet)
-      ? this.broadcastCosmos(txWithAddresses)
-      : this.broadcastWeb3WithFeeDelegation(txWithAddresses)
+      ? await this.broadcastCosmos(txWithAddresses)
+      : await this.broadcastWeb3WithFeeDelegation(txWithAddresses)
   }
 
   /**
    * Broadcasting the transaction using the feeDelegation
    * support approach for both cosmos and ethereum native wallets
    *
    * @param tx
-   * @returns {string} transaction hash
+   * @returns {TxResponse}
    */
-  async broadcastWithFeeDelegation(tx: MsgBroadcasterTxOptions) {
+  async broadcastWithFeeDelegation(
+    tx: MsgBroadcasterTxOptions,
+  ): Promise<TxResponse> {
     const { options } = this
     const { walletStrategy } = options
     const txWithAddresses = {
@@ -273,8 +293,8 @@ export class MsgBroadcaster {
 
     try {
       return isCosmosWallet(walletStrategy.wallet)
-        ? this.broadcastCosmosWithFeeDelegation(txWithAddresses)
-        : this.broadcastWeb3WithFeeDelegation(txWithAddresses)
+        ? await this.broadcastCosmosWithFeeDelegation(txWithAddresses)
+        : await this.broadcastWeb3WithFeeDelegation(txWithAddresses)
     } catch (e) {
       const error = e as any
 
@@ -552,7 +572,7 @@ export class MsgBroadcaster {
         .toNumber()
     }
 
-    const txResponse = await transactionApi.prepareTxRequest({
+    const prepareTxResponse = await transactionApi.prepareTxRequest({
       timeoutHeight,
       memo: tx.memo,
       message: web3Msgs,
@@ -563,45 +583,52 @@ export class MsgBroadcaster {
     })
 
     const signature = await walletStrategy.signEip712TypedData(
-      txResponse.data,
+      prepareTxResponse.data,
       tx.ethereumAddress,
     )
 
-    const response = await transactionApi.broadcastTxRequest({
-      signature,
-      txResponse,
-      message: web3Msgs,
-      chainId: ethereumChainId,
-    })
+    const broadcast = async () =>
+      await transactionApi.broadcastTxRequest({
+        signature,
+        message: web3Msgs,
+        txResponse: prepareTxResponse,
+        chainId: ethereumChainId,
+      })
 
     try {
-      const txResponse = await new TxGrpcApi(endpoints.grpc).fetchTxPoll(
-        response.txHash,
-      )
+      const response = await broadcast()
 
-      return txResponse
+      return await new TxGrpcApi(endpoints.grpc).fetchTxPoll(response.txHash)
     } catch (e) {
-      /**
-       * First MsgExec transaction with a PrivateKey wallet
-       * always runs out of gas for some reason, temporary solution
-       * to just broadcast the transaction twice
-       **/
-      if (
-        walletStrategy.wallet === Wallet.PrivateKey &&
-        checkIfTxRunOutOfGas(e)
-      ) {
-        /** Account Details * */
-        const accountDetails = await new ChainGrpcAuthApi(
-          endpoints.grpc,
-        ).fetchAccount(tx.injectiveAddress)
-        const { baseAccount } = accountDetails
-
-        /** We only do it on the first account tx fail */
-        if (baseAccount.sequence > 1) {
-          throw e
+      const error = e as any
+
+      if (isThrownException(error)) {
+        const exception = error as ThrownException
+
+        /**
+         * First MsgExec transaction with a PrivateKey wallet
+         * always runs out of gas for some reason, temporary solution
+         * to just broadcast the transaction twice
+         **/
+        if (
+          walletStrategy.wallet === Wallet.PrivateKey &&
+          checkIfTxRunOutOfGas(exception)
+        ) {
+          /** Account Details * */
+          const accountDetails = await new ChainGrpcAuthApi(
+            endpoints.grpc,
+          ).fetchAccount(tx.injectiveAddress)
+          const { baseAccount } = accountDetails
+
+          /** We only do it on the first account tx fail */
+          if (baseAccount.sequence > 1) {
+            throw e
+          }
+
+          return await this.broadcastWeb3WithFeeDelegation(tx)
         }
 
-        return await this.broadcastWeb3WithFeeDelegation(tx)
+        return await this.retryOnException(exception, broadcast)
       }
 
       throw e
@@ -949,22 +976,38 @@ export class MsgBroadcaster {
     const transactionApi = new IndexerGrpcTransactionApi(
       endpoints.web3gw || endpoints.indexer,
     )
-    const response = await transactionApi.broadcastCosmosTxRequest({
-      address: tx.injectiveAddress,
-      txRaw: createTxRawFromSigResponse(directSignResponse),
-      signature: directSignResponse.signature.signature,
-      pubKey: directSignResponse.signature.pub_key || {
-        value: pubKey,
-        type: '/injective.crypto.v1beta1.ethsecp256k1.PubKey',
-      },
-    })
 
-    // Re-enable tx gas check removed above
-    if (walletStrategy.wallet === Wallet.Keplr) {
-      new KeplrWallet(chainId).enableGasCheck()
-    }
+    const broadcast = async () =>
+      await transactionApi.broadcastCosmosTxRequest({
+        address: tx.injectiveAddress,
+        txRaw: createTxRawFromSigResponse(directSignResponse),
+        signature: directSignResponse.signature.signature,
+        pubKey: directSignResponse.signature.pub_key || {
+          value: pubKey,
+          type: '/injective.crypto.v1beta1.ethsecp256k1.PubKey',
+        },
+      })
+
+    try {
+      const response = await broadcast()
 
-    return await new TxGrpcApi(endpoints.grpc).fetchTxPoll(response.txHash)
+      // Re-enable tx gas check removed above
+      if (walletStrategy.wallet === Wallet.Keplr) {
+        new KeplrWallet(chainId).enableGasCheck()
+      }
+
+      return await new TxGrpcApi(endpoints.grpc).fetchTxPoll(response.txHash)
+    } catch (e) {
+      const error = e as any
+
+      if (isThrownException(error)) {
+        const exception = error as ThrownException
+
+        return await this.retryOnException(exception, broadcast)
+      }
+
+      throw e
+    }
   }
 
   /**
@@ -1077,4 +1120,41 @@ export class MsgBroadcaster {
 
     return simulationResponse
   }
+
+  private async retryOnException<T>(
+    exception: ThrownException,
+    retryLogic: () => Promise<T>,
+  ): Promise<any> {
+    const errorsToRetry = Object.keys(this.retriesOnError)
+    const errorKey =
+      `${exception.contextModule}-${exception.contextCode}` as keyof typeof this.retriesOnError
+
+    if (!errorsToRetry.includes(errorKey)) {
+      throw exception
+    }
+
+    const retryConfig = this.retriesOnError[errorKey]
+
+    if (retryConfig.retries >= retryConfig.maxRetries) {
+      this.retriesOnError = defaultRetriesConfig()
+
+      throw exception
+    }
+
+    await sleep(retryConfig.timeout)
+
+    try {
+      retryConfig.retries += 1
+
+      return await retryLogic()
+    } catch (e) {
+      const error = e as any
+
+      if (isThrownException(error)) {
+        return this.retryOnException(error, retryLogic)
+      }
+
+      throw e
+    }
+  }
 }

deprecated/packages/wallet-ts/src/broadcaster/helper.ts

@@ -1,10 +1,14 @@
-import { TransactionException } from '@injectivelabs/exceptions'
+import {
+  TransactionException,
+  ChainCosmosErrorCode,
+  TransactionChainErrorModule,
+} from '@injectivelabs/exceptions'
 
 export const checkIfTxRunOutOfGas = (e: unknown) => {
   return (
     e instanceof TransactionException &&
-    e.contextCode === 11 &&
-    e.contextModule === 'sdk' &&
+    e.contextCode === ChainCosmosErrorCode.ErrOutOfGas &&
+    e.contextModule === TransactionChainErrorModule.CosmosSdk &&
     e.originalMessage.includes('out of gas')
   )
 }

packages/exceptions/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@injectivelabs/exceptions",
   "description": "List of exceptions that can be reused throughout Injective's projects.",
-  "version": "1.14.34-beta.0",
+  "version": "1.14.34-beta.5",
   "sideEffects": false,
   "license": "Apache-2.0",
   "type": "module",
@@ -56,9 +56,9 @@
     "start": "node dist/index.js"
   },
   "dependencies": {
-    "http-status-codes": "^2.2.0"
-  },
-  "devDependencies": {
+    "@injectivelabs/grpc-web": "^0.0.1",
+    "@injectivelabs/ts-types": "^1.14.34-beta.2",
+    "http-status-codes": "^2.2.0",
     "shx": "^0.3.2"
   },
   "gitHead": "6442ae377bbfb3459d2fb3a44c650630a5b7f445"

packages/exceptions/src/exceptions/messages.ts

@@ -751,7 +751,7 @@ export const chainErrorMessagesMap: Record<
   },
 
   'mempool is full': {
-    message: 'The mempool is full',
+    message: 'The transaction failed to be included within a block on time.',
     code: ChainCosmosErrorCode.ErrMempoolIsFull,
     module: TransactionChainErrorModule.CosmosSdk,
   },