@interchainjs/vue v1.11.15

@interchainjs/vue

React query helper hooks(Tx, Query) generated by Telescope.

Tree Shakable Helpers

InterchainJS provides tree shakable helper functions to optimize your application's bundle size. These helpers follow a factory pattern that allows modern JavaScript bundlers to eliminate unused code through tree shaking. These helpers improve modularity and optimize performance by allowing you to import only the functionality you need. Tree shakable tutorial video: https://youtu.be/3dRm9HEklMo

How Tree Shakable Helpers Work

Each helper function is individually exported (e.g., getAllBalances). Each customized hook is individually exported using a use* prefix (e.g., useGetBalance) This pattern enables:

1. Bundle Size Optimization: Only the functions you import and use are included in your final bundle
2. Lazy Initialization: Helper functions are only constructed when explicitly called
3. Customizable Configuration: Each helper can be configured with specific parameters

For example, query helpers are functions that return other functions, constructed with specific parameters:

// Import only what you need
import { getAllBalances } from "@interchainjs/cosmos/bank/v1beta1/query.rpc.func";

// Now you can query the blockchain
const balance = await getAllBalances(endpoint, {
  address: "cosmos1addresshere",
});

For example, customized hooks are functions that return the result you want:

// Import only what you need
import { useGetBalance } from "@interchainjs/vue/cosmos/bank/v1beta1/query.rpc.vue";

// Initialize RPC endpoint and address, then you can get balance by tree shakable hooks
const request = computed(() => ({
  address: address.value,
  denom,
}));

const {
  data: balance,
  isSuccess: isBalanceLoaded,
  isLoading: isFetchingBalance,
  refetch: refetchBalance,
} = useGetBalance({
  request,
  options: {
    enabled: !!address,
    select: ({ balance }) =>
      new BigNumber(balance?.amount ?? 0).multipliedBy(
        10 ** -COIN_DISPLAY_EXPONENT
      ),
  },
  clientResolver: rpcEndpoint,
});

Available Helper Types

InterchainJS provides two main types of tree shakable helpers and customized hooks:

1. Query Helpers/Customized Hooks: For retrieving data from the blockchain

   import { getValidator } from "@interchainjs/cosmos/staking/v1beta1/query.rpc.func";
   import { useGetValidators } from "@interchainjs/vue/cosmos/staking/v1beta1/query.rpc.vue";

2. Transaction Helpers/Customized Hooks: For broadcasting transactions

   import { createDelegate } from "@interchainjs/cosmos/staking/v1beta1/tx.rpc.func";
   import { useDelegate } from "@interchainjs/vue/cosmos/staking/v1beta1/tx.rpc.vue";

Example: Combining Query and Transaction Helpers

Here's how you might use both types together in a staking scenario:

// Import helpers
import { getValidator } from "@interchainjs/cosmos/staking/v1beta1/query.rpc.func";
import { delegate } from "@interchainjs/cosmos/staking/v1beta1/tx.rpc.func";

// Query validator info
const { validator } = await getValidator(endpoint, {
  validatorAddr: "cosmosvaloper1...",
});

// Execute delegation
const result = await delegate(
  singingClient,
  signerAddress,
  {
    delegatorAddress: signerAddress,
    validatorAddress: validator.operatorAddress,
    amount: { denom: "uatom", amount: "1000000" },
  },
  fee,
  "Delegation via InterchainJS"
);

By importing only the specific helpers you need, you ensure that your application bundle remains as small and efficient as possible.

Interchain JavaScript Stack ⚛️

A unified toolkit for building applications and smart contracts in the Interchain ecosystem

Credits

🛠 Built by Hyperweb (formerly Cosmology) — if you like our tools, please checkout and contribute to our github ⚛️

Disclaimer

AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.

No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.