Transactions

serve-axon

Publish this hotkey's axon endpoint (ip:port) for a subnet.

View as Markdown

Writes the connection info to chain storage so validators on the subnet know where to reach this miner or validator; it does not start any server — running the actual axon service is up to the caller. Signed by the hotkey, which must be registered on the subnet, and subject to the chain's serving rate limit (re-publishing too soon fails). Use serve_axon_tls if peers should verify a TLS certificate, and reset_axon to stop advertising the endpoint.

SignerOriginPalletWraps
hotkeysigned account (pallet role may apply)SubtensorModuleSubtensorModule.serve_axon

Parameters

ParameterTypeRequiredDescription
netuidintegeryesSubnet on which to publish the endpoint.
ipstringyesPublic IPv4 or IPv6 address of the endpoint, in standard dotted or colon notation.
portintegeryesTCP port the endpoint listens on.
protocolintegernoApplication protocol tag stored alongside the endpoint; its meaning is subnet-defined.
versionintegernoVersion number of the serving neuron's software, stored with the endpoint.

Address parameters (--hotkey, --coldkey, --dest, ...) accept a raw ss58 address, an address-book or proxy-book name, or a local wallet/hotkey name.

CLI

Preview with --dry-run (shows fee, effects, and policy result without submitting), then submit:

btcli tx serve-axon \
  --netuid <int> \
  --ip <value> \
  --port <int> --dry-run
btcli tx serve-axon \
  --netuid <int> \
  --ip <value> \
  --port <int> -w my_coldkey

Python

import bittensor as bt
from bittensor.wallet import Wallet

wallet = Wallet(name="my_coldkey", hotkey="my_hotkey")
intent = bt.ServeAxon(netuid=1, ip="...", port=0)

sub = bt.Subtensor()
plan = sub.plan(intent, wallet)   # fee, effects, policy — no submission
result = sub.execute(intent, wallet)
if not result.success:
    print(result.error.code, result.error.remediation)

(bt.Subtensor is also the async client — async with bt.Subtensor() as client: — see The client.) Or build the intent by op name, as an agent would:

result = sub.execute_tool("serve_axon", {...}, wallet)

On-chain implementation

SubtensorModule.serve_axonpallets/subtensor/src/macros/dispatches.rs#L642:

#[pallet::call_index(4)]
#[pallet::weight((<T as crate::pallet::Config>::WeightInfo::serve_axon(), DispatchClass::Normal, Pays::No))]
pub fn serve_axon(
    origin: OriginFor<T>,
    netuid: NetUid,
    version: u32,
    ip: u128,
    port: u16,
    ip_type: u8,
    protocol: u8,
    placeholder1: u8,
    placeholder2: u8,
) -> DispatchResult {
    Self::do_serve_axon(
        origin,
        netuid,
        version,
        ip,
        port,
        ip_type,
        protocol,
        placeholder1,
        placeholder2,
        None,
    )
}

Delegates to do_serve_axon.

Every file is browsable under /code exactly as built into the runtime, or as plain text under /code/raw/<path> (index: /code/index.json).