Skip to content

Latest commit

 

History

History
161 lines (121 loc) · 8.18 KB

README.md

File metadata and controls

161 lines (121 loc) · 8.18 KB

@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 using a create* prefix (e.g., createGetAllBalances). 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 { createQueryRpc } from "@interchainjs/cosmos/utils";
import { createGetAllBalances } from "@interchainjs/cosmos/bank/v1beta1/query.rpc.func";

// Initialize RPC client
const rpc = createQueryRpc(endpoint);

// Create the specific helper function you need
const getAllBalances = createGetAllBalances(rpc);

// Now you can query the blockchain
const balance = await getAllBalances({
  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 { createGetValidator } 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 { createQueryRpc } from "@interchainjs/cosmos/utils";
import { createGetValidator } from "@interchainjs/cosmos/staking/v1beta1/query.rpc.func";
import { createDelegate } from "@interchainjs/cosmos/staking/v1beta1/tx.rpc.func";

// Setup query client
const rpc = createQueryRpc(endpoint);
const getValidator = createGetValidator(rpc);

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

// Setup transaction function
const delegate = createDelegate(signingClient);

// Execute delegation
const result = await delegate(
  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

Category Tools Description
Chain Information Chain Registry, Utils, Client Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application.
Wallet Connectors Interchain Kitbeta, Cosmos Kit Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface.
Signing Clients InterchainJSbeta, CosmJS A single, universal signing interface for any network
SDK Clients Telescope Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules.
Starter Kits Create Interchain Appbeta, Create Cosmos App Set up a modern Interchain app by running one command.
UI Kits Interchain UI The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit.
Testing Frameworks Starship Unified Testing and Development for the Interchain.
TypeScript Smart Contracts Create Hyperweb App Build and deploy full-stack blockchain applications with TypeScript
CosmWasm Contracts CosmWasm TS Codegen Convert your CosmWasm smart contracts into dev-friendly TypeScript classes.

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.