Skip to content

chore(cli): refresh docs and bulletin allowance field reads#135

Merged
andrew-ifrita merged 2 commits into
mainfrom
spha/cli-misc-cleanup
May 13, 2026
Merged

chore(cli): refresh docs and bulletin allowance field reads#135
andrew-ifrita merged 2 commits into
mainfrom
spha/cli-misc-cleanup

Conversation

@sphamjoli
Copy link
Copy Markdown
Member

@sphamjoli sphamjoli commented May 13, 2026 •
edited
Loading

Summary

  • Reads renamed transactions / bytes fields from AuthorizationExtent (the _allowance aliases no longer exist on the new chain types). This clears the lingering type errors on main.
  • Updates the CLI README to reflect the env-aware command surface.
  • Tidies the UI doc pages, register modal, error display, profile view, and IPFS helper.

Test plan

  • bun run --cwd packages/cli typecheck
  • bun run --cwd packages/cli test tests/integration/bulletin
  • Skim the rendered CLI page in the UI

Order

Last in the stack. Base is spha/cli-auto-claim-user-store (#134).

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 13, 2026 •
edited
Loading

CI Summary

Check Result
Lint Passed
Lint (UI) Passed
Format Passed
Typecheck Passed
Typecheck (UI) Passed
Build Passed
Build (UI) Passed
Release Passed
Deploy UI Failed
Deploy Example Failed
Benchmark UI Passed
PR Title Passed
Labels Passed
Test Passed - 154 passed, 0 failed
Release - Passed

Test this PR

Download artifact (GitHub CLI required):

gh run download 25802896159 -n cli-release-0.0.0-pr.135 -R paritytech/dotns-sdk

Install globally:

npm install -g ./parity-dotns-cli-0.0.0-pr.135.tgz

Verify:

dotns --help
Deploy UI — Failed

Failed at: Deploy — Deploy workflow failed — see run logs for upload/register/contenthash details

Stage Status
✓ Build Build succeeded
✗ Deploy Deploy workflow failed — see run logs for upload/register/contenthash details

View run

Deploy Example — Failed

Failed at: Deploy — Deploy workflow failed — see run logs for upload/register/contenthash details

Stage Status
✓ Site validation Site validated
✗ Deploy Deploy workflow failed — see run logs for upload/register/contenthash details

View run

Benchmark UI - Passed (117s)
Property Value
Duration 117s
Domain pr135-ui.bulletin-benchmarks.dot
CID bafybeiekrbzkxvklvfj6jq36bpa57hawbbl7eotnkmxzitzvjtb72ubj7m
Preview (dot.li) open
Preview (direct) open
Workflow view
Labels

pkg: cli, scope: bulletin, type: docs, dependencies, pkg: ui

Test - Passed

154 passed, 0 failed across 154 tests.

View run

$ bun test tests/unit/
bun test v1.2.6 (8ebd5d53)

::group::tests/unit/text/textHelp.test.ts:
(pass) text --help lists subcommands and auth options [13.00ms]
(pass) text view --help shows name and key arguments [3.00ms]
(pass) text set --help shows name, key, and value arguments [3.00ms]

::endgroup::

::group::tests/unit/text/textJson.test.ts:
(pass) text view --help shows --json option [2.00ms]
(pass) text set --help shows --json option [2.00ms]
(pass) text set --json emits JSON error when both mnemonic and key-uri provided [3.00ms]

::endgroup::

::group::tests/unit/content/contentJson.test.ts:
(pass) content view --help shows --json option [1.00ms]
(pass) content set --help shows --json option [2.00ms]
(pass) content set --json emits JSON error when both mnemonic and key-uri provided [2.00ms]

::endgroup::

::group::tests/unit/content/contentHelp.test.ts:
result:  {
  exitCode: 0,
  standardOutput: "Usage: dotns content [options] [command]\n\nManage domain content hashes\n\nOptions:\n  --env <environment>         DotNS environment: paseo-v2 (env: DOTNS_ENV)\n  --network <environment>     Alias for --env\n  --rpc <wsUrl>               WebSocket RPC endpoint (env: DOTNS_RPC)\n  --keystore-path <path>      Keystore path (env: DOTNS_KEYSTORE_PATH)\n  --min-balance <pas>         Minimum balance in PAS (env:\n                              DOTNS_MIN_BALANCE_PAS)\n  --account <name>            Keystore account name (default: keystore default)\n  --password <pw>             Keystore password (env: DOTNS_KEYSTORE_PASSWORD)\n  -m, --mnemonic <phrase>     BIP39 mnemonic phrase (env: DOTNS_MNEMONIC)\n  -k, --key-uri <uri>         Substrate key URI (env: DOTNS_KEY_URI)\n  -h, --help                  display help for command\n\nCommands:\n  view [options] <name>       View domain content hash\n  set [options] <name> <cid>  Set domain content hash (IPFS CID)\n  help [command]              display help for command\n",
  standardError: "",
  combinedOutput: "Usage: dotns content [options] [command]\n\nManage domain content hashes\n\nOptions:\n  --env <environment>         DotNS environment: paseo-v2 (env: DOTNS_ENV)\n  --network <environment>     Alias for --env\n  --rpc <wsUrl>               WebSocket RPC endpoint (env: DOTNS_RPC)\n  --keystore-path <path>      Keystore path (env: DOTNS_KEYSTORE_PATH)\n  --min-balance <pas>         Minimum balance in PAS (env:\n                              DOTNS_MIN_BALANCE_PAS)\n  --account <name>            Keystore account name (default: keystore default)\n  --password <pw>             Keystore password (env: DOTNS_KEYSTORE_PASSWORD)\n  -m, --mnemonic <phrase>     BIP39 mnemonic phrase (env: DOTNS_MNEMONIC)\n  -k, --key-uri <uri>         Substrate key URI (env: DOTNS_KEY_URI)\n  -h, --help                  display help for command\n\nCommands:\n  view [options] <name>       View domain content hash\n  set [options] <name> <cid>  Set domain content hash (IPFS CID)\n  help [command]              display help for command\n",
}
(pass) content --help lists subcommands and auth options [2.00ms]
(pass) content view --help shows name argument and options [2.00ms]
(pass) content set --help shows name and cid arguments [2.00ms]

::endgroup::

::group::tests/unit/utils/formatting.test.ts:
(pass) native balance formatting uses DOT/PAS 10 decimals > defaults to 10 native decimals and 18 EVM decimals [1.00ms]
(pass) native balance formatting uses DOT/PAS 10 decimals > formatNativeBalance renders 5000 PAS from 5000 * 10^10 units
(pass) native balance formatting uses DOT/PAS 10 decimals > formatNativeBalance renders fractional 0.1 PAS as 10^9 units
(pass) native balance formatting uses DOT/PAS 10 decimals > formatNativeBalance renders zero balance
(pass) native balance formatting uses DOT/PAS 10 decimals > parseNativeBalance inverts formatNativeBalance
(pass) native balance formatting uses DOT/PAS 10 decimals > parseNativeBalance('0.1') is 10^9

::endgroup::

::group::tests/unit/utils/contractInteractions.test.ts:
(pass) isRevertFlag matches the EVM revert bit > flags=0n → false
(pass) isRevertFlag matches the EVM revert bit > flags=1n → true [1.00ms]
(pass) isRevertFlag matches the EVM revert bit > flags=2n → false
(pass) isRevertFlag matches the EVM revert bit > flags=3n → true
(pass) buildRevertError > empty data returns the unmapped-origin hint
(pass) buildRevertError > known ABI selector decodes to the named error [5.00ms]
(pass) buildRevertError > unknown selector falls back to raw hex [1.00ms]

::endgroup::

::group::tests/unit/auth/auth.test.ts:
(pass) auth set creates keystore and stores multiple accounts [330.01ms]
(pass) auth set accepts account names with special characters [470.02ms]
(pass) auth list reports missing keystore [4.00ms]
(pass) auth list shows all accounts and auth types [307.01ms]
(pass) auth use switches default account [461.01ms]
(pass) auth remove last account clears default [77.00ms]
(pass) auth remove preserves remaining accounts and reassigns default [226.01ms]
(pass) auth clear deletes all accounts [91.00ms]

::endgroup::

::group::tests/unit/auth/authHelp.test.ts:
(pass) root help lists auth command [1.00ms]
(pass) auth help shows options and subcommands [1.00ms]
(pass) auth set help shows all options [1.00ms]
(pass) auth list help shows options [2.00ms]
(pass) auth use help shows options [1.00ms]
(pass) auth remove help shows options [2.00ms]
(pass) auth clear help shows options [1.00ms]
(pass) auth parses keystore-path option [1.00ms]
(pass) auth parses password option [2.00ms]
(pass) auth set parses account option [1.00ms]
(pass) auth set parses mnemonic option [2.00ms]
(pass) auth set parses key-uri option [2.00ms]
(pass) auth help command shows help [2.00ms]
(pass) auth help set shows set command help [2.00ms]
(pass) auth help list shows list command help [2.00ms]
(pass) auth help use shows use command help [2.00ms]
(pass) auth help remove shows remove command help [2.00ms]
(pass) auth help clear shows clear command help [2.00ms]

::endgroup::

::group::tests/unit/auth/authRevert.test.ts:
(pass) auth set rejects account name with forward slash [3.00ms]
(pass) auth set rejects account name with backslash [2.00ms]
(pass) auth set rejects account name that is just a dot [2.00ms]
(pass) auth set rejects account name that is double dots [1.00ms]
(pass) auth set rejects account name starting with dot [1.00ms]
(pass) auth set rejects account name ending with dot [1.00ms]
(pass) auth set rejects account name with special characters [9.00ms]
(pass) auth set rejects account name that is too long [2.00ms]
(pass) auth use rejects non-existent account [73.00ms]
(pass) auth remove rejects non-existent account [90.00ms]

::endgroup::

::group::tests/unit/auth/resolveAuthSourceReadOnly.test.ts:
(pass) resolveAuthSourceReadOnly honours environment variables > $label
(pass) resolveAuthSourceReadOnly honours environment variables > $label
(pass) resolveAuthSourceReadOnly honours environment variables > $label
(pass) resolveAuthSourceReadOnly honours environment variables > $label
(pass) resolveAuthSourceReadOnly honours environment variables > $label

::endgroup::

::group::tests/unit/store/storeHelp.test.ts:
(pass) store --help lists subcommands [1.00ms]
(pass) store info --help shows auth options [1.00ms]
(pass) store list --help shows options [1.00ms]
(pass) store get --help shows key argument [1.00ms]
(pass) store set --help shows key and value arguments with auth [2.00ms]
(pass) store delete --help shows key argument with auth [1.00ms]
(pass) store check --help shows address argument [1.00ms]
(pass) store authorize --help shows address argument with auth [1.00ms]
(pass) store unauthorize --help shows address argument [2.00ms]
(pass) store authorize-controller --help shows address argument [1.00ms]
(pass) store unauthorize-controller --help shows address argument [1.00ms]
(pass) store ensure-auth --help shows description and auth options [1.00ms]

::endgroup::

::group::tests/unit/pop/popJson.test.ts:
(pass) pop info --help shows --json option [2.00ms]
(pass) pop status --help shows --json option [1.00ms]

::endgroup::

::group::tests/unit/pop/setPopHelp.test.ts:
(pass) root help lists pop command [1.00ms]
(pass) pop help shows commands and description [2.00ms]
(pass) pop help shows auth options [1.00ms]
(pass) pop info help shows description [1.00ms]
(pass) pop status help shows description [1.00ms]
(pass) pop info help shows auth options [1.00ms]
(pass) pop info parses auth options at pop level [1.00ms]
(pass) pop info parses auth options at info level [1.00ms]
(pass) pop help command shows pop help [1.00ms]
(pass) pop help status shows info help [1.00ms]
(pass) pop help info shows info help [1.00ms]

::endgroup::

::group::tests/unit/account/accountHelp.test.ts:
(pass) account --help lists subcommands including is-mapped, is-whitelisted, whitelist [2.00ms]
(pass) account is-mapped --help shows address argument and --json [1.00ms]
(pass) account is-whitelisted --help shows address argument and --json [1.00ms]
(pass) account whitelist --help shows address argument, --remove, and --json [1.00ms]
(pass) account is alias works for is-mapped [1.00ms]
(pass) account iw alias works for is-whitelisted [1.00ms]

::endgroup::

::group::tests/unit/cli/reporter.test.ts:
(pass) cli reporter > stream reporter emits durable progress lines
(pass) cli reporter > withConsoleToStderr redirects console and stdout writes

::endgroup::

::group::tests/unit/cli/environment.test.ts:
(pass) defaults to paseo-v2 [1.00ms]
(pass) accepts friendly paseo-v2 aliases
(pass) DOTNS_ENV selects rpc and contract set
(pass) --env takes precedence over DOTNS_ENV while --rpc only overrides endpoint

::endgroup::

::group::tests/unit/bulletin/uploadManifest.test.ts:
(pass) upload manifest resume behavior > returns stale manifest when fingerprint does not match [2.00ms]
(pass) upload manifest resume behavior > deduplicates completed blocks by index [1.00ms]

::endgroup::

::group::tests/unit/bulletin/uploadProfiling.test.ts:
(pass) upload profiler > writes schema-complete profile report with peak aggregation [16.00ms]
(pass) upload profiler > default profile path is deterministic for a given fingerprint [1.00ms]

::endgroup::

::group::tests/unit/bulletin/bulletinHelp.test.ts:
(pass) root help lists bulletin command [2.00ms]
(pass) bulletin help shows commands and description [1.00ms]
(pass) bulletin upload help shows all options [2.00ms]
(pass) bulletin upload help shows default values [1.00ms]
(pass) bulletin authorize help shows all options [1.00ms]
(pass) bulletin authorize help shows default values [1.00ms]
(pass) bulletin history help shows options [1.00ms]
(pass) bulletin history:remove help shows usage [1.00ms]
(pass) bulletin history:clear help shows description [1.00ms]
(pass) bulletin help command shows bulletin help [1.00ms]
(pass) bulletin help upload shows upload help [2.00ms]
(pass) bulletin help authorize shows authorize help [1.00ms]
(pass) bulletin status help shows all options [1.00ms]
(pass) bulletin help status shows status help [1.00ms]
(pass) bulletin list alias works [1.00ms]
(pass) bulletin verify help shows usage [1.00ms]
(pass) bulletin help verify shows verify help [1.00ms]

::endgroup::

::group::tests/unit/register/registerHelp.test.ts:
(pass) root help lists register command [2.00ms]
(pass) register help shows subcommands [1.00ms]
(pass) register domain help shows options [2.00ms]
(pass) register subname help shows options [1.00ms]
(pass) register domain parses reverse flag [1.00ms]
(pass) register domain parses governance flag [1.00ms]
(pass) register domain parses owner option [1.00ms]
(pass) register domain parses transfer with destination [2.00ms]
(pass) register domain parses account option [1.00ms]
(pass) register domain parses keystore-path option [1.00ms]
(pass) register domain parses password option [1.00ms]
(pass) register domain parses mnemonic option [1.00ms]
(pass) register domain parses key-uri option [1.00ms]
(pass) register domain parses commitment-buffer option [1.00ms]
(pass) register domain parses commitment-buffer alias --cb [1.00ms]
(pass) register subname parses name and parent [1.00ms]
(pass) register subname parses owner option [2.00ms]
(pass) getCommitmentBufferSeconds defaults to 6 when env is not set
(pass) getCommitmentBufferSeconds reads from DOTNS_COMMITMENT_BUFFER env variable
(pass) COMMITMENT_POLL_INTERVAL_MS is 2000
(pass) COMMITMENT_POLL_TIMEOUT_MS is 30000

::endgroup::

::group::tests/unit/register/registerJson.test.ts:
(pass) register domain --help shows --json option [1.00ms]
(pass) register subname --help shows --json option [2.00ms]
(pass) register domain --json emits JSON error when --transfer without --to [1.00ms]

::endgroup::

::group::tests/unit/lookup/lookupHelp.test.ts:
(pass) lookup --help lists subcommands and auth options [1.00ms]
(pass) lookup name --help shows label argument and options [1.00ms]
(pass) lookup owner-of --help shows label argument and options [1.00ms]
(pass) lookup transfer --help shows label argument and destination option [1.00ms]
(pass) lookup transfer parses destination at transfer level [1.00ms]
(pass) lookup transfer parses auth options at lookup level [1.00ms]

::endgroup::

 154 pass
 0 fail
 565 expect() calls
Ran 154 tests across 22 files. [2.73s]

@sphamjoli sphamjoli mentioned this pull request May 13, 2026
Merged
3 tasks
@andrew-ifrita andrew-ifrita force-pushed the spha/cli-auto-claim-user-store branch from 1118da0 to 0b4f813 Compare May 13, 2026 13:20
Base automatically changed from spha/cli-auto-claim-user-store to main May 13, 2026 13:40
sphamjoli added 2 commits May 13, 2026 15:41
@sphamjoli @andrew-ifrita
chore(cli): refresh docs and bulletin allowance field reads
20713a4 
Reads the renamed `transactions` / `bytes` fields from
`AuthorizationExtent` (replacing the `_allowance` aliases that no
longer exist on the new chain types), updates the CLI README to
reflect the env-aware command surface, and tidies the UI doc pages,
modal, and IPFS helper.

Depends on the previous three PRs.
@sphamjoli @andrew-ifrita
chore: update sdk version
8b4cdde
@andrew-ifrita andrew-ifrita force-pushed the spha/cli-misc-cleanup branch from b2113d2 to 8b4cdde Compare May 13, 2026 13:41
andrew-ifrita
andrew-ifrita approved these changes May 13, 2026
View reviewed changes
Copy link
Copy Markdown
Collaborator

@andrew-ifrita andrew-ifrita left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@andrew-ifrita
Copy link
Copy Markdown
Collaborator

andrew-ifrita commented May 13, 2026

CI failures are unrelated to this change. Looks good so i will merge

@andrew-ifrita andrew-ifrita merged commit ed083ed into main May 13, 2026
28 of 30 checks passed
@andrew-ifrita andrew-ifrita deleted the spha/cli-misc-cleanup branch May 13, 2026 13:50
andrew-ifrita pushed a commit that referenced this pull request May 13, 2026
@sphamjoli
feat(ci): env-aware bulletin benchmarks and timeline dashboard (#136)
fddb3b4 
## Summary
- Adds an `env` workflow input to `deploy-sized-benchmark-entry.yml`
(default `paseo-v2`), forwarded to `deploy.yml` so sized benchmark runs
target the active DotNS environment.
- Sets `register-base: true` on the on-demand UI deploy and the per-PR
UI benchmark deploy so the base domain is registered if it is not
already owned.
- Adds a per-size duration timeline to the bulletin benchmark dashboard
using ECharts, with a Flatpickr custom-range picker alongside the 7d /
30d / All presets.

## Test plan
- [ ] Trigger an on-demand benchmark and confirm the UI deploy runs
`register-base: true` for `bulletin-benchmarks.dot` on Paseo V2.
- [ ] Open the dashboard, toggle sizes via the legend, switch between 7d
/ 30d / All, then pick a custom date range. Confirm the chart updates
and the slider zooms within the selected window.
- [ ] Resize the browser; the chart container scales without overflow.

## Order
Fifth in the stack. Base is `spha/cli-misc-cleanup` (#135).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@andrew-ifrita andrew-ifrita andrew-ifrita approved these changes

@waytwotall waytwotall Awaiting requested review from waytwotall waytwotall is a code owner

@corey-hathaway corey-hathaway Awaiting requested review from corey-hathaway

@filvecchiato filvecchiato Awaiting requested review from filvecchiato

Assignees

No one assigned

Labels

dependencies pkg: cli pkg: ui scope: bulletin type: docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@sphamjoli @andrew-ifrita