useContractMutation

Callable

• useContractMutation<TAction>(action: TAction, options?: Partial<ChainOptions<any>> & { signer?: PolkadotSigner; txOptions?: TxOptionsOf<Awaited<ReturnType<TAction>>> }): [state: AsyncValue<Value, MutationError>, execute: (...args: Parameters<TAction>[length] extends 2 ? [submitOptions: SubmitOptions] : [submitOptions?: SubmitOptions]) => Subject<any>]

---

• Hook 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: Partial<ChainOptions<any>> & { signer?: PolkadotSigner; txOptions?: TxOptionsOf<Awaited<ReturnType<TAction>>> }

    Additional options

  Returns [state: AsyncValue<Value, MutationError>, execute: (...args: Parameters<TAction>[length] extends 2 ? [submitOptions: SubmitOptions] : [submitOptions?: SubmitOptions]) => Subject<any>]

  The current transaction state & submit function