cancel_named

Call v133 → current #3

Cancel a scheduled task by its unique name identifier.

View calls on chain

Click items to navigate. Pan and zoom to explore.

Used by: developersanalytics

The Big Picture

Named cancellation is the ergonomic way to cancel tasks by name rather than block/index.

Use Cases

  • Cancel governance proposals by ID
  • Abort named operations cleanly

From Chain Metadata

Cancel a named scheduled task.

Input Parameters

#NameTypeDescription
0
id
[u8; 32] [32] TaskNameid ([u8; 32])

Permissions

Origin
Unknown
Required Role

Permission data inferred from metadata. May be incomplete.

Requirements

  • Named task exists in Lookup storage
  • Caller has permission

Effects

Events Emitted

Storage Modified

Postconditions

  • Task removed from Agenda
  • Lookup entry removed

Side Effects

  • Reserved deposit returned
  • Emits Canceled event

Code Examples

import { createClient, Binary } from "polkadot-api";
import { getWsProvider } from "polkadot-api/ws";
import { sub } from "@polkadot-api/descriptors"; // generated by: npx papi add sub -w wss://entrypoint-finney.opentensor.ai:443

const client = createClient(getWsProvider("wss://entrypoint-finney.opentensor.ai:443"));
const api = client.getTypedApi(sub);

// Build cancel_named call (typed, named args)
const id = "0x0000000000000000000000000000000000000000000000000000000000000000";

const tx = api.tx.Scheduler.cancel_named({
  id,
});

Runtime Info

Pallet Index
15
Call Index
3
First Version
v133
Current Version
v411