Skip to main content

useInstantiateContract

Mutation hook to instantiate a CosmWasm smart contract. Note: senderAddress will be filled with current connected account.

Usage​

import { useInstantiateContract, useCosmWasmSigningClient } from "graz";

// basic example
interface TData {
  // ...
}
const { data: signingClient } = useCosmWasmSigningClient();
const { instantiateContract } = useInstantiateContract<TData>({
  codeId: 4,
});
const instantiateMessage = { foo: "bar" };
instantiateContract({
  signingClient,
  msg: {
    foo: "bar",
  },
  label: "test",
});

Types​

  • InstantiateContractMutationArgs
    {
      signingClient?: SigningCosmWasmClient;
      msg: Message;
      label: string;
      fee: StdFee | "auto" | number;
      options?: InstantiateOptions;
      senderAddress: string;
      codeId: number;
    }

Params​

Object params

  • codeId: number
  • onError?: (error: unknown, args: InstantiateResult) => void
  • onMutate?: (data: InstantiateResult) => void
  • onSuccess?: (data: InstantiateResult) => void

Note: InstantiateResult is from @cosmjs/cosmwasm-stargate

Return Value​

{
  error: unknown;
  isLoading: boolean;
  isSuccess: boolean;
  instantiateContract: (args: InstantiateContractMutationArgs) => void;
  instantiateContractAsync: (args: InstantiateContractMutationArgs) => Promise<InstantiateResult>;
  status: "error" | "idle" | "loading" | "success";
}