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]id ([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 { ApiPromise, WsProvider } from "@polkadot/api";
import { stringCamelCase } from "@polkadot/util";

const provider = new WsProvider("wss://entrypoint-finney.opentensor.ai:443");
const api = await ApiPromise.create({ provider });

// Build cancel_named call
const id = 0;

const call = api.tx[stringCamelCase("Scheduler")][stringCamelCase("cancel_named")](
  id
);

Runtime Info

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