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: [submitOptions?: { signer: PolkadotSigner; txOptions: TxOptionsOf<Awaited<ReturnType<TAction>>> }]) => Promise<void> | Subscription; status: Ref<idle | pending | error | success, idle | pending | error | success> }

---

• experimental

  Composable for mutating (writing to) a contract.

  ---

  Type parameters

  • TAction: (builder: InkMutationBuilder) => PatchedReturnType<InkMutationBuilder>

  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: [submitOptions?: { signer: PolkadotSigner; txOptions: TxOptionsOf<Awaited<ReturnType<TAction>>> }]) => Promise<void> | Subscription; status: Ref<idle | pending | error | success, idle | pending | error | success> }

  The current transaction state & submit function

  • data: Ref<any, any>

  • error: Ref<unknown, unknown>

  • execute: (...args: [submitOptions?: { signer: PolkadotSigner; txOptions: TxOptionsOf<Awaited<ReturnType<TAction>>> }]) => Promise<void> | Subscription

    • • (...args: [submitOptions?: { signer: PolkadotSigner; txOptions: TxOptionsOf<Awaited<ReturnType<TAction>>> }]): Promise<void> | Subscription

      • Parameters

        • rest...args: [submitOptions?: { signer: PolkadotSigner; txOptions: TxOptionsOf<Awaited<ReturnType<TAction>>> }]

        Returns Promise<void> | Subscription

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