useContractMutation

Callable

• useContractMutation<TAction>(action: TAction, options?: ChainComposableOptions & { signer?: PolkadotSigner; txOptions?: TxOptionsOf<Awaited<ReturnType<TAction>>> }): { data: Ref<any, any>; error: Ref<unknown, unknown>; execute: (...args: Parameters<TAction>[length] extends 2 ? [submitOptions: SubmitOptions] : [submitOptions?: SubmitOptions]) => Subject<any>; status: Ref<error | idle | pending | success, error | idle | pending | success> }

---

• Composable for mutating (writing to) a contract.

  ---

  Type parameters

  • TAction: (builder: MutationBuilder, variables: any) => PatchedReturnType<MutationBuilder>

  Parameters

  • action: TAction

    The function to create the transaction

  • optionaloptions: ChainComposableOptions & { signer?: PolkadotSigner; txOptions?: TxOptionsOf<Awaited<ReturnType<TAction>>> }

    Additional options

  Returns { data: Ref<any, any>; error: Ref<unknown, unknown>; execute: (...args: Parameters<TAction>[length] extends 2 ? [submitOptions: SubmitOptions] : [submitOptions?: SubmitOptions]) => Subject<any>; status: Ref<error | idle | pending | success, error | idle | pending | success> }

  The current transaction state & submit function

  • data: Ref<any, any>

  • error: Ref<unknown, unknown>

  • execute: (...args: Parameters<TAction>[length] extends 2 ? [submitOptions: SubmitOptions] : [submitOptions?: SubmitOptions]) => Subject<any>

    • • (...args: Parameters<TAction>[length] extends 2 ? [submitOptions: SubmitOptions] : [submitOptions?: SubmitOptions]): Subject<any>

      • Parameters

        • rest...args: Parameters<TAction>[length] extends 2 ? [submitOptions: SubmitOptions] : [submitOptions?: SubmitOptions]

        Returns Subject<any>

  • status: Ref<error | idle | pending | success, error | idle | pending | success>