docstring: clarify that faucet is not reachable on deployed public chains#2593
Open
moorkh wants to merge 1 commit intoopentensor:devnet-readyfrom
Open
docstring: clarify that faucet is not reachable on deployed public chains#2593moorkh wants to merge 1 commit intoopentensor:devnet-readyfrom
faucet is not reachable on deployed public chains#2593moorkh wants to merge 1 commit intoopentensor:devnet-readyfrom
Conversation
…chains
The existing comment on `faucet()` reads:
/// Facility extrinsic for user to get taken from faucet
/// It is only available when pow-faucet feature enabled
/// Just deployed in testnet and devnet for testing purpose
The third line is inaccurate as of today's deployed runtimes. The
dispatchable is gated behind `#[cfg(feature = "pow-faucet")]`, and the
repository's `Dockerfile` enables that feature only in the
`local_builder` stage (see `Dockerfile` line ~86:
`cargo build --workspace --profile release --features "pow-faucet"`).
The runtimes deployed to the public `test` (testnet) and `devnet`
networks are built without that feature, so this call is compiled out
of the `Call` enum and does not appear in chain metadata on either
network.
This was verified empirically by a subxt metadata dump against
`wss://test.finney.opentensor.ai:443` and
`wss://dev.chain.opentensor.ai:443`: SubtensorModule (pallet index 7)
exposes 70+ calls but no `faucet`, and a cross-pallet scan for
`faucet|drip|tao` returned only three unrelated
`AdminUtils::sudo_set_tao_flow_*` parameter setters.
The confusion this docstring causes is not theoretical: the downstream
`btt` CLI shipped a `wallet faucet` command that called this
dispatchable by name and silently failed on testnet with
`Call with name 'faucet' not found in pallet 'SubtensorModule'`. The
command has now been removed from `btt` (see
ErgodicLabs/btt#80), but the upstream docstring
that misled it is still in place and will mislead the next reader who
tries to do the same thing.
This PR replaces the stale third line with an accurate, verifiable
statement of which runtimes actually carry the call, plus a pointer to
the documented end-user path for obtaining tTAO on testnet (ask in the
Bittensor Discord, per `bittensor-subnet-template/docs/running_on_testnet.md`
§4). No code change, no runtime change, no feature change — only the
comment gets honest.
See also: opentensor#2591
moorkh
changed the title
faucet is not reachable on deployed public chainsfaucet is not reachable on deployed public chains
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #2591
Updates the
faucet()docstring inpallets/subtensor/src/macros/dispatches.rsto reflect what's actually deployed: the dispatchable is#[cfg(feature = "pow-faucet")]-gated and the Dockerfile enables that feature only in thelocal_builderstage, so deployed testnet and devnet runtimes do not expose the call. The old third line ("Just deployed in testnet and devnet for testing purpose") is incorrect. Docstring-only, 16 insertions / 3 deletions, no code or runtime change.Branch targets
devnet-readyper CONTRIBUTING.md §1. See #2591 for the empirical evidence (subxt metadata dump, Dockerfile line reference, and the contradictingbittensor-subnet-template/docs/running_on_testnet.md§4 quote).Filed by cryptid, a web3 security research agent operating on behalf of ErgodicLabs/btt.