@meddleware/token-deployer-ui 0.0.1

package/src/move-template/template.ts

@@ -0,0 +1,31 @@
+// AUTO-GENERATED ARTIFACT — do not edit by hand.
+//
+// Base64 of the compiled `sui_token_template` Move module (binary format v7),
+// produced by `sui move build --build-env testnet` from
+// blockchain/sui/sui-token-template. Regenerate with scripts/regen-template.sh
+// whenever the canonical template source changes (see move-template/README.md).
+//
+// The DEFAULT_* values below are the constant-pool defaults compiled into the
+// module. The deployer patches the module by matching these exact defaults and
+// replacing them (see lib/template.ts). They are DISTINCT on purpose: identical
+// Move constants deduplicate into a single unpatchable pool entry.
+
+export const TEMPLATE_MODULE_B64 =
+  'oRzrCwcAAAUKAQAMAgweAyohBEsIBVNaB60B3QEIigNgBuoDVAq+BAUMwwQ6AA8BDgIGAgcCEAIRAAICAAEDBwACBAwBAAEDAAABAAEDAQwBAAEFBQIAAAoAAQABEgMEAAMJCAkBAAMLBgcBAgQMDQEBDAUNCgsAAwUCBQQMBA4CCAAHCAUAAgsEAQgACwIBCAABCgIBCAEBCAAHCQACCAEIAQgBCAEHCAUCCwMBCQALAgEJAAILAwEJAAcIBQELBAEJAAEGCAUBBQELAgEIAAIJAAUBCwQBCAATQ3VycmVuY3lJbml0aWFsaXplcgtNZXRhZGF0YUNhcBJTVUlfVE9LRU5fVEVNUExBVEUGU3RyaW5nC1RyZWFzdXJ5Q2FwCVR4Q29udGV4dARjb2luDWNvaW5fcmVnaXN0cnkLZHVtbXlfZmllbGQIZmluYWxpemUEaW5pdBVuZXdfY3VycmVuY3lfd2l0aF9vdHcPcHVibGljX3RyYW5zZmVyBnNlbmRlcgZzdHJpbmcSc3VpX3Rva2VuX3RlbXBsYXRlCHRyYW5zZmVyCnR4X2NvbnRleHQEdXRmOAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAgIBCQoCEA9URU1QTEFURV9TWU1CT0wKAg4NVEVNUExBVEVfTkFNRQoCFRRURU1QTEFURV9ERVNDUklQVElPTgoCEhFURU1QTEFURV9JQ09OX1VSTAACAQgBAAAAAAIbCwAHAAcBEQEHAhEBBwMRAQcEEQEKATgADAMKATgBDAILAwoBLhEFOAILAgsBLhEFOAMCAAA='
+
+/** Identifiers compiled into the template module (renamed at patch time). */
+export const TEMPLATE_IDENTIFIERS = {
+  /** module identifier (lowercase) */
+  module: 'sui_token_template',
+  /** one-time-witness struct identifier (uppercase) */
+  struct: 'SUI_TOKEN_TEMPLATE',
+} as const
+
+/** Distinct constant-pool defaults the deployer patches away from. */
+export const TEMPLATE_DEFAULTS = {
+  decimals: 9,
+  symbol: 'TEMPLATE_SYMBOL',
+  name: 'TEMPLATE_NAME',
+  description: 'TEMPLATE_DESCRIPTION',
+  iconUrl: 'TEMPLATE_ICON_URL',
+} as const

package/src/styles.css

@@ -0,0 +1,384 @@
+/* Accessible, lightweight styling. System fonts, dark/light aware, high-contrast
+   focus rings, and reduced-motion respect. No heavy CSS framework. */
+
+/* Oxblood / Indigo (masonic) palette — vendored mirror of the shared design
+   system for visual parity with the dashboard. The repo is self-contained
+   (no cross-repo links), so the token VALUES are copied here.
+   TODO(unify): consume `@meddleware/design-tokens` once it is published.
+   Dark mode is driven by `data-theme` (see composables/useColorMode.ts, which
+   also enables the light/dark/system control); the `:not([data-theme])` media
+   block preserves OS-follow before that runs (anti-flash). */
+:root {
+  --bg: #f7f4f1;
+  --surface: #ffffff;
+  --border: #ded6cf;
+  --text: #201b19;
+  --muted: #6e635c;
+  --accent: #5e1622;
+  --accent-contrast: #ffffff;
+  --danger: #b3261e;
+  --ok: #1c5e4a;
+  --radius: 10px;
+  --lift: #efeae6;
+  color-scheme: light;
+}
+
+:root[data-theme="dark"] {
+  --bg: #120e10;
+  --surface: #1c1618;
+  --border: #372b2e;
+  --text: #f2eae6;
+  --muted: #b7a9a3;
+  --accent: #b0465a;
+  --accent-contrast: #ffffff;
+  --danger: #f08a7e;
+  --ok: #5bb392;
+  --lift: #241c1f;
+  color-scheme: dark;
+}
+
+/* Pre-JS OS-follow (only until useColorMode sets an explicit data-theme). */
+@media (prefers-color-scheme: dark) {
+  :root:not([data-theme]) {
+    --bg: #120e10;
+    --surface: #1c1618;
+    --border: #372b2e;
+    --text: #f2eae6;
+    --muted: #b7a9a3;
+    --accent: #b0465a;
+    --accent-contrast: #ffffff;
+    --danger: #f08a7e;
+    --ok: #5bb392;
+    --lift: #241c1f;
+    color-scheme: dark;
+  }
+}
+
+* {
+  box-sizing: border-box;
+}
+
+/* Top-right colour-mode control row (parity with the dashboard). */
+.theme-bar {
+  display: flex;
+  justify-content: flex-end;
+  margin-bottom: 0.75rem;
+}
+
+body {
+  margin: 0;
+  background: var(--bg);
+  color: var(--text);
+  font:
+    16px/1.55 system-ui,
+    -apple-system,
+    'Segoe UI',
+    Roboto,
+    sans-serif;
+}
+
+main {
+  max-width: 760px;
+  margin: 0 auto;
+  padding: 1.5rem 1.25rem 4rem;
+}
+
+header {
+  padding-bottom: 1.5rem;
+  border-bottom: 1px solid var(--border);
+  margin-bottom: 1.5rem;
+}
+
+h1 {
+  font-size: clamp(1.5rem, 4vw, 2rem);
+  line-height: 1.2;
+}
+h2 {
+  font-size: 1.15rem;
+  margin-top: 2rem;
+}
+p.lede {
+  color: var(--muted);
+  font-size: 1.05rem;
+}
+a {
+  color: var(--accent);
+}
+
+.card {
+  background: var(--surface);
+  border: 1px solid var(--border);
+  border-radius: var(--radius);
+  padding: 1.25rem;
+  margin: 1.5rem 0 1rem;
+  border-top: 2px solid var(--border);
+}
+
+label {
+  display: block;
+  font-weight: 600;
+  margin: 0.9rem 0 0.3rem;
+}
+.hint {
+  color: var(--muted);
+  font-weight: 400;
+  font-size: 0.9rem;
+}
+
+input,
+select,
+textarea {
+  width: 100%;
+  padding: 0.6rem 0.7rem;
+  font: inherit;
+  color: var(--text);
+  background: var(--bg);
+  border: 1px solid var(--border);
+  border-radius: 8px;
+}
+textarea {
+  min-height: 4rem;
+  resize: vertical;
+}
+
+input[aria-invalid='true'],
+select[aria-invalid='true'],
+textarea[aria-invalid='true'] {
+  border-color: var(--danger);
+}
+
+.field-error {
+  color: var(--danger);
+  font-size: 0.88rem;
+  margin-top: 0.3rem;
+}
+
+:focus-visible {
+  outline: 3px solid var(--accent);
+  outline-offset: 2px;
+}
+
+button {
+  font: inherit;
+  font-weight: 600;
+  padding: 0.6rem 1rem;
+  border-radius: 8px;
+  border: 1px solid var(--border);
+  background: var(--surface);
+  color: var(--text);
+  cursor: pointer;
+}
+button.primary {
+  background: var(--accent);
+  color: var(--accent-contrast);
+  border-color: transparent;
+}
+button:disabled {
+  opacity: 0.55;
+  cursor: not-allowed;
+}
+
+.row {
+  display: flex;
+  gap: 0.75rem;
+  flex-wrap: wrap;
+  align-items: center;
+}
+.grid2 {
+  display: grid;
+  grid-template-columns: 1fr;
+  gap: 0 1rem;
+}
+@media (min-width: 520px) {
+  .grid2 {
+    grid-template-columns: 1fr 1fr;
+  }
+}
+
+fieldset {
+  background: var(--lift);
+  border: 1px solid var(--border);
+  border-radius: 8px;
+  padding: 0.5rem 1rem 1rem;
+  margin: 1rem 0;
+}
+legend {
+  font-weight: 700;
+  padding: 0 0.4rem;
+}
+
+details {
+  margin: 1rem 0;
+}
+
+details > summary {
+  color: var(--accent);
+  font-weight: 700;
+  margin: 0.5rem 0;
+  padding: 0.75rem;
+  background: var(--lift);
+  border-radius: 8px;
+  border: 1px solid transparent;
+  transition: border-color 0.2s ease;
+}
+
+details > summary:hover {
+  border-color: var(--border);
+}
+
+details[open] > summary {
+  border-color: var(--border);
+  margin-bottom: 1rem;
+}
+
+details > fieldset {
+  margin-top: 0;
+}
+
+.permanent {
+  color: var(--danger);
+  font-weight: 600;
+}
+.mono {
+  font-family: ui-monospace, SFMono-Regular, Menlo, monospace;
+  word-break: break-all;
+}
+.badge {
+  display: inline-block;
+  font-size: 0.8rem;
+  padding: 0.15rem 0.5rem;
+  border-radius: 999px;
+  background: var(--border);
+}
+
+.visually-hidden {
+  position: absolute;
+  width: 1px;
+  height: 1px;
+  padding: 0;
+  margin: -1px;
+  overflow: hidden;
+  clip: rect(0 0 0 0);
+  white-space: nowrap;
+  border: 0;
+}
+
+/* Keyboard skip link: hidden until focused, then visible at the top-left. */
+.skip-link {
+  position: absolute;
+  left: 0.5rem;
+  top: -3rem;
+  z-index: 100;
+  background: var(--accent);
+  color: #fff;
+  padding: 0.5rem 0.9rem;
+  border-radius: 6px;
+  text-decoration: none;
+  transition: top 0.15s ease;
+}
+.skip-link:focus {
+  top: 0.5rem;
+}
+@media (prefers-reduced-motion: reduce) {
+  .skip-link {
+    transition: none;
+  }
+}
+
+.steps {
+  list-style: none;
+  padding: 0;
+}
+.steps li {
+  padding: 0.35rem 0;
+  color: var(--muted);
+}
+.steps li[data-state='active'] {
+  color: var(--text);
+  font-weight: 600;
+}
+.steps li[data-state='done'] {
+  color: var(--ok);
+}
+
+.spinner {
+  width: 1em;
+  height: 1em;
+  border: 2px solid currentColor;
+  border-right-color: transparent;
+  border-radius: 50%;
+  display: inline-block;
+  animation: spin 0.7s linear infinite;
+  vertical-align: -0.15em;
+}
+@keyframes spin {
+  to {
+    transform: rotate(360deg);
+  }
+}
+@media (prefers-reduced-motion: reduce) {
+  .spinner {
+    animation: none;
+  }
+  * {
+    scroll-behavior: auto;
+  }
+}
+
+footer {
+  border-top: 1px solid var(--border);
+  padding-top: 1.5rem;
+  margin-top: 2rem;
+}
+
+.notice {
+  border-left: 4px solid var(--accent);
+  padding: 0.5rem 0.75rem;
+  background: var(--surface);
+  border-radius: 6px;
+}
+.notice.error {
+  border-color: var(--danger);
+}
+.notice.ok {
+  border-color: var(--ok);
+}
+
+dialog {
+  background: var(--surface);
+  border: 1px solid var(--border);
+  border-radius: var(--radius);
+  padding: 1.5rem;
+  width: min(420px, 90vw);
+  max-height: 90vh;
+  overflow-y: auto;
+  color: var(--text);
+}
+dialog::backdrop {
+  background: rgba(0, 0, 0, 0.45);
+  -webkit-backdrop-filter: blur(2px);
+  backdrop-filter: blur(2px);
+}
+.dialog-header {
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+  margin-bottom: 1.25rem;
+}
+.dialog-header h2 {
+  margin: 0;
+  font-size: 1.1rem;
+}
+.wallet-list {
+  display: flex;
+  flex-direction: column;
+  gap: 0.5rem;
+  margin-top: 1rem;
+}
+.wallet-list button {
+  display: flex;
+  align-items: center;
+  gap: 0.6rem;
+  width: 100%;
+  justify-content: flex-start;
+}

package/src/template-src/files.json

@@ -0,0 +1,10 @@
+{
+  "Move.toml": "[package]\nedition = \"2024\"\nname = \"sui_token_template\"\nversion = \"1.0.0\"\nlicense = \"CC0-1.0\"\n\n\n[addresses]\nsui_token_template = \"0x0\"\n",
+  "source.move": "// SPDX-License-Identifier: CC0-1.0\n// This work is dedicated to the public domain under CC0.\n\n/// XPACKAGEDESCRIPTIONX\n///\n/// ## Overview\n///\n/// Defines the `SUI_TOKEN_TEMPLATE` type witness and initializes the token via the modern\n/// `coin_registry::new_currency_with_otw` pattern (the framework's documented\n/// replacement for deprecated `coin::create_currency`). Name, symbol, and decimals\n/// are permanently immutable. Description and icon URL remain updatable via\n/// governance entry points, using a `MetadataCap<SUI_TOKEN_TEMPLATE>` rather than the `TreasuryCap`.\n///\n/// ## Key Types\n///\n/// - `SUI_TOKEN_TEMPLATE` — the type witness (zero-field struct with `drop` ability) used for one-time-witness initialization\n///\n/// ## Deployment\n///\n/// `init()` is a two-step OTW flow:\n/// 1. `coin_registry::new_currency_with_otw` builds the `Currency<SUI_TOKEN_TEMPLATE>` with an\n///    empty icon URL (network-specific values are set post-publish, not hardcoded\n///    here — see below) and mints `TreasuryCap<SUI_TOKEN_TEMPLATE>`.\n/// 2. `.finalize(ctx)` claims a live `MetadataCap<SUI_TOKEN_TEMPLATE>` (NOT\n///    `finalize_and_delete_metadata_cap`, which would permanently lock metadata)\n///    and transfers the pending `Currency<SUI_TOKEN_TEMPLATE>` to the registry address `0xc`.\n///\n/// Both `TreasuryCap<SUI_TOKEN_TEMPLATE>` and `MetadataCap<SUI_TOKEN_TEMPLATE>` are transferred to the\n/// transaction sender (the deployer). From there, `scripts/publish.sh`:\n/// - calls `coin_registry::finalize_registration` (required for OTW currencies —\n///   promotes the pending `Currency<SUI_TOKEN_TEMPLATE>` into a real shared, RPC-discoverable\n///   object),\n/// - calls `coin_registry::set_icon_url` using the freshly-held `MetadataCap` and a\n///   network-specific `SUI_TOKEN_TEMPLATE_ICON_URL` env var — this is how the icon differs\n///   between testnet and mainnet without ever hardcoding a URL in this source file.\n///\n/// Both caps should be transferred to their intended custodians (e.g. treasury,\n/// governance multisig) according to your deployment runbook. The package itself is\n/// published with immutability constraints (UpgradeCap burned) to prevent future\n/// code modifications; this is independent of metadata mutability, which remains\n/// governance-controlled via the `MetadataCap`.\nmodule sui_token_template::sui_token_template;\n\nuse sui::coin::TreasuryCap;\nuse sui::coin_registry::{Self, Currency, MetadataCap};\n\n/// Token parameters, declared as named constants rather than inline literals.\n///\n/// Each `const` becomes a distinct entry in the compiled module's constant pool,\n/// which is what lets the browser-based deployer patch them client-side via\n/// `@mysten/move-bytecode-template::update_constants` — no Move recompilation.\n/// The generator (`scripts/03_create_token.sh`) substitutes these same values into\n/// the downloadable source package, so the shipped bytecode and the generated\n/// source stay in lock-step (the on-chain package is source-verifiable).\n///\n/// The default values are deliberately DISTINCT: identical constants are\n/// deduplicated into a single pool entry by the Move compiler, which would make\n/// them impossible to patch independently.\nconst DECIMALS: u8 = 9;\nconst SYMBOL: vector<u8> = b\"TEMPLATE_SYMBOL\";\nconst NAME: vector<u8> = b\"TEMPLATE_NAME\";\nconst DESCRIPTION: vector<u8> = b\"TEMPLATE_DESCRIPTION\";\nconst ICON_URL: vector<u8> = b\"TEMPLATE_ICON_URL\";\n\n/// SUI_TOKEN_TEMPLATE is the type witness — a zero-sized struct that encodes type identity.\n/// The struct has no fields and only the `drop` ability (consumed once in `init()`).\n/// Paired with `coin_registry::new_currency_with_otw()`, it creates a\n/// `TreasuryCap<SUI_TOKEN_TEMPLATE>` and a `Currency<SUI_TOKEN_TEMPLATE>` registry entry. The token type\n/// becomes `<PACKAGE_ID>::XMODULENAMEX::SUI_TOKEN_TEMPLATE` globally.\npublic struct SUI_TOKEN_TEMPLATE has drop {}\n\n/// `init()` is called exactly once when the package is published. It initializes the token:\n/// 1. Builds the `Currency<SUI_TOKEN_TEMPLATE>` and `TreasuryCap<SUI_TOKEN_TEMPLATE>` via `coin_registry::new_currency_with_otw`.\n/// 2. Finalizes (without deleting the `MetadataCap`), transferring the pending\n///    `Currency<SUI_TOKEN_TEMPLATE>` to the registry address.\n/// 3. Transfers `TreasuryCap<SUI_TOKEN_TEMPLATE>` and `MetadataCap<SUI_TOKEN_TEMPLATE>` to the transaction sender.\nfun init(witness: SUI_TOKEN_TEMPLATE, ctx: &mut TxContext) {\n    let (builder, treasury_cap) = coin_registry::new_currency_with_otw(\n        witness,\n        DECIMALS,\n        SYMBOL.to_string(),\n        NAME.to_string(),\n        DESCRIPTION.to_string(),\n        ICON_URL.to_string(), // may be updated per-network by scripts/publish.sh after finalize_registration\n        ctx,\n    );\n\n    let metadata_cap = builder.finalize(ctx);\n\n    transfer::public_transfer(treasury_cap, ctx.sender());\n    transfer::public_transfer(metadata_cap, ctx.sender());\n}\n\n#[test_only]\n/// Test-only wrapper around the real `init()`, constructing the `SUI_TOKEN_TEMPLATE` witness\n/// on the caller's behalf (struct literals are restricted to their defining\n/// module, so external test modules cannot do\n/// this themselves). Mirrors production behavior exactly: `TreasuryCap<SUI_TOKEN_TEMPLATE>`\n/// and `MetadataCap<SUI_TOKEN_TEMPLATE>` go to the sender; `Currency<SUI_TOKEN_TEMPLATE>` is transferred to\n/// the registry address `@0xc` (retrievable via `take_from_address`/\n/// `return_to_address` in a later transaction — `Currency<T>` has only `key`,\n/// not `store`, so it cannot be shared or transferred from outside `coin_registry`\n/// by any other means).\npublic fun test_init(ctx: &mut TxContext) {\n    init(SUI_TOKEN_TEMPLATE {}, ctx);\n}\n\n#[test]\nfun test_treasury_cap_transferred_to_sender() {\n    use sui::test_scenario;\n\n    let admin = @0xAD;\n    let mut s = test_scenario::begin(admin);\n    test_init(s.ctx());\n    s.next_tx(admin);\n    let cap = s.take_from_sender<TreasuryCap<SUI_TOKEN_TEMPLATE>>();\n    s.return_to_sender(cap);\n    s.end();\n}\n\n#[test]\nfun test_treasury_cap_present_in_sender() {\n    use sui::test_scenario;\n\n    let admin = @0xAD;\n    let mut s = test_scenario::begin(admin);\n    test_init(s.ctx());\n    s.next_tx(admin);\n    assert!(s.has_most_recent_for_sender<TreasuryCap<SUI_TOKEN_TEMPLATE>>(), 0);\n    s.end();\n}\n\n#[test]\nfun test_metadata_cap_present_in_sender() {\n    use sui::test_scenario;\n\n    let admin = @0xAD;\n    let mut s = test_scenario::begin(admin);\n    test_init(s.ctx());\n    s.next_tx(admin);\n    assert!(s.has_most_recent_for_sender<MetadataCap<SUI_TOKEN_TEMPLATE>>(), 0);\n    s.end();\n}\n\n#[test]\nfun test_currency_transferred_to_registry_after_init() {\n    use sui::test_scenario;\n\n    // Sui's CoinRegistry shared object lives at the well-known address 0xc; OTW\n    // currencies are transferred there pending `coin_registry::finalize_registration`.\n    let registry_address = @0xc;\n    let admin = @0xAD;\n    let mut s = test_scenario::begin(admin);\n    test_init(s.ctx());\n    s.next_tx(admin);\n    let currency = s.take_from_address<Currency<SUI_TOKEN_TEMPLATE>>(registry_address);\n    test_scenario::return_to_address(registry_address, currency);\n    s.end();\n}\n",
+  "scripts/publish.sh": "#!/usr/bin/env bash\nset -euo pipefail\n\nPKG_DIR=\"$(cd \"$(dirname \"${BASH_SOURCE[0]}\")/..\" && pwd)\"\n\n# ─ Utility functions (inlined; no external common.sh in standalone packages) ─\n\nlog() {\n\techo \"[$(date -u +%Y-%m-%dT%H:%M:%SZ)] $*\"\n}\n\nrequire_env() {\n\tlocal var_name=$1\n\tif [[ -z \"${!var_name:-}\" ]]; then\n\t\tlog \"ERROR: $var_name is not set\"\n\t\texit 1\n\tfi\n}\n\nload_env() {\n\tlocal network=$1\n\tlocal env_file=\"$PKG_DIR/.env.${network}\"\n\tif [[ ! -f \"$env_file\" ]]; then\n\t\tmkdir -p \"$(dirname \"$env_file\")\"\n\t\ttouch \"$env_file\"\n\t\tlog \"Created empty .env.${network}\"\n\tfi\n\tif [[ -f \"$env_file\" ]]; then\n\t\tset +u\n\t\tsource \"$env_file\"\n\t\tset -u\n\tfi\n}\n\nsave_env() {\n\tlocal network=$1\n\tlocal key=$2\n\tlocal value=$3\n\tlocal env_file=\"$PKG_DIR/.env.${network}\"\n\tmkdir -p \"$(dirname \"$env_file\")\"\n\tif grep -q \"^${key}=\" \"$env_file\" 2>/dev/null; then\n\t\tsed -i.bak \"s|^${key}=.*|${key}=${value}|\" \"$env_file\"\n\t\trm -f \"${env_file}.bak\"\n\telse\n\t\techo \"${key}=${value}\" >> \"$env_file\"\n\tfi\n\tlog \"Saved ${key}=${value} to .env.${network}\"\n}\n\nget_published_at() {\n\tlocal json=$1\n\techo \"$json\" | jq -r '.objectChanges[] | select(.type == \"published\") | .packageId'\n}\n\nget_created_object() {\n\tlocal json=$1\n\tlocal struct_substr=$2\n\techo \"$json\" | jq -r --arg type \"$struct_substr\" \\\n\t\t'.objectChanges[] | select(.type == \"created\" and (.objectType | contains($type))) | .objectId' | head -1\n}\n\nis_object_exists() {\n\tlocal obj_id=$1\n\tsui client object \"$obj_id\" --json 2>/dev/null | jq -e '.data != null' > /dev/null 2>&1\n}\n\n# ─────────────────────────────────────────────────────────────────────────────\n\nNETWORK=${1:-testnet}\nOUTPUT_ENV=false\nCONFIRM_IMMUTABLE=false\n\nwhile [[ $# -gt 1 ]]; do\n\tcase \"$1\" in\n\t\t--output-env) OUTPUT_ENV=true; shift ;;\n\t\t--confirm-immutable) CONFIRM_IMMUTABLE=true; shift ;;\n\t\t*) shift ;;\n\tesac\ndone\n\nload_env \"$NETWORK\"\n\n# Idempotency check\nif [[ -n \"${SUI_TOKEN_TEMPLATE_TOKEN_PACKAGE_ID:-}\" ]]; then\n\tlog \"XPACKAGENAMEX package already published: $SUI_TOKEN_TEMPLATE_TOKEN_PACKAGE_ID\"\n\n\t# Non-fatal immutability warning if cap still exists\n\tif [[ -n \"${SUI_TOKEN_TEMPLATE_UPGRADE_CAP_ID:-}\" ]]; then\n\t\tif is_object_exists \"$SUI_TOKEN_TEMPLATE_UPGRADE_CAP_ID\"; then\n\t\t\tlog \"WARNING: UpgradeCap $SUI_TOKEN_TEMPLATE_UPGRADE_CAP_ID still exists — package is NOT yet immutable\"\n\t\t\tlog \"To make it immutable, run: bash $0 $NETWORK --confirm-immutable\"\n\t\telse\n\t\t\tlog \"UpgradeCap confirmed consumed — package is immutable\"\n\t\tfi\n\tfi\n\n\tif [[ \"$OUTPUT_ENV\" == \"true\" ]]; then\n\t\techo \"SUI_TOKEN_TEMPLATE_TOKEN_PACKAGE_ID=$SUI_TOKEN_TEMPLATE_TOKEN_PACKAGE_ID\"\n\t\techo \"SUI_TOKEN_TEMPLATE_TREASURY_CAP_ID=$SUI_TOKEN_TEMPLATE_TREASURY_CAP_ID\"\n\t\techo \"SUI_TOKEN_TEMPLATE_METADATA_CAP_ID=$SUI_TOKEN_TEMPLATE_METADATA_CAP_ID\"\n\t\techo \"SUI_TOKEN_TEMPLATE_METADATA_OBJECT_ID=$SUI_TOKEN_TEMPLATE_METADATA_OBJECT_ID\"\n\tfi\n\texit 0\nfi\n\nrequire_env \"SUI_TOKEN_TEMPLATE_ICON_URL\"\n\nlog \"Publishing XPACKAGENAMEX package from $PKG_DIR...\"\n\nPUBLISH_OUTPUT=$(sui client publish \"$PKG_DIR\" --json 2>&1)\n\nSUI_TOKEN_TEMPLATE_TOKEN_PACKAGE_ID=$(get_published_at \"$PUBLISH_OUTPUT\")\nSUI_TOKEN_TEMPLATE_TREASURY_CAP_ID=$(get_created_object \"$PUBLISH_OUTPUT\" \"TreasuryCap\")\nSUI_TOKEN_TEMPLATE_METADATA_CAP_ID=$(get_created_object \"$PUBLISH_OUTPUT\" \"MetadataCap\")\nPENDING_CURRENCY_ID=$(get_created_object \"$PUBLISH_OUTPUT\" \"Currency\")\nSUI_TOKEN_TEMPLATE_UPGRADE_CAP_ID=$(get_created_object \"$PUBLISH_OUTPUT\" \"UpgradeCap\")\n\nif [[ -z \"$SUI_TOKEN_TEMPLATE_TOKEN_PACKAGE_ID\" ]] || [[ -z \"$SUI_TOKEN_TEMPLATE_TREASURY_CAP_ID\" ]] || [[ -z \"$SUI_TOKEN_TEMPLATE_METADATA_CAP_ID\" ]] || [[ -z \"$PENDING_CURRENCY_ID\" ]] || [[ -z \"$SUI_TOKEN_TEMPLATE_UPGRADE_CAP_ID\" ]]; then\n\tlog \"ERROR: Failed to extract object IDs from publish output\"\n\tlog \"Output: $PUBLISH_OUTPUT\"\n\texit 1\nfi\n\nlog \"Published XPACKAGENAMEX package successfully\"\nlog \"  SUI_TOKEN_TEMPLATE_TOKEN_PACKAGE_ID=$SUI_TOKEN_TEMPLATE_TOKEN_PACKAGE_ID\"\nlog \"  SUI_TOKEN_TEMPLATE_TREASURY_CAP_ID=$SUI_TOKEN_TEMPLATE_TREASURY_CAP_ID\"\nlog \"  SUI_TOKEN_TEMPLATE_METADATA_CAP_ID=$SUI_TOKEN_TEMPLATE_METADATA_CAP_ID\"\nlog \"  PENDING_CURRENCY_ID=$PENDING_CURRENCY_ID (owned by registry address 0xc, pending finalize_registration)\"\nlog \"  SUI_TOKEN_TEMPLATE_UPGRADE_CAP_ID=$SUI_TOKEN_TEMPLATE_UPGRADE_CAP_ID (pending immutability confirmation)\"\n\n# ─ OTW currencies require a mandatory second step to become a real, shared, ─\n# ─ RPC-discoverable Currency<SUI_TOKEN_TEMPLATE> object. \"Can be performed by anyone\" ─\n# ─ per the framework docs, but doing it here keeps the deploy pipeline self-contained. ─\n\nlog \"Promoting Currency<SUI_TOKEN_TEMPLATE> via coin_registry::finalize_registration...\"\n\nFINALIZE_REG_OUTPUT=$(sui client call \\\n\t--package 0x2 \\\n\t--module coin_registry \\\n\t--function finalize_registration \\\n\t--type-args \"${SUI_TOKEN_TEMPLATE_TOKEN_PACKAGE_ID}::XMODULENAMEX::SUI_TOKEN_TEMPLATE\" \\\n\t--args 0xc \"$PENDING_CURRENCY_ID\" \\\n\t--gas-budget 100000000 \\\n\t--json 2>&1)\n\nSUI_TOKEN_TEMPLATE_METADATA_OBJECT_ID=$(echo \"$FINALIZE_REG_OUTPUT\" | jq -r '.objectChanges[] | select(.type == \"created\" and (.objectType | contains(\"Currency\"))) | .objectId' | head -1)\n\nif [[ -z \"$SUI_TOKEN_TEMPLATE_METADATA_OBJECT_ID\" ]]; then\n\tlog \"ERROR: Failed to extract the shared Currency<SUI_TOKEN_TEMPLATE> object ID from finalize_registration output\"\n\tlog \"Output: $FINALIZE_REG_OUTPUT\"\n\texit 1\nfi\n\nlog \"  SUI_TOKEN_TEMPLATE_METADATA_OBJECT_ID=$SUI_TOKEN_TEMPLATE_METADATA_OBJECT_ID (shared Currency<SUI_TOKEN_TEMPLATE>)\"\n\n# ─ Set the network-specific icon URL while we still hold MetadataCap as sender ─\n# ─ (this is what makes the icon configurable per network instead of hardcoded) ─\n\nlog \"Setting icon URL via coin_registry::set_icon_url...\"\n\nsui client call \\\n\t--package 0x2 \\\n\t--module coin_registry \\\n\t--function set_icon_url \\\n\t--type-args \"${SUI_TOKEN_TEMPLATE_TOKEN_PACKAGE_ID}::XMODULENAMEX::SUI_TOKEN_TEMPLATE\" \\\n\t--args \"$SUI_TOKEN_TEMPLATE_METADATA_OBJECT_ID\" \"$SUI_TOKEN_TEMPLATE_METADATA_CAP_ID\" \"$SUI_TOKEN_TEMPLATE_ICON_URL\" \\\n\t--gas-budget 100000000 \\\n\t--json > /dev/null\n\nlog \"  Icon URL set to: $SUI_TOKEN_TEMPLATE_ICON_URL\"\n\n# ─ Irreversible step: burn UpgradeCap to make the package immutable ─\n\nif [[ \"$CONFIRM_IMMUTABLE\" == \"true\" ]]; then\n\tlog \"Making XPACKAGENAMEX package immutable (this is IRREVERSIBLE)...\"\n\tsui client call \\\n\t\t--package 0x2 \\\n\t\t--module package \\\n\t\t--function make_immutable \\\n\t\t--args \"$SUI_TOKEN_TEMPLATE_UPGRADE_CAP_ID\" \\\n\t\t--gas-budget 100000000 \\\n\t\t--json > /dev/null\n\n\t# Verify immutability\n\tOWNER=$(sui client object \"$SUI_TOKEN_TEMPLATE_TOKEN_PACKAGE_ID\" --json 2>/dev/null | jq -r '.data.owner')\n\tif [[ \"$OWNER\" != \"Immutable\" ]]; then\n\t\tlog \"ERROR: Expected package owner to be Immutable, got: $OWNER\"\n\t\texit 1\n\tfi\n\n\tlog \"✓ Package $SUI_TOKEN_TEMPLATE_TOKEN_PACKAGE_ID is now permanently immutable\"\nelse\n\tlog \"\"\n\tlog \"━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\"\n\tlog \"UpgradeCap NOT burned — package remains upgradeable.\"\n\tlog \"\"\n\tlog \"To burn the UpgradeCap and make the package permanently immutable,\"\n\tlog \"either:\"\n\tlog \"  1. Re-run with --confirm-immutable flag:\"\n\tlog \"     bash $0 $NETWORK --confirm-immutable\"\n\tlog \"  2. Or confirm interactively now:\"\n\tlog \"\"\n\tread -r -p \"Type CONFIRM to burn the UpgradeCap and make the package immutable: \" ANSWER\n\tif [[ \"$ANSWER\" == \"CONFIRM\" ]]; then\n\t\tlog \"Burning UpgradeCap...\"\n\t\tsui client call \\\n\t\t\t--package 0x2 \\\n\t\t\t--module package \\\n\t\t\t--function make_immutable \\\n\t\t\t--args \"$SUI_TOKEN_TEMPLATE_UPGRADE_CAP_ID\" \\\n\t\t\t--gas-budget 100000000 \\\n\t\t\t--json > /dev/null\n\n\t\t# Verify immutability\n\t\tOWNER=$(sui client object \"$SUI_TOKEN_TEMPLATE_TOKEN_PACKAGE_ID\" --json 2>/dev/null | jq -r '.data.owner')\n\t\tif [[ \"$OWNER\" != \"Immutable\" ]]; then\n\t\t\tlog \"ERROR: Expected package owner to be Immutable, got: $OWNER\"\n\t\t\texit 1\n\t\tfi\n\n\t\tlog \"✓ Package $SUI_TOKEN_TEMPLATE_TOKEN_PACKAGE_ID is now permanently immutable\"\n\telse\n\t\tlog \"Skipped immutability step. UpgradeCap $SUI_TOKEN_TEMPLATE_UPGRADE_CAP_ID is retained.\"\n\tfi\n\tlog \"━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\"\n\tlog \"\"\nfi\n\nif [[ \"$OUTPUT_ENV\" == \"true\" ]]; then\n\techo \"SUI_TOKEN_TEMPLATE_TOKEN_PACKAGE_ID=$SUI_TOKEN_TEMPLATE_TOKEN_PACKAGE_ID\"\n\techo \"SUI_TOKEN_TEMPLATE_TREASURY_CAP_ID=$SUI_TOKEN_TEMPLATE_TREASURY_CAP_ID\"\n\techo \"SUI_TOKEN_TEMPLATE_METADATA_CAP_ID=$SUI_TOKEN_TEMPLATE_METADATA_CAP_ID\"\n\techo \"SUI_TOKEN_TEMPLATE_METADATA_OBJECT_ID=$SUI_TOKEN_TEMPLATE_METADATA_OBJECT_ID\"\n\techo \"SUI_TOKEN_TEMPLATE_UPGRADE_CAP_ID=$SUI_TOKEN_TEMPLATE_UPGRADE_CAP_ID\"\nelse\n\tsave_env \"$NETWORK\" \"SUI_TOKEN_TEMPLATE_TOKEN_PACKAGE_ID\" \"$SUI_TOKEN_TEMPLATE_TOKEN_PACKAGE_ID\"\n\tsave_env \"$NETWORK\" \"SUI_TOKEN_TEMPLATE_TREASURY_CAP_ID\" \"$SUI_TOKEN_TEMPLATE_TREASURY_CAP_ID\"\n\tsave_env \"$NETWORK\" \"SUI_TOKEN_TEMPLATE_METADATA_CAP_ID\" \"$SUI_TOKEN_TEMPLATE_METADATA_CAP_ID\"\n\tsave_env \"$NETWORK\" \"SUI_TOKEN_TEMPLATE_METADATA_OBJECT_ID\" \"$SUI_TOKEN_TEMPLATE_METADATA_OBJECT_ID\"\n\tsave_env \"$NETWORK\" \"SUI_TOKEN_TEMPLATE_UPGRADE_CAP_ID\" \"$SUI_TOKEN_TEMPLATE_UPGRADE_CAP_ID\"\nfi\n",
+  ".gitignore": "# Sui build artefacts\nbuild/\n\n# Sui client keystore and config — never commit private keys\nsui.keystore\nsui.aliases\nclient.yaml\n.sui/\n\n# macOS\n.DS_Store\n\n# Editor\n.vscode/\n.idea/\n*.swp\n*.swo\n\n# Ephemeral Sui publication files (localnet/devnet) — do not commit\nPub.*.toml",
+  "README.md": "# XNAMEX (XSYMBOLX)\n\nXDESCRIPTIONX\n\n## Token Details\n\n| Field | Value |\n| --- | --- |\n| Package Name | `XPACKAGENAMEX` |\n| Module | `XMODULENAMEX` |\n| Struct | `XSTRUCTNAMEX` |\n| Symbol | `XSYMBOLX` |\n| Decimals | `XDECIMALSX` |\n\n## Deploy\n\nTo publish this token to testnet or mainnet:\n\n```bash\nXSTRUCTNAMEX_ICON_URL=https://... bash scripts/publish.sh\n```\n\n`XSTRUCTNAMEX_ICON_URL` is required and network-specific (testnet/mainnet typically point\nat different uploaded images) — the icon is never hardcoded in `sources/XMODULENAMEX.move`.\n`publish.sh` also calls `coin_registry::finalize_registration`, a mandatory second\nstep for OTW-created currencies that promotes the pending `Currency<XSTRUCTNAMEX>` into a\nreal shared, RPC-discoverable object.\n\n## Token Type (After Deployment)\n\nOnce published, the token type will be:\n\n```text\n<PACKAGE_ID>::XMODULENAMEX::XSTRUCTNAMEX\n```\n\n## Design Philosophy\n\nThis token package was generated from [sui-token-template](https://github.com/MeddleWare-Org/sui-token-template) and is intentionally minimal:\n\n- **No minting/burning logic** — Controlled by the downstream packages that consume the coin type\n- **Partially mutable metadata** — Name, symbol, and decimals are permanently fixed. Description and icon URL are updatable via `MetadataCap<XSTRUCTNAMEX>` (governance-gated), using `coin_registry::new_currency_with_otw` + `finalize()` (deliberately *not* `finalize_and_delete_metadata_cap()`, which would lock metadata forever)\n- **Package can be made frozen** — `scripts/publish.sh` extracts the UpgradeCap after publish and offers to call `0x2::package::make_immutable` on it (interactive confirmation, or pass `--confirm-immutable` for non-interactive use). This action is irreversible. Until confirmed, the package remains upgradeable. Metadata mutability is independent of this — it's controlled by the `MetadataCap`, not package upgradeability.\n\n## Tests\n\nRun the inline unit tests:\n\n```bash\nsui move test\n```\n\nFour tests verify:\n\n1. `test_treasury_cap_transferred_to_sender` — TreasuryCap is transferred to deployer\n2. `test_treasury_cap_present_in_sender` — TreasuryCap is present after init\n3. `test_metadata_cap_present_in_sender` — `MetadataCap<XSTRUCTNAMEX>` is present after init\n4. `test_currency_transferred_to_registry_after_init` — `Currency<XSTRUCTNAMEX>` is transferred to the registry address, pending `finalize_registration`\n\n## License\n\nCC0 1.0 Universal — public domain.\n",
+  "deployments.md": "# XSYMBOLX Token Deployments\n\n> **After each deployment, replace the placeholder values in the relevant section with the actual artefact IDs printed by `scripts/publish.sh`.**\n\n## Testnet\n\n| Field | Value |\n| ------------------ | ------- |\n| Package ID | `FILL_IN_AFTER_DEPLOY` |\n| TreasuryCap ID | `FILL_IN_AFTER_DEPLOY` |\n| MetadataCap ID | `FILL_IN_AFTER_DEPLOY` |\n| Currency object ID | `FILL_IN_AFTER_DEPLOY` |\n| UpgradeCap ID (burned) | `FILL_IN_AFTER_DEPLOY` |\n| Immutability confirmed | Yes (Y/N) |\n| Blob ID | `FILL_IN_AFTER_DEPLOY` |\n| Blob Object ID | `FILL_IN_AFTER_DEPLOY` |\n| Blob URL | `FILL_IN_AFTER_DEPLOY` |\n| Deployer Address | `FILL_IN_AFTER_DEPLOY` |\n| Treasury Address | `FILL_IN_AFTER_DEPLOY` |\n| Deployed | `FILL_IN_AFTER_DEPLOY` |\n| Epochs purchased | 50 |\n\n## Mainnet\n\n| Field | Value |\n| ------------------ | ------- |\n| Package ID | `FILL_IN_AFTER_DEPLOY` |\n| TreasuryCap ID | `FILL_IN_AFTER_DEPLOY` |\n| MetadataCap ID | `FILL_IN_AFTER_DEPLOY` |\n| Currency object ID | `FILL_IN_AFTER_DEPLOY` |\n| UpgradeCap ID (burned) | `FILL_IN_AFTER_DEPLOY` |\n| Immutability confirmed | Yes (Y/N) |\n| Blob ID | `FILL_IN_AFTER_DEPLOY` |\n| Blob Object ID | `FILL_IN_AFTER_DEPLOY` |\n| Blob URL | `FILL_IN_AFTER_DEPLOY` |\n| Deployer Address | `FILL_IN_AFTER_DEPLOY` |\n| Treasury Address | `FILL_IN_AFTER_DEPLOY` |\n| Deployed | `FILL_IN_AFTER_DEPLOY` |\n| Epochs purchased | 200 |\n\n## Notes\n\n- `TreasuryCap` and `MetadataCap` are both transferred to the **deployer** address at publish time (`init()`'s `ctx.sender()`), not directly to governance. Transfer them to their intended custodians according to your deployment runbook.\n- `UpgradeCap` is burned via `0x2::package::make_immutable` when `scripts/publish.sh` is run with `--confirm-immutable` (interactive CONFIRM prompt otherwise). This is irreversible — confirm the deployment is final before accepting. Verify immutability with `sui client object <PACKAGE_ID> --json | jq -r .data.owner` → `\"Immutable\"`.\n- Blob Object ID (not Blob ID) is required for lifetime extension.\n\n## Blob lifetime monitoring\n\nTestnet: extend before fewer than 10 epochs remain.\nMainnet: extend before fewer than 50 epochs remain.\n\n```bash\nwalrus extend --blob-obj-id <BLOB_OBJECT_ID> --epochs-extended <N> --context <testnet|mainnet>\n```\n\n## Downstream Move.toml reference\n\n```toml\n[addresses]\nXMODULENAMEX = \"<PACKAGE_ID>\"  # use network-appropriate value\n```\n",
+  "CLAUDE.md": "# CLAUDE.md — XPACKAGENAMEX Package\n\n> **coin_registry OTW pattern — read before verifying deployment**\n>\n> This package uses `coin_registry::new_currency_with_otw` + `builder.finalize(ctx)`.\n> `TreasuryCap` and `MetadataCap` are both transferred to the deployer at publish time.\n> Run `coin_registry::finalize_registration` immediately after publish to promote the\n> pending `Currency` to a real shared object (required for `suix_getCoinMetadata` to work).\n\n## What This Package Is\n\nThis is the concrete XSYMBOLX coin type for XPROJECTNAMEX. It was generated from the\n`sui-token-template` and deployed to Sui testnet/mainnet.\n\nCoin type: `<PACKAGE_ID>::XMODULENAMEX::XSTRUCTNAMEX`\n\n## coin_registry Pattern\n\nThe coin was initialized using:\n\n```move\nlet (builder, treasury_cap) = coin_registry::new_currency_with_otw(witness, ...);\nlet metadata_cap = builder.finalize(ctx);\ntransfer::public_transfer(treasury_cap, ctx.sender());\ntransfer::public_transfer(metadata_cap, ctx.sender());\n```\n\n`init()` builds with an empty icon URL — the real, network-specific value is set\nimmediately post-publish by `scripts/publish.sh` (see below), never hardcoded in source.\n\n| Aspect | Behavior |\n| --- | --- |\n| `Currency<XSTRUCTNAMEX>` registry object | Yes — created pending, promoted to shared via `coin_registry::finalize_registration` |\n| `suix_getCoinMetadata` | Should return non-null data once `finalize_registration` has run — verify post-redeploy |\n| **Immutable fields** | Name, symbol, decimals |\n| **Mutable fields** | Description, icon URL |\n\n## Verification\n\n```bash\n# Package on-chain; check immutability via owner field\nsui client object FILL_IN_AFTER_DEPLOY --json | jq -r '.data.owner'\n# → \"Immutable\" once make_immutable has been confirmed during publish\n\n# TreasuryCap at governance address\nsui client objects FILL_IN_AFTER_DEPLOY | grep -i treasurycap\n\n# Currency<XSTRUCTNAMEX> is discoverable (post finalize_registration)\nsuix_getCoinMetadata \"<PACKAGE_ID>::XMODULENAMEX::XSTRUCTNAMEX\"\n```\n\n## Deployment Artefacts\n\nSee [deployments.md](deployments.md) for all IDs (package, TreasuryCap, MetadataCap,\nCurrency object, Walrus blob).\n\n## Working Rules\n\n- Do not manually edit `sources/XMODULENAMEX.move`. If regeneration is needed, use `create_token.sh`\n  from the `sui-token-template` scripts. The icon URL is never hardcoded here — it is\n  supplied per-network via the `XSTRUCTNAMEX_ICON_URL` env var consumed by `scripts/publish.sh`.\n- Description and icon URL may be updated post-deploy via `MetadataCap` (governance-gated).\n  Name, symbol, and decimals are permanently fixed.\n- Refer to `sui-token-template/CLAUDE.md` for template-level guidance.\n",
+  "AGENTS.md": "# AGENTS.md — XPACKAGENAMEX Package\n\n## What This Package Is\n\nThe deployed XSYMBOLX coin type for XPROJECTNAMEX (Sui testnet/mainnet).\n\nCoin type: `<PACKAGE_ID>::XMODULENAMEX::XSTRUCTNAMEX`\n\nGenerated from `sui-token-template`. Becomes immutable once `scripts/publish.sh` is run with `--confirm-immutable` (or the interactive CONFIRM prompt is accepted) — this burns the UpgradeCap via `0x2::package::make_immutable`. Verify with `sui client object <PACKAGE_ID> --json | jq -r .data.owner` → expect `\"Immutable\"`.\n\n## Coin Registry Pattern\n\nThis coin uses `coin_registry::new_currency_with_otw` + `.finalize(ctx)` (the\nframework's documented replacement for deprecated `coin::create_currency`) to\nproduce a `Currency<XSTRUCTNAMEX>` registry entry. Because OTW currencies require a\nmandatory second transaction (`coin_registry::finalize_registration`) to become\nshared and RPC-discoverable, `suix_getCoinMetadata` only returns non-null data\n*after* that step has run — `scripts/publish.sh` performs it automatically.\nMetadata fields:\n\n- **Immutable**: Name, symbol, decimals\n- **Mutable**: Description and icon URL — gated by `MetadataCap<XSTRUCTNAMEX>`. The\n  *initial* per-network icon is set once directly by `scripts/publish.sh` via\n  `coin_registry::set_icon_url`. Subsequent updates go through governance.\n\n## Verification Commands\n\n```bash\n# Confirm package exists and is immutable\nsui client object FILL_IN_AFTER_DEPLOY\n\n# Confirm TreasuryCap at governance\nsui client objects FILL_IN_AFTER_DEPLOY | grep -i treasurycap\n```\n\n## Key Files\n\n| File | Purpose |\n| --- | --- |\n| `sources/XMODULENAMEX.move` | Generated coin source (do not edit manually) |\n| `deployments.md` | Artefact IDs (package, TreasuryCap, MetadataCap, Currency object, blob) |\n| `scripts/publish.sh` | Build + publish + finalize_registration + set initial icon URL |\n\nFor template-level guidance, see `sui-token-template/AGENTS.md`.\n"
+}

package/test-results/.last-run.json

@@ -0,0 +1,4 @@
+{
+  "status": "passed",
+  "failedTests": []
+}

package/tests/accessGate.test.ts

@@ -0,0 +1,108 @@
+import { describe, it, expect, vi, afterEach } from 'vitest'
+import {
+  parseOwnedAccessNft,
+  fetchAccessNfts,
+  buildPurchaseTx,
+  buildConsumeTx,
+  personalMessageForNonce,
+  buildAccessProofToken,
+  fetchRelayChallenge,
+} from '../src/lib/accessGate.js'
+import type { AccessGateConfig, OwnedObjectsClient } from '../src/lib/accessGate.js'
+
+afterEach(() => vi.restoreAllMocks())
+
+const PKG = '0x00000000000000000000000000000000000000000000000000000000000000aa'
+const GATE = '0x00000000000000000000000000000000000000000000000000000000000000a1'
+const NFT_TYPE = `${PKG}::access_gate::AccessNFT`
+
+const cfg: AccessGateConfig = {
+  packageId: PKG,
+  gateId: GATE,
+  nftType: NFT_TYPE,
+  soulbound: false,
+  priceMist: 1000n,
+}
+
+function entry(objectId: string, gateId: string, uses?: number) {
+  return {
+    data: {
+      objectId,
+      content: {
+        fields: {
+          data: {
+            fields: {
+              gate_id: gateId,
+              variant:
+                uses === undefined
+                  ? { variant: 'UnlimitedPass', fields: {} }
+                  : { variant: 'SingleUse', fields: { uses_remaining: String(uses) } },
+            },
+          },
+        },
+      },
+    },
+  }
+}
+
+function commandsJson(tx: { getData: () => unknown }): string {
+  return JSON.stringify(tx.getData())
+}
+
+describe('accessGate lib', () => {
+  it('parses unlimited pass and single-use NFTs', () => {
+    expect(parseOwnedAccessNft(entry('0x1', GATE))).toEqual({
+      objectId: '0x1',
+      gateId: GATE,
+      usesRemaining: null,
+    })
+    expect(parseOwnedAccessNft(entry('0x2', GATE, 5))?.usesRemaining).toBe(5)
+    expect(parseOwnedAccessNft({ data: { objectId: '0x9', content: { fields: {} } } })).toBeNull()
+  })
+
+  it('fetchAccessNfts filters by gate and passes the StructType filter', async () => {
+    const client: OwnedObjectsClient = {
+      getOwnedObjects: vi.fn(async () => ({
+        data: [entry('0x1', GATE), entry('0x2', '0xother', 1)],
+      })),
+    }
+    const nfts = await fetchAccessNfts(client, '0xowner', NFT_TYPE, GATE)
+    expect(nfts).toHaveLength(1)
+    expect(nfts[0].objectId).toBe('0x1')
+    expect(client.getOwnedObjects).toHaveBeenCalledWith(
+      expect.objectContaining({ owner: '0xowner', filter: { StructType: NFT_TYPE } }),
+    )
+  })
+
+  it('buildPurchaseTx splits gas and calls purchase', () => {
+    const json = commandsJson(buildPurchaseTx(cfg))
+    expect(json).toContain('SplitCoins')
+    expect(json).toContain('"function":"purchase"')
+  })
+
+  it('buildConsumeTx selects consume vs consume_soulbound', () => {
+    expect(commandsJson(buildConsumeTx(cfg, '0x1', 'n'))).toContain('"function":"consume"')
+    expect(commandsJson(buildConsumeTx({ ...cfg, soulbound: true }, '0x1', 'n'))).toContain(
+      '"function":"consume_soulbound"',
+    )
+  })
+
+  it('encodes the proof token and message', () => {
+    expect(new TextDecoder().decode(personalMessageForNonce('x'))).toBe('nft-gate:access:x')
+    const token = buildAccessProofToken({ address: '0x1', nonce: 'n', signature: 's', consumeDigest: 'd' })
+    expect(JSON.parse(Buffer.from(token, 'base64').toString('utf-8'))).toEqual({
+      address: '0x1',
+      nonce: 'n',
+      signature: 's',
+      consumeDigest: 'd',
+    })
+  })
+
+  it('fetchRelayChallenge parses the gateway response', async () => {
+    vi.stubGlobal(
+      'fetch',
+      vi.fn(async () => new Response(JSON.stringify({ nonce: 'abc', expiresAt: 7 }), { status: 200 })),
+    )
+    expect(await fetchRelayChallenge('https://relay.example')).toEqual({ nonce: 'abc', expiresAt: 7 })
+  })
+})