useMutation

Callable

• useMutation<TAction, TChainId>(action: TAction, options?: ChainComposableOptions<TChainId> & { signer?: MaybeRefOrGetter<PolkadotSigner>; txOptions?: any }): { data: Ref<TxEvent, TxEvent>; error: Ref<unknown, unknown>; execute: (...args: [submitOptions?: { signer: PolkadotSigner; txOptions: TxOptionsOf<ReturnType<TAction>> }]) => Subject<TxEvent>; status: Ref<error | idle | pending | success, error | idle | pending | success> }

---

• Composable for sending transactions to chains.

  ---

  Type parameters

  • TAction: (tx: any) => Transaction<any, any, any, any>
  • TChainId: any

  Parameters

  • action: TAction

    The function to create the transaction

  • optionaloptions: ChainComposableOptions<TChainId> & { signer?: MaybeRefOrGetter<PolkadotSigner>; txOptions?: any }

    Additional options

  Returns { data: Ref<TxEvent, TxEvent>; error: Ref<unknown, unknown>; execute: (...args: [submitOptions?: { signer: PolkadotSigner; txOptions: TxOptionsOf<ReturnType<TAction>> }]) => Subject<TxEvent>; status: Ref<error | idle | pending | success, error | idle | pending | success> }

  The current transaction state & submit function

  • data: Ref<TxEvent, TxEvent>

  • error: Ref<unknown, unknown>

  • execute: (...args: [submitOptions?: { signer: PolkadotSigner; txOptions: TxOptionsOf<ReturnType<TAction>> }]) => Subject<TxEvent>

    • • (...args: [submitOptions?: { signer: PolkadotSigner; txOptions: TxOptionsOf<ReturnType<TAction>> }]): Subject<TxEvent>

      • Parameters

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

        Returns Subject<TxEvent>

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